Telemetry2U IoT Platform Quick Guide

Configuring your gateway settings.

Before you can connect a gateway to Telemetry2U, you will need to log into your gateway and configure it correctly. Every gateway is different so you may need to refer to your gateway’s user manual. It is important to ensure that your gateway setting match the settings you intend to use on your node(s). Below is an example of a Dragino LPS8 gateway

The gateway must be set to use the ‘LoRaWAN Semtech UDP Packet Forwarder’. You then need to go into the gateways LoRa settings and select which frequency plan you intend to use. If you are using AU915 or US915 you must use Frequency Sub-Band 2. Then go into the LoRaWAN configuration section and choose to use a custom LoRaWAN server. The server address and uplink/downlink port will vary depending on what frequency plan you use. Refer to the table to ensure you use the correct address and port. Make sure you take a copy of the Gateway ID as this will be required in the next step.

You can read more about gateway configurations and firewall rules here in the documentation.

Configuring node settings

Before connecting your first node, you need to ensure that your gateway is configured correctly and verified that it has connected to Telemetry2U as described in the previous section. It is also important that your nodes settings match the region and frequency sub-band used by your gateway. For more information on how to do this, you will need to refer to your node’s user manual.

Add node to Telemetry2U

Once logged in, navigate to the ‘Node Maintenance’ section via 'Admin' and create a new node. Enter all the required details of your node. The following are the minimum settings that are required

• Description – This is the name that will be used to identify your node
• Profile – Must match the frequency plan selected for use in your gateway. If you intend to use your node in Class-C, you need to select profile XXX-C
• Device EUI – A unique HEX key that can often be found on your nodes label. If not, you will need to physically connect to your node as described in your node’s user manual
• Application Key – Also often found on the node label. If not, you will need to physically connect to your node as described in your node’s user manual
• Device Configuration - This must match the node that you are using. If the node you are attempting to use is not in the list, please contact us and we will look into adding it for you.
• Network Provider - If using private LoRaWAN network with a Gateway point to Telemetry2U, Select Telemetry2U from the dropdown box. Alternatively, use a public LoRaWAN network and set-up an integration. For a step-by-step guide on connection to the Helium network, check out TB03 – Integrating to the Helium Network. If connecting through The Things Industries (TTI), check out the TTI documentation here.

There are some optional fields (model number, serial number, asset number, location) that you may choose to enter but they are not required to proceed.

The ‘No contact minutes’ and corresponding ‘notification group’ can be used to notify you when a node comes on and offline. You should set this for 3 times the nodes transmit interval (60 minutes if transmit interval is 20 minutes). When you created your account, an email notification group should have been created automatically that will be available in the dropdown box and can be used for now. You can later choose to change this so that you receive SMS alerts as well, but you must first configure your notifications groups as described later in this guide.

When sensors trigger alerts (or when a node/gateway has lost contact), an Email, SMS or voice alert can be sent to all users within a notification group(s).

If you created a 14-day free trial account, a notification group would have been created automatically and configured to send emails 24/7. The group will be labelled ‘Email xxxxxx xxxxxx’ (the first name and last name used in your account profile). You can modify the time filters, if necessary, but you will not be able to configure SMS and voice alerts as they are not available on the trial subscription.

If you have a paid account with SMS and voice, we normally recommend that you create separate notification groups for each type of alert - Email, SMS, and voice. This will offer more flexibility when creating and configuring alerts later.

When editing a notification group, you will see all the users attached to your account and you can select which ‘Members’ should receive which alerts and during what times. The voice call is persistent, meaning it will contact members in the priority selected. If the first member does not pick up and acknowledge the call with a key press, another call will be made to the next member in the order of the selected priority (Range: 1-3).

Once you have created/modified the notification group(s), you may choose to go back into the node and gateway sections and change ‘No Contact’ notification.

It is important to note that Email notifications are unlimited, but SMS and Voice Calls are limited monthly. The number you can send is dependent on your plan options selected during sign-up. The trial account offers Email only, however, you can upgrade to a paid plan at any time if required.

Once you have configured your notification groups, you can create an alert group that will trigger selected notification groups when a sensor passes its limits. Navigate to ‘Alert Maintenance’ via Admin and create a new alert group with a unique name. You can then edit the alert to configure what sensors you want to monitor and what notification groups will be notified.

First, select which notification groups you would like to receive the alerts under the 'Notification Group' section at the top of the page. This list will be populated with the notification groups you created in the last section.

To add an alert condition to a sensor, select a node form the 'Add conditions for node' drop-down box. This will add it to the table below. Now select an ‘Input’ along with a ‘Condition’. The most used conditions are ‘Greater than’ and ‘Less than’. The most recent sensor value is compared against the ‘Threshold’ to trigger a notification.

You can add some filtering with the ‘Consecutive readings’ option (range: 1-3). If this is set to three, the sensor must be outside its limit for three readings in a row before a notification is triggered and therefore determines the alert delay. Again, with a setting of three consecutive readings and a sensor set for 20-minute sampling means the sensor would need to be outside the limit for 60 minutes before any notifications are sent.

As well as trigger notifications during an alert condition, you can also trigger actions. Actions consist of downlink commands that are automatically sent to a node when a sensor either goes into alert or recovers from an alert. This feature can be used to provide a level of automation. Below are some examples where an action may be useful.

• Turn on a relay for a few seconds to sound a siren if a temperature input deviates
• Turn a water pump on if the soil moisture levels drop too low
• Change the transmission rate from 20-minutes to 5-minutes when a sensor deviates

