Multitech Reveal User manual

RevealTM Water Sensor
User Guide

REVEAL WATER SENSOR
2 RevealTM Water Sensor User Guide
Reveal Water Sensor
Model: RBS301-WAT
Part Number: RB00009 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
Multi-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 in 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

CONTENTS
RevealTM Water Sensor User Guide 3
Contents
Chapter 1 – Product Overview ................................................................................................................................. 5
Sensor Overview ........................................................................................................................................................... 5
Part Number.................................................................................................................................................................. 5
Documentation ............................................................................................................................................................. 6
Chapter 2 – Preparing Sensor................................................................................................................................... 7
Preparing an RBS301 Sensor......................................................................................................................................... 7
Preparing an RBS306 Sensor......................................................................................................................................... 7
Quick Start..................................................................................................................................................................... 7
Installing Probe Water Sensors..................................................................................................................................... 8
Installing Rope Water Sensors ...................................................................................................................................... 9
Chapter 3 – Hardware Specifications and Information ........................................................................................... 10
Absolute Maximum Ratings ........................................................................................................................................ 10
Battery Life.................................................................................................................................................................. 10
Replacing the Battery.................................................................................................................................................. 10
Mechanical Drawings .................................................................................................................................................. 12
Indoor RBSx01 Sensors ............................................................................................................................................. 12
Armored Outdoor/Industrial RBSx06 Sensors .......................................................................................................... 13
Chapter 4 – Common Messages ............................................................................................................................. 14
Message Protocol........................................................................................................................................................ 14
Common Messages ..................................................................................................................................................... 14
Message Protocol........................................................................................................................................................ 14
Uplink Messages ......................................................................................................................................................... 14
Reset Message 0x00.................................................................................................................................................. 15
Supervisory Message 0x01........................................................................................................................................ 17
Tamper Message 0x02 .............................................................................................................................................. 17
Link Quality Message 0xfb ........................................................................................................................................ 17
Downlink Messages..................................................................................................................................................... 18
General Configuration............................................................................................................................................... 18
Advanced Configuration............................................................................................................................................ 20
Downlink ACK.............................................................................................................................................................. 21
Chapter 5 – Sensor-Specific Messages.................................................................................................................... 22
Uplink Messages ......................................................................................................................................................... 22
Downlink Messages..................................................................................................................................................... 22
Chapter 6 – Regulatory Information....................................................................................................................... 23
Federal Communications Commission (FCC) .............................................................................................................. 23
Harmonized Commodity Description (HS Code)......................................................................................................... 23
Export Control Classification Number (ECCN)............................................................................................................. 23

CONTENTS
4 RevealTM Water Sensor User Guide
Index...................................................................................................................................................................... 24

PRODUCT OVERVIEW
RevealTM Water Sensor User Guide 5
Chapter 1 – Product Overview
Sensor Overview
The RevealTM Water Leak sensor uses a sensor probe to detect the presence of water or other liquids. When it
detects water or another liquid, it sends an alert over the wireless network.
Part Number
Part Number Rating Wireless Region
Water Probes
RBS301-WAT-US Indoor LoRaWAN North America, South
America
RBS301-WAT-EU Indoor LoRaWAN Europe
RBS301-WAT-AU Indoor LoRaWAN Australia, South America
RBS306-WAT-US Outdoor/Industrial LoRaWAN North America, South
America
RBS306-WAT-EU Outdoor/Industrial LoRaWAN Europe
Water Ropes – 1 meter length
RBS301-WR1M-US Indoor LoRa North America, South
America
RBS301-WR1M-EU Indoor LoRa Europe
RBS301-WR1M-AU Indoor LoRa Australia, South America
RBS306-WR1M-US Outdoor/Industrial LoRa North America, South
America
RBS306-WR1M-EU Outdoor/Industrial LoRa Europe
Water Ropes – 10 meter length
RBS301-WR10M-US Indoor LoRa North America, South
America
RBS301-WR10M-EU Indoor LoRa Europe
RBS301-WR10M-AU Indoor LoRa Australia, South America
RBS306-WR10M-US Outdoor/Industrial LoRa North America, South
America
RBS306-WR10M-EU Outdoor/Industrial LoRa Europe

