changes to communication
Fork of XBeeLib by
IOSampleZB Class Reference
Class to handle the incoming IO Data Samples in ZigBee modules. More...
#include <IOSampleZB.h>
Public Member Functions | |
IOSampleZB (const uint8_t *const raw_data=NULL, size_t size=0) | |
Class constructor. | |
~IOSampleZB () | |
Class destructor. | |
RadioStatus | get_dio (XBeeZB::IoLine line, DioVal *const dio_value) const |
get_dio - read the value of a DIO configured as digital input | |
RadioStatus | get_adc (XBeeZB::IoLine line, uint16_t *const val) const |
get_adc - read the value of the espcified ADC line | |
bool | is_valid () |
is_valid - checks if the IOSampleZB object has at least one DIO or ADC sample. |
Detailed Description
Class to handle the incoming IO Data Samples in ZigBee modules.
Definition at line 21 of file IOSampleZB.h.
Constructor & Destructor Documentation
IOSampleZB | ( | const uint8_t *const | raw_data = NULL , |
size_t | size = 0 |
||
) |
Class constructor.
- Parameters:
-
raw_data The IO Sample data, as returned by an "IS" command response or in the IoSampleRxZBDM (0x92) frames size size (in bytes) of raw_data.
Definition at line 20 of file IOSampleZB.cpp.
~IOSampleZB | ( | ) |
Class destructor.
Definition at line 36 of file IOSampleZB.cpp.
Member Function Documentation
RadioStatus get_adc | ( | XBeeZB::IoLine | line, |
uint16_t *const | val | ||
) | const |
get_adc - read the value of the espcified ADC line
- Parameters:
-
line ADC line being read val pointer where the value read from the ADC will be stored
- Returns:
- Success if the operation was successful, Failure otherwise
Definition at line 53 of file IOSampleZB.cpp.
RadioStatus get_dio | ( | XBeeZB::IoLine | line, |
DioVal *const | dio_value | ||
) | const |
get_dio - read the value of a DIO configured as digital input
- Parameters:
-
line DIO line being read val pointer where the DIO value read will be stored
- Returns:
- Success if the operation was successful, Failure otherwise
Definition at line 41 of file IOSampleZB.cpp.
bool is_valid | ( | ) |
is_valid - checks if the IOSampleZB object has at least one DIO or ADC sample.
- Returns:
- true if valid, false otherwise
Definition at line 55 of file IOSampleZB.h.
Generated on Tue Jul 12 2022 17:33:34 by 1.7.2