#include <XBee.h>

Inheritance diagram for XBeeRequest:

Public Member Functions
	XBeeRequest (uint8_t apiId, uint8_t frameId)

void	setFrameId (uint8_t frameId)

uint8_t	getFrameId ()

uint8_t	getApiId ()

virtual uint8_t	getFrameData (uint8_t pos)=0

virtual uint8_t	getFrameDataLength ()=0

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

Definition at line 616 of file XBee.h.

Constructor & Destructor Documentation

◆ XBeeRequest()

XBeeRequest::XBeeRequest	(	uint8_t	apiId,
		uint8_t	frameId
	)

Constructor TODO make protected

Definition at line 760 of file XBee.cpp.

Member Function Documentation

◆ getApiId()

uint8_t XBeeRequest::getApiId ( )

Returns the API id

Definition at line 773 of file XBee.cpp.

◆ getFrameData()

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.

◆ getFrameDataLength()

virtual uint8_t XBeeRequest::getFrameDataLength ( )

pure virtual

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

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

◆ getFrameId()

uint8_t XBeeRequest::getFrameId ( )

Returns the frame id

Definition at line 769 of file XBee.cpp.

◆ setFrameId()

void XBeeRequest::setFrameId ( uint8_t frameId )

Sets the frame id. Must be between 1 and 255 inclusive to get a TX status response.

Definition at line 765 of file XBee.cpp.

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

libraries/BayXBee/XBee.h
libraries/BayXBee/XBee.cpp

Public Member Functions

Protected Member Functions