Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
XBee
by 
Suga koubou
PayloadRequest Class Reference
All TX packets that support payloads extend this class. More...
#include <XBee.h>
Inherits XBeeRequest.
Inherited by Tx16Request, Tx64Request, and ZBTxRequest.
Public Member Functions | |
| uint8_t * | getPayload () |
| Returns the payload of the packet, if not null. | |
| void | setPayload (uint8_t *payloadPtr) |
| Sets the payload array. | |
| uint16_t | getPayloadLength () |
| Returns the length of the payload array, as specified by the user. | |
| void | setPayloadLength (uint16_t payloadLength) |
| Sets the length of the payload to include in the request. | |
| 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
All TX packets that support payloads extend this class.
Definition at line 755 of file XBee.h.
Member Function Documentation
| virtual uint8_t getFrameData | ( | uint16_t | pos ) | [pure virtual, inherited] |
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, and RemoteAtCommandRequest.
| virtual uint16_t getFrameDataLength | ( | ) | [pure virtual, inherited] |
Returns the size of the api frame (not including frame id or api id or checksum).
Implemented in Tx16Request, Tx64Request, ZBTxRequest, AtCommandRequest, and RemoteAtCommandRequest.
| uint8_t * getPayload | ( | ) |
| uint16_t getPayloadLength | ( | ) |
| void setFrameId | ( | uint8_t | frameId ) | [inherited] |
| void setPayload | ( | uint8_t * | payloadPtr ) |
| void setPayloadLength | ( | uint16_t | payloadLength ) |
Generated on Thu Jul 14 2022 22:48:11 by
1.7.2