xbee_cmd_response Struct Reference

Data Fields
xbee_at_cmd_t	command
void FAR *	context
xbee_dev_t *	device
uint16_t	flags
int16_t	handle
const wpan_address_t FAR *	source
	Source of the response (NULL if a local AT command response) More...
uint32_t	value
const uint8_t FAR *	value_bytes
uint_fast8_t	value_length

Detailed Description

Structure used to pass AT Command responses to registered callback handlers. This is used for both local and remote command responses.

Field Documentation

xbee_at_cmd_t command

The AT Command (e.g., VR, NI) sent in the request that generated this response.

void FAR* context

Context registered with callback in call to xbee_cmd_set_callback(). This is usually a pointer to extra data needed by the callback.

xbee_dev_t* device

Local XBee device that sent the local (or received the remote) response.

uint16_t flags

Additional information about the response. Perform a bitwise AND (&) with the following values:

• #XBEE_CMD_RESP_MASK_STATUS Status byte from the XBee response. A non-zero status indicates an error. May be one of the following values:
  • XBEE_AT_RESP_SUCCESS (0)
  • XBEE_AT_RESP_ERROR
  • XBEE_AT_RESP_BAD_COMMAND
  • XBEE_AT_RESP_BAD_PARAMETER
• #XBEE_CMD_RESP_FLAG_TIMEOUT Did not receive a response before timing out.
• #XBEE_CMD_RESP_ATND_RSSI_INVALID [DigiMesh only] The RSSI field of the DigiMesh ATND response is not valid.

int16_t handle

The handle to the request that generated this response. Useful if the callback needs to (optionally) modify the original request and then send it again.

const wpan_address_t FAR* source

Source of the response (NULL if a local AT command response)

uint32_t value

The value sent with the response, if any, in host byte order. Only set if .value_length is 4 bytes or less.

const uint8_t FAR* value_bytes

The value sent with the response; contains .value_length bytes. Do not modify the data pointed to by .value_bytes, it may be sent to more than one callback.

uint_fast8_t value_length

Number of bytes in .value_bytes or zero if there wasn't a value sent with the response.