tyrrell UG65 Lora Wan Niagara 4 Driver User Guide

The LoRaWAN Driver provides a fast and simple interface to a LoRaWAN-based system of devices.
It can be used with any Niagara Station to communicate with a Milesight LoRaWAN Gateway, supporting both local LAN and remote cellular connections.

Integration of LoRaWAN networks into Niagara without manual setup of JSON payloads
Support for known and unknown devices

Bidirectional connection to LoRaWAN Gateway via HTTP interface
Compatible with all brands of Niagara 4

Follow the installation instructions provided in the user manual to install the LoRaWAN Driver on your Niagara platform.
Configure the Milesight LoRaWAN Gateway (e.g., UG65) to establish a connection with the driver.

Follow the setup guidelines outlined in the manual.
The LoRaWAN driver is licensed based on points. Ensure that you have the necessary licenses for the number of points in your system.

Refer to the manual for instructions on licensing and software maintenance.
Check the list of supported devices to ensure compatibility with your LoRaWAN devices.

The driver supports both known and unknown devices.

INTRODUCTION

The LoRaWAN Driver can be used to provide a fast and simple interface to a LoRaWAN-based system of devices. The driver can be used from any Niagara Station (Web Sup / JACE / 3rd Party Controller) to a Milesight LoRaWAN Gateway (such as UG65).
This includes Milesight Gateways on a local LAN or via a remote cellular connection.

The driver is designed to simply the integration of LoRaWAN networks into Niagara without having to manually setup and decode JSON payloads. The driver will support ‘known’ devices and also support new/unknown devices.
The connection to the LoRaWAN Gateway is bidirectional over an HTTP interface.

The Driver is compatible with all brands of Niagara 4 (Tridium / Centraline / Distech / Honeywell / JCI / Trend etc).

The LoRaWAN Driver can be used in several different scenarios on different Tridium Niagara-based platforms via a Milesight Gateway:

Web Supervisor
JACE8000 / JACE9000

Any 3rd Party Controller (IoT Controller / Lynxspring / iSMA MAC36 etc).

Example 1
Web Supervisor – Milesight UG65 Gateway (Local LAN)

The Web Supervisor integrates directly with the local Milesight UG65 Gateway.

All configured LoRaWAN devices will be discoverable in the Niagara Station and their enclosed points will also be discoverable.

Example 2
Niagara Enabled Controller – Milesight UG65 Gateway (Local LAN)

The JACE8000 / 3rd Party Controller integrates directly with the local Milesight UG65 Gateway.

All configured LoRaWAN devices will be discoverable in the Niagara Station and their enclosed points will also be discoverable.

Example 3
Cloud-Based Niagara 4 – Remote Milesight UG65 Gateway (Cellular)

The Web Supervisor integrates remotely to the remote Milesight UG65 Gateway (with an integrated SIM card).
All configured LoRaWAN devices will be discoverable in the Niagara Station and their enclosed points will also be discoverable.

LICENSING & SOFTWARE MAINTENANCE

The LoRaWAN driver is licensed based on points. Each LoRaWAN point will also consume one Global Capacity Point License.
You will need to provide your Niagara 4 Host ID as part of your purchase. If you are expanding your system in the future you will need to ensure that your LoRaWAN Driver has been expanded to cover the number of new points being added.
Once the license has been generated you can re-import your Niagara license files from the Platform > License Manager providing you have an internet connection, alternatively you can be emailed a copy of the new license files.
The LoRaWAN Driver includes a software maintenance feature. Every new purchase of the driver will support the current release of Niagara 4 and the next release of Niagara 4, any subsequent upgrades will require a software maintenance license to be purchased.
As an example, the current release of Niagara 4 is N4.13, a new driver purchase will cover you for N4.13 and a future upgrade to N4.14. Any further upgrades, for example to N4.15 or above, will require a software maintenance license to be updated. The software maintenance license would then cover you for the now current release of Niagara 4 (as an example N4.15). You can upgrade from any previous release with a single software maintenance purchase.
Ensure the target Host License Manager is up to date with a Tyrrell. license and Tyrrell.certifcate containing the required license features.
Any questions or queries concerning this item should be sent to sales@tyrrellproducts.com

LoRaWAN Driver License Packs

Product Code	Descrip/on
LoRaWAN 0025	LoRaWAN Driver 25 Point License Pack 1x LoRaWAN Network 25x LoRaWAN Points
LoRaWAN 0050	LoRaWAN Driver 50 Point License Pack 1x LoRaWAN Network 50x LoRaWAN Points
LoRaWAN 0100	LoRaWAN Driver 100 Point License Pack 1x LoRaWAN Network 100x LoRaWAN Points
LoRaWAN 0250	LoRaWAN Driver 250 Point License Pack 1x LoRaWAN Network 250x LoRaWAN Points
LoRaWAN 0500	LoRaWAN Driver 500 Point License Pack 1x LoRaWAN Network 500x LoRaWAN Points

