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

All TX packets that support payloads extend this class. More...

#include <XBee.h>

Inheritance diagram for PayloadRequest:
XBeeRequest Tx16Request Tx64Request ZBTxRequest

Public Member Functions

 PayloadRequest (uint8_t apiId, uint8_t frameId, uint8_t *payload, uint8_t payloadLength)
 
uint8_t * getPayload ()
 Returns the payload of the packet, if not null.
 
void setPayload (uint8_t *payloadPtr)
 Sets the payload array.
 
uint8_t getPayloadLength ()
 Returns the length of the payload array, as specified by the user.
 
void setPayloadLength (uint8_t payloadLength)
 Sets the length of the payload to include in the request. More...
 
- 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.
 
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).
 

Additional Inherited Members

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

Detailed Description

All TX packets that support payloads extend this class.

Member Function Documentation

void PayloadRequest::setPayloadLength ( uint8_t  payloadLength)

Sets the length of the payload to include in the request.

For example if the payload array is 50 bytes and you only want the first 10 to be included in the packet, set the length to 10. Length must be <= to the array length.


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