IndustrialPro™ and MobilityPro™ Gateway Wireless Modems BEP Reference Version 3.8.4 IndustrialPro™ and MobilityPro™ Gateway BEP Reference No part of this publication, or any software included with it, may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, including photocopying, electronic, mechanical, recording or otherwise, without the prior written permission of the copyright holder. Sixnet, LLC (Sixnet) provides this document as is, without warranty of any kind either expressed or implied including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Sixnet may make changes of improvements in the equipment, software, or specifications described in this document at any time and without notice. These changes may be incorporated in new releases of this document. This document may contain technical inaccuracies or typographical errors. Sixnet and its subsidiaries waive responsibility for any labor, materials, or costs incurred by any person or party as a result of using this document. Sixnet and any of its subsidiaries or other affiliates shall not be liable for any damages (including, but not limited to, consequential, indirect or incidental, special damages, or loss of profits or data) even if they were foreseeable and Sixnet has been informed of their potential occurrence arising out of or in connection with this document or its use. Computer Software Copyrights The Sixnet products described in this manual include copyrighted Sixnet computer programs stored in semi-conductor memories or other media. Laws in Canada, the United States and other countries preserve for Sixnet certain rights for copyrighted computer programs, including the exclusive right to copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrighted Sixnet computer programs contained in the Sixnet products described in this manual may not be copied without the express written permission of Sixnet. Furthermore, the purchase of Sixnet products shall not be deemed to grant either directly or by implication, estoppels, or otherwise, any license under the copyrights, patents or patent applications of Sixnet, except for the normal nonexclusive, royalty-free license to use that arises by operation of laws in the sale of a product. Sixnet, LLC 2425, 46th Avenue, Lachine, Quebec H8T 3C9, Canada Phone: +1 514-422-9110 Fax: +1 514-422-3338 Web: www.sixnet.com Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 2 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Change history Version Date 3.8.4 May 31, 2010 3.8.3 February 18, 2010 3.8.2 February 12, 2010 3.8.1 January 11, 2010 Description Add precisions for RF2 payload No change No change Change document format Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 3 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Table of content 1 Introduction....................................................................................................................................................... 6 1.1 Scope ..................................................................................................................................................................... 6 1.2 References ............................................................................................................................................................. 6 1.3 Modem Configuration ........................................................................................................................................... 6 2 BEP Specification................................................................................................................................................ 7 2.1 Message format..................................................................................................................................................... 7 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.2 2.2.1 2.2.2 2.3 2.4 2.4.1 2.4.2 2.5 2.5.1 2.5.2 2.5.3 2.5.4 2.5.5 2.5.6 2.5.7 2.5.8 IP Protocol.......................................................................................................................................................................... 7 Byte-ordering and sign....................................................................................................................................................... 7 Message framing................................................................................................................................................................ 7 Applications........................................................................................................................................................................ 8 Message exchanges ........................................................................................................................................................... 8 Management and Configuration Servers ........................................................................................................................... 9 Message structure ............................................................................................................................................... 10 BEP Message payload order............................................................................................................................................. 11 BEP ACK Message payload order ..................................................................................................................................... 11 Message Size........................................................................................................................................................ 11 Headers................................................................................................................................................................ 11 BEP Message header........................................................................................................................................................ 12 BEP ACK message header................................................................................................................................................. 14 Payloads............................................................................................................................................................... 16 Modem Information......................................................................................................................................................... 16 RF Information ................................................................................................................................................................. 18 I/O Information ................................................................................................................................................................ 20 GPS Information............................................................................................................................................................... 21 Odometer Information..................................................................................................................................................... 21 IP Information .................................................................................................................................................................. 22 Authentication Information ............................................................................................................................................. 22 Action ............................................................................................................................................................................... 23 Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 4 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Figures Figure 1 - BEP messages without framing............................................................................................................................... 8 Figure 2 - BEP messages with framing .................................................................................................................................... 8 Figure 3 - BEP messages Acknowledgment............................................................................................................................. 9 Figure 4 - BEP messages Acknowledgment with retransmission............................................................................................ 9 Figure 5 – BEP/BEP ACK messages exchanges for MOM/IMOM .......................................................................................... 10 Figure 6 - BEP Message Structure ......................................................................................................................................... 11 Tables Table 1 - BEP Field types ......................................................................................................................................................... 7 Table 2 - BEP header ............................................................................................................................................................. 12 Table 3 - BEP Payload mask 2................................................................................................................................................ 13 Table 4 - BEP ACK Header ..................................................................................................................................................... 14 Table 5 – MI1: Modem Information 1 payload..................................................................................................................... 16 Table 6 – MI2: Modem Information 2 payload..................................................................................................................... 16 Table 7 – Model ID ................................................................................................................................................................ 17 Table 8 – MI3: Modem Information 3 payload..................................................................................................................... 17 Table 9 – RF1: RF Information 1 payload .............................................................................................................................. 18 Table 10 – RF2: RF Information 2 payload ............................................................................................................................ 18 Table 11 – Service Type in use .............................................................................................................................................. 19 Table 11 – IO1: IO Information 1 payload............................................................................................................................. 20 Table 12 – GP1: GPS Information 1 payload ......................................................................................................................... 21 Table 13 – GO1: GPS Odometer Information 1 payload....................................................................................................... 21 Table 15 – IP1: IP Information 1 payload.............................................................................................................................. 22 Table 16 – AU1: Authentication Information 1 payload....................................................................................................... 22 Table 17 – AC1: Action 1 payload ......................................................................................................................................... 23 Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 5 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 1 Introduction 1.1 Scope This document describes the BlueTree Event Protocol (BEP) used by Sixnet1 IndustrialPro™ and MobilityPro™ Gateway Wireless modems as well as BlueTree legacy modems (BT-4000/BT-5000 Series). BEP is used by Sixnet Industrial Wireless modems to communicate information to a centralized server: • Modem information • Digital and Analog Input/Output • GPS data • RF Status • WAN IP address changes • Authentication In turn, BEP may be used by a centralized management server to communicate actions to be performed by a Sixnet Industrial Wireless modem. 1.2 References [AT] 1.3 AT Command Reference – Version 3.8.4. Modem Configuration The modem configuration allows defining: • the content of the BEP messages, • whether BEP messages are framed by synchronization sequences, • whether BEP messages sent by the modem shall be acknowledged by the server, • when BEP messages shall be sent by the modem, • the memory block size of stored events (AT+BSFMBS). Please refer to [AT] for details on how to configure event reporting on the modems and more especially to section 26 Event Handling. The following AT commands may be used to diagnose issues with the BEP feature: • AT+BEVLOG: Log BEP messages sent on each BEP destination as well as received BEP ACK messages. • AT+BSFMST: Store and Forward Memory status (number of free and used memory blocks as well as number of stored event per destination). • AT+BSFMRM: Erase the content of the Store and Forward Memory. 1 Formerly BlueTree Wireless Data Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 6 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2 BEP Specification 2.1 Message format 2.1.1 IP Protocol BEP messages can be exchanged using TCP/IP or UDP/IP (see [AT]). IP packet fragmentation may cause messages to arrive in several IP packets. Each IP packet may contain several BEP messages. 2.1.2 Byte-ordering and sign In the following tables, the information is given in the order it is transmitted (most significant byte/bit first) except that BEP uses little-endian byte ordering for binary data expressed as integers (INT for signed integer, UINT for unsigned integer) or floating point (float) values. Future versions of the protocol may support big-endian byte ordering. The BEP header contains an option flag indicating which encoding is being used in the message. Signed integers (8, 16 or 32-bit) use 2's complement encoding. The field types used in the BEP message are described in the following table: Table 1 - BEP Field types Size (bytes) 8 4 2 1 Size (bits) Type Description Unsigned integer Unsigned integer Unsigned integer Unsigned integer 1 4 4 variable UINT64 UINT32 UINT16 UINT8 UINT1 … UINT7 INT8 INT32 FLOAT32 STR variable STR0 1..7 2.1.3 Unsigned integer Signed integer coded in 2's complement Signed integer coded in 2's complement Floating point IEEEE 754 encoded Character string. Its length is given by a preceding length field. It may not be null terminated. The range of possible length is given in the Size column. Null terminated character string. An empty string has one null character. The length of payloads using STR0 type must account for the terminating null character. The range of possible length is given in the Size column. Message framing BEP messages may be framed by two sequences of two bytes each. When configured with message framing, the modem sends a start sequence of two bytes before each BEP message and a sequence of two bytes after each BEP message. The framing sequences are defined by the AT command +BSYNC (see [AT]). Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 7 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Figure 1 - BEP messages without framing Figure 2 - BEP messages with framing Note: • The framing also applies to messages sent by the server to the modems (BEP ACK); when the modem is configured with BEP message framing, it expects the BEP ACK messages to be framed by the start and end sequences. • There is no escape mechanism for the content of the BEP message to prevent the occurrence of the Start or End framing sequence in the message itself. • The sequences are sent in reverse order; the second byte is sent first and the first byte is sent last. For example with the configuration AT+BSYNCF="0xABCD","0x1234" will be sent in the following order on the network: CD AB <header> <payloads> 34 12. • 2.1.4 Message framing is not applied to messages exchanged between the modem and a management server (MOM) or configuration server (IMOM), no matter the modem +BSYNC configuration settings. Applications BEP messages contain an application ID that impacts message exchanges. The following application can be specified: • AVL (Automatic Vehicle Location). This application allows to report events (I/O, GPS, RF, …) to an application server. It may be used by fixed or mobile installations. • MOM (Mobile Originated Management). This application allows to report events and also to perform management actions on the modem (configuration changes, status report, firmware upgrade, …). A typical application is BlueVue Group. • IMOM (Initial Mobile Originated Management). This application allows to perform initial configuration of recently deployed modems. This application is not yet supported. 2.1.5 Message exchanges BEP messages are sent by Sixnet Industrial Wireless modems to one or several BEP enabled servers using either TCP/IP or UDP/IP. The occurrence, periodicity and content of the messages are defined by the modem configuration (see [AT]). Messages sent by the modems may require to be acknowledged by the server. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 8 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Figure 3 - BEP messages Acknowledgment When no acknowledgement is received by the modem after a configurable period of time, the modem resends the BEP message. Figure 4 - BEP messages Acknowledgment with retransmission When a destination is not reachable messages are stored in memory until they can be sent again (or until no more memory is available). Messages are stored into non-volatile memory during modem shutdown. When using TCP/IP, the firmware disconnects from the BEP report destination after 15 seconds of inactivity. This inactivity timeout is set to 15 minutes for Management Server (MOM) or Configuration Server (IMOM) applications. It will reconnect as soon as it has to send a new message. 2.1.6 Management and Configuration Servers For Management Server (MOM) or Configuration Server (IMOM) applications, the modem and the server exchange a series of BEP/BEP ACK messages. The series may last as long as required for the server to run a set of AT commands on the modem. The sequence is always initiated by the modem which, at the programmed interval, sends a BEP message to the server. The server replies by a BEP ACK whose content indicates whether an action (AT Command) needs to be performed by the modem. When an action needs to be performed by the modem, the BEP ACK message shall have its Acknowledgement field set and have the AC payload contain a non-null ID and an action specified. The modem performs the action and sends a response back to the server in a BEP message. When no more action needs to be performed by the modem, the server sends a BEP ACK message with the Acknowledgement field unset. The modem sends no response and will send a new BEP message at the next programmed frequency. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 9 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Modem Management Server BEP (MOM/IMOM, ACK Required, AC [ID=0, no action]) BEP ACK (MOM/IMOM, ACK Required, AC [ID1, AT Command 1]) Programmed BEP message frequency BEP (MOM/IMOM, ACK Required, AC [ID1, AT Response 1]) BEP ACK (MOM/IMOM, ACK Required, AC [ID2, AT Command 2]) BEP (MOM/IMOM, ACK Required, AC [ID2, AT Response 2]) ... BEP ACK (MOM/IMOM, ACK Required, AC [IDn, AT Command n]) BEP (MOM/IMOM, ACK Required, AC [IDn, AT Response n]) BEP ACK (MOM/IMOM, ACK Not Required) BEP (MOM/IMOM, ACK Required, AC [ID=0, no action]) ... Figure 5 – BEP/BEP ACK messages exchanges for MOM/IMOM 2.2 Message structure Each BEP message is composed of: • • A fixed header: o Modem ID (ESN/IMEI) o Message options (payload mask 1, acknowledgement required field, application ID and BEP version) o Message sequence number o Message length o Event ID o Payload mask 2 or, in the case of acknowledgement message, the sequence number of the message being acknowledged.. An optional sequence of payloads o Various information from the modem (RF status, GPS information, I/O information, …) Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 10 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Figure 6 - BEP Message Structure Note: • 2.2.1 Some payloads have their length field coded on one byte (payload size 1..255 bytes), others have their length field coded on two bytes (payload size 1..65535 bytes). BEP Message payload order Payloads follow the BEP message header in the following order: 1. Modem Info (MI) – as defined in Payload Mask 2 2. RF Info (RF) – as defined in Payload Mask 2 3. I/O Info (IO) – as defined in Payload Mask 2 4. GPS Info (GP) – as defined in Payload Mask 2 5. GPS Odometer Info (GO) – as defined in Payload Mask 2 6. IP information (IP) – as defined in Payload Mask 2 7. Authentication (AU) – as defined in Payload Mask 1 8. Action results (AC) – as defined in Payload Mask 1 2.2.2 BEP ACK Message payload order Payloads follow the BEP ACK message header in the following order: ACK payloads follow the message header in the following order: 1. Authentication (AU) – as defined in Payload Mask 1 2. Action (AC) – as defined in Payload Mask 1 2.3 Message Size BEP messages have a variable size. The message size can be determined from the header content (payload definition) and each payload size. 2.4 Headers The BEP header has a fixed size of 24 bytes. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 11 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.4.1 BEP Message header Table 2 - BEP header Byte Offset 0 8 Field Name 8 Modem ID Message options Payload Mask 1 Authentication Info Size (bytes) 8 4 1 Size (bits) 2 Type Description UINT64 Modem ESN or IMEI See details below See details below Value determines the presence of the authentication info payload and its format: 00bin No Authentication Info payload UINT2 01bin AU1: Authentication Info payload format 1 10bin AU2: Authentication Info payload format 2 11bin Action 2 AU3: Authentication Info payload format 3 Value determines the presence of the Action payload and its format: 00bin No Action payload UINT2 01bin AC1: Action payload format 1 10bin AC2: Action payload format 2 11bin AC3: Action payload format 3 Reserved 4 UINT4 Reserved for future use. Must be set to 0000bin Reserved 4 UINT4 Reserved for future use. Must be set to 0000bin Byte order 1 UINT1 The value of this bit determines the byte order of multi-byte binary fields (INT, UINT, FLOAT): 0bin Little-endian Compression 1 UINT1 Encryption 1 UINT1 9 1bin Network (Big-endian) (not supported) The value of this bit determines whether compression has been applied to the payload: 0bin No Compression 1bin Compression (not supported) The value of this bit determines whether encryption has been applied to the payload: 0bin No encryption 1bin Acknowledgement 1 Payload is encrypted (not supported) The value of this bit determines whether an acknowledgement message shall be sent by the receiver of this message: 0bin No acknowledgement UINT1 1bin 10 Application ID 11 Reserved 4 UINT4 Message shall be acknowledged Application ID, shall be set to: 1 AVL application 2 Reserved 3 MOM (Mobile Originated Management) 4 Initial Configuration Reserved for future use, shall be set to 0000bin 4 1 Version UINT8 UINT4 BEP protocol version, shall be set to 0001bin 12 Sequence number 4 UINT32 16 Packet length 2 UINT16 18 Event ID 2 UINT16 BEP message sequence number. The first message has the sequence number set to 1. Message sequence numbers persist modem reboot. BEP message total length (including header and all payloads but excluding possible framing). Can be used as offset to the next message (or to the framing end sequence). Index number of the event triggering this message as configured in the modem by +BEVENT=<index>,… Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 12 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Byte Offset 20 Field Name Payload mask 2 Size (bytes) 4 Size (bits) Type Description This field is encoded as an unsigned 32-bit integer. The position of each byte depends on the message byte order field. See Table 3 - BEP Payload mask 2 for the position of each payload type content. 24 Table 3 - BEP Payload mask 2 Bit position Field Name MSB - 32 Reserved Size (bits) 16 16 Odometer Info 2 Type Description UINT16 Reserved for future use, shall be set to 0000_0000_0000_0000bin UINT2 Value determines the presence of the odometer info payload and its format: 00bin No Odometer Info payload 01bin GO1: Odometer Info payload format 1 10bin GO2: Odometer Info payload format 2 11bin 14 IP info 2 GO3: Odometer Info payload format 3 Value determines the presence of the IP info payload and its format: 00bin No IP Info payload UINT2 01bin IP1: IP Info payload format 1 10bin IP2: IP Info payload format 2 11bin 12 10 8 Reserved Reserved Modem Info 2 2 2 IP3: IP Info payload format 3 Reserved for future use, shall be set to 00bin Reserved for future use, shall be set to 00bin Value determines the presence of the modem info payload and its format: 00bin No Modem Info payload UINT2 UINT2 UINT2 01bin MI1: Modem Info payload format 1 10bin MI2: Modem Info payload format 2 11bin 6 RF Info 2 MI3: Modem Info payload format 3 Value determines the presence of the RF info payload and its format: 00bin No RF Info payload UINT2 01bin RF1: Info payload format 1 10bin RF2: Info payload format 2 11bin 4 I/O Info 2 RF3: Info payload format 3 Value determines the presence of the I/O info payload and its format: 00bin No I/O Info payload UINT2 01bin IO1: I/O Info payload format 1 10bin IO2: I/O Info payload format 2 11bin 2 GPS Info 2 IO3: I/O Info payload format 3 Value determines the presence of the GPS info payload and its format: 00bin No GPS Info payload UINT2 01bin GP1: GPS Info payload format 1 10bin GP2: GPS Info payload format 2 11bin GP3: GPS Info payload format 3 Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 13 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Bit position Field Name Size (bits) Type Description LSB 2.4.2 BEP ACK message header BEP ACK message is used by a BEP server to acknowledge the reception of a BEP message and avoid retransmission. It is identical to the BEP Message header except for the last field containing the ACK sequence number instead of the payload mask. The following fields must be identical to the message header being acknowledged: • Modem ID • Version • Application ID • Event ID The following fields shall be set: • Sequence number of packets sent by the server to the modem • Packet length. It shall be set to the length of the header (24) plus the length of the payloads (may be 0 when no payload follows the header). • Ack. sequence number: shall be set to the sequence number of the message being acknowledged. • ACK Payload mask. This mask is used by the server to indicate that the BEP header is followed by one or several payloads. Table 4 - BEP ACK Header Byte Offset 0 8 Field Name Modem ID Payload Mask 1 Authentication Info Size (bytes) 8 1 Size (bits) 2 Type Description UINT64 Modem ESN or IMEI See details below Value determines the presence of the authentication info payload and its format: 00bin No Authentication Info payload UINT2 01bin AU1: Authentication Info payload format 1 10bin AU2: Authentication Info payload format 2 11bin Action 2 Reserved 9 Message options 9 AU3: Authentication Info payload format 3 Value determines the presence of the Action payload and its format: 00bin No Action payload UINT2 AC1: Action payload format 1 10bin AC2: Action payload format 2 11bin AC3: Action payload format 3 4 UINT4 Reserved for future use. Must be set to 0000bin 4 UINT4 See details below Reserved for future use. Must be set to 0000bin 3 Reserved 01bin Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 14 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Byte Offset Field Name Size (bytes) Byte Order Size (bits) 1 Compression 1 Type Description UINT1 The value of this bit determines the byte order of multi-byte binary fields (INT, UINT, FLOAT): 0bin Little-endian 1bin Network (Big-endian) (not supported) The value of this bit determines whether compression has been applied to the payload: 0bin No Compression UINT1 1bin Encryption 1 UINT1 Acknowledgement 1 UINT1 Compression (not supported) The value of this bit determines whether encryption has been applied to the payload: 0bin No encryption 1bin Payload is encrypted (not supported) The value of this bit determines whether an acknowledgement message shall be sent by the receiver of this message: 0bin No acknowledgement 1bin 10 Application ID 11 Reserved 4 UINT4 Message shall be acknowledged Shall be identical to the Application ID field of the message being acknowledged. Reserved for future use, shall be set to 0000bin 4 1 Version UINT8 UINT4 BEP protocol version, shall be set to 0001bin 12 Sequence number 4 UINT32 16 Packet length 2 UINT16 18 Event ID 2 UINT16 Ack Seq, number 4 UINT32 BEP message sequence number. The first message has the sequence number set to 1, and then it keeps being increased by 1 each time a new BEP ACK is sent. BEP message total length (including header but excluding possible framing). Can be used as offset to the next message (or to the framing end sequence). Set to 24 when the BEP ACK contains no payload, set to 24 + payload total length otherwise. Index number of the event triggering this message as configured in the modem by +BEVENT=<index>,… Sequence number of the packet being acknowledged. 20 24 Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 15 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.5 Payloads 2.5.1 Modem Information 2.5.1.1 MI1 format The MI1 format contains the following information: Table 5 – MI1: Modem Information 1 payload Byte Offset 0 1 Field Name Payload content length Modem name Size (bytes) 1 1..32 Size (bits) Type Description UINT8 STR Number of characters of the Modem Name Modem name string containing Length characters. Note: The string is not null terminated. variable 2.5.1.2 MI2 format The MI2 format contains the following information: Table 6 – MI2: Modem Information 2 payload Byte Offset 0 2 6 Field Name Payload content length Model ID Size (bytes) 2 4 Size (bits) Type Description UINT16 UINT32 Size in bytes of the remaining of the payload. Sixnet Industrial Wireless modem model ID – See Table 7 – Model ID Sixnet Industrial Wireless firmware version as returned in the field 'FW:' of ATI1. Modem configuration version (as returned by AT+BCFGV?). RF Module PRL version as returned in the field 'PRL:' of ATI1. This field is empty (one NUL character) for non CDMA modem. Firmware version 1..32 STR0 Configuration version PRL version 1.32 1..32 STR0 STR0 variable Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 16 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Table 7 – Model ID Model Model ID Wireless Technology BT-4200 BT-4400 BT-4600 BT-5200 BT-5400 BT-5600 BT-4600A BT-5600A BT-6600 BT-6601 BT-6601EB BT-6621 BT-5600v2 BT-6800 BT-6801 BT-6801EB BT-6821 BT-5800v2 BT-6401 BT-6401EB BT-6421 0x4200 0x4400 0x4600 0x5200 0x5400 0x5600 0x4601 0x5601 0x6601 0x6611 0x6651 0x6631 0x7601 0x6800 0x6810 0x6850 0x6830 0x7800 0x6410 0x6450 0x6430 CDMA 1xRTT GSM/GPRS CDMA EV-DO rel. 0 CDMA 1xRTT GSM/GPRS CDMA EV-DO rel. 0 CDMA EV-DO rev. A CDMA EV-DO rev. A CDMA EV-DO rev. A CDMA EV-DO rev. A CDMA EV-DO rev. A CDMA EV-DO rev. A CDMA EV-DO rev. A HSPA HSPA HSPA HSPA HSPA GSM/EDGE GSM/EDGE GSM/EDGE GPS GPS GPS GPS GPS GPS GPS 2.5.1.3 MI3 format The MI3 format contains the following information: Table 8 – MI3: Modem Information 3 payload Byte Offset 0 Field Name Payload content length Size (bytes) 2 4 Size (bits) Type Description UINT16 Size in bytes of the remaining of the payload. Sixnet Industrial Wireless modem model ID – See Table 7 – Model ID Modem model string as returned in the field 'Model:' of ATI1. Phone number string as returned in the field 'Phone:' of ATI1. Modem serial number string as returned in the field 'S/N:' of ATI1. Phone number string as returned in the field 'Name:' of ATI1. Sixnet Industrial Wireless firmware version as returned in the field 'FW:' of ATI1. Modem configuration version (as returned by AT+BCFGV?). RF Module PRL version as returned in the field 'PRL:' of ATI1. This field is empty (one NUL character) for non CDMA modem. GPS version as returned in the field 'GPS:' of ATI1. This field is empty (one NUL character) for non GPS modem. RF version as returned in the field 'RF:' of ATI1. HW version as returned in the field 'HW:' of ATI1. OS version as returned in the field 'OS:' of ATI1. 2 Model ID 6 Modem Model Phone number 1..32 1..32 UINT32 STR0 STR0 Serial number 1..32 STR0 Modem name 1..32 STR0 Firmware version 1..32 STR0 Configuration version 1..32 STR0 PRL version 1..32 STR0 GPS version 1..64 STR0 RF version HW version OS version 1..32 1..32 1..32 STR0 STR0 STR0 Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 17 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Byte Offset Field Name Boot version SIM card number Size (bytes) 1..32 Size (bits) 1..32 Type Description STR0 Boot version as returned in the field 'BOOT:' of ATI1. SIM card as returned in the field 'SIM:' of ATI1. This field is empty (one NUL character) for non GSM modem. STR0 variable 2.5.2 RF Information 2.5.2.1 RF1 format The RF1 format contains the following information: Table 9 – RF1: RF Information 1 payload Byte Offset 0 1 Field Name Payload content length RSSI Size (bytes) 1 1 Size (bits) Type Description UINT8 INT8 Always set to 1 Signed RSSI coded in 2'complement on one byte. Possible range is -128 (80hex) to +127 (7Fhex) dBm (actual range depends on modem model and varies from -113 to -51 dBm) 2 2.5.2.2 RF2 format The RF2 format contains the following information: Table 10 – RF2: RF Information 2 payload Byte Offset 0 1 2 Field Name Payload content length RSSI Reserved Size (bytes) 1 1 Roaming Size (bits) Type Description 7 UINT8 UINT8 UINT7 Size in bytes of the remaining of the payload. True dBm value turned positive (multiplied by -1) Reserved for future use, must be set to 0000000bin 1 UINT1 Value indicates whether the modem is roaming: 0bin Modem is registered to its Home network 1bin 3 Service Type 1..32 STR0 Carrier 1..32 STR0 Modem is roaming Service type in use, see Table 11. Carrier (CDMA only), as returned by AT+GMM after the modem model. variable Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 18 IndustrialPro™ and MobilityPro™ Gateway BEP Reference Table 11 – Service Type in use Service Type in use AT+BNSTAT value Wireless Technology 1xRTT EVDO EVDO.A GPRS EDGE UMTS HSDPA HSUPA HSPA NONE 6-7 81-87 91-97 101 102 103 104 105 106 CDMA1xRTT, CDMA EV-DO rel. 0, CDMA EV-DO rev. A CDMA EV-DO rel. 0, CDMA EV-DO rev. A CDMA EV-DO rev. A GSM GPRS/EDGE/HSPA GSM EDGE/HSPA GSM EDGE/HSPA GSM HSPA GSM HSPA GSM HSPA No service 2.5.2.3 RF3 format Reserved for future use. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 19 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.5.3 I/O Information 2.5.3.1 IO1 format The IO1 format contains the following information: Table 12 – IO1: IO Information 1 payload Byte Offset 0 1 Field Name 1 Payload content length Digital I/O state Reserved Size (bytes) 1 4 Size (bits) IGN Type Description UINT8 Always set to 20 Digital Inputs and Outputs as defined below: Reserved for future use. Must be set to 000bin 3 UINT3 1 UINT1 State of the digital input signal IGN (IGNITION): 0bin IGN is OFF 1bin DI4 1 IGN is ON State of the digital input signal DI4: 0bin DI4 is OFF UINT1 1bin DI3 1 UINT1 DI2 1 UINT1 DI1 1 UINT1 DI4 is ON State of the digital input signal DI3: 0bin DI3 is OFF 1bin DI3 is ON State of the digital input signal DI2: 0bin DI2 is OFF 1bin DI2 is ON State of the digital input signal DI1: 0bin DI1 is OFF 1bin 2 3 Reserved Reserved 1 5 UINT8 UINT5 DO3 1 UINT1 DO2 1 UINT1 DO1 1 UINT1 DI1 is ON Reserved for future use. Must be set to 0. Reserved for future use. Must be set to 00000bin State of the digital output signal DO3: 0bin DO3 is OFF 1bin DO3 is ON State of the digital output signal DO2: 0bin DO2 is OFF 1bin DO2 is ON State of the digital output signal DO1: 0bin DO1 is OFF 1bin 4 5 9 13 17 Reserved Input power Analog Input 1 Analog Input 2 Analog Input 3 1 4 4 4 4 DO13 is ON Reserved for future use. Must be set to 0. Single precision floating point value IEEE 754 encoded. Single precision floating point value IEEE 754 encoded. Single precision floating point value IEEE 754 encoded. Single precision floating point value IEEE 754 encoded. UINT8 FLOAT32 FLOAT32 FLOAT32 FLOAT32 21 2.5.3.2 IO2 format Reserved for future use. 2.5.3.3 IO3 format Reserved for future use. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 20 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.5.4 2.5.4.1 Notes: • GPS Information GP1 format This payload has a 2 bytes length field. The GP1 format contains the following information: Table 13 – GP1: GPS Information 1 payload Byte Offset 0 2 Field Name Payload content length GPS NMEA/TAIP Size (bytes) 2 1..1024 Size (bits) Type Description UINT STR Size in bytes of the following GPS raw NMEA or TAIP message Last GPS raw message read from the GPS module. Depending on the modem protocol setting (+BGPSPR), the message can either be a NMEA message or a TAIP message. Notes: • The string is not null terminated, its size is determined by the Payload content length. • The message does not contain the latest valid GPS fix but the last data received from the GPS module. • When set to NMEA, the actual content of the message depends on the +BGPSNM NMEA message selection configuration. variable 2.5.4.2 GP2 format Reserved for future use. 2.5.4.3 GP3 format Reserved for future use. 2.5.5 Odometer Information 2.5.5.1 GO1 format The GO1 format contains the following information: Table 14 – GO1: GPS Odometer Information 1 payload Byte Offset 0 1 Field Name Payload content length Odometer Size (bytes) 1 4 Size (bits) Type Description UINT8 INT32 Always set to 4 Value of the modem odometer 5 2.5.5.2 GO2 format Reserved for future use. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 21 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.5.5.3 GO3 format Reserved for future use. 2.5.6 IP Information 2.5.6.1 IP1 format The IP1 format contains the following information: Table 16 – IP1: IP Information 1 payload Byte Offset 0 1 Field Name Payload content length WAN IP Size (bytes) 1 4 Size (bits) Type Description UINT8 UINT32 Always set to 4 IPv4 IP address in network byte order. The encoding of this field does not depend on the header byte order field. 5 2.5.6.2 IP2 format Reserved for future use. 2.5.6.3 IP3 format Reserved for future use. 2.5.7 Authentication Information 2.5.7.1 AU1 format The AU1 format contains the following information: Table 17 – AU1: Authentication Information 1 payload Byte Offset 0 2 18 Field Name Payload content length MD5 hash Nonce Size (bytes) 2 16 1..128 Size (bits) Type Description UINT16 UINT8 Size in bytes of the remaining of the payload. MD5 hash computed on the following appended data (in the given order): STR0 • Entire BEP packet with this field set to all FFhex, • Last nonce field received for this connection with the server • The modem password (as set by AT+BRPSWD). The password may be empty. Null-terminated string representing the nonce used for calculating the MD5 hash of the message. When received by the modem, this nonce is used for subsequent MD5 hash calculation. variable 2.5.7.2 AU2 format Reserved for future use. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 22 IndustrialPro™ and MobilityPro™ Gateway BEP Reference 2.5.7.3 AU3 format Reserved for future use. 2.5.8 Action 2.5.8.1 AC1 format The AC1 format contains the following information: Table 18 – AC1: Action 1 payload Byte Offset 0 2 4 Field Name Payload content length Request ID Size (bytes) 2 2 Action 1..~4k Size (bits) Type Description UINT16 UINT16 Size in bytes of the remaining of the payload. Identification of the request. This field is used to link a request with its response. The modem copies this field from the BEP ACK it receives to the BEP message it sends with the action response. This field is set to 0 by the modem when it is not associated to a Server request (this is the case for the first message sent by the modem to the server). AT command to execute (Server -> Modem), or AT response to executed command (Modem -> Server) The size of the Action field is variable. The maximum size for messages sent by the modem depends on the overall size of the BEP message and on the modem store and forward memory block size (as set by AT+BSFMBS). By default it is about 400 bytes (4 x default block size – header and other payload size). STR0 variable Notes: • ACK flag is always set in BEP messages Modem -> Server for destinations type 3 (Management Server) or 4 (Initial Configuration Server). • When the ACK flag is set in the message Server -> Modem which includes an AC payload, the response to the AT command shall be sent back in a new BEP message having an AC payload. • When no action needs to be performed, the ACK flag shall be unset in the BEP ACK message sent by the Server to the modem. • AC1 payload are only processed when coming from destinations type 3 (Management Server) or 4 (Initial Configuration Server). 2.5.8.2 AC2 format Reserved for future use. 2.5.8.3 AC3 format Reserved for future use. Rev 3.8.4 – June 7, 2010 Copyright © 2010 Sixnet LLC. All rights reserved. 23