XBee-Arduino
0.2
|
Represents a Series 1 TX packet that corresponds to Api Id: TX_64_REQUEST. More...
#include <XBee.h>
Public Member Functions | |
Tx64Request (XBeeAddress64 &addr64, uint8_t option, uint8_t *payload, uint8_t payloadLength, uint8_t frameId) | |
Tx64Request (XBeeAddress64 &addr64, uint8_t *payload, uint8_t payloadLength) | |
Creates a unicast Tx64Request with the ACK option and DEFAULT_FRAME_ID. | |
Tx64Request () | |
Creates a default instance of this class. More... | |
XBeeAddress64 & | getAddress64 () |
void | setAddress64 (XBeeAddress64 &addr64) |
uint8_t | getOption () |
void | setOption (uint8_t option) |
uint8_t | getFrameData (uint8_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. More... | |
uint8_t | getFrameDataLength () |
Returns the size of the api frame (not including frame id or api id or checksum). | |
![]() | |
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... | |
![]() | |
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. | |
Additional Inherited Members | |
![]() | |
void | setApiId (uint8_t apiId) |
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.
Tx64Request::Tx64Request | ( | ) |
Creates a default instance of this class.
At a minimum you must specify a payload, payload length and a destination address before sending this request.
|
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.