Welcome to a step-by-step guide to using the new LORIOT Network Ranger WebSocket application.
The LORIOT Network Ranger application is a new tool which displays the relayed GPS and radio information of a LoRaWAN device and the relevant gateway(s) within range.
✔ The Network Ranger application is available to all users on a Public or Private network server and is accessible through the user dashboard or via direct link.
➜ In this guide, we will demonstrate:
- Configuring the Network Ranger application in the user dashboard
- Testing LoRaWAN devices and gateways using the application and an overview of the displayed information.
Integrated LoRaWAN GPS Devices
LoRaWAN devices are required to be back-end integrated by LORIOT to be compatible with the Network Ranger application.
We currently support the following LoRaWAN devices:
Adeunis Field Test Device ChipCAD Micromite ZANE GPS Devices
➜ For device data to be displayed in the Network Ranger application, first we must add the compatible LoRaWAN device to our virtual application in the user dashboard.
✔ This is based on the assumption you have already created a Network and added at least one gateway.
a) Login into your user account as usual and select Applications from the menu.
b) Create a new application or select your existing application: Applications ➜ New Application.
c) Enroll a Device in an existing Application: Select Application ➜ Enroll Device
➜ Fill out the mandatory fields depending on the selected enrollment process method and click on "Enroll".
✔ The device is now registered in the virtual application and ready to communicate with the network server via the gateway.
WebSocket Application Output
For the virtual application to route device data to the Network Ranger application, the virtual application requires to have WebSocket enabled in Application Outputs.
The default application output for a virtual application is already a WebSocket. If if it has previously been changed, the WebSocket must be re-enabled in Application Outputs.
✔ Server v5.0 enables multiple simultaneous application outputs for a single virtual application; therefore you can still output to your chosen output(s) in parallel to a WebSocket.
a) Go to the overview page for your application and select Manage outputs: Application → Select Application → Manage outputs
b) The WebSocket output is the default output of a new application, but if not already selected, it is required to add as an output.
➜ Select Add new output and select WebSocket from the available list.
✔ The Application output is now set to WebSocket which the applications can use.
Gateway Information & Output Verbosity
Gateway and Radio information must be included with a device payload for it to be displayed in the Network Ranger application. This feature is available to all accounts on the network server.
a) We can enable the inclusion of radio and gateway location verbosity in the application features window: Application ➜ Select Application ➜ Features
b) Location data is the default option for an Application, however if not already selected please re-configure.
➜ Output Verbosity should also be Extended
✔ The application is now configured to enable the gateway location and radio information for the WebSocket.
Network Ranger Application
WebSocket applications are located within the Application Menu: Application ➜ Select Application ➜ WebSocket Applications
✔ Here we find the Network Ranger application
➜ Select the Network Ranger application link to open launch the Application.
➜ The Network Ranger Application will automatically localizes the device based on the latest transmitted data.
Application Access Tokens
To connect to any of the application interfaces provided by LORIOT, it's required to prove you are a legitimate user of the network application.
The mechanism used is a security/access token and it permits the Network Ranger application to access the data of devices registered in the LORIOT Application.
✔ To safeguard your data ensure to keep the tokens protected.
➜ The WebSocket applications including the Network Ranger application will automatically retrieve your unique Access Token and include it in the URL.
Network Ranger Features
a) The Network Ranger application makes use of the Google Maps API to display the location of gateways and devices.
b) The standard functionality of Google Maps to zoom in or out, change to Satellite overlay and view locations at street level is available.
✔ We can view the building/location of a gateway at street level, for instance, on the right is the LORIOT headquarters in Zurich.
➜ There are three noticeable features initially on the Network Ranger Map.
- Spreading Factor (SF)
The Gateway icon represents gateways:
Colorful dots represent GPS devices on the map:
The color represents the spreading factor the device used to communicate with any gateway which received its packet:
✔ Gateways will only show on the map once they have received a radio packet from a device.
✔ Devices will only show on the map once they have successfully connected with a gateway.
When a device communicates with a gateway, it will transmit a radio packet including its GPS coordinates.
The gateway will upload this data to the Network Server, and the Network Ranger application will display the device location on the map including the device details; DevEUI, radio transmission data, which gateway received the packet, the timestamp and the transmission distance.
➜ We can view these details by selecting a device icon on the map
➜ We can see in the image above the gateway has received a transmission from the device.
The relevant data is displayed in the top left corner and a short description is also shown next to the gateway and device.
➜ In the example below, the device packet has been received by three separate gateways and the gateway gwEUI identifies the gateways.
The Gateway receives a packet from a compatible Network Ranger device and it will display in the application.
➜ Selecting the gateway icon will display the Spreading Factor and distance transmitted of a device packet.
➜ Hovering over a gateway icon will show the gateway ID (GwEUI)
The Network Ranger application is designed to provide the visualization of GPS device location, radio information and display the network coverage of gateways receiving packets.
Utilizing this application can assist with network deployment and tracking of GPS LoRaWAN devices.