Radio Bridge RBM101, User Manual

Page 1: ...Radio Bridge RBM101 User Guide VERSION 0 1 APRIL 2017 ...

Page 2: ...4 SERIAL COMMANDS 8 4 1 Commands to the Module 8 4 2 Messages from the Module 9 4 2 1 CMD Command Response 9 4 2 2 ERR Error Message 9 4 2 3 STA Status Message 9 4 2 4 SNF Sniffer 10 4 2 5 APP Application Payload 10 4 3 AT Command Reference 10 4 3 1 AT Commands 10 4 3 1 1 SP Send Packet 10 4 3 1 2 EP Emergency Packet 11 4 3 1 3 WR Write Configuration 11 4 3 1 4 RE Restore Parameters 11 4 3 1 5 FR ...

Page 3: ... 4 3 1 27 VR Firmware version 17 4 3 1 28 HR Hardware version 17 4 3 1 29 DB RSSI of last packet 18 4 3 1 30 EA Number of ack failures 18 4 3 1 31 OS Number of out of sequence packets 18 4 3 1 32 RD Device type 18 4 3 1 33 PL Power Level 18 4 3 1 34 RP Reduce Power Level 19 4 3 1 35 TC Test carrier 19 4 3 1 36 TP Test packets 19 4 3 1 37 SN Sniffer Mode 19 4 3 1 38 BR Baud Rate 20 4 3 1 39 DF Dupl...

Page 4: ...ld 28 6 3 6 Sequence Number in Packets 28 6 4 Sniffer Mode 29 6 4 1 Setting Device to Sniffer Mode 29 6 4 2 SNF Fields 29 6 4 2 1 Time Stamp 29 6 4 2 2 Device Type 29 6 4 2 3 Device ID 29 6 4 2 4 Sequence Number 30 6 4 2 5 Encryption 30 6 4 2 6 Command 30 6 4 2 7 Payload 30 6 5 Bootloader 30 6 5 1 Using Terminal Emulators 30 7 FCC LIMITATIONS 32 7 1 1 FCC Part 15 231 32 7 1 2 Governor 32 8 MECHANI...

Page 5: ...idgeBee 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 This document provides guidelines for configuring and using the RBM101 module 1 2 Revision History Revision Date Description 1 0 May 2017 Initial release of the documen...

Page 6: ...M bands while consuming minimal power The tradeoff in loss of available bandwidth is acceptable for most sensing and control applications since most IoT devices have very low data rates The Federal Communications Commission FCC in the United States allows for basic monitoring and control at these low frequency bands as long as a number of limitations are maintained The SubGig protocol is designed ...

Page 7: ...ations The following table provides the general specifications for the RBM101 Table 3 General Specifications Specification Value Operating Frequency 315MHz Channels 1 channel 0 Operating temp 40 to 85 C Antenna options SMA u FL 3 3 Power Requirements The following table provides the power requirements for the RBM101 Table 4 Power Requirements Specification Value Supply voltage 2 7 3 6V Transmit cu...

Page 8: ...RX In UART data in 4 Broadcast_ID In Broadcast the device ID when held low 5 nReset In Device is reset when held low 6 D0 Both Future use 7 N C Not connected 8 N C Not connected 9 Sleep_Request In Sleep mode is requested when held low 10 GND Ground 11 D1 Both Future use 12 D2 Both Future use 13 nSleep Out Low when device is in sleep mode 14 N C Not connected 15 D3 Both Future use 16 D4 Both Future...

Page 9: ...e AT Commands section All values through the serial command interface are coded as ASCII characters In other words the hex value 0x12 would be coded as the ASCII string 12 which allows for convenient control through a terminal emulator Host processors communicating to the module through a UART must convert values to ASCII coded values 4 1 Commands to the Module Every command to the module starts w...

Page 10: ... would expect the response CMD OK If the AT command is requesting the firmware version which happens to be v1 01 the response would be CMD 0101 4 2 2 ERR Error Message This is an error message from the module that sends a 4 digit error code as ASCII coded hex characters For instance error code 0x0000 would be represented by ERR 0000 Some error messages have an associated Device ID and if this is t...

