XBee-Arduino  0.2
Public Member Functions | List of all members
AtCommandRequest Class Reference

Represents an AT Command TX packet The command is used to configure the serially connected XBee radio. More...

#include <XBee.h>

Inheritance diagram for AtCommandRequest:
XBeeRequest RemoteAtCommandRequest

Public Member Functions

 AtCommandRequest (uint8_t *command)
 
 AtCommandRequest (uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 
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. More...
 
uint8_t getFrameDataLength ()
 Returns the size of the api frame (not including frame id or api id or checksum).
 
uint8_t * getCommand ()
 
void setCommand (uint8_t *command)
 
uint8_t * getCommandValue ()
 
void setCommandValue (uint8_t *command)
 
uint8_t getCommandValueLength ()
 
void setCommandValueLength (uint8_t length)
 
void clearCommandValue ()
 Clears the optional commandValue and commandValueLength so that a query may be sent.
 
- Public Member Functions inherited from XBeeRequest
 XBeeRequest (uint8_t apiId, uint8_t frameId)
 Constructor TODO make protected.
 
void setFrameId (uint8_t frameId)
 Sets the frame id. More...
 
uint8_t getFrameId ()
 Returns the frame id.
 
uint8_t getApiId ()
 Returns the API id.
 

Additional Inherited Members

- Protected Member Functions inherited from XBeeRequest
void setApiId (uint8_t apiId)
 

Detailed Description

Represents an AT Command TX packet The command is used to configure the serially connected XBee radio.

Member Function Documentation

uint8_t AtCommandRequest::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.

Implements XBeeRequest.

Reimplemented in RemoteAtCommandRequest.


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