AXIS Sensor Metrics Dashboard

About the application

AXIS Sensor Metrics Dashboard allows you to collect, store, and visualize data from sensors connected to your device in a structured manner.

For a list of supported devices, see axis.com/products/axis-sensor-metrics-dashboard#compatible-products

Supported sensors

The application supports the following sensor types:

  • Axis built-in accelerometer

  • Satellite navigation systems using RS232 serial port mode

  • All single register data holder Modbus devices over IP or RS485 serial port mode

Note

You have to select which serial port mode to use.

The Modbus data sources read from only one register. To access more registers, add more data sources.

Get started

Download and install the application

To install the application, go to the axis.com/products/axis-sensor-metrics-dashboard and download the latest version. Log in to the device you want to install the application on and follow these steps:

  1. Go to Apps.

  2. Click Add app.

  3. Select the file in your downloads folder.

  4. Click Install.

  5. Turn on the app to activate the application.

Note

To upgrade the application, just install the new version. There is no need to uninstall the previous version.

Configure the application

Add a data source

To collect and visualize data, add data sources to your device.

  1. In AXIS Sensor Metrics Dashboard, go to Source.

  2. Click + Add data source.

  3. Add a name for the source.

  4. In the Source drop-down menu, select the type of sensor you want to add.

  5. Under Sensor, enter sensor type and unit for the sensor output.

  6. Configure the sensor type-specific settings.

  7. Click Save.

  8. To start reading data from the sensor, toggle Start.

  9. The name, type and unit that you have specified for the sensor is visualized in the Dashboard tab. For more information, see View live sensor data in the dashboard.

Edit a data source

  1. Go to Source.

  2. Click on the source you want to edit.

  3. Select Edit in the drop-down menu and edit the sensor-specific settings.

View live sensor data in the dashboard

  1. Go to Source.

  2. Go to the sensor you want to view data from and make sure you have toggled Start.

  3. To view the latest read data from the sensor, go to Dashboard.

  4. The name, type and unit that you have specified for the sensor is shown in the Dashboard tab. If you want to edit any of the settings, see Edit a data source.

Download data from a data source

You can download sensor metrics data to a file for expanded usability in applications such as Microsoft® Excel. The file format is CSV.

  1. Go to Source.

  2. Click on the source you’d like to download data from.

  3. Select Download data in the drop-down menu.

  4. Select a file from the drop-down menu.

  5. Click Download.

  6. The file is downloaded to your downloads folder, and is also available under Data files from where you can download it again at a later stage.
  1. To download the csv file from Data files:
  2. Go to Data files.

  3. Select the file you’d like to download.

  4. Click the download icon next to the filename.

  5. Download could take a while depending on the file size.
Note

The GPS data columns for longitude and latitude are represented in radians.

Remove a data source

You can remove sensor metrics data sources that you no longer require. Data from the removed source will no longer be collected, but it doesn’t affect stored data.

  1. Go to Source.

  2. Click on the source you’d like to remove.

  3. Select Remove in the drop-down menu.

  4. Click Yes to confirm.

Connect sensors

You can connect sensors to the main unit using either the network or the serial port.

Modbus over IP: 

Connect the sensor to the same Wi-Fi network as the camera. Be sure to assign an IP address that is within the same subnet as the camera. 

Modbus over Serial: 

Connect a Modbus serial (RS485) device to the camera serial port. A description of the pin configuration of the F9114/F91111 serial port can be found in the F9114 user manual.

GPS: 

Connect a GPS (RS232) to the correct pins of the serial port of the camera. A description of the pin configuration of the F9114/F9111 serial port can be found in the F9114 user manual.

Examples

Add a serial Modbus data source

In this example, we are going to add a Modbus data source over a serial connection.

  1. Click + Add data source.

  2. Type the name of the source. 

  3. Select Modbus over serial in the Source drop-down menu. 

  4. Click the link Current serial port configuration on main unit to configure your serial port to match the requirements of your modbus device. 

  5. Back in the application, set a Sample time and select a unit of time.

    The sample time determines how often the application reads data from the sensor, updates the values in the dashboard, and writes the values to the CSV file.

  6. To show the sensor data in the dashboard, add Type and Unit.

  7. Configure the Device ID. Consult the modbus vendor manual if necessary. 

  8. Configure which Register to read from. Typically this can also be found in the vendor manual. 

  9. Specify Scaling and Offset.

    The values can be used to do a measurement unit conversion of the sensor data. 

  10. Click Test read to see what sensor value is being read.

    This is a quick way to confirm that the device is configured and wired correctly. 

  11. Turn on Threshold and add a threshold value which, when crossed, will be used as a trigger in event management.

  12. Set a Retention time.

    The retention time specifies for how the created data files remain on the SD card before they're automatically deleted.

  13. Click Add

  14. Click Start to start reading from the data source.

Note

In the section Write to Modbus device, it is possible to change the value of certain registers. That could be for example changing the baud rate of the modbus sensor. Another use case is if you have multiple identical devices, you need to assign different Device IDs to them to be able to communicate with them in parallel.

Add a GPS data source

In this example, we are going to add a GPS device connected over the RS232 serial connection.

  1. Click + Add data source.

  2. Type the name of the source.

  3. Select Satellite navigation (GPS) in the Source drop-down menu.

  4. Click the link Current serial port configuration on main unit to configure the serial port of the camera to match the requirements of your RS232 GPS device. Consult the GPS vendor manual if necessary.

  5. Back in the application, set a Retention time.

    The retention time specifies for how long the created datafiles will remain on the SD card. After the specified time they will be automatically deleted.

  6. Click Add.

  7. Click Start to start reading from the data source.

Activate logging of events (Optional):

  1. Go to the data source configuration.

  2. To enable the speed event functionality, toggle Speed event.

  3. Select an appropriate threshold value.

  4. To use the event as a condition in a rule, perform steps 7-14 of Use sensor data in event management.

Note

GPS data sources only work when the serial port mode is set to RS232. Use of GPS connected with RS485 is not supported.

Set up rules for events

You can create rules to make your device perform an action when certain events occur. A rule consists of conditions and actions. The conditions can be used to trigger the actions. For example, the device can start a recording or send an email when it detects motion, or show an overlay text while the device is recording.

You can create rules to make your device perform actions when certain events occur. A rule consists of conditions and actions. The conditions can be used to trigger the actions. For example, the device can play an audio clip according to a schedule or when it receives a call, or send an email if the device changes IP address.

To learn more, check out our guide Get started with rules for events.

Use sensor data in event management

In this example use case we will flash a LED based on data from a device’s accelerometer.

  1. Go to the app in the device web interface.
  2. Go to Sources.

  3. Go to Accelerometer and click on the ... menu.

  4. Select Edit in the drop down menu.

  5. Enable Shock event.

  6. Set the Shock trigger level to a threshold value that will trigger an event when exceeded.

  7. Click Save.

  8. Go to System > Events.

  9. Click on +Add a rule.

  10. Type a name for the rule.

  11. Under Condition, select AXIS Sensor Metrics Dashboard: Shock in the drop-down menu.

  12. Under Action, Select Flash status LED.

  13. Select color.

  14. Select duration of the flash.

  15. Click Save.