|
XBee-Arduino
0.2
|
Represents an AT Command RX packet. More...
#include <XBee.h>
Public Member Functions | |
| uint8_t * | getCommand () |
| Returns an array containing the two character command. | |
| uint8_t | getStatus () |
| Returns the command status code. More... | |
| uint8_t * | getValue () |
| Returns an array containing the command value. More... | |
| uint8_t | getValueLength () |
| Returns the length of the command value array. | |
| bool | isOk () |
| Returns true if status equals AT_OK. | |
Public Member Functions inherited from FrameIdResponse | |
| uint8_t | getFrameId () |
Public Member Functions inherited from XBeeResponse | |
| XBeeResponse () | |
| Default constructor. More... | |
| uint8_t | getApiId () |
| Returns Api Id of the response. | |
| void | setApiId (uint8_t apiId) |
| uint8_t | getMsbLength () |
| Returns the MSB length of the packet. | |
| void | setMsbLength (uint8_t msbLength) |
| uint8_t | getLsbLength () |
| Returns the LSB length of the packet. | |
| void | setLsbLength (uint8_t lsbLength) |
| uint8_t | getChecksum () |
| Returns the packet checksum. | |
| void | setChecksum (uint8_t checksum) |
| uint8_t | getFrameDataLength () |
| Returns the length of the frame data: all bytes after the api id, and prior to the checksum Note up to release 0.1.2, this was incorrectly including the checksum in the length. | |
| void | setFrameData (uint8_t *frameDataPtr) |
| uint8_t * | getFrameData () |
| Returns the buffer that contains the response. More... | |
| void | setFrameLength (uint8_t frameLength) |
| uint16_t | getPacketLength () |
| Returns the length of the packet. | |
| void | reset () |
| Resets the response to default values. | |
| void | init () |
| Initializes the response. | |
| void | getZBTxStatusResponse (XBeeResponse &response) |
| Call with instance of ZBTxStatusResponse class only if getApiId() == ZB_TX_STATUS_RESPONSE to populate response. | |
| void | getZBRxResponse (XBeeResponse &response) |
| Call with instance of ZBRxResponse class only if getApiId() == ZB_RX_RESPONSE to populate response. | |
| void | getZBRxIoSampleResponse (XBeeResponse &response) |
| Call with instance of ZBRxIoSampleResponse class only if getApiId() == ZB_IO_SAMPLE_RESPONSE to populate response. | |
| void | getTxStatusResponse (XBeeResponse &response) |
| Call with instance of TxStatusResponse only if getApiId() == TX_STATUS_RESPONSE. | |
| void | getRx16Response (XBeeResponse &response) |
| Call with instance of Rx16Response only if getApiId() == RX_16_RESPONSE. | |
| void | getRx64Response (XBeeResponse &response) |
| Call with instance of Rx64Response only if getApiId() == RX_64_RESPONSE. | |
| void | getRx16IoSampleResponse (XBeeResponse &response) |
| Call with instance of Rx16IoSampleResponse only if getApiId() == RX_16_IO_RESPONSE. | |
| void | getRx64IoSampleResponse (XBeeResponse &response) |
| Call with instance of Rx64IoSampleResponse only if getApiId() == RX_64_IO_RESPONSE. | |
| void | getAtCommandResponse (XBeeResponse &responses) |
| Call with instance of AtCommandResponse only if getApiId() == AT_COMMAND_RESPONSE. | |
| void | getRemoteAtCommandResponse (XBeeResponse &response) |
| Call with instance of RemoteAtCommandResponse only if getApiId() == REMOTE_AT_COMMAND_RESPONSE. | |
| void | getModemStatusResponse (XBeeResponse &response) |
| Call with instance of ModemStatusResponse only if getApiId() == MODEM_STATUS_RESPONSE. | |
| bool | isAvailable () |
| Returns true if the response has been successfully parsed and is complete and ready for use. | |
| void | setAvailable (bool complete) |
| bool | isError () |
| Returns true if the response contains errors. | |
| uint8_t | getErrorCode () |
| Returns an error code, or zero, if successful. More... | |
| void | setErrorCode (uint8_t errorCode) |
Additional Inherited Members | |
Protected Attributes inherited from XBeeResponse | |
| uint8_t * | _frameDataPtr |
Represents an AT Command RX packet.
| uint8_t AtCommandResponse::getStatus | ( | ) |
Returns the command status code.
Zero represents a successful command
| uint8_t * AtCommandResponse::getValue | ( | ) |
Returns an array containing the command value.
This is only applicable to query commands.
1.8.6