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

#include <XBee.h>

Inheritance diagram for RemoteAtCommandRequest:
AtCommandRequest XBeeRequest

Public Member Functions

 RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 
 RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command)
 
 RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 
 RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command)
 
uint16_t getRemoteAddress16 ()
 
void setRemoteAddress16 (uint16_t remoteAddress16)
 
XBeeAddress64getRemoteAddress64 ()
 
void setRemoteAddress64 (XBeeAddress64 &remoteAddress64)
 
bool getApplyChanges ()
 
void setApplyChanges (bool applyChanges)
 
uint8_t getFrameData (uint8_t pos)
 
uint8_t getFrameDataLength ()
 
- Public Member Functions inherited from AtCommandRequest
 AtCommandRequest (uint8_t *command)
 
 AtCommandRequest (uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 
uint8_t * getCommand ()
 
void setCommand (uint8_t *command)
 
uint8_t * getCommandValue ()
 
void setCommandValue (uint8_t *command)
 
uint8_t getCommandValueLength ()
 
void setCommandValueLength (uint8_t length)
 
void clearCommandValue ()
 
- Public Member Functions inherited from XBeeRequest
 XBeeRequest (uint8_t apiId, uint8_t frameId)
 
void setFrameId (uint8_t frameId)
 
uint8_t getFrameId ()
 
uint8_t getApiId ()
 

Static Public Attributes

static XBeeAddress64 broadcastAddress64 = XBeeAddress64(0x0, BROADCAST_ADDRESS)
 

Additional Inherited Members

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

Detailed Description

Represents an Remote AT Command TX packet The command is used to configure a remote XBee radio

Definition at line 952 of file XBee.h.

Constructor & Destructor Documentation

◆ RemoteAtCommandRequest() [1/4]

RemoteAtCommandRequest::RemoteAtCommandRequest ( uint16_t  remoteAddress16,
uint8_t *  command,
uint8_t *  commandValue,
uint8_t  commandValueLength 
)

Creates a RemoteAtCommandRequest with 16-bit address to set a command. 64-bit address defaults to broadcast and applyChanges is true.

Definition at line 1117 of file XBee.cpp.

◆ RemoteAtCommandRequest() [2/4]

RemoteAtCommandRequest::RemoteAtCommandRequest ( uint16_t  remoteAddress16,
uint8_t *  command 
)

Creates a RemoteAtCommandRequest with 16-bit address to query a command. 64-bit address defaults to broadcast and applyChanges is true.

Definition at line 1124 of file XBee.cpp.

◆ RemoteAtCommandRequest() [3/4]

RemoteAtCommandRequest::RemoteAtCommandRequest ( XBeeAddress64 remoteAddress64,
uint8_t *  command,
uint8_t *  commandValue,
uint8_t  commandValueLength 
)

Creates a RemoteAtCommandRequest with 64-bit address to set a command. 16-bit address defaults to broadcast and applyChanges is true.

Definition at line 1131 of file XBee.cpp.

◆ RemoteAtCommandRequest() [4/4]

RemoteAtCommandRequest::RemoteAtCommandRequest ( XBeeAddress64 remoteAddress64,
uint8_t *  command 
)

Creates a RemoteAtCommandRequest with 16-bit address to query a command. 16-bit address defaults to broadcast and applyChanges is true.

Definition at line 1139 of file XBee.cpp.

Member Function Documentation

◆ getFrameData()

uint8_t RemoteAtCommandRequest::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.

Reimplemented from AtCommandRequest.

Definition at line 1171 of file XBee.cpp.

◆ getFrameDataLength()

uint8_t RemoteAtCommandRequest::getFrameDataLength ( )
virtual

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

Reimplemented from AtCommandRequest.

Definition at line 1203 of file XBee.cpp.


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