Page 11: ...inator and receiving data from an endpoint then the first 32 bits 8 ASCII coded hex characters of this message will be the Device ID of the data source 4 3 AT Command Reference This section defines the serial AT commands that can be sent to the module 4 3 1 AT Commands All AT commands begin with an ASCII AT followed by a two ASCII character command and followed by optional parameters depending on ...

Page 12: ...rnor is engaged the normal Send Packet command will return an error and will not transmit However even when the governor is engaged the emergency packet will still transmit The EP AT command should only be used for conditions regarding physical safety such as intruder alarms fire alarms personal emergency response systems etc See the section Governor for more detail 4 3 1 3 WR Write Configuration ...

Page 13: ...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 character prior to booting the application The parameter is a 4 digit ASCII coded hex value and is in units of milliseconds Default 0BB8 for 3 seconds Range 0000 to 0BB8 If the range is set to 0 the bootloader w...

Page 14: ...its Device ID so it can be read by a coordinator This command should come after a discover endpoint DE command at the coordinator and used to associate the endpoint with the coordinator Taking the BID pin of the module low will create the same broadcast as this command This is often connected to a push button for endpoints that do not have a host processor to issue AT commands at endpoints If the ...

Page 15: ...ator Default is endpoint If the command is sent without an argument then the current value is returned 4 3 1 17 SM Sleep mode Sets the sleep mode for the device This command is applicable for endpoints only and is not applicable to coordinator devices The parameter value can be one of the following 0 Endpoint is always on 1 Endpoint sleeps Default is always on See the section on Sleep Modes for mo...

Page 16: ...indicate it is still alive and functional When an endpoint is in sleep mode it will wake up temporarily to send the supervisory message and then re enter sleep mode automatically This period should be as infrequent as possible and typically on the order of one hour When the device is configured as an endpoint this setting indicates the period at which it sends the supervisor message to the coordin...

Page 17: ...he 128 bit key is 0x12345678901234567890123456789012 then the parameter would be the ASCII string 12345678901234567890123456789012 4 3 1 23 SK Session Key Sets the encryption key that is used to encrypt the payload for normal operation This key can be set either through AT commands or in the field by use of the Broadcast Key command If the session key is broadcast in the field it is encrypted with...

Page 18: ...d along with KU upper half of session key and encryption is automatically enabled on the endpoint when both halves of the key arrive 4 3 1 26 SV SubGig stack version This command will return two ASCII coded hex bytes representing the SubGig stack version where the first two digits represent the major version and the last two digits represent the minor version For example version 1 2 would be repre...

Page 19: ...t of sequence packets This command returns the number of out of sequence packets that have been received since last reset 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 Power Level Set the radio transmit power level The parameter i...

Page 20: ...nstant carrier signal at the center frequency of the module The parameter value can be one of the following 0 Test carrier disabled 1 Test carrier enabled Test carrier is disabled by default 4 3 1 36 TP Test packets This command will cause the module to enter a debug mode where it transmits constant packets over RF The parameter value can be one of the following 0 Test packets disabled 1 Test pack...

Page 21: ...mediately update to the new baud rate If the setting is unsuccessful an error message will be returned at the original baud rate the and the baud rate will remain unchanged 4 3 1 39 DF Duplicate Filter Sets the window of time to filter duplicate packets If an identical packet arrives within the window defined by this parameter it is discarded and not reported to the host The parameter is a 16 bit ...

Page 22: ...defined by the Listen Window to send messages to the endpoint before it re enters sleep mode 0002 Queued message sent to sleepy endpoint The message we queued for the sleepy endpoint has been sent in the listen window 0003 Supervisory now current Coordinator received a supervisory message from an endpoint that was not previously reporting 5 2 Error Messages This section defines the error messages ...

Page 23: ... Command invalid for endpoints A command was sent to an endpoint that is invalid for endpoints 0007 Add endpoint failed The host attempted to add an endpoint but the process failed Likely due to maximum endpoints exceeded 0008 Remove endpoint failed The host attempted to remove an endpoint but the process failed Likely due to endpoint not in the list 0009 Not ASCII coded hex The values provided we...

