XBee modules

Dependencies:   DigiLogger

Fork of XBeeLib by Digi International Inc.

Embed: (wiki syntax)

« Back to documentation index

IOSample802 Class Reference

IOSample802 Class Reference

Class to handle the incoming IO Data Samples in 802.15.4 modules. More...

#include <IOSample802.h>

Public Member Functions

 IOSample802 (const uint8_t *const raw_data=NULL, size_t size=0)
 Class constructor.
 ~IOSample802 ()
 Class destructor.
RadioStatus get_dio (XBee802::IoLine line, DioVal *const dio_value) const
 get_dio - read the value of a DIO configured as digital input
RadioStatus get_adc (XBee802::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 IOSample802 object has at least one DIO or ADC sample.

Detailed Description

Class to handle the incoming IO Data Samples in 802.15.4 modules.

Definition at line 21 of file IOSample802.h.


Constructor & Destructor Documentation

IOSample802 ( const uint8_t *const   raw_data = NULL,
size_t  size = 0 
)

Class constructor.

Parameters:
raw_dataThe IO Sample data, as returned by an "IS" command response or in the Io16Bit (0x83) or Io64Bit (0x82) frames
sizesize (in bytes) of raw_data

Definition at line 23 of file IOSample802.cpp.

~IOSample802 (  )

Class destructor.

Definition at line 37 of file IOSample802.cpp.


Member Function Documentation

RadioStatus get_adc ( XBee802::IoLine  line,
uint16_t *const   val 
) const

get_adc - read the value of the espcified ADC line

Parameters:
lineADC line being read
valpointer where the value read from the ADC will be stored
Returns:
Success if the operation was successful, Failure otherwise

Definition at line 59 of file IOSample802.cpp.

RadioStatus get_dio ( XBee802::IoLine  line,
DioVal *const   dio_value 
) const

get_dio - read the value of a DIO configured as digital input

Parameters:
lineDIO line being read
valpointer where the DIO value read will be stored
Returns:
Success if the operation was successful, Failure otherwise

Definition at line 42 of file IOSample802.cpp.

bool is_valid (  )

is_valid - checks if the IOSample802 object has at least one DIO or ADC sample.

Returns:
true if valid, false otherwise

Definition at line 55 of file IOSample802.h.