1. Home
  2. Docs
  3. Documentation
  4. Avimesa.Live

Avimesa.Live

Avimesa.Live is an industrial-IoT web app that allows you to view your Avimesa Messages. It provides Data Visualization, Device Management, Alerting and Device Simulation. Using the built-in sensor data simulator you can get started developing quickly and inexpensively without the need for special hardware.

Table of Contents

Top

1. Overview

1.1 Summary

Avimesa.Live is a web-app built on the Sails.js framework, a popular Node.js MVC framework. It interfaces with your Avimesa account to provide data visualization of your messages sent from Avimesa 1000 devices and Avimesa Gadget clients. It also provides front-end device management and tools to manage sensors on each device and create alerts for different scenarios. There is also a Device Simulator tool that allows you to simulate different devices and sensors enabling you to get started developing quickly without the need for special hardware.

Top

2. Getting Start

If you are viewing this after creating an account, please wait a few minutes for a secondary email to arrive with your account credentials. In the meantime you can read this document to learn more about what Avimesa.Live has to offer and also view a short guide on what you can do to get started once your account is finished setting up. The Getting Started with Device Simulator Guide below will teach you how initially navigate the Avimesa.Live interface and set up two basic sensors and use the Device Simulator.

2.1 Signing Up

  1. First visit the Avimesa.Live page at avimesa.live and click on sign up on the top-right alt text
  2. Enter your Information into the fields and click on Create Account alt text
  3. You will now receive a verification email addressed to the email address that you used to sign up. The email will be from support@avimesa.com and will prompt you to click on confirm email to complete your registration. alt text
  4. Now you will be notified that your account is being created. Within a couple minutes, you will receive another email with your Avimesa account credentials and API Keys. Here you can also view the Getting Started with Avimesa.Live guide to learn a bit more about Avimesa.Live and how to navigate the system. alt text
  5. You will now receive an email titled Welcome to Avimesa.Live!. This email contains you Avimesa Group Api credentials and The Keys for your first two provisioned devices. You can also click on the link provided to view the login page. alt text
  6. Login at by going to avimesa.live and clicking on login on the top-right. Here you can login with the email and password that you used to signup in step 2. alt text
  7. Once you are logged in you will see the landing page. If you would like to learn about the basics of the Device Simulator, then continue reading to the Getting Started with Device Simulator section next. alt text

Top

2.2 Getting Started with Device Simulator

This will guide you through adding two sensors and sending simulated data with Device Simulator and viewing them on the chart. You can also view this guide on the Getting Started section within the Avimesa.Live navigation bar.

1. Go to Devices and click on the Device ID with which you want to send data from

2. Click on + to add a sensor on top right of sensors info. Sensors must be added here otherwise messages sent from a device won’t be received properly.

3. Add a new Amp (AC) sensor on channel 1 with min reading 0 and max 5

4. Add a new Temp (Fahrenheit) sensor on channel 2 with min reading 0 and max 300

5. Go to Device Simulator

6. Select the Device you just configured sensors for, then select some values for the temperature & amperage and click Run.

7. View the results on the graph below!

Next Steps

Before you use real sensors, make sure you delete the simulated ones you created before to prep for real data. First select a sensor, then delete it.

You are now ready to try sending some real data!

Top

3. Features

Avimesa.Live provides many different features and tools to manage devices, sensors, alerts, and users.

3.1 Devices

Avimesa.Live provides ways to easily manage your devices. On Avimesa.Live, if you click on Devices on the navigation menu you will view the Devices Overview page providing basic information on all of your provisioned Avimesa Devices. alt text

On this same page, you can click on the cog icon for any device to edit or delete that device. When you select edit, you will be brought to the edit-device page. alt text