Create a new action group under ‘Action Maintenance’ in the admin sections and give it unique name. You can then configure the action to send the required downlink command(s) to any node under your account. A single action can send commands to multiple nodes when called. Firstly, select the node you wish to control from the dropdown box and select which command you want to send. Some commands require a variable ‘Parameter’ which you can also configure.

Once complete hit the save button. The action will then be available for use in the Alerts page as described in the previous section so you will need to go back into the alerts page and configure appropriately.

Depending your subscribed plan options, you may be able to add extra users to your account. There are a couple of options here.

1. You can create a new user without them registering an account on Telemetry2U they will be able receive alerts, however they will not be able to log in to Telemetry2U and see any data or make any changes.
2. You can ask the new user to register an account with Telemetry2U first. When you then create a new user under your account with the same email address used for the new registration, their account will be linked to your 'Company' account. You can now configure their account and access accordingly.

You can create a new user by navigating to ‘User Maintenance’ in the Admin section and selecting ’Create User’. Enter all the required fields including the Email, Name, Data format, Time zone, Map provider and contact numbers. Please ensure that the phone numbers are entered in international format (+61xxxxxxxxx for Australia) otherwise they may not work when notifications are sent.

As the account administrator, you have the control to limit user account access and features. You may not want a user to be able to edit alerts or see all nodes for example. This can be done under ‘User Access’ back on the ‘Node Maintenance’ page. The checkboxes will define what level of access the user has. If the ‘All Nodes’ checkbox is ticked, the user will have access to all nodes under the account, otherwise, you need to select which nodes they have access to in bottom section.

Audit reports provide a complete overview of a node’s performance over a selected time frame as well as display the upper and lower limit lines on the charts page(s). Audit reports can be manually downloaded via the “Audit’ link in the main menu, but one must firstly be created under ‘Admin’.

Click the ‘Audit Report’ button in the admin section and create a new report. You will need to define a ‘Site Name’ and a ‘Report Name’ before saving. You can then edit the Audit Report and select which node(s) you would like to include, and the level of information required.

You can add a node from the drop-down box and then select the 'Input' of interest and define the ‘Upper limit’ and ‘Lower limit’. These limits will be displayed both on the main 'Charts' page and on the audit report charts. Once you hit the save button, the audit report will be available for download.

As well as downloading Audit Reports manually, you can also set them to be email automatically to a notification group by setting up a ‘Scheduled Job’ under the admin section. To do so, create a new job and give it a clear description. Select which notification group you would like the report sent to and choose ‘Run audit report’ as the ‘Job type’. Select a frequency anywhere from 1-day to 1-year and define what time of day you would like the Audit Report to be sent.

Remember to hit the 'Save' button once you have everything configured correctly.

Creating a real-time dashboard can be done on the main 'Dashboard' page linked in the main menu. There are buttons to create, rename and delete dashboards as well as an editing button. You should already have a blank dashboard labelled ‘Default’ on the main page so you can edit that to get started.

With editing turned on, a new menu should pop up where you can select from a range of widgets that include gauges, indicators, buttons, and text blocks. If you click on a widget, it will land on the main page. The main page is essentially a grid that is 25x blocks across and will go as deep as required. You can drag and drop widgets into position as well as resize them with the arrow in the bottom right corner. This in combination with the widget styling attributes offers plenty of flexibility

Double click on any widget in the grid to attach a sensor input to be displayed. Select the 'Node' and the required 'Inputs' from the dropdown boxes. Where applicable, you can also adjust the styling attributes. There is no limit to how many widgets you can add to a single page.

To delete a widget from the main grid, make it as small as possible and drag it by the centre over the ‘delete’ icon in the editing menu

Once you have finished setting up your widgets, it is important that you hit the save icon in the top right corner before turning editing off , otherwise any changes you make will be lost.

The ‘Charts’ page linked in the main menu provides a quick and convenient way for you to check on your sensor(s) history as well as the current status and statistics.

The charts page will always load to the last viewed page with the current days data. Click on the ‘Chart Settings’ link at the top of the page to configure your chart’s appearance.

Firstly, select the ‘Node’ of interest from the list and select your required date range. You can either use the buttons to display a block of data (1-day, 2-days,1-week, or 1-month), or you can use the date pickers to select a custom date range and then click the 'Load' button. Use the ‘<<’ and ‘>>’ buttons at the top of the page to quickly navigate backwards and forwards over your selected period.

Most nodes will have more than one sensor input that you can plot. You must select which sensors you want plotted as well as how many different charts you would like them plotted on (range: 1-4).

Once you have finished making you changes, hit the ‘Load’ button. The settings will be saved for the node selected and the charts page will be updated.

The ‘Reports’ page linked in the main menu offers another way to quicky view your sensor(s) data and status as well as add annotations to alert events that later appear in the audit reports.

From the main page, you can see the last record from all your sensors. The colours (if any) clearly indicates if a node has a sensor that is heading towards, currently in, or has recovered from an alert. You can click the appropriate icon(s) to leave annotations on alert events. This is explained further in the ‘Icon description’ below.

You can view a single nodes data history in table format by clicking on the nodes name or by selecting the node of interest from the dropdown box. Change the time range using either the buttons to display a block of data (1-day, 2-days,1-week, or 1-month), or the date pickers to select a custom date range before clicking the 'Load' button.