ban4jp - / XBee_with_SPI

Dependents:   XBeeWiFi_SPI_example

Fork of XBee by Suga koubou

Embed: (wiki syntax)

« Back to documentation index

AtCommandRequest Class Reference

AtCommandRequest Class Reference

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

#include <XBee.h>

Inherits XBeeRequest.

Inherited by RemoteAtCommandRequest.

Public Member Functions

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 AT Command TX packet The command is used to configure the serially connected XBee radio.

Definition at line 916 of file XBee.h.


Member Function Documentation

void clearCommandValue (  )

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

uint8_t getApiId (  ) [inherited]

Returns the API id.

virtual 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.

Implements XBeeRequest.

Reimplemented in RemoteAtCommandRequest.

virtual uint16_t getFrameDataLength (  ) [virtual]

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

Implements XBeeRequest.

Reimplemented in RemoteAtCommandRequest.

uint8_t getFrameId (  ) [inherited]

Returns the frame id.

void setFrameId ( uint8_t  frameId ) [inherited]

Sets the frame id.

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