Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: XBeeWiFi_SPI_example
Fork of
XBee
by 
Suga koubou
RemoteAtCommandRequest Class Reference
Represents an Remote AT Command TX packet The command is used to configure a remote XBee radio. More...
#include <XBee.h>
Inherits AtCommandRequest.
Public Member Functions | |
| RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength) | |
| Creates a RemoteAtCommandRequest with 16-bit address to set a command. | |
| RemoteAtCommandRequest (uint16_t remoteAddress16, uint8_t *command) | |
| Creates a RemoteAtCommandRequest with 16-bit address to query a command. | |
| RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength) | |
| Creates a RemoteAtCommandRequest with 64-bit address to set a command. | |
| RemoteAtCommandRequest (XBeeAddress64 &remoteAddress64, uint8_t *command) | |
| Creates a RemoteAtCommandRequest with 16-bit address to query a command. | |
| 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). | |
| void | clearCommandValue () |
| Clears the optional commandValue and commandValueLength so that a query may be sent. | |
| 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 an Remote AT Command TX packet The command is used to configure a remote XBee radio.
Definition at line 944 of file XBee.h.
Constructor & Destructor Documentation
| 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.
| 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.
| 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.
| 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.
Member Function Documentation
| void clearCommandValue | ( | ) | [inherited] |
Clears the optional commandValue and commandValueLength so that a query may be sent.
| uint8_t getApiId | ( | ) | [inherited] |
Returns the API id.
| virtual 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.
Reimplemented from AtCommandRequest.
| virtual uint16_t getFrameDataLength | ( | ) | [virtual] |
Returns the size of the api frame (not including frame id or api id or checksum).
Reimplemented from AtCommandRequest.
| uint8_t getFrameId | ( | ) | [inherited] |
Returns the frame id.
| void setFrameId | ( | uint8_t | frameId ) | [inherited] |
Sets the frame id.
Must be between 1 and 255 inclusive to get a TX status response.
Generated on Tue Jul 12 2022 23:53:35 by
1.7.2