Matching results

    Getting started with the dashboard and rules

    This tutorial tells you how to detect a change on the system and trigger an action in order to automate monitoring of your device fleet and how to visualize your operational KPI with the dashboard.

    The first section introduces a use case which has been defined for embedded application tutorial like for the HL8518-S. If you use a different application, don’t worry as you can adapt the rules and the dashboard to your own use case.

    Use case Description

    To exploit data from the fleet, organisations often choose to define a custom dashboard in AirVantage, with visual widgets and alerts.

    To put the dashboard tutorial on this page in context, imagine the following use case:

    For a fleet of refrigerated trucks, containers must be monitored via AirVantage to ensure that temperature-sensitive perishable cargo (blood, chilled food…) remains within safety parameters

    • when the truck’s container door is closed, refrigeration system (fan, compressor) must operate
    • an alarm sensor checks CO2 level to detect fire or human presence in the container

    Every two days, the fan is physically checked by a maintenance engineer.

    Application description

    Each truck is fitted with a device that sends the following data to AirVantage:

    • Variables:
      • doorOpen (boolean), true if the door is opened
      • Temperature (float), just the temperature value
      • FanDuration (int between 0 and 3200 minutes): duration in minutes when the fan works
      • Alarm (boolean): status of the alarm system (on/off). The CO2 rate is analyzed to raise an alert
      • Fan (Boolean): status of fan (on/off)
      • CO2 Alert (Boolean): alert sent if CO2 is too high (can be sent only if alarm is on)
    • Settings:
      • TargetTemp (float, by default is -5): this settings define the targeted temperature. When the temperature is reached, the fan stops.

    And AirVantage must be able to send the following Commands to the truck’s device:

    • Arm CO2 Alarm/Disarm CO2 Alarm (Arm command checks the door is closed)
    • Start/stop Fan (startFan checks FanDuration < 3000). Fan is automatically stopped when temp <= targetTemp

    Building the rules

    Rules must be created to detect any change about your system and automate action when a given change has been detected. Thus you can highlight a specific behavior of your system and fix the problem.

    A rule musst contain a name, a list of conditions and a list of actions to trigger like notify a user by email, act on the system or push the alert to your application.

    Thus the following rules can be defined:

    • If temp > 0 then send command startFan
    • If temp > 10 then send email
    • If fanDuration > 3000 then send email
    • If doorOpen is false & alarm is false then send command wind alarm

    Create the rules

    In order to simplify the creation of a rule, a set of templates is available to focus on what you want to monitor. If you want to use any of the available data and operator, choose Custom:

    • Communication status change: define a condition based on the system (name, label, offer or communication)
    • Data sent to AirVantage: define a condition based on a data from the device
    • Monthly usage limit exceeded: Monthly data exchanged is greated than a given MB
    • Usage limit exceeded: define a condition based on any connectivity metrics (voice duration, nb of SMS, …)
    • Usage status change: define a condition based on the data plan status
    • Custom: define a condition with one among all the available conditions

    Let’s create the following rule If temp > 0 then send command startFan:

    • Go to Configure > Alert Rules.
    • Click on the + button
    • Fill the name and description. The name will be used in the interface and the connectors to show the event raised by this rule
    • Click on the Data sent to AirVantage template
    • Select your application which sends the data you want to monitor
    • Select the Temperature data
    • By default, the last raw data value sent by the device is used but you can change to aggregated data.
    • Select the operand is greater than and fill the right value
    • Select the action Send Command and select the startFan command
    • Select the application and the command with the parameters
    • Click on Save

    This rule will create a Send Command operation which will be executed as soon as the device will be connected with AirVantage.

    You can proceed like this for each rule.

    The command will not be sent again when the conditions are no longer met. However, the Add label action will remove the label when the conditions are no longer met.

    View the events

    Each rule will raise an event (an alert) each time the condition is met. The event can be view in 3 pages:

    Top Bar Notification

    In the top bar, a quick notification when an event has been raised. By clicking on an event, you can see more details about this event.

    System’s Alert State

    In the table in Monitor > Systems, the systems are identified in error if a problem has been detected by a rule as long as the problem is still raised.

    Alerts History

    In Monitor > Alerts, all the current alerts are listed for troubleshooting. If you click on an alert, a dialog box shows you the details of the alert.

    Building the dashboard

    Now that you can detect systems change, you may want to have a single dashboard to show KPI about your fleet and drill down to a system’s dashboard.

    Here the way to define a dashboard for a system:

    • Go to Monitor > System
    • Choose your referenced system you used to build your dashboard (all the system will share this dashboard)
    • Click on the line to drill down into the system’s view.
    • You can add or remove a widget, change the size of some widgets by clicking on the top bar button. For more information about the dashboard, click here .

    You can customize your fleet dashboard:

    • Click on the top left icon
    • Proceed like for the system dashboard. By default, the widget will show the data aggregated for all the fleet but you can select a specific system.

    This dashboard contains the following widgets:

    First Line (from left to right)

    • Single Value Widget: Temperature (raw value), Unit: °C and precision set to 0, title: Target Temperature
    • Gauge widget: Current Temp (raw value), Precision: 2, minimum: -15, maximum: 20, threshold 1: -1, threshold 2: 5
    • Map Widget: no configuration required - shows truck location
    • Single Value Widget: Fan state (raw value), 2 rules to set an icon:
    • Alarm State Widget: See the configuration on the right

    Second Line (from left to right)

    • Combo Chart Widget: Fan Use Duration with chart option to show the period browser (drop-down list), select SUM aggregation and configure the option like in the screenshot on the right.
      • Show the data configuration and select histogram Type in the Serie section, check cumulated

    • Command widget: based on the fan and alarm commands above
      • Add a new button for each command you want to access on a given line
      • Add a new tab if you want to add a new line
      • Configure the command associated to the button by selecting the application which manages the command and the command with the parameter. If no parameter is selected, all the mandatory parameter will be required to the user.

    Third Line:

    • Alert history: This widget requires no configuration.

    Next Step Once your system communicates correctly with AirVantage and data values can be browsed and displayed, you may want to get them in your specific application. Have a look to our AirVantage API to learn how to use these API to build powerfull application for your customer.