RBM101 U ADIO RIDGE UIDE ABLE OF ONTENTS RADIO BRIDGE RBM101 USER GUIDE ..................4 1.1. About this Guide ........................4 1.2. Revision History .........................4 1.3. Document Conventions ......................4 1.4. Part Numbering ..........................5 THE SUBGIG™ STANDARD ......................5 TECHNICAL SPECIFICATIONS ..................... 5 3.1.
Page 3
RBM101 U ADIO RIDGE UIDE 4.3.1.13 BO – Broadcast ID Only ....................13 4.3.1.14 LI – List IDs ........................13 4.3.1.15 RI – Remove ID ....................... 14 4.3.1.16 CE – Coordinator enable ....................14 4.3.1.17 SM – Sleep mode ......................14 4.3.1.18 LW –...
Page 4
RBM101 U ADIO RIDGE UIDE 6.2.2. Supervisory Messages Occurrence ..................27 6.3. Security and Encryption ......................27 6.3.1. Session Key ..........................27 6.3.2. Provisioning Key ........................27 6.3.3. Encryption Requirements ....................... 27 6.3.4. Using session keys directly with no key broadcast ..............28 6.3.5.
1.1. About this Guide The BridgeBee modules designed and manufactured by Radio Bridge provide wireless connectivity for Internet of Things (IoT) applications. The RBM101 BridgeBee module described in this document is an implementation of the SubGig standard, and can not only achieve thousands of feet of range but also penetrate buildings and other structures much better than higher frequency ISM bands.
Although the SubGig™ protocol is designed to be very simple and easy to use, much of the protocol is abstracted in and hidden in the RBM101 for ease of use. For more information, please see the published SubGig™ specification.
Indoor / urban environment range Outdoor / line of site range Transmit power RF data rate 38,400 bps Receiver sensitivity 3.2. General Specifications The following table provides the general specifications for the RBM101. Table 3 General Specifications Specification Value Operating Frequency 315MHz Channels...
RBM101 U ADIO RIDGE UIDE 3.4. Pin Signals The following table shows the pin assignments for the RBM101. Table 5 Pin Assignments Name Direction Function Power supply UART_TX UART data out UART_RX UART data in Broadcast_ID Broadcast the device ID when held low...
4. S ERIAL OMMANDS The Radio Bridge modules utilize the UART serial port for communicating payload data between modules and for configuration of the modules themselves. The serial port runs with these default settings. Table 6 Serial Command Default Settings...
RBM101 U ADIO RIDGE UIDE 4.2. Messages from the Module The messages from the device do not have an “AT” prefix but have the following structure: Table 8 Module Messages Structure Message Type Space 0x20 Message Carriage Return 0x0D 3 bytes...
RBM101 U ADIO RIDGE UIDE Some status messages have an associated Device ID, and if this is the case then the status code would be followed by the Device ID. For example the status message for a sleepy supervisory message for Device ID 12345678 would be: STA 0001 12345678 Note that status messages do not include errors.
RBM101 U ADIO RIDGE UIDE When this command is sent to the coordinator, the first eight ASCII characters contain the 32- bit Device ID of the endpoint it is sending the payload to, and the next 8 bytes are the 64-bit payload.
XMODEM protocol. From the bootloader there will be a menu option to run the new firmware image and jump back to normal program execution. It is recommended to use the Radio Bridge configuration app for firmware updates. 4.3.1.9 BT – Bootloader Timeout This command changes the time that the bootloader waits for the <DEL>...
RBM101 U ADIO RIDGE UIDE This command causes the coordinator to listen for 8 seconds and then timeout with an error message if no new Device IDs are received. If any new commands are sent during the 8 second window they will be rejected with an error message. The coordinator will only respond to the first endpoint that it hears.
RBM101 U ADIO RIDGE UIDE CMD 12345678 CMD 24681012 CMD OK If the device is not configured as a coordinator, then the module will return an error. 4.3.1.15 RI – Remove ID Command to coordinator to remove an endpoint. Argument is an ASCII-coded 32-bit Device ID.
RBM101 U ADIO RIDGE UIDE Range: 0000 to FFFF Note that larger values for the listen window gives the coordinator more time to respond but at the expense of power consumption at the endpoint 4.3.1.19 QP - Queue Packet This command is similar to the Send Packet (SP) command except it queues the packet to be sent to a sleepy endpoint during the Listen Window.
RBM101 U ADIO RIDGE UIDE “0”: Encryption off “1”: Encryption on Default is encryption off. Note that the Session Key must be set prior to turning encryption on with this command. If an endpoint receives the session key that was broadcast by the coordinator, encryption will be automatically enabled.
RBM101 U ADIO RIDGE UIDE 4.3.1.24 KU – Send Upper Half of Session Key Send the upper half of the session key encrypted by the provisioning key. Note that both the session key and provisioning key must be set prior to this command. This command is only valid for coordinator devices and the parameter with this command is the 32-bit ASCII coded Device ID of the target endpoint.
The return value is in the form of a four digit ASCII-coded hex value. 4.3.1.32 RD – Device type This command returns the device type of the module. The return value for the RBM101 is the ASCII string “RBM101” 4.3.1.33 PL –...
RBM101 U ADIO RIDGE UIDE 4.3.1.34 RP – Reduce Power Level Set the radio transmit power to a reduced level based on governor requirements. The parameter value can be one of the following: “0”: Reduced power mode off “1”: Reduced power mode on Default is off.
RBM101 U ADIO RIDGE UIDE 4.3.1.38 BR – Baud Rate This command will change the baud rate of the main serial UART. The parameter is a single ASCII coded hex character according to the following table. Table 9 Baud Rate...
RBM101 U ADIO RIDGE UIDE 5. M ESSAGES 5.1. Status Messages This section defines status messages that are sent from the module back to the host over the serial port. Note that status messages do not include errors. Error messages are defined...
Page 23
RBM101 U ADIO RIDGE UIDE 0001 Bad packet Received a packet over the radio that cannot be understood or interpreted properly. May indicate a device is not compliant with the SubGig standard 0002 Out of sequence Received a packet over the radio that was out of sequence.
Page 24
RBM101 U ADIO RIDGE UIDE 000f Packet already in Host is attempting to queue a new packet but there is queue already a packet in the queue. 0010 Session key not set An attempt to enable an encryption function failed...
Page 25
RBM101 U ADIO RIDGE UIDE 001f Write to flash failed An attempted write to flash failed 0020 Radio receive The configuration of the radio receiver failed config failed 0021 Radio transmit data Loading data into the transmit buffer on the radio failed...
RBM101 U ADIO RIDGE UIDE 6. C ONFIGURATION 6.1. Sleep Mode Configuration Devices can be configured to enter sleep mode during periods of inactivity. If the endpoint sleeps then it is called a “sleepy” endpoint. 6.1.1. Waking up from Sleepy Endpoint...
RBM101 U ADIO RIDGE UIDE 6.1.2. Using Pins to Control Sleep Mode The following table defines the pins that are used to control sleep mode. Table 12 Pins used to control sleep mode Description SLEEP_RQ Sleep request input active high. Pull this pin low to take the device out of sleep mode and high to request it to enter sleep mode.
RBM101 U ADIO RIDGE UIDE the supervisory message will be sent automatically back to the coordinator on this periodic interval. When the timeout is set on a coordinator, this indicates the interval in which it expects a supervisory to have arrived from all endpoints. The timers used for supervisory messages are low power RC timers which have significant drift, and thus the coordinator period must be set at a longer period than the endpoints.
RBM101 U ADIO RIDGE UIDE If the session key is programmed directly through AT commands, the encryption enable command must be used to enable encryption on all devices. From there packets can be sent between coordinator and endpoints as normal with no further consideration of the encryption keys.
RBM101 U ADIO RIDGE UIDE In other words, the sequence number creates a unique encrypted packet even when the underlying command is the same. If an encrypted packet is repeated identically, the sequence number would be out of order and a corresponding error message is sent to the host. The out of sequence error can occur at either an endpoint or coordinator.
RBM101 U ADIO RIDGE UIDE 6.4.2.4 Sequence Number Sequence Number: The SubGig sequence number (see the SubGig spec for more detail). This is represented as a 24-bit ASCII-coded hex number. 6.4.2.5 Encryption Encryption: “N” for unencrypted or “Y” for encrypted 6.4.2.6 Command...
Page 32
“Bootloader”. If these pads are shorted together during reset, the bootloader will enter automatically. The firmware images provided by Radio Bridge are signed and encrypted meaning that they cannot be loaded on other hardware, and no other firmware images can be loaded on the module through the bootloader.
5 seconds, however similar to the 2 second total transmission time for periodic signals, this is not possible to violate with the RBM101. To illustrate the difference between periodic and event based messages, consider a simple system that measures temperature.
Page 34
The governor will automatically reset and resume normal operation when a new message is sent outside of the periodic time interval. Example 1: If the RBM101 receives a request to transmit 20 messages each spaced by exactly 5 seconds, the first 10 messages would be allowed to transmit and messages 11-20 would be rejected.