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

Embed: (wiki syntax)

« Back to documentation index

Tx64Request Class Reference

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.

Definition at line 1180 of file XBee.cpp.

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.

Definition at line 1171 of file XBee.cpp.


Member Function Documentation

uint8_t getApiId (  ) [inherited]

Returns the API id.

Definition at line 961 of file XBee.cpp.

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.

Definition at line 1185 of file XBee.cpp.

uint16_t getFrameDataLength (  ) [virtual]

Returns the size of the api frame (not including frame id or api id or checksum).

Implements XBeeRequest.

Definition at line 1210 of file XBee.cpp.

uint8_t getFrameId (  ) [inherited]

Returns the frame id.

Definition at line 957 of file XBee.cpp.

uint8_t * getPayload (  ) [inherited]

Returns the payload of the packet, if not null.

Definition at line 987 of file XBee.cpp.

uint16_t getPayloadLength (  ) [inherited]

Returns the length of the payload array, as specified by the user.

Definition at line 995 of file XBee.cpp.

void setFrameId ( uint8_t  frameId ) [inherited]

Sets the frame id.

Must be between 1 and 255 inclusive to get a TX status response.

Definition at line 953 of file XBee.cpp.

void setPayload ( uint8_t *  payloadPtr ) [inherited]

Sets the payload array.

Definition at line 991 of file XBee.cpp.

void setPayloadLength ( uint16_t  payloadLength ) [inherited]

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.

Definition at line 999 of file XBee.cpp.