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 what permissions have been granted by the company administrator in the User Access section. If you don't have access to something to any required features, contact the company administrator and request required permissions/user roles.
All the following administrator functions are explained in the documentation proceeding sections.
- Node Administration
- Calibration Administration
- Alerts Administration
- Actions Administration
- Audits Administration
- User Administration
- Gateway Administration
- Network Integrations
If you can't find what you need in this documentation, please feel free to contact us! We'll get back to you ASAP.
6.2 - Company Admin
To set up a new company, a Company Administrator who will have full access over the user accounts and notification groups, as well as controlling what access permissions the other users will have, must first be allocated.
Company Administrators can grant the 'Company Admin' permission to other users so they can perform the same role. This process is explained in the User Access section below. Administrators can only grant permissions to other users that they themselves have been granted. (i.e. an administrator without the 'Node Admin' permission granted will not be able to grant that permission to other users.)
6.2.1 - User Maintenance
The User Maintenance section allows Company Administrators to add, edit or delete users, as well as allocate node access rights and control permissions. The main page shows a list of all users linked to the Company account. All user accounts will be listed here, even if they have not registered or verified their account during the registration process.
It is important to note the difference between a ‘user account’ and a ‘registered account’. After a user has registered a new account (as described in Section 1.1 - Registering and Account) they will still need to have their account linked to a company by an administrator. Linking a registered account to a company account is a separate process explained in the next section.
6.2.2 - Creating or Editing a User
To create a new user, click on the Create New hyperlink in the top left corner.
The minimum requirements for creating a new account are the First Name and Last name. The rest of the fields are optional, however, at the very least users should have the correct time zone and contact phone numbers and email address entered so their data is displayed correctly and that they can be set-up to receive alerts.
The optional fields include:
- Date/time format: The date on the Charts and Reports pages will be shown in this format.
- Time Zone: This will be the displayed Date and Time on the reports and Charts page, which depends on the users location.
- Map Provider: GPS positions will be displayed with this provider when clicked. The link is found on the Reports Page.
- Alert E-mail: Email alerts will be sent to this address.
- Alert SMS number: SMS alerts will be sent to this phone number.
- Alert voice number: Voice alerts will be made to this phone number. Please make sure to enter the number in international format
It is important to note that numbers have to be entered in international format for the alerts to operate correctly, e.g. 61xxxxxxxxx
Once you hit the Create button, the new user will be sent an email with an invitation link. The link will take the new user to a page where they will be asked to Register a new Account with Telemetry2U. Once they complete the registration process, the new user will be automatically linked to your company account.
For a detailed step-by-step walk through guide on inviting a new user to join you account, check out TB07 - Inviting New Users to Join Your T2U Account
The new user will be able to log in, but they will not be able to access and data until a Company Administrator assigns the new users User Roles and Node Access Controls under the User Access Controls. This is described further in the next section.
6.2.3 - Configure User Access
Back on the main Node Maintenance page, click on the User Access link on the right side of any user. From here, company administrators can adjust individual users' roles and control what nodes are accessible to them on the Telemetry2u.com interface. Care must be taken here to limit your users' access. For example, you would not necessarily want certain users having access to things like Calibrations, or the ability to add other users and setup alerts without the company administrator's knowledge.
Company adminsitrators can only user roles that they themselves have access for. If a feature/button is missing from your administration page that you require, contact a company administrator with a higher level of access.
By default, all User Roles and Node Access Controls will be turned off. 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.
Each User Role must be selected individually with the checkboxes for every user.
- Actions Admin - Actions can be triggered from both alerts and alert recovery events. Actions are made up of downlink commands that can be sent to any unit under the company account, essentially offering a level of automation. Actions can also be used to change settings and control outputs of devices on a timed schedule.
- 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. Alternatively, each node can be allocated individually under the Node Access Controls section at the bottom of the page.
- 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.
Confirm CFR21 Action: Users with this role have the ability to confirm CFR21 actions/tasks for both themselves and other users. Relevant pages will have an extra section at the bottom of the page titled 21CFR confirmation required. Any users without the Confirm CFR21 Action role assigned will need to request a user with the Confirm CFR21 Action role assigned to enter their Email address and Password before any changes can be saved on that page. Read more detail about T2U’s compliance with CFR21 Part 11 here.
21CFR is an optional feature enabled on a per-client basis, contact sales for more information or to have it activated. If 21CFR is not enabled, the user role will not be visible.
- Device Allocation - Gives the user the ability to add new devices to your Telemetry2U account. You can read more about adding devices in Section 6.4 - Node Admin. The ammount of devices you can add to your T2U account may be limited depending on you plan / subscription.
- Edit Dashboard - Allows the user to add, edit, delete and customise their own real time Dashboards.
- Gateway Admin - Allows users to add, edit, or delete gateways on your T2U account.
- Node Admin - Allows the user to edit the more basic details of nodes that the company administrator has linked to their account as well as send node commands to control outputs etc.
- View Documents - Telemetry2U can arrange for a NATA calibration in some sensors. NATA certificates can be downloaded directly in PDF format by users if this option is selected.
- View Gateway Status - Allows users to simply check a Gateways status. They will not be able to change any settings or delete any gateways.
- View Raw Data - The user will be able to view raw HEX data as an option on the Reports page.
- 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.
Under the Node Access Control section, you can give users access to nodes one-by-on to limit what they have access to. This is overridden if the user has the All Nodes option checkced under the User Roles.
Company adminsitrators can only assign nodes that they themselves have access to.
6.2.4 - Notification Groups
Once you have created some users, you can add them to notification groups so they can receive E-mail, SMS and Voice alerts from Telemetry2u.com when a node's sensor input falls outside of its user defined range (set on the Alerts Page). Notification groups can consist of one or more users and can only be added by Company Administrators with permissions to edit existing or delete notification groups or members. All that is required to create a notification group is a 'Description'. This description will be seen on the alerts configuration page where all notification groups are displayed and can be added to alert groups via checkboxes. This is explained in more detail in Section 6.3 - Alerts. Time filters can be set so that alerts will only be sent if they fall between these times. It is important to note that Notification Groups must be configured before any alerts can be sent from Telemetry2U to an end user.
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.
SMS and Voice notifications sent by Telemetry2U will always be sent from the same phone number. It's a good idea to save +61-488-849-850 in your phone and assign it a unique ring tone so it's easily identified.
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.
For a step-by-step guide on how to giude on shceduling notifications, check out TB05 - Voice call/Alert Example.
6.3 - Alerts Admin
Users with the Alert Admin role granted in the User Access section will have access to the Alert Maintenance page. The main Alert Maintenance page will allow Company Administrators to create new, edit existing or delete alert groups.
'Alert groups' consist of a set of alert conditions attached to individual sensor inputs for nodes linked you your account. When any alert condition is met, notifications are triggered to all the users in the notification group(s) attached to the Alert Group and any actions performed. For this reason, it it important to set up your Notification Groups and Actions before configuring any alerts.
It is possible to delete individual alert conditions from an alert group, or delete the entire group altogether with the button on the right hand side of the page.
SMS and Voice notifications sent by Telemetry2U will always be sent from the same phone number. It's a good idea to save +61-488-849-850 in your phone and assign it a unique ring tone so it's easily identified.
Take a look at our step-by-step guide on using actions for automation - TB04 LoRaWAN IoT Automation Example.
6.3.1 - Creating and Editing Alerts
Click the Create New button to be taken to a new page to enter the alerts settings. Give the alert group a unique name in the Description field (this field is mandantory).
Click on the clock icons to use the time pickers and configure the time range that the alert group will be triggered with the From time and To time fields (set to 24/7 by default). No notifications or actions will occour outside of the user configured time range. When the time comes around, a notification or action will be triggered on the next record received that it outside of range.
Choose which Notification Groups should receive the alerts with the appropriate checkboxes. If no notification groups are selected no Email, SMS, or Voice notifications will be sent, however, any actions assigned to the alert will still be triggered. By default, the Send on Recovery option will be checked when the notifictaion group is Selected. You may choose to turn this off if you don't want the notification group to receive recovery notifications.
It's possible to differentiate when alerts should be sent. If the Selected box is checked, a notification will be triggered to that group as soon as a sensor deviates outside of the defined range. Normally, another notification will be triggered when the sensor recovers since the Send on recovery box is checked by defaut. You can choose disable recovery notifications for each notification group by un-checking the relevant Send on recovery box.
To add a new alert conditon to the list, firstly select a node from the Add condition for node: dropdown box. The selected node will appear below where you can configure how the alert condition will trigger with the following settings.
Alerts work by comparing the received sensor value against a user defined value (Threshold) with various comparison techniques. 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 - Choose which sensor(s) input the alert condition 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 alert condition is triggered. In practice, this works somewhat like a delay combined with the transmit interval.
- 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.
- Alert Action - If your account has been granted the Actions Admin role under User Access Controls you'll be able to select from the list of actions you have created under the Actions Maintenance section that will be triggered under an alert conditon.
- Send on recovery - If this box is checked, a second alert notification will be sent when the sensor value comes back within range.
- Recovery Action - Same as the Alert Action described above, only it triggers when the alert condition recovers.
- 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.
Once you've 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. From the Alert Maintenance page, click the Edit link on the right hand side of the page.
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.
The number nodes/devices that can be added to your account may be limited depending on your subscription or custom plan.
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 will still be required to set up the No Contact Alerts/Notifications as well as assign a suitable Description and any Notes. All fields are explained below:
Check out our step-by-step example on how to connect a LoRaWAN device to Telemetry2U over the Helium Network.
- 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.
- Network Provider - You can use a private LoRaWAN network connection by acquiring a LoRaWAN gateway and pointing it to Telemetry2U’s network Server(s) as described in Section 6.5 – Gateway Admin. Alternatively, use a public LoRaWAN network server and setup and integration as described in Section 6.8 – Network Integrations.
- 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.
- App Key - The Application Key is unique to each device and be retrieved from the device settings or sticker. It's only required when using Telemetry2U as the Network Provider. You won’t be able to edit this field when using other providers as the application key is normally only required by the network server.
- Device Configuration - Sensor data is received by Telemetry2U applications server in raw HEX format. This data needs to be converted into a user-friendly format to be interpreted and displayed in a user friendly format. The device configuration contains both the payload decoder as well as a list of downlink commands used to change the nodes settings or control outputs. Telemetry2U has a bunch of common payload decoders to pick from the list. Alternatively, create your own custom payload decoder(s) and downlink commands using our simple ‘custom payload builder’ page. Read more in Sections 6.4.4 – 5.
- 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.
After any changes, click the Save button at the bottom of page.
You can Edit a nodes settings at any time bacl on the Node Maintenance page.
6.4.2 - Assigning Labels to Sensor Inputs
It's possible to give each sensor a unique name that will be used on all pages. One exception is on the Calibration page - the default names are always used. It's' 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.
If the Hide Input box is checked, that sensor input will not be displayed on most pages.
It's also possible to define what Unit the sensor should use, for example, °C for temperature sesnors. The Unit defined here will override the unit allocated in the custom devices page as well as the unit used in the device configuration script. This unit will be displaed for that sensor on all pages, including the Charts and Reports pages.
You can also decrease the level of Precision used for each sensor input. If you want the senosr to display 1-decimal place, enter a value of "1". If you want to display 2-decimal places, enter "2". The maximum number of decimal places displayed will be limited by the device configuration.
The final sensor value can be multiplied by the Scaling field if required.
The Sort order defines the display order on the charts and reports page.
Click the Save button after any changes.
Labels allocated here with override the Description in the custom payload decoders page described in Section 6.4.4 - Creating Custom Payload Decoders.
6.4.3 - Sending Node Commands
If the Node Admin role has been enabled in the User Access Control section, users will be able to send downlink commands to nodes that either adjust settings or control outputs. To send commands, first select which node you want to send the command to from the Node dropdown box. Then, 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 variable - like setting the transmit time - this can be done by entering a value in the Parameter field.
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.4.4 - Creating Custom Payload Decoders
Creating a custom payload decoder on Telemetry2 is straight forward and can be done by just about anyone with little technical expertise required. To begin, navigate to Admin >> Custom Devices. From the new page, click the Create New link in the top left corner. You'll should be taken straight to a page where you can configure the new decoders settings.
Navigate back to the Custom Devices main page to modify either the custom device’s uplink Packet designer or the Downlink Commands with the links at the right of the page
Telemetry2U have many payload decoders that are ready to go. Before creating your own custom decoder, ensue the one needed is not already in our list. Payload decoders are listed/selected under Admin >> Node Maintenance. You can read more about this in Section 6.4.1 – Creating and Editing Nodes.
Start with the general Packet Designer settings in the top section as described in detail below.
- Device Type - This is a unique name given to the decoder. This name will be used on to identify the decoder on all pages.
- Port - LoRaWAN uplinks are often received on a specific port. The port number is defined here. This allows for some filtering of potentially unwanted packets.
- Check Port - If this box is checked, only packets sent over the Port number defined above will be processed. If this box is unchecked, data received on any port will be processed by the decoder.
- Byte Order - Used for multi-byte fields and determines if they are most or least significant byte first. For bit fields, the normal convention is used where the ordering is bits 7 down to bit 0. You’ll need to refer to the LoRaWAN device manufactures documentation so see what technique should be used for your device.
- Field Count - This will determine the number of fields that are in the packet. The number entered here will determine how many rows will be available in the configuration table below.
- Next Decoder - Some sensors send different types of packets over different ports. for example, The Dragino LHT52 sends Temperature and Humidity data over port 2 while the battery and firmware information are sent over port 5. You could set up two decoder and filter them by the port numbers.
As mentioned above, once a value is entered in the Field Count, that number of rows will appear in the table at the bottom of the page. The payload decoder will process each row individually. Each variable is explained further below.
- Start - Shows the start byte being used for the row. The next start value will increment by the value of the Length defined in the current row.
- Length - How many bytes to be processed in the current row.
Data Type - Determines how the Length of bytes will be processed/converted. There a several techniques.
- Unsigned Integer - Converts the bytes to an unsigned integer. Can displays positive numbers only.
- Signed Integer - Converts bytes to a signed integer that can display negative values.
- Floating Point - Converts bytes to a floating point.
- Match Offset - Checks if the field's decimal value is equal to a decimal value set in the offset column. The conversion is done with on eitehr the LSB or MSB as defined by the Byte Order at the top of the page. If its not a match, the packet is ignored by the decoder. If a decoder is optionally selected in the Next Decoder field at the top of the page, the packet will be run through that.
- Reserved - Apart from being used to skip bytes / bits that aren’t used in a packet it could also be used to skip things a person isn’t interested in reporting. It needs to have a description but is not returned as a field
- Description - A unique name that will be used to identify the field on all pages.
- Unit - The Unit assigned to the field. As well as using characters, choose from a huge array of Unicode characters.
- Order - Defines the order the field will be displayed on the charts and tables pages.
- Scaling - Values are calculated as (Reading * Scaling) + Offset, so the scaling is applied before the offset.
- Offset - Used with the Scaling value to process the result. An exception is if Match Offset was used for the Data Type, in which case the value is ignored unless the fields match.
- Precision - How many decimal places will be displayed/used in the result.
- Low Limit - This field is optional. If a reading is below the low limit, it will be set to the low limit.
- High Limit - This field is optional. If a reading is above the high limit, it will be set to the high limit.
- Invalid Reading - This value is compared to the raw reading without any scaling. When received it will trigger an alert if any conditions are based on that field. For example, some Dragino sensors report 65535 if a temperature probe is disconnected.
Click the Save button after making any changes. Click the Cancel button to leave the page without saving the changes.
Once you've created your custom payload decoder(s), they'll be availiable for selection under as the Device Configuration under Admin >> Node Maintenance. You can read more about this in Section 6.4.1 – Creating and Editing Nodes.
For some actual examples on how to create custom devices on Telemetry2U, please take a look at TB09 - Custom Payload Decoder Examples.
6.4.5 - Creating Custom Downlink Commands
Once you’ve finished editing the Packet Designer, navigate back to the main Custom Devices page and click on the Downlink Commands link on the right of the page to add all the downlink commands required for your application.
On the new page, select how many commands you would like to add with the Command Count dropdown box. Add up to 20 downlink commands as required. You need to enter a value for each of the following fields
- Description - A unique name given to the downlink command that will be used on all pages.
- Port - Commands will be sent over this port.
- Packet (hex) - The raw HEX commands to be sent to the end-device.
Click the Save button after making any changes. Click the Cancel button to undo any changes
Once you’ve saved all the commands, they’ll be immediately available to send under the Send Node Command section as described in Section 6.4.3 – Sending Downlink Commands.
You’ll also be able to configure dashboard buttons with any commands as described in Section 2.2 – Building Dashboards.
6.5 - Gateway Admin
If the Gateway Maintenance permission has been granted in the User Access section, users will have the ability to add new gateways and edit existing gateway parameters, such as the name, gateway ID, operating frequency band and Gateway Down Alerts. This role is usually restricted to company administrators, as an error could prevent the Gateway from connecting to the network server. The main Gateway Maintenance displays a list of all the gateways connected to the commpany account. Add new gateways by clicking the Create New link in the top left corner.
Edit or delete existing nodes by clicking on the relative links on the right of the page.
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.
The options for creating/editing an Gateway for Telemetry2u are explained below.
The number of LoRaWAN gateways you can add to your account may be limited depending on your plan/subscription.
- 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 - Determines what frequency, sub-band and port your Gateway will operate on. This must match the nodes frequency plan and sub-band..
- 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.
The Gateways Status page has a colour code to give a quick indication of a gateway status
- White - Gateway has been seen in the last 10 minutes
- Yellow - Gateway has not been seen for 10-minutes
- Pink - Gateway has not been seen in more than an hour
Only users with the Gateway Status role assigned in the User Access Controls will have access to the gateway status page.
6.6 - Calibrations
Using Telemetry2U’s IoT platform, it is possible to apply calibrations to any node’s individual sensor input. The calibration coefficients are managed server side, they’re not saved in the node itself. When a calibration is applied, it only affects data from midnight of that day (00:00), historical data remains unchanged. The same applies if the calibration coefficients are every changed or updated. The fact that historical data remains unchanged ensures that its easy to keep track of sensor drifts over time.
Telemetry2U currently allows for a 2-point or a 3-point calibration.
To have access to calibrations, you need to have the Calibration user role assigned in the User Access Controls. This is explained further in Section 6.2.3.
6.6.1 - Entering or Editing Sensor Calibrations
Using the top menu, navigate to Admin >> Enter Calibration Data. You will be taken directly to the Calibration Entry page.
Select the Node you would like to calibrate from the Node: dropdown box. You should immediately see all the available sensors and calibration options at the bottom of the page.
- Input - Displays a list of all the inputs available to be calibrated on the selected node.
- Units - The unit(s) used for the sensor input.
- Calibration Type - Select either a 2-point or 3-point calibration technique.
- Uncalibrated Readings - Enter raw sensor values seperated by a ','(comma).
- Calibrated Readings - Enter reference sensor values seperated by a ','(comma).
- Offset - You can apply an offset to any calibration technique here.
- Current Uncalibrated - Displays sensor values without the coefficents applied.
- Current Calibrated - Displays the sensor values with the coefficents applied so you can see what effect the calibration had.
The Calibrated by: field will be automatically populated with the current users E-mail address but can be changed.
The Notes: field can't be blank or the page can't be saved.
Click the Save button at the bottom of the page when complete.
If the sensor you’re trying to calibrate is not in the list, ensure that the sensor input has not been turned off under the Input Labels section on the Node maintenance page. Refer to Section 6.42 for more details.
The above image shows an example of a 3-point calibration applied to the external temperature input of a Dragino LHT65. The external sensor of the LHT65 was placed in a water bath with known temperature meter (reference meter) at -30C, 0C and 30C. The values recorded by the LHT65 (-29.8,-0.2,30.2) were entered into the Uncalibrated readings reading field separated with a comma(,). The values recorded from the reference temperature meter (-30.2,0.2,30.1) were entered into the Calibrated readings in the same way. No offset has been applied. You can see that Current uncalibrated and Current calibrated readings differ by 0.3, indicating the calibration improved the accuracy of the LHT65’s external temperature sensor by 0.3C
It is possible to apply an offset only to a sensor input. To do so, select a 2-point for the Calibration type and enter 0,1 in both the Uncalibrated readings and the Calibrated readings fields. Enter the required offset and hit the Save button. Again, you should be able to confirm it worked OK by comparing the Current uncalibrated reading against the Current calibrated reading.
When applying an offset calibration, you’ll still need to fill the Notes: field before hitting the Save button at the bottom of the page.
For more detailed instructions, check out the Nata Facility Calibration Instructions for temperature sensors.
6.6.2 - Uploading Calibration Certificates
If you’ve calibrated any sensors and have a calibration certificate, it is possible to upload that calibration certificate in PDF format to Telemetry2U’s cloud server making it accessible from any connected device. If you navigate to Admin >> Add Calibration Certificate, you’ll see a list of all uploaded calibration certificates along with the Document Date, Comments. Description, and the Node that the certificate is linked to. To download a calibration certificate, click on the View PDF icon on the right of the page. You can also remove a certificate with the Delete button if required. If a certificate is deleted, there is no way to recover it.
To upload a new certificate, click Create New link in the top left corner of the Add Calibration Certificates page. You’ll be taken to a new page where you must first select the node that you want the calibration certificate attached to from the Node: drop down box. Choose the Document Type and confirm the Document Date. The Comments field is optional. Click on the Choose File and navigate to where the calibration certificate is located in your local folders. Click the Create button when complete.
To upload a new calibration certificate, the user must have the Calibration role assigned in the User Access Controls on the User Maintenance page. You can read more about this in Section 6.2.3 – User Access Controls .
6.6.3 - Downloading Calibration Certificates
In some cases, you might not want a user to have the ability to add or delete calibration certificates but still allow them access to view and download certificates. This can be done by ensuring that the View Documents user role is checked in the User Access Controls on the User Maintenance page. You can read more about how to so this in Section 6.2.3 – User Access Controls. When this user roll is assigned, the user will have an option called View calibration certificates in the admin section.
There is no advantage to assigning the View Certificates role if the user has already been granted the Calibration role. A user with this role will already be able to download certificates.
6.7 - Actions and Automation
Telemetry2U uses actions to provide a level of automation. Actions consist of downlink commands that are sent to individual nodes and can be used to change the nodes settings or toggle an output. Actions can consist of multiple steps and can be scheduled on a day/time basis. For example, you could use one action to turn a pump on at 8:00pm and another to turn a pump off at 6:00am. Alternatively, actions can be triggered from alert conditions. A working example here could be to use one action to turn a pump via an I/O controller on if the soil moisture levels drop too low and then send another action when the soil moisture gets back to a desired level. These techniques in combination with the vast array of LoRaWAN sensors on the market allow for a huge variety of automation applications.
Alternatively, actions can be triggered from alert conditions. A working example here could be to use one action to turn a pump via an I/O controller on if the soil moisture levels drop too low and then send another action when the soil moisture gets back to a desired level. These techniques in combination with the vast array of LoRaWAN sensors on the market allow for a huge variety of automation applications.
You can create, edit or delete actions under Admin >> Actions. From there, you should see a list of all existing actions under your account.
In order to use actions, you must have the Actions Admin user role assigned under the User Access Controls section. You can read more about this in Section 6.2.3 - User Access Controls.
6.7.1 - Creating and Editing Actions
To configure a new action, click on the Create New link in the top left corner. On the new page, give the action a unique Description. Select the node you want to receive the action/downlink command from the Action Steps section. The selected node will appear at the bottom of the page. You can configure the following options as required.
- Command - Choose from the list of downlink commands linked to your device profile.
- Parameter - Some downlink commands require a value, like changing the uplink interval or time controlling an output. You can enter that variable here. If the command does not support a variable, just leave it blank.
Make sure to hit the Save button at the bottom of the page after any changes.
To remove an unwanted action step, click the Delete button on the right of the step.
You can add as many Action Steps as required. They will all be sent together as soon as the action is triggered.
6.7.2 - Scheduling Actions
To run an action on a timed schedule, navigate to Admin >> Scheduled Jobs. You’ll see a list of actions already created on a new page. Click the Create New button in the top left corner. On the new page, give the scheduled job a unique name in the Description / e-mail subject field. Configured the following fields as required.
- Email Notification Group - This field must have a value, though it’s not used for Actions (Audit Reports only) so you can select any notification group.
- Item to run - Choose from the list of actions created as described in Section 6.7.1 – Creating/Editing Actions.
- Run Frequency - Select the days of the week you would like the action to run.
- Run At time - Use the picker to select the time you want the action to run.
You can delete any scheduled job back on the main page or you can temporarily deactivate them with the Enabled checkbox.
6.7.3 - Automating Actions
Actions can be triggered from alert conditions. When configuring an alert condition (as described in Section 6.3.1 – Creating and Editing Alerts), there are options for an Alert Action and a Recovery Action. These fields will contain a list of any actions created as described above in Section 6.7.1.
When a sensor trips an alert condition, the Alert Action will be triggered, when the sensor recovers from the alert condition, the Recovery Action will be triggered.
Check out our step-by-step walk-through guide on how to automate tasks with actions on the T2U IoT Platform in TB04 - LoRaWAN/IoT Automation Example.
6.8 - Integrations
Integrations provide a way for public LoRaWAN network servers to transfer raw packets to and from Telemetry2U’s application server, where you can visualise data, configure alerts etc.
The main advantage of using an integration is you may not need to invest in a gateway (assuming that you’re within range of a public LoRaWAN network).
When using an integration, it’s important to ensure that the nodes Network Provider setting matches the type of integration used. You can read more about this in Section 6.4.1 – Creating and Editing Nodes. It is possible to create multiple integrations for different network servers, the type of integration used will be determined by the Network Provider setting.
To create an integration, navigate to Admin >> Setup Integration. From the Network Provider dropdown box, select the integration you wish to use. If you've previously set-up an integration, you'll be taken staight to that page.
Public networks tend to be a bit more unstable then a private LoRaWAN network. If you want to maintain full control over your network, consider investing in a gateway.
It may take up to an hour for an intergration to start working depending on which public network server is used
6.8.1 - Integrating to the Helium Network
If you choose Helium and the Network Provider, you’ll be taken to the Helium Integration settings page. There are basically two parts to the integration, you need to log into you Helium account and create a new custom HTTP integration. You’ll then need to copy and paste the following into the relevant sections on the Helium Console.
- Endpoint URL - This will always be https://telemetry2u.com/api/Helium.
- Key - This will always be Authorization.
- Value - This will be different every time. It can be reset with the button at the bottom of the page.
After saving the integration, stay on the Helium Console and go back into the integration settings find the Downlink URL. Copy that into the Downlink URL section back on the Telemetry2U integration settings.
Click the Save button after making any changes.
You can generate a new Value with the Regenerate Password button or delete the integration from Telemetry2U (only) with the Remove Integration button.
Check out our step-by-step walk-through guide for integrationg to the Helium Network in TB03 - Integratiing to the Helium Network
6.8.2 - Integrating to The Things Industries
If you choose TTN as the Network Provider, you’ll be taken to the TTN Integration settings page. Firstly, select the appropriate Region from the drop-down box. Now log into your TTI account and add a new Webhook integration. Enter the following details into the appropriate fields
- Webhook ID - This will always be telemetry2u.
- Telemetry2U Token - This will be different every time. It can be reset with the button at the bottom of the page.
- Application ID - As configured on the TTI Console.
- Telemetry2U Token - A Unique Key required for downlink commands to work.
Click the Save button after making any changes.
You can generate a new Telemetry2U Token with the Regenerate Password button or delete the integration from Telemetry2U (only) with the Remove Integration button.
Check out our step-by-step walk-through guide for integrationg to TTI, check out their documentation