On this page, you can edit the devices information. Here are some descriptions for what each field are:

  • Device ID: The provisioned Identifier for the Device within the Avimesa Messages Infrastructure. Cannot be changed.
  • Device Auth Key: The Authentication Code or Password for secure communication with the Avimesa Messages Infrastructure. Cannot be changed.
  • Device Name: A Name that you provide to identify and differentiate your different devices. Can be anything you want.
  • Device Location: An identifier for the location of the device. Can be anything you want.
  • Sleep Interval: Currently Only used for Avimesa 1000 Devices. This determines the amount in seconds that an Avimesa 1000 will sleep before waking up to send another message. Can be any integer you want.
  • Device Type: The Device Type that this Device is provisioned to be. It can either be an Avimesa Gateway, Avimesa 1000, or an Avimesa Gadget Client/Device Simulator. When Devices are created through Avimesa.Live they are defaulted to Avimesa Gadget Device.
  • isCustomScript: This is used if you want to use a Custom Script. You can upload one in the details page for a device. Beware: if your script is not formatted correctly, your Avimesa.Live functionality may not process correctly.

Back on the first page you can also add/remove Avimesa devices. If you click on Add Device you will be prompted to select the type of Device this will be as well as enter a Name and Location for the device. alt text

When you select delete device, you will be asked to verify if you would like to delete the device. alt text

After the device has been added/deleted, there will be a short delay to process the request and then your page should refresh. If it did not refresh or the device did not appear/disappear properly, you can click Refresh All Devices to try reloading the page for the updated Device list.

When you click on a specific device, you will be brought to that devices detailed page. alt text

On this page you can see the information on the Device and also upload a custom script for the device if you want. Beware: if your script is not formatted correctly, your Avimesa.Live functionality may not process correctly. If you do not know what you are doing, it is highly recommended you do not upload a custom script.

On this same page you can also configure your sensors and alerts related to the device. You can learn more about these below.

Top

3.2 Sensors

Avimesa.Live provides ways to manage the Sensors on your Devices. To add sensors, first go to the devices page and select the device that you would like to add sensors for. alt text

Here you will see that your device does not have any sensors configured yet. You can click on the + sign on the top right to add a sensor alt text

On this page you can add the information that relates to the sensor you are using (or would like to simulate in the case of Device Simulator). Here are some descriptions for what each field are:

  • Sensor Name: A name identifier for your sensor. Can be anything you want.
  • Sensor Units: The Units of measurement that your sensor outputs for you to recognize. Can be anything you want.
  • Location Description: A Short description of where this sensor may be located. Can be anything you want.
  • Sensor Channel no.: This is the channel that the Sensor will be attached to within the Avimesa 1000. If using Avimesa Gadget, this is the channel within the Dialtone that you send a message with.
  • Min Reading: The Minimum value that the sensor can output.
  • Max Reading: The Maximuim value that the sensor can ouput.

Once you have added a sensor, you will see now see a table with basic information on the sensors configured for that device. alt text

Here you can select the cog to edit the information for that sensor or you can delete that sensor altogether. If you click on a sensor you will also view detailed information regarding that single sensor. On that page you can view a graph pertaining to that sensor only and the history of alerts that were triggered that are related to that sensor.

Speaking of graphs, once you have added at least one sensor, you will see a new section on the device details page labeled Sensor Graphs. This graph is also now viewable on the welcome/landing and the Device Simulator page of the web-app. There you will be able to see a graph for all your configured sensors for all devices. While on the specific details page for a device, you will only view sensor graphs for the sensors that are configured for that device. If you would like to see a graph for a specific sensor only, you can select a sensor as mentioned above to view a specific graph for that sensor. alt text

Here you can see a simple graph displaying the sensor data for any data that you have coming in. A couple features of the graph include:

  • Selecting A Sensor: On the top-left you can see a dropdown to change the graph to display data for any sensor of your choice
  • Date: On the top-right you can select the date ex. 5/22/2020 to select a different date. This will view a summary of the data received for all 24-hours of the date selected.
  • Latest 5m: On the top-right if you select latest 5m, the graph will show the data for the latest 5 minutes received. This is the default setting.

Top

3.3 Alerts & Notifications

