XBee-Arduino  0.2
Public Member Functions | Protected Member Functions | List of all members
XBeeRequest Class Referenceabstract

Super class of all XBee requests (TX packets) Users should never create an instance of this class; instead use an subclass of this class It is recommended to reuse Subclasses of the class to conserve memory This class allocates a buffer to. More...

#include <XBee.h>

Inheritance diagram for XBeeRequest:
AtCommandRequest PayloadRequest RemoteAtCommandRequest Tx16Request Tx64Request ZBTxRequest

Public Member Functions

 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.
 
virtual uint8_t getFrameData (uint8_t pos)=0
 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...
 
virtual uint8_t getFrameDataLength ()=0
 Returns the size of the api frame (not including frame id or api id or checksum).
 

Protected Member Functions

void setApiId (uint8_t apiId)
 

Detailed Description

Super class of all XBee requests (TX packets) Users should never create an instance of this class; instead use an subclass of this class It is recommended to reuse Subclasses of the class to conserve memory

This class allocates a buffer to.

Member Function Documentation

virtual uint8_t XBeeRequest::getFrameData ( uint8_t  pos)
pure 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.

Implemented in RemoteAtCommandRequest, AtCommandRequest, ZBTxRequest, Tx64Request, and Tx16Request.

void XBeeRequest::setFrameId ( uint8_t  frameId)

Sets the frame id.

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


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