Page 24: ...has increased since the last supervisory message 0015 Reported out of sequence packets increased The number of out of sequence packets reported by an endpoint through a supervisory message has increased since the last supervisory message 0016 Unexpected ack received Device received an ack but was not waiting for one 0017 Radio init failed Initialization of the radio failed 0018 Radio receive overf...

Page 25: ... failed Starting the transmit operation on the radio failed 0023 Serial transmit overflow The serial port had a transmit overflow condition and thus data has likely been lost from the module back to the host 0024 Bootloader failed The initialization of the bootloader has failed and bootloader cannot run 0025 Invalid baud rate The baud rate setting is invalid baud rate is unchanged 0026 Duplicate b...

Page 26: ...eep and once the command has been sent the pin can be released high The SLEEP_RQ pin has a pull up resistor and can be controlled with an open drain type output from the host When the SLEEP_RQ input pin is high the module will finish its current transaction prior to re entering sleep mode 6 1 1 2 Supervisory Message time expires The SubGig specification requires a periodic supervisory message to b...

Page 27: ...or see the Supervisor section and stays awake for a small period of time to receive any pending messages that the coordinator needs to send to it This window of time is defined by the LW Listen Window AT command and is set on the endpoint Thus when a coordinator detects that an endpoint is sleepy it will send a status message back to the host to indicate that it has received a supervisory message ...

Page 28: ...eeded basis to indicate that an endpoint has not reported within the last window if an endpoint has started reporting again after a period of not reporting or if a supervisor message has arrived from a sleepy endpoint See the Error Messages and Status Messages sections for more detail The supervisory messages also signal a window of time that a coordinator can communicate back to a sleepy endpoint...

Page 29: ... field Summary of the process of broadcasting the session key in the field 1 AT command to coordinator to assign provisioning key 2 AT command to endpoint to assign provisioning key 3 AT command to coordinator to assign session key 4 AT commands to coordinator to send the upper and lower portions of the session key Since the payload is 64 bits and the AES encryption key is 128 bits this must be se...

Page 30: ...de Sniffer mode is entered using the ATSN command and until it is disabled all SubGig packets are displayed to the host over the serial port with the SNF prefix see the section Messages from the Module The format of the SNF output is as follows SNF time stamp device type device ID sequence number encryption command payload Each field is separated by one space hex 0x20 and the SNF line itself is te...

Page 31: ...s a bootloader to allow for firmware upgrades The configuration utility provides an easy to use interface for the bootloader and programming the module with new firmware images and is recommended above using any terminal emulators or manual methods of upgrading the image 6 5 1 Using Terminal Emulators When usage of the configuration utility is not possible the bootloader can also be used through a...

Page 32: ...urable through the BT Bootloader Timeout AT command The maximum wait time is 3 seconds default but the delay can be reduced to reduce the amount of time it takes to enter the main application If the bootloader timeout is set to zero the bootloader is skipped completely at reset and the main application is entered directly As a failsafe measure there are two pads on the top side of the module with ...

Page 33: ...wever 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 An event based system would send an alert if the temperature changed by a minimum value or exceeded some threshold which would initiate a transmission A pe...

Page 34: ...is no longer blocking messages Example 2 If the RBM101 receives a request to transmit 20 messages each spaced by exactly 30 seconds and the RP AT command has not been used to reduce the transmit power then messages 11 20 will be rejected Example 3 If the RBM101 receives a request to transmit 20 messages each spaced by exactly 30 seconds and the RP AT command is first used to reduce the transmit po...

Page 35: ...USER GUIDE COPYRIGHT 2017 RADIO BRIDGE INC RADIO BRIDGE RBM101 USER GUIDE PAGE 34 OF 35 Using these or any other type of workaround to the governor will invalidate the FCC certification for the RBM101 8 MECHANICAL DRAWINGS ...

Page 36: ...out warranty of any kind expressed or implied including but not limited to the implied warranties of fitness or merchantability for a particular purpose Radio Bridge 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 10 1 2 Warranty To view product warranty information go to the following website www radiobridge com 10 1...