Telemetry2U IoT Platform Documentation

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

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.

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.

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 with an combinations;

1. E-mail: Receipt of emails can be delayed depending on your mail server. They are sent from T2U Instantly.
2. SMS: Are usually received instantly, but your account must support SMS's.
3. Voice Calls: Are usually received instantly, but your account must support Calls.
4. App Notifications: Are usually received instantly, but you must first install and configure the T2U App.

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 Voice Call 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.

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.

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.

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:

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

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.
  1. Unsigned Integer - Converts the bytes to an unsigned integer. Can displays positive numbers only.
  2. Signed Integer - Converts bytes to a signed integer that can display negative values.
  3. Floating Point - Converts bytes to a floating point.
  4. 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 either 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.
  5. Reserved - Apart from being used to skip bytes / bits that are not 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.

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.

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 separated by a ','(comma).
• Calibrated Readings - Enter reference sensor values separated by a ','(comma).
• Offset - You can apply an offset to any calibration technique here.
• Current Uncalibrated - Displays sensor values without the coefficients applied.
• Current Calibrated - Displays the sensor values with the coefficients 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.

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.

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 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.

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.