#include <XBee.h>
Inheritance diagram for PayloadRequest:
Collaboration diagram for PayloadRequest:
Public Member Functions | |
| PayloadRequest (uint8_t apiId, uint8_t frameId, uint8_t *payload, uint8_t payloadLength) | |
| uint8_t * | getPayload () |
| void | setPayload (uint8_t *payloadPtr) |
| uint8_t | getPayloadLength () |
| void | setPayloadLength (uint8_t payloadLength) |
 Public Member Functions inherited from XBeeRequest | |
| 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 |
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
◆ getPayload()
| uint8_t * PayloadRequest::getPayload | ( | void | ) |
Returns the payload of the packet, if not null
◆ getPayloadLength()
| uint8_t PayloadRequest::getPayloadLength | ( | void | ) |
Returns the length of the payload array, as specified by the user.
◆ setPayload()
| void PayloadRequest::setPayload | ( | uint8_t * | payloadPtr | ) |
Sets the payload array
◆ setPayloadLength()
| 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:
- BayEOS-Arduino/libraries/BayEOS/XBee.h
- BayEOS-Arduino/libraries/BayEOS/XBee.cpp
