Digi XBEE-PRO S3B Manual

XBee‐PRO®900HP/XBee‐PRO®XSCRFModules
©2014DigiInternationalInc. 86
*Multi-byte parameters should be specified with big-endian byte ordering.
When a GPM command is sent to a radio via a unicast the receiving radio will unicast a response back to the
requesting radio's source endpoint specified in the request packet. No response is sent for broadcast
requests. If the source endpoint is set to the DIGI_DEVICE endpoint (0xE6) or explicit API mode is enabled
on the requesting radio then a GPM response will be output as an explicit API RX indicator frame on the
requesting node (assuming API mode is enabled.)
The format of the response is very similar to the request packet:
*Multi-byte parameters should be specified with big-endian byte ordering.
The following commands exist for interacting with GPM:
PLATFORM_INFO_REQUEST (0x00):
A PLATFORM_INFO_REQUEST frame can be sent to query details of the GPM structure.
PLATFORM_INFO (0x80):
When a PLATFORM_INFO_REQUEST command request has been unicast to a node, that node will send a
response in the following format to the source endpoint specified in the requesting frame.
Byte Offset in
Payload
Number of
Bytes
Field Name General Field Description
0
1 GPM_CMD_ID This field will be the same as the request field
1
1
GPM_STATUS Status indicating whether the command was
successful
2
2* GPM_BLOCK_NUM The block number addressed in the GPM
4
2*
GPM_START_INDEX The byte index within the addressed GPM
block
6
2* GPM_NUM_BYTES The number of bytes in the GPM_DATA field
8
varies GPM_DATA
Field Name
Command-Specific Description
GPM_CMD_ID
Should be set to PLATFORM_INFO_REQUEST (0x00)
GPM_OPTIONS
This field is unused for this command. Set to 0.
GPM_BLOCK_NUM
This field is unused for this command. Set to 0.
GPM_START_INDEX
This field is unused for this command. Set to 0.
GPM_NUM_BYTES
This field is unused for this command. Set to 0.
GPM_DATA
No data bytes should be specified for this command.
Field Name
Command-Specific Description
GPM_CMD_ID
Should be set to PLATFORM_INFO (0x80)
GPM_STATUS
A 1 in the least significant bit indicates an error occurred. All other bits
are reserved at this time.
GPM_BLOCK_NUM
Indicates the number of GPM blocks available.
GPM_START_INDEX
Indicates the size, in bytes, of a GPM block.
GPM_NUM_BYTES
The number of bytes in the GPM_DATA field. For this command, this
field will be set to 0.

Digi XBEE-PRO S3B Specifications

General

Brand	Digi
Model	XBEE-PRO S3B
Category	Control Unit
Language	English