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
« Back to documentation index
RxIoSampleBaseResponse Class Reference
Represents a Series 1 RX I/O Sample packet.
More...
#include <XBee.h >
Inherits RxResponse .
Inherited by Rx16IoSampleResponse, and Rx64IoSampleResponse.
Detailed Description
Represents a Series 1 RX I/O Sample packet.
Definition at line 484 of file XBee.h .
Member Function Documentation
uint16_t getAnalog
(
uint8_t
pin ,
uint8_t
sample
)
Returns the 10-bit analog reading of the specified pin.
Valid pins include ADC:0-5. Sample index starts at 0
Definition at line 336 of file XBee.cpp .
uint8_t getApiId
(
)
[inherited]
Returns Api Id of the response.
Definition at line 40 of file XBee.cpp .
void getAtCommandResponse
(
XBeeResponse &
responses )
[inherited]
uint8_t getChecksum
(
)
[inherited]
Returns the packet checksum.
Definition at line 64 of file XBee.cpp .
uint8_t getData
(
int
index )
[inherited]
Returns the specified index of the payload.
The index may be 0 to getDataLength() - 1 This method is deprecated; use uint8_t* getData()
Definition at line 563 of file XBee.cpp .
uint8_t * getData
(
)
[inherited]
uint16_t getDataLength
(
)
[virtual, inherited]
uint8_t getDataOffset
(
)
[virtual, inherited]
Returns the position in the frame data where the data begins.
Implements RxDataResponse .
Definition at line 470 of file XBee.cpp .
uint8_t getErrorCode
(
)
[inherited]
Returns an error code, or zero, if successful.
Error codes include: CHECKSUM_FAILURE, PACKET_EXCEEDS_BYTE_ARRAY_LENGTH, UNEXPECTED_START_BYTE
Definition at line 92 of file XBee.cpp .
uint8_t * getFrameData
(
)
[inherited]
Returns the buffer that contains the response.
Starts with byte that follows API ID and includes all bytes prior to the checksum Length is specified by getFrameDataLength() Note: Unlike Digi's definition of the frame data, this does not start with the API ID.. The reason for this is all responses include an API ID, whereas my frame data includes only the API specific data.
Definition at line 640 of file XBee.cpp .
uint16_t getFrameDataLength
(
)
[inherited]
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.
Definition at line 72 of file XBee.cpp .
uint8_t getLsbLength
(
)
[inherited]
Returns the LSB length of the packet.
Definition at line 56 of file XBee.cpp .
void getModemStatusResponse
(
XBeeResponse &
response )
[inherited]
uint8_t getMsbLength
(
)
[inherited]
Returns the MSB length of the packet.
Definition at line 48 of file XBee.cpp .
uint16_t getPacketLength
(
)
[inherited]
Returns the length of the packet.
Definition at line 636 of file XBee.cpp .
void getRemoteAtCommandResponse
(
XBeeResponse &
response )
[inherited]
void getRx16IoSampleResponse
(
XBeeResponse &
response )
[inherited]
Call with instance of Rx16IoSampleResponse only if getApiId() == RX_16_IO_RESPONSE.
Definition at line 399 of file XBee.cpp .
void getRx16Response
(
XBeeResponse &
response )
[inherited]
void getRx64IoSampleResponse
(
XBeeResponse &
response )
[inherited]
Call with instance of Rx64IoSampleResponse only if getApiId() == RX_64_IO_RESPONSE.
Definition at line 419 of file XBee.cpp .
void getRx64Response
(
XBeeResponse &
response )
[inherited]
uint8_t getSampleSize
(
)
Returns the number of samples in this packet.
Definition at line 308 of file XBee.cpp .
void getTxStatusResponse
(
XBeeResponse &
response )
[inherited]
void getZBRxIoSampleResponse
(
XBeeResponse &
response )
[inherited]
void getZBRxResponse
(
XBeeResponse &
response )
[inherited]
void getZBTxStatusResponse
(
XBeeResponse &
response )
[inherited]
void init
(
)
[inherited]
Initializes the response.
Definition at line 648 of file XBee.cpp .
bool isAnalogEnabled
(
uint8_t
pin )
Returns true if the specified analog pin is enabled.
Definition at line 324 of file XBee.cpp .
bool isAvailable
(
)
[inherited]
Returns true if the response has been successfully parsed and is complete and ready for use.
Definition at line 80 of file XBee.cpp .
bool isDigitalEnabled
(
uint8_t
pin )
Returns true if the specified digital pin is enabled.
Definition at line 328 of file XBee.cpp .
bool isDigitalOn
(
uint8_t
pin ,
uint8_t
sample
)
Returns true if the specified pin is high/on.
Valid pins include DIO:0-8. Sample index starts at 0
Definition at line 374 of file XBee.cpp .
bool isError
(
)
[inherited]
Returns true if the response contains errors.
Definition at line 88 of file XBee.cpp .
void reset
(
)
[inherited]
Resets the response to default values.
Definition at line 654 of file XBee.cpp .