Telemetry2U IoT Platform Documentation
6.1 - Main Admin Page
The main admin page can be found at the top of the Telemetry2U main menu. Administrators are able to click on any of the buttons featured which will allow them to perform various tasks.
The contents of the admin page will vary for each user depending on what permissions have been granted by the company administrator in the User Access section. If you find that you do not have access to something that you may require, you should first contact your company administrator to check if you can have the required permissions granted
All of the administrator functions are explained in the following documentation.
6.2.3 - Configure User Access
By clicking on the 'User Access' link, company administrators can adjust individual users' permission levels and control what nodes are accessible to them on the Telemetry2u.com interface. Care must be taken here to limit your users' ability to interfere with each other. For example, you would not necessarily want certain end users having access to 'Calibrations', or the ability to add other users and setup alerts without the company administrator's knowledge. Company adminsitrators can only assign privilages that they themselves have permission for. These permissions can only be set by Telemety2U administrators, so if a feature is missing from your administration page that you believe you should have access to, please contact Telemetry2U.
It is important to note that all parameters will be unchecked by default when a new user is created. All permissions will need to be set for each user individually before they will have access to any nodes or features on the main Telemetry2U page. (See the Telemetry2U Interface section for more information).
Each User Access option must be selected individually with the checkboxes for every user. However, granting the 'All Nodes' permission gives access to all nodes and you will not need to select nodes individually in the 'Nodes Access Control' section.
- Add Annotations - Gives users the ability to add notes to alarm events. Annotations can be added from the Reports page as described in section 4.3 - Adding and Editing Annotations. Without this permission granted, users still have the ability to view annotations left by administrators.
- Alerts Admin - Gives users access to add, edit or delete their own E-Mail, SMS and Voice Alerts on any node that the company administrator has given them access to.
- All Nodes - This will make every node linked to the company availible on that user's account.
- Audit Admin - Allows the user to create, edit or delete Audit Reports that are made available to all users within the company.
- Calibrations - Allows for calibrations to be applied to sensor inputs on nodes that have been added to that user's account.
- Company Admin - Gives the user access to add/edit new users, add/edit alert notification groups, Copy Dashboards and set all other permissions that they themselves have been granted by Telemetry2U. When Telemetry2U sets up a new company account, this setting is normally reserved for the first Company Administrator.
- Edit Dashboard - Allows the user to add, edit, delete and customise their own real time Dashboards.
- Node Admin - Allows the user to edit the details of nodes that the company administrator has linked to their account as well as send node commands to control outputs etc.
- Node Access Control - Selecting these boxes determines if the node will be available on the user's account. It is possible for multiple users to have access to the same nodes.
6.2.5 - Notification Group Members
If you click on the 'Create New' hyperlink, you will taken to a list of your company members that you can then select with the 'Member' checkbox to add them to the Notification Group. You can then set what type of notifications they should receive; either E-mail, SMS, Voice - or a combination of the three. You can also select which days and times the messages will be sent to each user for each type of alert. This option allows you to set different users to receive the same notifications at different time, allowing you to tailor notifications to suit staff' shifts.
The 'Priority' option only works in conjunction with the Voice Alerts. Voice alerts will prompt the user for a keypad entry to confirm that the message has been received. If the keypad input is not detected, it is assumed that the call was not answered and the next person on the priority list will be called. This cycle will continue up to three times, ensuring important alerts are received and actioned.
6.3 - Alerts Admin
6.3.1 - Creating and Editing Alerts
If you click on 'Create New' button, you will be taken to a new page. You need to give your new alert group a name in the 'Description' field at the top of the page, then choose which of your Notification Groups should receive the alerts with the appropriate checkboxes. If no notification groups are selected no alert messages will be sent, so it is critical to complete this step properly.
To add a new alert conditon to the list, select a node from the 'Add condition for this node' dropdown box. The node will appear in the box below where you can select which sensor input you would like to attach to the alert. You are also given the option to select the 'Comparison type' and set 'Filters'.
'Comparison types' relate to how you would like to compare your input data to your alert conditions (i.e; 'greater than', 'less than' or 'equal to'), and 'Filters' allow you limit which kinds of results trigger alerts. It is possible to add multiple conditions to the same node sensor input.
Once you have finished making changes to the alert conditions, make sure that the 'Active' box is checked at the top of the page before clicking 'Save'. Editing alerts groups is the same process as creating one.
Alerts work by comparing the received sensor value against a user defined value (Threshold) with various comparison techniques made available. There is also some optional filtering that can be applied to reduce the chance of false alerts from normal events (like a freezer door being held open for longer than usual). These parameters are explained in some detail below:
- Input - This is which sensor input the comparison will be attached to.
- Comparison - The sensor input is compared against the threshold with the function selected here. Comparisons include - Greaten then, Less then, Equal to and Value Changed.
- Threshold - This is the value that the sensor input is compared to to trigger an alert notification.
- Consecutive Readings - How many 'out-of-range' reading in a row are required before an alarm condition is actioned. In practice, this works somewhat like a delay.
- Minutes Between Alerts - This is a limit on how may alerts can be sent in a certain period of time. This ensures that many messages won't be sent if the sensor input is hovering around the threshold value. By default this is set to 60 minutes, but can be reduced to a minimum of 20 minutes.
- Send on recovery - If this box is checked, a second alert notification will be sent when the sensor value comes back within range.
- Ignore changes above % - Optional extra filtering that will ignore sending an alert if the value changes by more then a given percentage.
- Active - Alerts will not be sent unless this is checked. This allows you to disable certain alerts from the group, or disable the entire group altogether.
- Delete - Allows you to delete a single alert condition. Use with caution, as there is no way to recover a deleted alert.
6.4 - Node Admin
If the Node Admin permission has been granted in the User Access section, users will have the ability to edit node parameters, such as the node name, EUI security keys, operating frequency band and Node Down Alerts. This role is usually restricted to Company Administrators as a improperly set Device EUI or Application Key will prevent the node from connecting to the network server. The main Node Maintenance screen shows a list of all of the nodes linked you your account. From here, administrators have the ability to create new nodes as well as edit or delete existing nodes by clicking on the relative links. You will only be able to edit nodes that your account permissions set for under under the User Access section. If you are not seeing a node on your account that you think should be visible to, you need to contact your company administrator and ask them to grant you access from their account.
6.4.2 - Creating or Editing Nodes
Creating and editing a node is done on the same screen. The 'Notes' and the 'Alert/Notification' fields are optional but all other fields are required for a proper connection to be established with the network server. Care must be taken when entering the EUI keys (usually retrieved from the nodes settings by connecting to it via a terminal) in particular as a mistake will mean a connection will never be established. When nodes are purchased from Telemetry2U, they are usually added to the server and tested before shipment, meaning setting these critical parameters is not usually required by the Company Administrator. The Company Administrator wil be required to set up the 'No Contact' Alerts/Notifications and give the node its name and any notes. All fields are explained below:
- Description - This name should be unique as it is the main node identifier that is seen on the Dashboard, Charts and Reports page. It is possible to have two nodes with the same name, however this is not recommended (this can create confusion when trying to configure individual nodes in other sections).
- Notes - This field is optional and can only be seen on the Node Maintenance page, which is used/seen by Company Administrators only.
- Profile - Telemetry2U nodes can operate in Class A and Class B and is selected with this field. The node Class and the server class must match for a connection to be established. If you need to change the Class of your node, you will need to delete the node and re-add it as this option can not be edited.
- Device EUI - This is HEX security key that is unique to an individual node and is usually found on the node sticker or packaging. It is important that this key is entered correctly for a connection to be established.
- Device Configuration - This field must be selected correctly and is responsible for the payload decoder - which converts the raw HEX packets received by the nodes to a user readable decimal format. This setting is dependant on the type of node you are using and what sensors you have attached to its inputs.
- No Contact Minutes 1 - This is how much time (in minutes) must pass before an alert is sent to the notification group selected in the next field if no data has been received from the node. This is important to ensure you are alerted if the node goes down or there is a problem with the connection.
- Notification Group 1 - This notification group will receive the alerts if the node loses contact.
- No Contact Minutes 2 - As a backup, this is how much time (in minutes) must pass before an alert is sent to a secondary notification group (again, selected in the next field). This ensures action will be taken if an important node is compromised.
- Notification Group 2 - This notification group will receive the alerts if the node loses contact.
6.4.2 - Assigning Lables to Sensor Inputs
It is possible to give each sensor a unique name that can be displayed over the default sensor on most pages, including the Reports, and Charts pages, and Audit Reports. One exception is on the Calibration page, where the names are always displayed with the default name. It is important to note the difference between the sensor name given here, and the name given when creating or editing a node in section 6.4.1 above, they are different as the sensor input belong to the node.
To assign names to sensor inputs you must first click on the ‘Input Labels’ link found on the main Node Maintenance page. From here you can assign the name(s) by typing into the corresponding boxes. You must hit save before leaving the page or the changes will not take effect.
6.4.3 - Sending Node Commands
If 'Node Admin' has been enabled in the User Access section, users will be able to send commands to their nodes to either adjust settings or control outputs. To send a command, you will first need to select which node you want to send the command to from the 'Node' dropdown box. Then, select from the 'Command' box and pick from a list of pre-defined commands. These commands will vary depending on the 'Device Configuration' selected in the Node Maintenance section and is generally different for every node. Some commands require a value to send - like setting the time - and this can be done by entering that value in the 'Parameter' box.
The 'Profile' selected in the Node Maintenance section will dictate when the node will receive the command. If Class A mode was used, the the node will receive the command very shortly after its next uplink. Most of the nodes used with Telemetry2U run in Class A to save power. If Class C mode was selected, the node would receive commands in around 5 seconds as it is awake all the time. To read more about this, please go to Section 7.2 on LoRaWAN Classes.
6.5.1 - Creating or Editing Gateways
Creating or editing a Gateway is done on the same screen. The 'Notes' and the Alert/Notification' fields are optional but all of the other fields are required for a proper connection to be established with the network server. Care must be taken when entering the Gateway ID (found in the Gateway settings) in particular as a mistake will mean a connection will never be established. When Gateways are purchased from Telemetry2U, they are usually added to the server and tested before shipment, meaning setting these critical parameters is not usually required by the Company Administrator. The Company Administrator wil be required to set up the Alerts/Notifications and give the Gateway its name and any notes.
All of the options for creating/editing an Gateway for Telemetry2u are explained below.
- Gateway ID - This is a unique ID that can be found in the Gateway setting by connecting to your Gateway manually. Every Gateway has a different interface, but Telemetry2U supplies Gateways that are pre-configured and pre-connected to the Telemetry2U server so they are ready to go out of the box.
- Name - This is the name given to the Gateway that can be seen on the Gateway Status page.
- Description - You can enter any notes you may have on the Gateway here. These can be seen on the Gateway status page.
- Network Server - This will determine what frequency band your Gateway will operate on. This must match the node frequency plan.
- Latitude - This field is optional to display the Gateways GPS position.
- Longitude - This field is optional to display the Gateways GPS position.
- Altitude - This field is optional to display the Gateways GPS position.
- No Contact Minutes 1 - This is how much time (in minutes) must pass before an alert is sent to the notification group selected in the next field if no data has been received from the Gateway. This is important to ensure you are alerted if the Gateway goes down or there is a problem with the connection.
- Notification Group 1 - This notification group will receive the alerts if the Gateway loses contact.
- No Contact Minutes 2 - As a backup, this is how much time (in minutes) must pass before an alert is sent to a secondary notification group (again, selected in the next field). This ensures action will be taken if an important Gateway is compromised.
- Notification Group 2 - This notification group will receive the alerts if the Gateway loses contact.
6.5.2 - Gateway Status
The Gateway status screen has no settings, it is simply where you can view the Gateway's current status. It can be handy to see if the Gateway is currently in communication with the network server and if the connection has been lost, you can see how long it has been down for. You will not receive any new data from any Nodes connected to a Gateway if that Gateway is down.
Users will only have access to the "Gateway Status' if the permission has been granted in the User Access section.