XBeeRequest Class Reference

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>

Inherited by AtCommandRequest, and PayloadRequest.

Public Member Functions
	XBeeRequest (uint8_t apiId, uint8_t frameId)
	Constructor TODO make protected.
void	setFrameId (uint8_t frameId)
	Sets the frame id.
uint8_t	getFrameId ()
	Returns the frame id.
uint8_t	getApiId ()
	Returns the API id.
virtual uint8_t	getFrameData (uint16_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.
virtual uint16_t	getFrameDataLength ()=0
	Returns the size of the api frame (not including frame id or api id or checksum).

---

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.

Definition at line 619 of file XBee.h.

---

Constructor & Destructor Documentation

XBeeRequest	(	uint8_t	apiId,
		uint8_t	frameId
	)

Constructor TODO make protected.

Definition at line 946 of file XBee.cpp.

---

Member Function Documentation

uint8_t getApiId

(

)

Returns the API id.

Definition at line 959 of file XBee.cpp.

virtual uint8_t getFrameData

(

uint16_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 Tx16Request, Tx64Request, ZBTxRequest, AtCommandRequest, RemoteAtCommandRequest, and IPv4TransmitRequest.

virtual uint16_t getFrameDataLength

(

)

[pure virtual]

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

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

uint8_t getFrameId

(

)

Returns the frame id.

Definition at line 955 of file XBee.cpp.

void setFrameId

(

uint8_t

frameId )

Sets the frame id.

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

Definition at line 951 of file XBee.cpp.