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
Tx64Request Class Reference
Represents a Series 1 TX packet that corresponds to Api Id: TX_64_REQUEST. More...
#include <XBee.h>
Inherits PayloadRequest.
Public Member Functions | |
Tx64Request (XBeeAddress64 &addr64, uint8_t *payload, uint16_t payloadLength) | |
Creates a unicast Tx64Request with the ACK option and DEFAULT_FRAME_ID. | |
Tx64Request () | |
Creates a default instance of this class. | |
virtual uint8_t | getFrameData (uint16_t pos) |
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 () |
Returns the size of the api frame (not including frame id or api id or checksum). | |
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. |
Detailed Description
Represents a Series 1 TX packet that corresponds to Api Id: TX_64_REQUEST.
Be careful not to send a data array larger than the max packet size of your radio. This class does not perform any validation of packet size and there will be no indication if the packet is too large, other than you will not get a TX Status response. The datasheet says 100 bytes is the maximum, although that could change in future firmware.
Definition at line 825 of file XBee.h.
Constructor & Destructor Documentation
Tx64Request | ( | XBeeAddress64 & | addr64, |
uint8_t * | payload, | ||
uint16_t | payloadLength | ||
) |
Creates a unicast Tx64Request with the ACK option and DEFAULT_FRAME_ID.
Tx64Request | ( | ) |
Member Function Documentation
uint8_t getFrameData | ( | uint16_t | pos ) | [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.
Implements XBeeRequest.
uint16_t getFrameDataLength | ( | ) | [virtual] |
Returns the size of the api frame (not including frame id or api id or checksum).
Implements XBeeRequest.
uint8_t * getPayload | ( | ) | [inherited] |
uint16_t getPayloadLength | ( | ) | [inherited] |
void setFrameId | ( | uint8_t | frameId ) | [inherited] |
void setPayload | ( | uint8_t * | payloadPtr ) | [inherited] |
void setPayloadLength | ( | uint16_t | payloadLength ) | [inherited] |
Generated on Tue Jul 12 2022 18:07:39 by 1.7.2