MULTITECH RBS301 Reveal Wireless Sensors User Guide
- June 1, 2024
- MULTITECH
Table of Contents
MULTITECH RBS301 Reveals Wireless Sensors
Reveal™ RBS301 Certifications Manual
- Model: RBS301-TEMP-INT-US, RBS301-WAT-US, RBS301-WR1M-US, RBS301-WR10M-US, RBS301-TEMP-EXT-US, RBS301-CON-US, RBS301-DWS-US, RBS301
- ABM-US, RBS301-TEMP-NOP-US, RBS301-TILT-HP-US, RBS301-TILT-US, RBS301-CMPS-US
- Part Number: RB00024 Rev. 1.0
Trademarks and Copyright
Copyright
This publication may not be reproduced, in whole or in part, without the
specific and express prior written permission signed by an executive officer
of Medi-Tech Systems, Inc. All rights reserved. Copyright © 2022 by Multi-Tech
Systems, Inc.
Trademarks and Registered Trademarks
MultiTech, the MultiTech logo, DeviceHQ, xDot, and Conduit are registered
trademarks and Reveal and mDot are trademarks of Multi-Tech Systems, Inc. All
other products and technologies are the trademarks or registered trademarks of
their respective holders.
Disclaimers
Information in this document is subject to change without notice and does not
represent a commitment on the part of Multi-Tech Systems, Inc. Multi-Tech
Systems, Inc. provides this document “as is,” without warranty of any kind,
expressed or implied, including, but not limited to, the implied warranties of
fitness or merchantability for a particular purpose. Multi-Tech Systems, Inc.
may make improvements and/or changes in this manual or the product(s) and/or
the software described in this manual at any time.
Legal Notices
See the Legal Notices section of the website for up-to-date information on
MultiTech warranty, returns policy, privacy statement, terms of sale, and
terms of service.
Customer Support
MultiTech offers free technical support for Reveal sensors at:
https://support.radiobridge.com
MultiTech also offers technical support plans and service packages to help our
customers get the most out of their MultiTech products.
World Headquarters
Multi-Tech Systems, Inc.
2205 Woodale Drive, Mounds View, MN 55112
Chapter 1 – Product Overview
Overview
The Reveal™ 301 sensor configuration is designed for indoor use and used for a
variety of sensors. 301 sensor configurations share similar housing and
internal components, with model-specific sensor attachments. This user guide
details the common specifications shared between all 301 sensor
configurations. Note: This manual is a generic guide for Reveal™ sensors with
a 301 configuration. For specific sensor product guides and related
information from Reveal™, go to: https://www.multitech.com/products/sensors
Documentation
The following documentation is available at
https://www.multitech.com/products/sensors.
Document | Description | Part Number |
---|---|---|
User Guide | This document provides an overview, of safety and regulatory |
information, design considerations, schematics, and general hardware
information.| RB00024
Connection Guide| This document provides instructions and information on how
to connect Reveal LoRaWAN sensors on gateways and networks.| RB00001
Chapter 2 – Preparing Sensor
Sensors ship with batteries installed. There is a plastic tab over the
battery, which needs to be removed. Pull the tab out of the sensor to connect
the battery. If the tab does not pull out easily, you may need to open the
case to remove it.
To open the case
- Use a pen or similar object to press the button on the opposite side of the case.
- Remove the battery tab. You may need to remove the battery to remove the tab.
- Re-insert the battery and close the case.
Quick Start
Use your sensor through either the Radio Bridge Console or a third-party
network. To use the Radio Bridge Console, use the following steps. To use a
third-party network, refer to the Connecting Radio Bridge LoRaWAN Sensors on
Gateways and Networks (RB00001), which is available through the sensor page at
https://www.multitech.com/products/sensors
-
Create a Radio Bridge console account at: https://console.radiobridge.com/
-
Click on Devices on the left.
-
Click Add Device.
-
Select the network you want to use.
-
Specify if you want to Register Through Radio Bridge or use an existing account with the network.
-
Make sure Console Only Device is NOT selected.
-
Enter the Device Name, Device ID, and Device Key.
Note : For easy Device ID and Key entry, scan the QR code on the device label. Then copy and paste data into the console. With the QR code, the first line is the Device ID and the rest is the key. -
Select the model from the Device Type drop-down. The model is on the device label.
-
Select the Join EUI and click Continue.
-
Review the summary and click Confirmation. The console shows complete when the device is successfully added.
Chapter 3 – Hardware Specifications and Information
Temperature Ranges
Parameter | Rating M |
---|---|
Operating ambient temperature | -30 to +70 |
Storage ambient temperature | -40 to +100 |
Battery Life
The sensor uses a lithium non-rechargeable battery, capable of an estimated
200,000+ messages.
Note: Refer to the Sensor Battery Estimator.xlsx spreadsheet on the
sensor’s product page for specific battery life estimates:
https://www.multitech.com/products/sensors
Battery life depends on the number of transmissions per day. The power required for message transmission is greater than the “sleep current” for high-power radio technologies (e.g, LoRaWAN). Different battery types deplete over time with different voltage profiles; a lithium battery maintains high voltage for the life of the battery with a rapid drop near the end of life, and an alkaline battery has a gradual reduction in voltage over time. Radio Bridge devices are shipped with lithium batteries, which are the recommended replacement type.
- Recommended battery: Panasonic CR2
- Recommended battery: Panasonic CR123/A
Battery life estimates in the online spreadsheet assume room temperature,
meaning temperatures near the maximum and minimum ratings negatively impact
battery life. Battery voltage lowers in cold temperatures, and internal
circuitry needs a minimum voltage to operate properly.
Note : Battery life will be reduced in cold environments leading to
possible device shutdown. The battery voltage is reported by the supervisory
messages and a low battery indicator. See the section on Message Protocol for
details.
Replacing the Battery
The replacement battery type is listed in the Battery Life topic. To replace
the battery:
- Use a pen or similar object to press the button on the opposite side of the case.
- Remove the battery.
- Insert the new battery and close the case.
Mechanical Drawings
The mechanical drawings provided in this section are for the main body of the
sensor. All dimensions use inches unless specified.
Indoor RBSx01 Sensors
Chapter 4 – Regulatory Information
47 CFR Part 15 Regulation Class B Devices
This equipment has been tested and found to comply with the limits for a Class
B digital device, under part 15 of the FCC Rules. These limits are designed to
provide reasonable protection against harmful interference in a residential
installation. This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used by the instructions, may cause harmful
interference to radio communications. However, there is no guarantee that
interference will not occur in a particular installation. If this equipment
does cause harmful interference to radio or television reception, which can be
determined by turning the equipment off and on, the user is encouraged to try
to correct the interference by one or more of the following measures:
- Reorient or relocate the receiving antenna.
- Increase the separation between the equipment and the receiver.
- Connect the equipment to an outlet on a circuit different from that to which the receiver is connected.
- Consult the dealer or an experienced radio/TV technician for help.
Warning:
To satisfy RF exposure requirements, this device and its antenna must operate
with a separation distance of at least 20 cm from all persons.” Reference FCC
KDB 784748, Section A.8. Changes or modifications to this unit not expressly
approved by the party responsible for compliance could void the user’s
authority to operate the equipment.
Federal Communications Commission (FCC)
Per FCC 15.19(a)(3) and (a)(4) This device complies with part 15 of the FCC
Rules. Operation is subject to the following two conditions: (1) This device
may not cause harmful interference, and (2) this device must accept any
interference received, including interference that may cause undesired
operation. Per FCC 15.21, Changes or modifications not expressly approved by
MultiTech could void the authority to operate the devices.
LoRaWAN RBS301 Sensor:
FCC ID: AU792U22A05869
IC: 125A-0066
Industry Canada Class B Notice
This Class B digital apparatus meets all requirements of the Canadian
Interference-Causing Equipment Regulations. This device complies with
Industry Canada license-exempt RSS standard(s). The operation is permitted for
the following two conditions: the device may not cause interference, and this
device must accept any interference, including interference that may cause
undesired operation of the device.
Harmonized Commodity Description (HS Code)
The Harmonized Commodity Description and Coding System generally referred to
as “Harmonized System” or simply “HS” is a multipurpose international product
nomenclature developed by the World Customs Organization (WCO). HS Code:
8531.90.9001
Export Control Classification Number (ECCN)
ECCNs are five-character alpha-numeric designations used on the Commerce
Control List (CCL) to identify dual-use items for export control purposes. An
ECCN categorizes items based on the nature of the product, i.e. type of
commodity, software, or technology and its respective technical parameters.
ECCN: 5a992.c
Chapter 5 – Common Messages
Common Messages
This chapter defines the protocol and message definitions common to all Reveal
wireless sensors. Common messages include basic error messages, tamper,
supervisory, link quality, and downlink acknowledgments. Sensor-specific
messages are in the Sensor-Specific Messages chapter.
Message Protocol
This section defines the protocol and message definitions for the device.
Note: MultiTech provides a web-based console at console.radiobridge.com for
configuring and monitoring devices. We recommend using this console rather
than the protocols defined in this section. If not using the console, use this
topic to configure the device through downlink messages and decode the device
data.
Uplink Messages
The uplink messages (sensor to a web application) have the following
structure.
Item | Size | Description |
---|---|---|
Protocol Version | 4 bits | A constant 1, provides extensibility to the specific |
format of a message type.
Packet Count| 4 bits| A sequential number starts at 0 for the first message
sent from the sensor to the cloud. It increments by one for each subsequent
message. When it reaches 0xF (15 decimal), it wraps back to 0. Packet count
helps identify when a message is lost. For example, if the packet count goes
2,4 instead of 2,3,4, it indicates a message has been lost. It can also help
identify out-of-order or duplicate messages.
Message Type| 1 byte| The byte format is 8 bits, with 256 combinations
possible.
Message Payload| 0-7 bytes| Each message type has between 0 and 8 bytes of
payload data specific to the sensor. Refer to the following table for payload
information.
Message| Payload| Description
---|---|---
0x00| 5-byte reset code| The device has reset. The reset cause is represented
in the 5-byte reset code payload.
0x01| >3 (9)| Daily supervisory message (1-2 per day). The 3-byte payload
contains the current sensor status. Refer to Supervisory Message 0x01 for
payload details.
0x02| 1-byte event| A tamper event has occurred. Refer to Tamper Message 0x02
for details.
—| Sensor event| Sensor events are defined in the Sensor Specific Messages
chapter.
Message | Payload | Description |
---|---|---|
0xfb | Link quality | Sent after each downlink configuration (refer to Link |
Quality Message) or to periodically ping the network server (refer to Link
Quality Check Period).
0xfe| —| Reserved.
0xff| 1-byte status| Downlink message ACK. Refer to Downlink ACK for more
details.
Bytes| Description
---|---
0| Sensor type code, a product identifier sent as part of the reset message.
Door/Window 0x01 Door/Window High Security 0x02 Contact 0x03
Temperature No-Probe 0x04 Temperature External Probe 0x05 Single Push Button 0x06
Dual Push Button 0x07
Acceleration-Based 0x08 Movement
Tilt 0x09
Water 0x0a
Tank Level Float 0x0b
Glass Break 0x0c
Ambient Light 0x0d Air Temperature and Humidity 0x0e High-Precision Tilt 0x0f
Ultrasonic Level 0x10
4-20mA Loop 0x11
Air Temp and Humidity – 0x12 External Probe
Thermocouple 0x13
Voltmeter 0x14
Custom (for customized 0x15 sensors)
GPS 0x16
Honeywell 5800 Bridge 0x17
Magnetometer 0x18
Internal Temp Sensor 0x19
Compass Sensor 0x1A
Weather Station Bridge 0x1B
Vibration Sensor High 0x1C-
Bandwidth 0x20
1| Hardware version.
Bytes| Description
---|---
2-3| Firmware version.
4-5| Reset code. Used for factory diagnostics.
Reset Message 0x00
Every time a sensor resets it sends a reset message to the cloud. The reset
message payload is defined in the following table.
Firmware Version
The 16-bit firmware version is constructed from reset payload Bytes 2-3, where
Byte 2 is the most significant. Beginning with version 2.0, the format is as
shown in the following table. The original format is compatible by redefining
the reserved most significant bit (Bit 15).
Byte | Description |
---|---|
15 | Format (bit == 0) |
14:8 | Major number (7 bits) |
7:0 | Minor number (8 bits) |
15 | Format (bit == 1) |
14:10 | Major number (5 bits) |
9:5 | Minor number (5 bits) |
4:0 | Build number (5 bits) |
16-Bit Firmware Version Examples
0x0103 is decoded as Firmware Version 1.3
0x8823 is decoded as Firmware Version 2.1.3
Supervisory Message 0x01
Wireless sensors periodically send a supervisory message so the backend system
can verify the device is still alive and report error conditions. The
supervisory message payload includes the current sensor status. You can also
trigger a supervisory message. To do this: Place a magnet near the triangular
notch on the side of the sensor. The following table shows the supervisory
message payload:
Bytes | Description |
---|---|
0 | Supervisory error codes are as follows: |
--- | --- |
7:5 | Not used. |
4 | Tamper detected since the last reset. |
3 | Current tamper state. |
2 | Error with the last downlink. |
1 | Battery low (under 2.8v). |
0 | Radio communication error, communication with the integrated radio failed |
and the device was reset.
1| Current sensor state, 1-byte. This is device-specific, refer Sensor
Specific Messages chapter for details. For other devices, use the periodic
reporting feature.
2| The battery level is a two-digit battery voltage. For example, if the
battery voltage is 2.9V, byte 2 would be 0x29.
3-6| Extended sensor state, 4 bytes. Allows sensors with higher precision or
multiple values to report during a supervisory event. For other devices, use
the periodic reporting feature.
7-8| Event accumulation count is the number of sensor events since the last
supervisory message. To improve battery life, can be used with the Disable
all sensor events setting so only an event total is reported during a
supervisory message, individual events are not reported as they occur. This
feature is available in firmware v2.0 and beyond.
Tamper Message 0x02
A sensor sends a message when the tamper switch has been opened or closed
through either an enclosure tamper or a wall-mount tamper. The tamper message
contains a 1-byte payload as shown in the following table.
Payload | Description |
---|---|
0x00 | The tamper switch opened. |
0x01 | The tamper switch is closed. |
Link Quality Message 0xfb
The link quality message provides a signal strength and a signal-to-noise
measurement at the device itself. The link quality message payload is shown in
the following table.
Bytes | Description |
---|---|
0 | Current Sub-Band, sub-band currently joined and used for communication to |
the gateway and network server. The value ranges from 1-8 for US915. For other
regions, the value depends on available channels.
1| RSSI of last DOWNLINK received, signed integer format values in bytes 1 and
2 in two’s complement format.
2| SNR of last DOWNLINK received, signed integer format values in bytes 1 and
2 in two’s complement format.
Downlink Messages
Downlink messages are from the cloud to the sensor and are used to configure
the sensor. The sensor initiates downlink messages, since the sensor is
typically sleeping with the radio turned off. For LoRaWAN devices, a downlink
can be received after any uplink within the receive window. The following
messages can be sent back to the sensor upon a downlink request.
Command | Payload | Description |
---|---|---|
0x00 | Not used | Not used |
0x01 | 4 bytes | General configuration |
— | 0-7 bytes | Sensor configuration, refer to the Sensor Specific Messages |
chapter
0xfc| 3 bytes| Advanced configuration
General Configuration
Use the general configuration command to configure parameters that apply to
all sensor types.
Byte | Description |
---|---|
0x00 | Disable sensor events |
0x01 | Radio config |
0x02 | Supervisory period. Default 19 hours. |
0x03 | Sampling rate |
Disable Sensor Events
The following table shows the disable sensor event bit definitions.
Bit | Description |
---|---|
7:1 | Not used |
0 | Disable all sensor events |
Radio Config
The following table shows the radio config byte definition.
Note: Available in firmware version 1.4 or newer.
Important: The duty cycle bit must be set for production deployments in
the EU868 band.
Bits | Description |
---|---|
7 | Not used (reserved) |
6 | Enable duty cycle requirement. LoRaWAN EU868 only. To enforce the EU868 |
band duty cycle requirements, enable them before production deployment. The default is disabled. Available in firmware
2.2.1 or later.
5:2| Uplink retries. LoRaWAN only. The range for uplink retries is 1-8 for
confirmed messages (ACK required) and does not apply to unconfirmed messages.
Default 0 (leave unchanged). Available in firmware v1.4 and above.
1| Use unconfirmed messages. LoRaWAN only. If set to use the unconfirmed
messages bit, the sensor does not look for an ACK from the network server. The
default is 1 (unconfirmed messages, no ACK required). EU sensors can’t use
confirmed messages, setting this bit to 0 on an EU device causes an error.
Available in firmware v1.4 and above.
0| Disable Adaptive Data Rate (ADR). LoRaWAN only. To enable ADR, set to 0.
To disable ADR, set it to
1. Default is 0 (enabled). Available in firmware v1.3 and above.
Supervisory Period
The general configuration command’s supervisory period controls the time
between supervisory messages as defined in the following table.
Bit 7 | Bits 6:0 |
---|---|
0 | Period defined in hours (1-127 hours). Available in firmware v1.3 and |
above.
1| Period defined in minutes (1-127 minutes) Available in firmware v1.3 and
above.
For example, to receive a report every 4 hours, set Byte 1 to 0x04. To receive a periodic report every 15 minutes, set Byte 1 to 0x8f.
Sampling Rate
The sampling rate controls the frequency at which devices wake from low-power
sleep mode to check the sensor state. Some sensors require very little power
to check the state and need to react quickly. Other sensors can be sampled at
a lower rate, such as 30-second or 30-minute intervals. Increasing the time
between samples increases battery life. Refer to the Battery Estimator on the
Radio Bridge site for battery life estimates relative to sampling rate:
https://radiobridge.com/documents/Sensor%20Battery%20Estimator.xlsx A value
of 0 in this field leaves the sampling rate at the current value. Use the
following table to determine the sampling rate if the value is not zero.
Note: The sampling period only applies to sensors that take measurements
like temperature and tilt, it does not apply to sensors with binary inputs
such as door/window sensors or push buttons. This feature is available in
firmware v2.0 and above.
Bit 7:6 | Bits 5:0 |
---|---|
00 | Sampling period is defined in increments of 250ms (0.25-15 seconds). |
01 | Sampling period is defined in increments of seconds (1-63 seconds). |
10 | Sampling period is defined in increments of minutes (1-63 minutes). |
11 | Sampling period is defined in increments of hours (1-63 hours). |
Advanced Configuration
Use this command for advanced configuration parameters that apply to all
sensor types. The advanced configuration command is defined in the following
table.
Byte | Description |
---|---|
0x01 | Port number (LoRaWAN only) |
0x02 | Link quality check period (LoRaWAN only) |
Port Number
For LoRAWAN devices only. Byte 0x01 of the advanced configuration command
changes the uplink port per theLoRaWAN protocol. The default port is 2, and a
value of 0 in this field means to leave it at the default. This feature is
available in firmware v1.4 and above.
Bit 7 | Bits 6:0 |
---|---|
0 | Period defined in hours (1-127 hours). |
1 | Period defined in minutes (60-127 minutes) |
Link Quality Check Period
For LoRaWAN devices only. Setting this register causes the device to ping the
network server periodically with a requested ack. Typically used with
unconfirmed messages, this feature creates a periodic confirmed message and
looks for the ACK to ensure the device is still connected. The following table
shows this byte’s encoded bit definitions. Available in firmware v2.0 and
above.
Downlink ACK
The cloud app uses this downlink ACK message to verify the that sensor
received the downlink message received and that it was considered valid. The
sensor replies to the downlink data with a 0xFF message (downlink ACK) with
the payload shown in the following table.
Command | Payload |
---|---|
0x00 | Not used |
0x01 | The message was invalid or undefined |
0x02 | Message was valid |
Part Ordering Information
Part Number | Rating | Wireless | Region |
---|---|---|---|
RBS301-TEMP-INT-US | Indoor | LoRaWAN | US/CAN |
RBS301-TEMP-EXT-US | Indoor | LoRaWAN | US/CAN |
RBS301-WAT-US | Indoor | LoRaWAN | US/CAN |
RBS301-WR1M-US | Indoor | LoRaWAN | US/CAN |
RBS301-WR10M-US | Indoor | LoRaWAN | US/CAN |
RBS301-CON-US | Indoor | LoRaWAN | US/CAN |
RBS301-DWS-US | Indoor | LoRaWAN | US/CAN |
RBS301-ABM-US | Indoor | LoRaWAN | US/CAN |
RBS301-TILT-US | Indoor | LoRaWAN | US/CAN |
References
- Radio Bridge Console
- Radio Bridge Console
- Radio Bridge Console
- radiobridge.com/documents/Sensor%20Battery%20Estimator.xlsx
- support.radiobridge.com
- support.radiobridge.com/
- Privacy Policy