PRODUCT OVERVIEW
6 RevealTM Water Sensor User Guide
Documentation
The following documentation is available at https://www.multitech.com/brands/reveal-wireless-liquid-sensors.
Document Description Part Number
User Guide This document provides overview, safety and regulatory
information, design considerations, schematics, and general
hardware information.
RB00009
Connection Guide This document provides instructions and information on how
to connect Radio Bridge LoRaWAN sensors on gateways and
networks.
RB00001

PREPARING SENSOR
RevealTM Water Sensor User Guide 7
Chapter 2 – Preparing Sensor
Preparing an RBS301 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:
1. Use a pen or similar object to press the button on the opposite side of the case.
2. Remove the battery tab. You may need to remove the battery to remove the tab.
3. Re-insert the battery and close the case.
Preparing an RBS306 Sensor
Sensors ship with batteries installed. There is a plastic tab over the battery, which needs to be removed. To
remove a tab that does not pull out easily:
Loosen screws to remove the battery tab. DO NOT REMOVE THE LID.
Hand-tighten the lid screws to seal the case against moisture. Do not overtighten the screws.
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
1. Create a Radio Bridge console account at: https://console.radiobridge.com/
2. Click on Devices on the left.
3. Click Add Device.
4. Select the network you want to use.
5. Specify if you want to Register Through Radio Bridge or use an existing account with the network.
6. Make sure Console Only Device is NOT selected.
7. Enter the Device Name,Device ID, and Device Key.

PREPARING SENSOR
8 RevealTM Water Sensor User Guide
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.
8. Select the model from the Device Type drop down. Model is on the device label.
9. Select the Join EUI and click Continue.
10. Review the summary and click Confirmation.
The console shows complete when the device is successfully added.
Installing Probe Water Sensors
Install the water sensor so the probe reaches an area where water leaks may occur, such as water heaters,
standing tanks, windows/doors, toilets, septic systems, condenser and refrigeration systems, floor drains, or water
control valves. The probe may be placed inside containers to detect water.
Note: The probe is designed for water detection. It is not rated for use with harsh chemicals, solvents, oils,
fuels, strong acids, or other caustic liquids.
1. Use the small adhesive pad attached to the probe to install it so the metal pins are flat on the floor. This
allows the pins to make contact with a puddle from a nearby leak and send an alert. Place the probe
where water from a leak would likely accumulate.
2. Use the included large adhesive pad to secure the case to the wall.
For increased security (optional), fasten the case to the wall using the included tamper screw as shown.
The tab will break away and send a tamper alert if the case is forcibly removed from the wall.
3. Assemble the case.
4. Coil any excess wire.
If needed for better positioning, run the wire along pipes or around obstacles.
For best radio performance, avoid placing the sensor in another enclosure or in an area
crowded with other equipment.
5. Secure the probe to the floor or wall using the small adhesive pad or with an appropriately sized screw in
any of the probe's wall or floor mounting holes.

PREPARING SENSOR
RevealTM Water Sensor User Guide 9
Installing Rope Water Sensors
Rope water sensors detect leaks along the length of the rope, it can be wrapped around a fixture or spread across
a room, dropped ceiling, or anywhere you need leak detection. Install the sensor so the rope reaches the area you
want to monitor for water leaks.
Note: When possible, install away from foot traffic and where heavy items will not be set on or rolled over the
rope.
1. Spread the rope into the area you want to monitor for leaks.
2. Attach the sensor to a wall:
For a indoor sensor, use the included large adhesive pad to secure the case to a wall. For
increased security (optional), fasten the case to the wall using the included tamper screw as
shown. The tab will break away and send a tamper alert if the case is forcibly removed from
the wall.
For an outdoor sensor, secure the sensor to a wall or floor with screws. Consult the
mechanical drawing for hole dimensions.
For best radio performance, avoid placing the sensor in another enclosure or in an area
crowded with other equipment.