LoRaWAN Driver Upgrade Packs

LoRa0025-UPG	25x LoRaWAN Points
LoRa0050-UPG	50x LoRaWAN Points
LoRa0100-UPG	100x LoRaWAN Points
LoRa0250-UPG	250x LoRaWAN Points
LoRa0500-UPG	500x LoRaWAN Points

DRIVER INSTALLATION

The LoRaWAN Driver supports Niagara 4.10 and above.

NOTE
If your installation is running an older version of the Niagara software then it must be upgraded to meet the above requirements to run this service.
Any future updates to the LoRaWAN Service will be available for the current release and previous Niagara 4 release. All other releases will become legacy and unsupported.

Niagara 4 Installation
You will need the version specific JAR files for your Niagara 4 installation. These can be downloaded from the Customer Portal or alternatively contact support.
To install the Service copy the below JARS to c:\niagara\niagara 4.x.xx\modules

LoRaWAN-rt.jar
LoRaWAN-wb.jar

Once the files have been put into the correct directory close your workbench, and relaunch. Any running Stations on the local machine will have to be re-started to make use of the LoRaWAN Driver.
The LoRaWAN Driver is now ready to use in a local station or to commission / update a JACE.
To install the driver on a JACE use the Commissioning Wizard on the platform of the target device.

MILESIGHT SETUP

The Milesight Gateway will need to have a specific configuration applied:

Create An Application(s)
Assign LoRaWAN Devices to the Application(s)

The integration between Niagara 4 and Milesight gateway will support HTTP connections only.
This is a current limitation of the Milesight Gateways.

MILESIGHT APPLICATIONS

Login to your Milesight Gateway (the default details are printed on the rear of the unit).
Navigate to Network Server > Applications

Create a new Application and save it.

Re-edit the Application and a new Operation – HTTP
Edit the Uplink Data field to http://IPADDRESS/lorawan/noAuthListener/uplink.
Where IPADDRESS is the address of your Niagara 4 Station. Example: http://192.168.23.10/lorawan/noAuthListener/uplink

Save both the Operation and Application, then return to the main menu.

LORAWAN SENSORS

Before configuring the Niagara Station you will need to ensure that your Milesight Gateway is paired with at least one LoRaWAN Device.
You may require a dedicated Mobile Phone App to configure the sensor, the guide will demonstrate an Elsy sensor.
Download the Sensor App onto your Mobile Device.

Note: Your mobile device must be fitted with a NFC chip to work.

Make note of the Sensor UID (a81758fffe05d501)

In the Milesight Gateway navigate to Network Server > Device

Add a new Device

Se2ng	Descrip/on
Device Name	Unique Name of the Device
Descrip/on	User Friendly DescripGon
Device EUI	From the Sensors App
Device Proﬁle	From Spec Sheet Of Device
Applica/on	Your Custom application in the previous step
Payload Codec	None By Default Can be changed for new/unknown devices (see later section)
App Key	From the Sensors App Milesight Default is: 5572404c696e6b4c6f52613230313823

Once you have added a device ensure it is active and sending data before proceeding.
Once working the Last Seen and Activated fields will update.

NIAGARA WEB SERVICE

Connect to your Niagara 4 Station.
Navigate to Station > Services > Web Service.
Set the HTTP option to TRUE and Ensure HTTPS ONLY is set to FALSE.

LORAWAN DRIVER

Navigate to Station > Config > Drivers and add a new LoRaWAN Driver.
Navigate to the AX Property Sheet view of the Network.

Change the Network Server Type to Milesight UG65

NETWORK SERVER

Expand the Network Server Section

Note: The user account MUST be the admin account.

Setting	Description
URL	IP of the Milesight Gateway http://192.168.23.150
Username	admin
Password	Admin account password

DEVICE MANAGER

Navigate to the LoRaWAN Driver > Device Manager and press Discover.
The driver will then discover all available devices from the Milesight Gateway

Add the required device(s) to the Station database.

When adding a device the Add Window will have a Device Type option. The driver has a preconfigured library of devices that will automatically ‘work’. New / Unknown devices can still be added but need to be set with a ‘Generic’ profile and the JSON payload decode. Refer to the section Supported Devices for more information.

Once the device has been added navigate to the Points container of the device.

POINT DISCOVERY

In the Point Manager Window press the Discover button and all available points will be presented.

Add the required Points to the Station Database.

The Points will all remain STALE until the LoRaWAN sensor next reports to the Gateway.

Check the device configuration either way for the next publish cycle or change the device config to report more frequently during setup.

