Laird Sentrius RS1 User Manual

A
Version 1.7
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
2
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
Version
Date
Notes
Contributor
Approver
1.0
05 Dec 2017
Initial version
Christopher Hofmeister
Jonathan Kaye
1.1
09 Apr 2018
Indicated that the Sentrius™ Sensor with an external sensor port (RJ45) will be available rather than is available.
Mark Cai
Jonathan Kaye
1.2
17 Oct 2018
Updated for firmware version 4.4. Added in Packet Format and Packet Type sections.
Colin Anderson
Jonathan Kaye
1.3
19 Dec 2018
Updated logos and URLs
Sue White
Jonathan Kaye
1.4
May 2019
Reset button, LIFO, and FIFO backlog retrieval. Updated rest of doc for clarity.
Colin Anderson
Jonathan Kaye
1.5
July 2019
Introduction of AS923 and AU915 regions.
Colin Anderson, Mark
Monson, Daniel Cesarz
Jonathan Kaye
1.6
15 Aug 2019
Added AS923 Region Label Support within various sections and created Section 16
Robert Gosewehr
Jonathan Kaye
1.7
28 Aug 2019
Reflect new part numbers and modified ext. probe specification
Chris Boorman
Jonathan Kaye
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
3
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
1 About this Guide ...................................................................................................................................................................................... 4
2 Introduction .............................................................................................................................................................................................. 4
2.1 Product Overview .......................................................................................................................................................................... 4
2.2 Specifications ................................................................................................................................................................................ 4
2.3 Architecture Overview .................................................................................................................................................................... 5
3 Powering Up the Sensor .......................................................................................................................................................................... 5
3.1 Battery Types ................................................................................................................................................................................ 5
3.2 Inserting Batteries .......................................................................................................................................................................... 5
4 Connecting to a LoRa network Server ...................................................................................................................................................... 6
4.1 AppEUI .......................................................................................................................................................................................... 6
4.2 DevEUI .......................................................................................................................................................................................... 6
4.3 AppKey .......................................................................................................................................................................................... 7
5 Configuring the Packet Format ................................................................................................................................................................. 7
6 Configuring the Packet Type ................................................................................................................................ .................................... 9
7 Adaptive Data Rate (ADR) ....................................................................................................................................................................... 9
7.1 Definitions ...................................................................................................................................................................................... 9
7.2 Data Rate, Sensor Performance, and Tradeoffs .......................................................................................................................... 10
7.3 MAC Commands and the LoRa Standard .................................................................................................................................... 10
8 Device Operation ................................................................................................................................................................................... 11
8.1 Care and Maintenance ................................................................................................................................................................ 11
8.2 Positioning of the Sensor ................................ ................................................................................................ ............................. 11
8.3 LoRa Messages ........................................................................................................................................................................... 11
8.4 Join Sequence ............................................................................................................................................................................. 11
8.5 Ack/Retries .................................................................................................................................................................................. 12
8.6 Disconnect ................................................................................................................................................................................... 12
8.7 Network Time .............................................................................................................................................................................. 12
8.8 Backlog Feature .......................................................................................................................................................................... 13
8.9 Measuring Humidity ..................................................................................................................................................................... 13
8.10 Setting up the Sensor .................................................................................................................................................................. 13
8.11 Sensor Firmware Version ............................................................................................................................................................ 14
8.12 Resetting the Sensor ................................................................................................................................................................... 14
9 Configuration ......................................................................................................................................................................................... 15
9.1 Label (Back Label Space) ............................................................................................................................................................ 15
9.2 Device Configuration ................................................................................................................................................................... 15
10 Mobile Application .................................................................................................................................................................................. 16
10.1 Overview ..................................................................................................................................................................................... 16
10.2 Install Sentrius™ Sensor Mobile App on Device .......................................................................................................................... 16
10.3 Connect to Sentrius™ Sensor...................................................................................................................................................... 16
10.4 Main Screen ................................................................................................................................................................................ 17
10.5 Configure Device ......................................................................................................................................................................... 17
10.6 View Sensor Data ................................................................................................................................................................ ........ 18
10.7 LoRa Configuration ...................................................................................................................................................................... 19
10.8 LoRa Network .............................................................................................................................................................................. 19
10.9 BLE Info ...................................................................................................................................................................................... 20
10.10 Update Firmware ......................................................................................................................................................................... 20
10.11 Integrating Sentrius™ Sensor into a Third-Party Application ........................................................................................................ 21
11 Bluetooth SIG ........................................................................................................................................................................................ 22
12 FCC and ISED Canada Regulatory Statements ..................................................................................................................................... 22
12.1 Power Exposure Information ........................................................................................................................................................ 22
12.2 OEM Responsibilities ................................................................................................................................................................... 22
13 CE Regulatory ....................................................................................................................................................................................... 23
13.1 EU Declarations of Conformity ..................................................................................................................................................... 23
14 Ordering Information .............................................................................................................................................................................. 24
14.1 Evaluation Kit Details (applies to 455-0001, 455-0002 as well as other regional variants) ............................................................ 25
15 Other Variants ........................................................................................................................................................................................ 25
15.1 External Sensor Port .................................................................................................................................................................... 25
16 Label Info ................................................................................................................................................................ ............................... 26
17 Additional information ............................................................................................................................................................................ 27
18 Appendix A - Cayenne packet format ..................................................................................................................................................... 27
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
4
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
This document is the parent guide of the RS1xx Configuration Guide. It provides a comprehensive guide on how to configure the Sentrius™ RS186 and RS191 sensors to suit the intended application. It covers all Sentrius™ RS1xx functionality, including Bluetooth and LoRa configurations in detail, as well as setting up the sensor on a LoRa network server.
In order to comply with the LoRaWAN spec, Laird offers several different versions of the Sentrius Sensor. Regions covered include Europe (EU), North America (US) and Australia (AU915). Also covered is the Asia(AS) region but, in order to meet local regulatory requirements, this region is covered by individual firmware versions for each country.
Note: Step by step instructions, screen shots, and pictures are based on the Sentrius RS191, but the same are
applicable for the Sentrius RS186 or other variants. Any differences are noted.
The Sentrius™ RS1xx LoRa-Enabled Sensor from Laird is the ultimate in secure, scalable, robust LoRa solutions for end-to-end control of your private LoRaWAN network. Based on the Semtech SX1272 chipset, it offers a long range up to ten miles, perfect for highly scalable, flexible IoT networks. The Sentrius™RS1xx Sensor works with Laird’s Sentrius™RG1xx Series Gateways for simple out-of­the-box integration and is compatible with third-party and LoRa network servers.
Figure 1: Top of the Sentrius RS1xx sensor
1. Temperature and humidity sensor
2. Bluetooth button
3. LEDs
4. Fixing holes
Figure 2: Back side of the Sentrius™ RS1xx sensor
Note: Laird has a comprehensive staff of design services engineers available to help customize the sensor.
Please contact your local Laird sales representative for more details.
See the RS1xx product brief for detailed specifications. It’s available from the Documentation tab of the RS1xx Series product page: https://www.lairdconnect.com/wireless-modules/lorawan-solutions/sentrius-rs1xx-lora-enabled-sensors
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
5
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
The major pieces of a LoRa network can be seen in Figure 3. The RS1xx sensor is an End Node in the diagram below. The RS1xx requires the other components in the diagram below to operate.
Figure 3: LoRa architecture
Note: The Sentrius™ Sensor has no power switch. Inserting the batteries powers up the device.
The Sentrius™ Sensor is designed for use with primary cell AA batteries, either lithium or alkaline 1.5V cells. Lithium batteries have more capacity but are costlier. Lithium batteries also have a lower temperature range of -40° C, as opposed to -20° C for alkaline. You must specify the type of battery being used because the algorithm that determines the percentage of remaining battery life must account for the battery type.
Default Battery Type for the Sentrius™ Sensor: Alkaline batteries
The battery type can be changed via the Sentrius™ mobile application. Refer to the Configuration section for details.
The batteries are inserted on the rear panel of the RS1xx sensor, as shown in Figure 2.
Note: The battery door cover has a gasket inside to keep out liquids. It is important that all screws on the back of the unit
are properly inserted and tightened. Failure to do so could result in liquid ingress which would void the warranty on the device.
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
6
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
Figure 4: Back label – See Label Info for any possible label updates.
The exact steps needed to connect to a LoRa network server vary by network provider but in all cases, the following three described LoRa keys described must be known by the external LoRa network server.
The AppEUI is an 8-byte ID used to uniquely identify your application and/or installation. For example, imagine you are installing the Sentrius™ Sensor in a store chain. You could use a specific AppEUI to identify a specific store or perhaps the entire chain of stores.
The default AppEUI is 0xf9,0xc6,0x0e,0xce,0xa3,0xad,0xc6,0xbd, and it is set in the device by Laird at the time of manufacturing.
The AppEUI can be read or changed via the Sentrius™ mobile application. The number is generated by the end-user, so any number can be used.
The DevEUI is an 8-byte ID used to uniquely identify your device. It is assigned and set in the device by Laird at the time of manufacturing.
The DevEUI is printed on the back label of the sensor as highlighted in red in Figure 4.
In previous versions of the label, there is a large area of whitespace which can be used to apply a secondary label or write in information. The AS923 region supported label only has the green box area for this feature.
The DevEUI is also accessible via the barcode on the back label where the last comma separated value is the DevEUI in the previous revision of the label. The AS923 region supported back label has a dedicated QR Code for the DevEUI.
Example Readout in previous label version: 450­0182,1,915 MHz Sentrius Sensor,0213117,0025CA0A010108D6
Note: The sensor labels may change at any time. Please reference Label Info for the latest label changes.
Normally there is no need to change the DevEUI. However, if necessary, it can be read or changed via the Sentrius mobile application. Because the IEEE governs the generation of the number, you must be familiar with these standards in order to change the DevEUI.
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
7
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
The AppKey is a 16-byte security key assigned to the device. Laird assigns and sets it in the device at the time of manufacturing.
The AppKey is printed on a removeable label that is attached to the device when it is shipped (Figure 5).
Important!
It is the user’s responsibility to keep track of the assigned AppKey and to keep it secure.
Figure 5: AppKey label
The AppKey is also accessible via the barcode on the back label.
Normally, there is no need to change the AppKey. However, it can be changed via the Sentrius™ mobile application if necessary.
Note: This key is write-only as there is a security risk in making it readable via the mobile application.
From firmware version 4.0 onwards, the RS1xx offers two packet format options:
Laird ▪ Cayenne
Prior to version 4.0, only the Laird option was available. If using the Laird packet format, the sensor must receive a network time packet (in Laird binary format) before data is stored in memory for future transmission. Data logging is not available with the Cayenne packet format, so network time is not required this packet format. Refer to the Network Time section for more information.
The packet format can be configured on the Mobile App through the LoRa Radio Settings and Info option.
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
8
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
Figure 6: Packet format menu
A brief summary of the different formats is shown in Table 1.
Table 1: Comparison of packet formats
Format
Description
Laird
Time stamp, synchronised to the network time Temperature and humidity data Number of Alarms Number of Backlog packets stored Aggregated packets Backlogs Remaining battery capacity
Cayenne
Temperature and humidity data Remaining battery capacity Note – no timestamp is transmitted
The Cayenne packet format is described in greater detail in Appendix A - Cayenne packet format. Refer to the Network Time section for more information.
Note: The battery capacity is reported as an integer value between 1 and 5. Each value represents a percentage range of
20% as follows
Table 2 : Battery percentage values
Value
Percentage Range
1
0 - 20
2
21 - 40
3
41 - 60
4
61 - 80
5
81- 100
https://www.lairdconnect.com/wireless-modules/lorawan­solutions
9
© Copyright 2019 Laird. All Rights Reserved
Americas: +1-800-492-2320
Europe: +44-1628-858-940
Hong Kong: +852 2923 0610
With the Cayenne packet format selected, you have the option of configuring the RS1xx to transmit either confirmed or unconfirmed packets. You can configure this option through the LoRa Radio Settings and Info option in the Sentrius Mobile application. This option is NOT available with the Laird packet format, which only transmits confirmed packets.
Figure 7: Packet type menu
With confirmed packets, there is a higher likelihood that an uplink data packet is successfully transmitted to the servers, as the RS1xx automatically resends a packet if an acknowledgement is not received (refer to the Ack/Retries section for more details on the Ack/Retry process). However, one downside is using up more bandwidth on the network as there is a downlink packet for each uplink.
With unconfirmed packets, the uplink packet is transmitted only once. If the packet is not received by the server, then the data is lost. It is not stored internally in the RS1xx for transmission at a later time.
With confirmed packets, if three successive uplinks are not acknowledged, the sensor tries to rejoin. Unconfirmed packets continue to be transmitted while the sensor is powered.
See the LoRaWAN Specification for a complete discussion of ADR. The LoRaWAN specification can be obtained from the
LoRa Alliance.
Knowledge of the following terms is important for this section:
Uplink/Upstream Transmissions originating from the sensor and received by the LoRa Network Server via the LoRa
Gateway.
Downlink/Downstream Transmissions originating from the LoRa Network Server and received by the sensor via the
LoRa Gateway.
Loading...
+ 18 hidden pages