BayEOS-Arduino  1.8.0_0.0.4
Public Member Functions | List of all members
Tx16Request Class Reference

#include <XBee.h>

Inheritance diagram for Tx16Request:
PayloadRequest XBeeRequest

Public Member Functions

 Tx16Request (uint16_t addr16, uint8_t option, uint8_t *payload, uint8_t payloadLength, uint8_t frameId)
 
 Tx16Request (uint16_t addr16, uint8_t *payload, uint8_t payloadLength)
 
 Tx16Request ()
 
uint16_t getAddress16 ()
 
void setAddress16 (uint16_t addr16)
 
uint8_t getOption ()
 
void setOption (uint8_t option)
 
uint8_t getFrameData (uint8_t pos)
 
uint8_t getFrameDataLength ()
 
- Public Member Functions inherited from PayloadRequest
 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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from XBeeRequest
void setApiId (uint8_t apiId)
 

Detailed Description

Represents a Series 1 TX packet that corresponds to Api Id: TX_16_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 814 of file XBee.h.

Constructor & Destructor Documentation

◆ Tx16Request() [1/2]

Tx16Request::Tx16Request ( uint16_t  addr16,
uint8_t *  payload,
uint8_t  payloadLength 
)

Creates a Unicast Tx16Request with the ACK option and DEFAULT_FRAME_ID

Definition at line 945 of file XBee.cpp.

◆ Tx16Request() [2/2]

Tx16Request::Tx16Request ( )

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 936 of file XBee.cpp.

Member Function Documentation

◆ getFrameData()

uint8_t Tx16Request::getFrameData ( uint8_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 950 of file XBee.cpp.

◆ getFrameDataLength()

uint8_t Tx16Request::getFrameDataLength ( )
virtual

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

Implements XBeeRequest.

Definition at line 963 of file XBee.cpp.


The documentation for this class was generated from the following files: