RemoteAtCommandRequest Class Reference

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

#include <XBee.h>

Inheritance diagram for RemoteAtCommandRequest:

AtCommandRequest XBeeRequest

List of all members.

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.
uint16_t getRemoteAddress16 ()
void setRemoteAddress16 (uint16_t remoteAddress16)
XBeeAddress64getRemoteAddress64 ()
void setRemoteAddress64 (XBeeAddress64 &remoteAddress64)
bool getApplyChanges ()
void setApplyChanges (bool applyChanges)
uint8_t getFrameData (uint8_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.
uint8_t getFrameDataLength ()
 Returns the size of the api frame (not including frame id or api id or checksum).

Static Public Attributes

static XBeeAddress64 broadcastAddress64 = XBeeAddress64(0x0, BROADCAST_ADDRESS)


Detailed Description

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

Constructor & Destructor Documentation

RemoteAtCommandRequest::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.

RemoteAtCommandRequest::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.

RemoteAtCommandRequest::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.

RemoteAtCommandRequest::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.


Member Function Documentation

uint8_t RemoteAtCommandRequest::getFrameData ( uint8_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.


The documentation for this class was generated from the following files:

Generated on Wed Dec 21 17:21:21 2011 for XBee-Arduino by  doxygen 1.5.8