XBee-mbed library http://mbed.org/users/okini3939/notebook/xbee-mbed/

Dependents:   device_server_udp led_sender_post XBee_API_ex1 XBee_API_ex2 ... more

Embed: (wiki syntax)

« Back to documentation index

RemoteAtCommandRequest Class Reference

RemoteAtCommandRequest Class Reference

Represents an Remote AT Command TX packet The command is used to configure a remote XBee radio. More...

#include <XBee.h>

Inherits AtCommandRequest.

Public Member Functions

 RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 Creates a RemoteAtCommandRequest with 16-bit address to set a command.
 RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command)
 Creates a RemoteAtCommandRequest with 16-bit address to query a command.
 RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 Creates a RemoteAtCommandRequest with 64-bit address to set a command.
 RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command)
 Creates a RemoteAtCommandRequest with 16-bit address to query a command.
virtual uint8_t getFrameData (uint16_t pos)
 Starting after the frame id (pos = 0) and up to but not including the checksum Note: Unlike Digi's definition of the frame data, this does not start with the API ID.
virtual uint16_t getFrameDataLength ()
 Returns the size of the api frame (not including frame id or api id or checksum).
void clearCommandValue ()
 Clears the optional commandValue and commandValueLength so that a query may be sent.
void setFrameId (uint8_t frameId)
 Sets the frame id.
uint8_t getFrameId ()
 Returns the frame id.
uint8_t getApiId ()
 Returns the API id.

Detailed Description

Represents an Remote AT Command TX packet The command is used to configure a remote XBee radio.

Definition at line 931 of file XBee.h.


Constructor & Destructor Documentation

RemoteAtCommandRequest ( uint16_t  remoteAddress16,
uint8_t *  command,
uint8_t *  commandValue,
uint8_t  commandValueLength 
)

Creates a RemoteAtCommandRequest with 16-bit address to set a command.

64-bit address defaults to broadcast and applyChanges is true.

Definition at line 1305 of file XBee.cpp.

RemoteAtCommandRequest ( uint16_t  remoteAddress16,
uint8_t *  command 
)

Creates a RemoteAtCommandRequest with 16-bit address to query a command.

64-bit address defaults to broadcast and applyChanges is true.

Definition at line 1312 of file XBee.cpp.

RemoteAtCommandRequest ( XBeeAddress64 remoteAddress64,
uint8_t *  command,
uint8_t *  commandValue,
uint8_t  commandValueLength 
)

Creates a RemoteAtCommandRequest with 64-bit address to set a command.

16-bit address defaults to broadcast and applyChanges is true.

Definition at line 1319 of file XBee.cpp.

RemoteAtCommandRequest ( XBeeAddress64 remoteAddress64,
uint8_t *  command 
)

Creates a RemoteAtCommandRequest with 16-bit address to query a command.

16-bit address defaults to broadcast and applyChanges is true.

Definition at line 1327 of file XBee.cpp.


Member Function Documentation

void clearCommandValue (  ) [inherited]

Clears the optional commandValue and commandValueLength so that a query may be sent.

Definition at line 1283 of file XBee.cpp.

uint8_t getApiId (  ) [inherited]

Returns the API id.

Definition at line 961 of file XBee.cpp.

uint8_t getFrameData ( uint16_t  pos ) [virtual]

Starting after the frame id (pos = 0) and up to but not including the checksum Note: Unlike Digi's definition of the frame data, this does not start with the API ID.

The reason for this is the API ID and Frame ID are common to all requests, whereas my definition of frame data is only the API specific data.

Reimplemented from AtCommandRequest.

Definition at line 1359 of file XBee.cpp.

uint16_t getFrameDataLength (  ) [virtual]

Returns the size of the api frame (not including frame id or api id or checksum).

Reimplemented from AtCommandRequest.

Definition at line 1391 of file XBee.cpp.

uint8_t getFrameId (  ) [inherited]

Returns the frame id.

Definition at line 957 of file XBee.cpp.

void setFrameId ( uint8_t  frameId ) [inherited]

Sets the frame id.

Must be between 1 and 255 inclusive to get a TX status response.

Definition at line 953 of file XBee.cpp.