Avimesa.Live allows you to configure different Alerts. When an alert is triggered it will send either an email and/or SMS message to signal you. To add an alert, within the device details page where you added a sensor, you can see the Alerts. Once you have added a sensor, simply click on the + sign on the Alerts section to add one. alt text

Here you can configure a new alert. Here are some descriptions for what each field are:

  • Name your alert: This is a short description for the alert that will be the subject of your email/SMS. ex: Temperature > 50C
  • Notify Users: A list of users within your group for whom you want to send this alert too.
  • Channels: Select whether you want to receive this Alert via Email or SMS or both.
  • Alert Conditions: The different conditions for when you want this alert to trigger. ex: Temp Sensor 1 is Greater than 50

Once you have configured an alert, you can see a list of them on the devices details page, where you added them. alt text

When alerts are created, Avimesa.Live will generate a script for the device and upload it to Avimesa Messages for you (Unless you have a custom script enabled). When an alert has been triggered, Avimesa Messages will send them to a Groups Notification queue where Avimesa.Live will see this and immediately send a notification via email/sms to the users selected on the Alert. You can view a history of the Notifications that were sent in Notification History by clicking on the navigation menu. alt text

Top

3.4 Users

Avimesa.Live has a user management system to allow any Avimesa Customers to create their own user base with individual logins and varying privileges as well. Visit the Users Overview page by clicking on Users on the navigation menu. alt text

Here you will see a list of all the users that are within your Avimesa Group. The First/default login account that is created along with your Avimesa Group is automatically an administrator within that group. Administrators of Groups can:

  • Add/Delete Users
  • Make Other Users Administrators
  • Add/Delete Devices

Within this page you can click on Create New User to create a new login for your group. alt text

On this page you will be able to create a new login. Here are some descriptions for what each field are:

  • First Name: The new users’ First name
  • Last Name: The new users’ Last name
  • Email Address: The new users’ Email Address (Will be their login)
  • Phone: The new users’ phone number. Used for SMS alerts. (optional)
  • Group: Select the group that you want this User to be a part of.
  • Make Admin: Check this if you want the new user to have administrator privileges (manage users/devices)
  • Password: A password for the new user. Once it is created they can change it themselves. alt text

For any users within your account, if you would like to delete them or make them administrators as well so they can configure users/devices. Click on the cog icon on the user you want to change and select the appropriate option.

Along with being able to manage other Users, you can also access your own profile and edit information there. To view your account information, click on your name under Avimesa.Live on the navigation menu and select User Settings alt text

Once you click on this, you will be greeted with your personal account information alt text

Here you can click on Edit Profile to change your name, email address, or phone number. You can also click on Change Passwrod to change your password if you would like.

Top

4. Device Simulator

Device Simulator allows you to simulate your devices with simulated sensor input. Using this tool you can get started on building/developing a potential solution quickly and inexpensively without the need for special hardware.

Click on the Device Simulator on the navigation menu to view the Device Simulator page. alt text

First on the Device Simulator Page, you can select the Device for which you want to simulate data for. Once you have chosen a Device from the dropdown menu, a list of sensors that have been configured on that device will appear. If there are no sensors configured for the device, you can click on the Page where it says Reconfigure Sensors for this device to go directly to the devices detail page to set up some sensors.

Table of Sensors shows the sensors you have configured as well as a Data Simulation Value. This Value is calculated based on the sensors min and max value that were configured upon the creation of the sensor.

  • 0 = 0%-20% of the values between the min and max
  • 1 = 20%-40% of the values between the min and max
  • 2 = 40%-60% of the values between the min and max
  • 3 = 60%-80% of the values between the min and max
  • 4 = 80%-100% of the values between the min and max

Within the Settings you can set the Delay and Message Count before you hit run. * Delay: The amount of time, in seconds, that the simulator will wait between each message. This must be at least 1 * Message Count: The amount of messages you want to simulate. alt text

On This page you will also see another Sensor Graph. This allows you to quickly view all of your sensor data without having to navigate off of the simulator page. Select the sensor that you want to view data for or the sensor you are currently simulating and you will see the data on the graph.

Top