The points will then only update their values when the LoRaWAN sensor reports to the LoRaWAN Gateway (for example every 5 minutes).

SUPPORTED DEVICES

The LoRaWAN driver automatically supports the following device types:

Adonis Pulse Counter
2x Configurable Pulse Counter Inputs
B Meters RFM-LR1
For pre-equipped single-jet water meters

ElSys CO2 Lite (3 in 1)
Temp / Hum / CO₂
Milesight AM102L
Temp / Hum
Milesight AM103L
Temp / Hum / CO₂

Milesight AM307
7 in 1 Sensor
Temp / Hum / Motion / Light / TVOC / Barometric Press / CO₂
Milesight AM308
9 in 1 Sensor
Temp / Hum / Motion / Light / TVOC / Pressure / CO₂ / PM2.5 / PM10
Milesight AM319
11 in 1 Sensor
Temp / Hum / Motion / Light / TVOC / Pressure / CO₂ / PM2/5 / PM10 / (HCHO)² / (O₃)²

Milesight EM300 DI
Temp / Hum / DI or Pulse Counter
Milesight EM300 MCS
Temp / Hum / Magnetic Switch
Milesight EM300 SLD/ZLD
Temp / Hum / Leak Detection

Milesight EM300 TH
Temp / Hum
Milesight TS101
Insertion Temp
Milesight TS201
Flying Lead Temperature Probe

Milesight TS301
1x Connector for PT100 Sensor OR Magnetic Switch
Milesight TS302
2x Connector for PT100 Sensor OR Magnetic Switch
Milesight UC300
IO Controller
4* DI / 2* DO / 2* 4-20mA / 2* 0-10v / 2* PT100 Sensor
*RS485 NOT CURRENTLY SUPPORTED!

Milesight VS350
Passage People Counter
Milesight WT101* (In Development)
Smart Radiator Thermostat

Other devices are supported in one of two ways:

Use the ‘Generic’ profile and decode the incoming JSON
For Sensor/Device Types that are not listed in the LoRaWAN Niagara driver, please ask Tyrrell Products Ltd about adding your LoRaWAN Device type to the driver’s dropdown list.

This will greatly simplify the process of adding devices in the future.

LORAWAN DEVICE PAYLOAD DE-CODING

New/unknown LoRaWAN device types can still be supported by using the “Generic (predecoded JSON)” Device Type drop-down list option in combination with some modifications to the device manufacturer-supplied JavaScript “Payload Decoder Function”.
This example will cover an EM300-TH.
You will need the manufacturer’s decoder script.

As an example: https://github.com/Milesight-IoT/SensorDecoders/blob/main/EM_Series/EM300_Series/EM300-TH/EM300-TH_Chirpstack.js#L1

More JSON has been chopped for the sake of convenience.

You will need to copy the whole of the JS to Notepad++ and modify the first part

Original Example

Information

The entry decoder. data on = milesight(bytes); must match up with the next section line function milesight(bytes).
Once modified copy with the whole of JS to apse into the milesight gateway.

Open the Milesight Web Server and log in.
Navigate to Network Server > Payload Codec Add a new Custom Payload Codec.

Paste the modified JSON into the Payload Decoder Field Save the custom codec.
Navigate to Network Server > Device

Edit the Device in question
Change the Payload Codec from None to JSON Codec EM300 (or appropriate Codec Name)

NIAGARA GENERIC JSON

Return to the Niagara Station and discover the LoRaWAN devices.
Add the target device handset the Device Type to Generic (pre-coded JSON)
The Point Discovery will not work and the points will have to be manually programmed based on their JSON payload names. These can all be obtained from the Payload Decoder.

In the above example, the JSON Field is temperature.
The Name and Facets can be configured as required based on the point type.

The next time the LoRaWAN device reports to the Gateway the points will update their values.

REVISION HISTORY

REVISION	DESCRIPTION
1.0	Draft Release For Approval
1.1	General Update
1.2	List of Automatically Supported Devices Expanded

FAQ

How do I expand my LoRaWAN system with new points?
- To expand your system with new points, you will need to ensure that your LoRaWAN Driver’s license covers the additional points. Contact support for assistance with expanding your license.

Can I use the LoRaWAN Driver with other brands of Niagara 4?
- Yes, the LoRaWAN Driver is compatible with all brands of Niagara 4, including Tridium, Centraline, Distech, Honeywell, JCI, and Trend.

Documents / Resources

tyrrell UG65 Lora Wan Niagara 4 Driver [pdf] User Guide
UG65 Lora Wan Niagara 4 Driver, UG65, Lora Wan Niagara 4 Driver, Wan Niagara 4 Driver, Niagara 4 Driver, 4 Driver

References

User Manual

tyrrell UG65 Lora Wan Niagara 4 Driver

Product Information