HARDWARE SPECIFICATIONS AND INFORMATION
10 RevealTM Water Sensor User Guide
Chapter 3 – Hardware Specifications and Information
Absolute Maximum Ratings
Parameter Rating Units
Operating ambient temperature
(indoor version)
-30 to +70 °C
Operating ambient temperature
(outdoor version)
-40 to +70 °C
Storage ambient temperature -40 to +100 °C
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 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. Power required for a 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 gradual reduction in
voltage over time. Radio Bridge devices are shipped with lithium batteries, which are the recommended
replacement type.
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 shut down.
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
Replacement battery type is listed in the Battery Life topic. To replace the battery:
1. Use a pen or similar object to press the button on the opposite side of the case.

HARDWARE SPECIFICATIONS AND INFORMATION
RevealTM Water Sensor User Guide 11
2. Remove the battery.
3. Insert the new battery and close the case.

HARDWARE SPECIFICATIONS AND INFORMATION
12 RevealTM Water Sensor User Guide
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

HARDWARE SPECIFICATIONS AND INFORMATION
RevealTM Water Sensor User Guide 13
Armored Outdoor/Industrial RBSx06 Sensors

COMMON MESSAGES
14 RevealTM Water Sensor User Guide
Chapter 4 – Common Messages
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.
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 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 starting 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 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 Device has reset. The reset cause is represented in the 5-byte
reset code payload.

COMMON MESSAGES
RevealTM Water Sensor User Guide 15
Message Payload Description
0x01 >3 (9) Daily supervisory message (1-2 per day). The 3-byte payload
contains current sensor status. Refer to Supervisory Message
0x01for payload details.
0x02 1-byte event A tamper event has occurred. Refer to Tamper Message 0x02for
details.
-- Sensor event Sensor events are defined in the Sensor Specific Messages
chapter.
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 detail.
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.
Bytes Description
0 Sensor type code, a product identifier sent as part of the reset message.
Water 0x0a
1 Hardware version.
2-3 Firmware version.
4-5 Reset code. Used for factory diagnostics.
Firmware Version
The 16-bit firmware version is constructed from reset payload Bytes 2-3, where Byte 2 is the most significant byte.
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)

COMMON MESSAGES
16 RevealTM Water Sensor User Guide
16-Bit Firmware Version Examples
0x0103 is decoded as Firmware Version 1.3
0x8823 is decoded as Firmware Version 2.1.3

COMMON MESSAGES
RevealTM Water Sensor User Guide 17
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 include 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 as follows:
Bits Description
7:5 Not used.
4 Tamper detected since last reset.
3 Current tamper state.
2 Error with 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 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 Tamper switch opened.
0x01 Tamper switch 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.

COMMON MESSAGES
18 RevealTM Water Sensor User Guide
Bytes Description
0 Current Sub-Band, sub-band currently joined and used for communication to the gateway and
network server. Value ranges from 1-8 for US915. For other regions, 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

COMMON MESSAGES
RevealTM Water Sensor User Guide 19
Radio Config
The following table shows the radio config byte definition.
Note: Available in firmware version 1.4 or newer.
Bits Description
7 Not used (reserved)
6 Enable duty cycle requirement. LoRaWAN EU868 only. To enforce the EU868 band duty cycle
requirements, enable before production deployment. 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. 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 to
1. Default is 0 (enabled). Available in firmware v1.3 and above.
Important: The duty cycle bit must be set for production deployments in the EU868 band.
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
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 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: 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.

COMMON MESSAGES
20 RevealTM Water Sensor User Guide
Bit 7:6 Bits 5:0
00 Sampling period defined in increments of 250ms (0.25-15 seconds).
01 Sampling period defined in increments of seconds (1-63 seconds).
10 Sampling period defined in increments of minutes (1-63 minutes).
11 Sampling period 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 the
LoRaWAN 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.
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.
Bit 7 Bits 6:0
0 Period defined in hours (1-127 hours).
1 Period defined in minutes (60-127
minutes)