Telemetry2U IoT Platform Documentation
4.1 - Reports Main Page
The main Reports Page shows you a table of current/recent readings from all of the nodes accessible on your account. Using the options in the top header, you are able to select a node from the 'Node' list to view the data history on that particular node in table format. Alternatively, you can click the hyperlink on the name of the node from the 'Node Description' from within the table to select a new node to view.
There are five types of reports available to view and download that can be selected from the 'Type' list. Not all of them will be available as they can depend on your account configuration and access privileges
- Data Report - Converted sensor data.
- Alert History - Displays a list of what alerts have been triggered and what notifications have been sent.
- Sent Commands - Shows a list of all commands sent by any user linked to the company account.
- Join Requests - A list of all join requests from any sensors linked ot the company account
- Raw Data - Displays the Raw hex value for the sensor data. This can be used for debugging
You can choose a custom 'Start Date' and 'End Date' to define the range of your dataset and then click on the 'Load' button to retrieve the data. Please note that there is a limit of 10,000 records for a period. The arrow next to the 'Load' button has some options to download the data in common formats including CSV and Excel.
If you would like to see a real-time working example of Telemetry2U's Charts page with some demonstration nodes we have set up, please log into our Guest Account and take a tour.
4.2 - Report Icons and Colours
Below is the example Reports Page shown after clicking on the 'LGT92 GPS/Motion Sensor Demo'. This page gives an example of all the Icons and Colours used on a typical report both in normal conditions, pre-alert and during an actual alert.
All of these Icons and colours are explained in the section below.
The 'Globe' Icon indicates that the position can be opened in one of three online map providers; Google Maps, Open Street Maps or Bing Maps. The map provider can be selected by company administrators in the 'User Maintenance section when creating or editing a user account.
The 'Warning' Icon indicates when a node has entered an alert condition. You can read more about the alert condition in the 'Alert Maintenance section.
If the user has the 'Add Annotation’ permission granted in the 'User Access' section, they will be able to click this icon to leave an annotation on the event that will then be recorded and made available in the Audit Report. These will only be seen on records with a Green background, and if an Annotation has not already been left
The 'Recovered' Icon indicates when a node has recovered from an alert condition. You can read more about alert conditions in the 'Alert Maintenance section. If the user has the 'Add Annotation’ permission granted in the 'User Access' section, they will be able to click this icon to leave an annotation on the event that will be recorded and made available in the Audit Report. These will only be seen on records with a Red background, and if an Annotation has not already been left.
The 'Pin-Board' Icon indicates that a user has clicked on a 'Warning' or 'Recovered' Icon and left an Annotation. If a user has had the 'Add Annotation’ permission granted in the 'User Access' section, they will be able to click on this Icon again to either edit or delete the Annotation.
An orange background on a record indicates that the node has a sensor input that has triggered an alert condition, but has not yet had enough 'Consecutive Readings' to alert any Notification Groups. You can read more about alert conditions and consecutive records in the 'Alert Maintenance' section.
A Red background on a record indicates that the node has a sensor input that has triggered an alert condition enough times in a row to exceed the 'Consecutive Readings' limit set on the Alerts page and the Notification Group(s) have been notified with a message. Users with the 'Add Annotation' permission granted can optionally click on the ‘Warning’ icon to leave an Annotation. You can read more about alert conditions and consecutive records in the 'Alert Maintenence' section.
A Green background on a record indicates that the node has a sensor input that has triggered an alert condition and sent a message(s) to the Notification Group(s), but has since recovered. Notification Groups are again sent a message to inform them the sensor has recovered. Users with the 'Add Annotation' permission granted can optionally click on the 'Recovered’ Icon to leave an Annotation. You can read more about alert conditions and consecutive records in the 'Alert Maintenance' section.
4.3 - Adding and Editing Annotations
Users with the 'Add Annotation' permission granted in the User Access Section will be able to write custom notes in the 'Annotation' field that will be saved in the database and optionally displayed in the Audit Reports. If the 'Add Annotation' permission is not granted, you will be able to view Annotations but not edit them.
To add an annotation to an alert event, click on either the 'Warning’ Icon or the 'Recovery’ Icon as described above in 'Report Icons and Colours' section.
To edit an Annotation, click on the 'Annotation’ Icon. The Annotation window will open where you will see the details of the alert and recipient(s) of the alert message(s). You will also see any Annotations left by other users.