PRO-FLEX SERIES TRANSCEIVER MODULES Host Protocol Guide Powered By Last updated Tuesday, June 30, 2009 The information in this document is subject to change without notice. Confirm the data is current by downloading the latest revision of this document from www.lsr.com.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Table of Contents 1 Introduction ..................................................................................................................... 4 1.1 1.2 1.3 1.4 2 Purpose & Scope ....................................................................................................................... 4 Audience ....................................................................................................................................
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 3.2.28 3.2.29 3.2.30 3.2.31 3.2.32 3.2.33 3.2.34 3.2.35 3.2.36 3.2.37 3.2.38 3.2.39 3.2.40 3.2.41 3.2.42 3.2.43 3.2.44 3.2.45 3.2.46 3.2.47 3.2.48 3.2.49 3.2.50 3.2.51 3.2.52 3.2.53 4 Send Simple RF Data Packet (Short Addressing) ........................................................................... 19 Received Simple RF Data Packet (Short Addressing).....................................................................
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 1 Introduction 1.1 Purpose & Scope The purpose of this document is to describe in detail the message protocol used to communicate between a Host Device and the RF Module microprocessor. 1.2 Audience This document is intended to be read by engineers and technical management. A general knowledge of common engineering practices is assumed. 1.3 Applicable Documents The reader should be familiar with the following documentation: 1.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 2 Host Protocol This document describes in detail the message protocol used to communicate between a Host Device and a Pro-FLEX RF Module microprocessor. 2.1 Host Serial Protocol Overview Header Payload Trailer Field Start Byte Length Type Data Checksum End Byte # Bytes 1 1 1 n 1 1 Figure 1 Host Protocol Message Format Field Name Start Byte Length Type Field Description The start byte is the first byte in a packet (0x01).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Module -> Host – (Respond with PAN ID – Type 0x82) < 0x01 0x0B 0x82 0x00 0x00 0x00 0x64 0x00 0xF2 0x04> The information in this document is subject to change without notice. Confirm the data is current by downloading the latest revision of this document from www.lsr.com.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 3 Host Protocol Message Definitions The information contained in this section is abbreviated and omits the header and trailer information which is common to all serial host messages. 3.1 Host Protocol Field Descriptions 3.1.1 Host to Module This field shows the message type for messages that get sent from the host device to the module, and are within the range of 0x01 through 0x7F.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description Figure 5 Message Length 3.1.5 Payload Field Length This column lists the length in bytes of each payload field. Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description Figure 6 Payload Field Length 3.1.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 3.2 Host to Module Host Protocol Message Definitions Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.1 Query Firmware Version 0x01 - - 0x81 5 X 12+n 1 Module Identifier Identifies this module as a ProFlex module (0x02). 1 Version Major Version major number. 1 Version Minor Version minor number. 1 Version Month Version month (1 - 12). 1 Version Day Version day (1 - 31).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 2 Short Transceiver Address Two byte transceiver short address (LSB to MSB). Valid short addresses are 0 - 65,520 and 65,535 (0x0000 – 0xFFF0 and 0xFFFF). When short address is set to 0xFFFF the long address is used instead of the short address. 8 Long Transceiver Address Eight byte transceiver long address (LSB to MSB).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description RF Channel The RF channel that the transceiver operates on (11-26). 11 = 2405 12 = 2410 13 = 2415 14 = 2420 15 = 2425 16 = 2430 17 = 2435 18 = 2440 19 = 2445 20 = 2450 21 = 2455 22 = 2460 23 = 2465 24 = 2470 25 = 2475 26 = 2480 3.2.6 Set RF Channel 0x06 - 6 1 - 0x86 5 - 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 1 Receive Filters Bitmask of the receive filtering. Bit 0: Allow Broadcast Address (0 = disable, 1 = enable) Bit 1: Allow Broadcast PAN ID (0 = disable, 1 = enable) Bit 2: Promiscuous Mode (0 = disable, 1 = enable) 1 Reserved 3.2.10 Set Receiver Configuration 0x0A - - X 0x8A 7 5 Reserved for future use. - 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name 2 PAN ID Description 3.2.14 Set Basic RF Settings 0x10 - - 0x90 39 5 Two byte PAN ID (LSB to MSB) of the network this transceiver should operate on. 2 Short Transceiver Address Two byte transceiver short address (LSB to MSB). Valid short addresses are 0 - 65,520 and 65,535 (0x0000 – 0xFFF0 and 0xFFFF).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.15 Query Basic RF Settings 0x11 - 5 2 - 0x91 39 PAN ID Two byte PAN ID (LSB to MSB) of the network this transceiver should operate on. 2 Short Transceiver Address Two byte transceiver short address (LSB to MSB). Valid short addresses are 0 - 65,520 and 65,535 (0x0000 – 0xFFF0 and 0xFFFF).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.17 Reset Request 0x13 - 5 - - 0x93 5 - 5 - 3.2.18 Query Supply Voltage 0x14 - - 0x94 X The supply voltage ADC reading (LSB to MSB). The supply voltage can be determined by the following formula: Supply Voltage = ((Supply ADC Reading x Voltage Reference ) / 204750).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Reserved Reserved for future use. Baud Rate Serial baud rate setting. 0 = 1,200, 1 = 2,400, 2 = 4,800, 3 = 9,600, 4 = 19,200, 5 = 38,400, 6 = 57,600, 7 = 115,200, 8 = 230,400, 9 = 460,800, 10 = 921,600. Description 3.2.21 Set Low Power Mode 0x17 - 6 1 - 0x97 5 - 3.2.22 Set Host Data Rate 0x18 - 6 1 - 0x98 5 - 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.24 Set Wakeup/Reset Settings 1 0x1C - Reset Setting Setting that determines behavior on a reset. When set to 0x00 the host is not alerted. When set to 0x01 a reset results in a “Wakeup/Reset” status alert message being sent to the host (see message type 0x9E). Wakeup Setting Setting that determines behavior on a wakeup from sleep.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 1 Test Mode Test Mode: 0 = Idle (transmit and receive not active) 1 = Receive 2 = Transmit Unmodulated 0 3 = Reserved 4 = Transmit Modulated 5 = Pseudo Random Binary Sequence (todo: validate if this is supported) 1 RF Channel The RF channel that the transceiver operates on while in test mode (11-26). 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.28 Send Simple RF Data Packet (Short Addressing) This message is used to send a RF packet to a destination transceiver using short addressing. It is assumed that the destination transceiver’s PAN ID is the same as the PAN ID of the source transceiver.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.30 Send Advanced RF Data Packet (Short Addressing) This message is used to send a RF packet to a destination transceiver using long addressing. In addition to the destination transceiver’s ID, it is required to designate the destination PAN ID. This allows for sending packets between PANs (intra PAN).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 2 Destination Transceiver Address Two byte destination transceiver address (LSB to MSB). This is the address of the transceiver the message is being sent to. This address should either be the source address of the transceiver that received it, or the broadcast address (0xFFFF).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name 8 Source Transceiver Address 1 Packet ID n n Data Bytes Description Eight byte source transceiver address (LSB to MSB). This is the address of the device that originated the message. Packet ID. Data bytes received over the RF link (n bytes). 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.35 Received Advanced RF Data Packet (Long Addressing) This message gets sent to the host when a RF packet is received from a transceiver using long addressing. In addition to the transceiver IDs, this message includes both the source and destination PAN IDs. This allows for receiving packets between PANs (intra PAN).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 1 Max Repeaters Maximum number of repeaters in the system (1-15). 1 Max Repeats Maximum number of repeats allowed (1-7). Note that maximum hop count is Max Repeats + 1. 1 Device Type Sets the device type as either a node (0x00), which does not repeat, or a repeater (0x01), which does repeat. 1 Timeslot 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.39 Received Simple Repeated RF Data Packet This message gets sent to the host when a RF packet is received from a transceiver using the repeating mechanism and short addressing. It is assumed that the source transceiver’s PAN ID is the same as the PAN ID of the destination transceiver.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.40 Send Advanced Repeated RF Data Packet This message is used to send a RF packet to a destination transceiver using the repeating mechanism and short addressing. In addition to the destination transceiver’s ID, it is required to designate the destination PAN ID. This allows for sending packets between PANs (intra PAN).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.41 Received Advanced Repeated RF Data Packet This message gets sent to the host when a RF packet is received from a transceiver using the repeating mechanism and short addressing. In addition to the transceiver IDs, this message includes both the source and destination PAN IDs. This allows for receiving packets between PANs (intra PAN).
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 0-7 Source Route LQI List List containing one byte Link Quality Indication (LQI) for the route back to the source from which the message originated. The length of this field is equal to the Repeat Count. n n Data Bytes Data bytes received over the RF link (n bytes). 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name 1 Source Address Mode 2 or 8 n Source Transceiver Address n Data Bytes Description 2 = short addressing 3 = long addressing This byte can be used to see how many bytes will follow in the Destination Transceiver Address. LSB to MSB If the Source Address Mode is short this field will contain two-bytes for the short address.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length n Payload Name Description Host Message Payload This is the host message payload for this specific message type. Example: Response to remote query statistics (msg type 0x95) would send back 16 bytes total consisting of four bytes each for packets sent, acks received, packets received, broadcast packets received. 3.2.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.47 Received Remote Command/Response with Long Addressing NA - - 0xB3 - 8 Source Transceiver Address Eight byte source transceiver address (LSB to MSB). This is the address of the device that originated the message. 1 Host Message Type This is the host message type of the remote command/response. Example: Query Version = 0x01.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 3.2.49 Set Packet Error Rate Test Receive Configuration 0x41 11 0xC1 5 2 Source Transceiver Address Two byte source transceiver address (LSB to MSB). This is the address of the transceiver that is sending the message. 2 Number of Packets to Receive LSB to MSB. Valid range is 5-65,535.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length 2 Payload Name Last Received Packet Number Description When in receive mode this indicates the number of the last packet received. Valid range is 0-65535, 0 = not yet received a packet. The purpose of this field is to indicate how far into the test we are, when in receive mode. This field should be ignored in transmit mode and will always return a zero.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description 1 Cancel Test This value if set to 1 will result in cancelling a test in progress, and if set to 0 will not affect the current state of the test. 1 Test Status 0 = Packet error rate test is not in progress. 1 = Packet error rate test is in progress 1 Test Mode 0 = Transmit mode. 1 = Receive mode.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE Host to Module Module to Host Allow Remote Message Length Payload Length Payload Name Description Channel Mask Two byte bitmask (LSB to MSB) of the RF channels to perform an energy scan on. The least significant bit corresponds to channel 11 and the most significant bit corresponds to channel 26. Energy Levels List List of energy levels that is one byte for each channel representing the RF energy level that was measured.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 4 Appendix A 4.1 RF Power Settings Setting Register Value RF Output Power Current Consumption 0x49 7 dBm 75 mA 0x79 12 dBm 85 mA 0x6C 16 dBm 100 mA 0xE0 18 dBm 115 mA 0xF9 20 dBm 145 mA 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 Table 4 RF Power Settings The register values in Table 4 RF Power Settings are provided for FCC purposes only.
PRO-FLEX SERIES TRANSCEIVER MODULES HOST PROTOCOL GUIDE 5 Contacting LS Research Headquarters LS Research, LLC W66 N220 Commerce Court Cedarburg, WI 53012-2636 USA Tel: 1(262) 375-4400 Fax: 1(262) 375-4248 Website www.lsr.com Technical Support support@lsr.com Sales Contact sales@lsr.com The information in this document is provided in connection with LS Research (hereafter referred to as “LSR”) products.
