Suga koubou
XBee-mbed library http://mbed.org/users/okini3939/notebook/xbee-mbed/
Dependents: device_server_udp led_sender_post XBee_API_ex1 XBee_API_ex2 ... more
PayloadRequest Class Reference
All TX packets that support payloads extend this class. More...
#include <XBee.h>
Inherits XBeeRequest.
Inherited by IPv4TransmitRequest, 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 757 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, RemoteAtCommandRequest, and IPv4TransmitRequest.
| 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, RemoteAtCommandRequest, and IPv4TransmitRequest.
| uint8_t * getPayload | ( | ) |
| uint16_t getPayloadLength | ( | ) |
| void setFrameId | ( | uint8_t | frameId ) | [inherited] |
| void setPayload | ( | uint8_t * | payloadPtr ) |
| void setPayloadLength | ( | uint16_t | payloadLength ) |
Generated on Tue Jul 12 2022 18:07:39 by
1.7.2