LSE_PUCRS / XBeeLib

Xbee s2b for lpc11u24

Dependencies:   DigiLogger

Dependents:  

Fork of XBeeLib by Digi International Inc.

IO/IOSampleZB.h@0:fcaad0dfa051, 2015-05-08 (annotated)

Committer:
spastor
Date:
Fri May 08 11:50:56 2015 +0200
Revision:
0:fcaad0dfa051
Child:
3:8662ebe83570
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
spastor 0:fcaad0dfa051 1 /**
spastor 0:fcaad0dfa051 2 * Digi XBee library for mbed. This is the only header you have to include from your application to use the library.
spastor 0:fcaad0dfa051 3 *
spastor 0:fcaad0dfa051 4 * Copyright (c) 2015 Digi International Inc.,
spastor 0:fcaad0dfa051 5 * All rights not expressly granted are reserved.
spastor 0:fcaad0dfa051 6 *
spastor 0:fcaad0dfa051 7 * This Source Code Form is subject to the terms of the Mozilla Public
spastor 0:fcaad0dfa051 8 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
spastor 0:fcaad0dfa051 9 * You can obtain one at http://mozilla.org/MPL/2.0/.
spastor 0:fcaad0dfa051 10 *
spastor 0:fcaad0dfa051 11 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343.
spastor 0:fcaad0dfa051 12 */
spastor 0:fcaad0dfa051 13
spastor 0:fcaad0dfa051 14 #ifndef _IO_IOSAMPLEZB_H_
spastor 0:fcaad0dfa051 15 #define _IO_IOSAMPLEZB_H_
spastor 0:fcaad0dfa051 16
spastor 0:fcaad0dfa051 17 #define MAX_IO_SAMPLE_ZB_LEN (2 + 2 * 5)
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 namespace XBeeLib {
spastor 0:fcaad0dfa051 20
spastor 0:fcaad0dfa051 21 /** Class to handle the incoming IO Data Samples in ZigBee modules */
spastor 0:fcaad0dfa051 22 class IOSampleZB {
spastor 0:fcaad0dfa051 23 public:
spastor 0:fcaad0dfa051 24 /** Class constructor
spastor 0:fcaad0dfa051 25 * @param raw_data The IO Sample data, as returned by an "IS" command response or in the IoSampleRxZB (0x92) frames
spastor 0:fcaad0dfa051 26 * @param size size (in bytes) of raw_data.
spastor 0:fcaad0dfa051 27 */
spastor 0:fcaad0dfa051 28 IOSampleZB(const uint8_t* const raw_data, size_t size);
spastor 0:fcaad0dfa051 29
spastor 0:fcaad0dfa051 30 /** Class destructor */
spastor 0:fcaad0dfa051 31 ~IOSampleZB();
spastor 0:fcaad0dfa051 32
spastor 0:fcaad0dfa051 33 /** get_dio - read the value of a DIO configured as digital input
spastor 0:fcaad0dfa051 34 *
spastor 0:fcaad0dfa051 35 * @param line DIO line being read
spastor 0:fcaad0dfa051 36 * @param val pointer where the DIO value read will be stored
spastor 0:fcaad0dfa051 37 * @returns
spastor 0:fcaad0dfa051 38 * Success if the operation was successful,
spastor 0:fcaad0dfa051 39 * Failure otherwise
spastor 0:fcaad0dfa051 40 */
spastor 0:fcaad0dfa051 41 RadioStatus get_dio(XBeeZB::IoLine line, DioVal* const dio_value) const;
spastor 0:fcaad0dfa051 42
spastor 0:fcaad0dfa051 43 /** get_adc - read the value of the espcified ADC line
spastor 0:fcaad0dfa051 44 *
spastor 0:fcaad0dfa051 45 * @param line ADC line being read
spastor 0:fcaad0dfa051 46 * @param val pointer where the value read from the ADC will be stored
spastor 0:fcaad0dfa051 47 * @returns
spastor 0:fcaad0dfa051 48 * Success if the operation was successful,
spastor 0:fcaad0dfa051 49 * Failure otherwise
spastor 0:fcaad0dfa051 50 */
spastor 0:fcaad0dfa051 51 RadioStatus get_adc(XBeeZB::IoLine line, uint16_t* const val) const;
spastor 0:fcaad0dfa051 52
spastor 0:fcaad0dfa051 53 protected:
spastor 0:fcaad0dfa051 54 uint16_t _digital_mask;
spastor 0:fcaad0dfa051 55 uint8_t _analog_mask;
spastor 0:fcaad0dfa051 56 uint8_t _sampled_data[MAX_IO_SAMPLE_ZB_LEN];
spastor 0:fcaad0dfa051 57 uint8_t _sampled_data_size;
spastor 0:fcaad0dfa051 58
spastor 0:fcaad0dfa051 59 inline uint16_t get_digital_channels(void) const;
spastor 0:fcaad0dfa051 60 };
spastor 0:fcaad0dfa051 61
spastor 0:fcaad0dfa051 62 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 63
spastor 0:fcaad0dfa051 64 #endif /* _IO_IOSAMPLEZB_H_ */