vghjvghi
Fork of XBeeLib3 by
IO/IOSampleDM.h@11:d7dc0e97d47e, 2017-12-05 (annotated)
- Committer:
- vinceP
- Date:
- Tue Dec 05 22:03:15 2017 +0000
- Revision:
- 11:d7dc0e97d47e
- Parent:
- 6:06522f3a6642
Ok
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
hbujanda | 6:06522f3a6642 | 1 | /** |
hbujanda | 6:06522f3a6642 | 2 | * Copyright (c) 2015 Digi International Inc., |
hbujanda | 6:06522f3a6642 | 3 | * All rights not expressly granted are reserved. |
hbujanda | 6:06522f3a6642 | 4 | * |
hbujanda | 6:06522f3a6642 | 5 | * This Source Code Form is subject to the terms of the Mozilla Public |
hbujanda | 6:06522f3a6642 | 6 | * License, v. 2.0. If a copy of the MPL was not distributed with this file, |
hbujanda | 6:06522f3a6642 | 7 | * You can obtain one at http://mozilla.org/MPL/2.0/. |
hbujanda | 6:06522f3a6642 | 8 | * |
hbujanda | 6:06522f3a6642 | 9 | * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 |
hbujanda | 6:06522f3a6642 | 10 | * ======================================================================= |
hbujanda | 6:06522f3a6642 | 11 | */ |
hbujanda | 6:06522f3a6642 | 12 | |
hbujanda | 6:06522f3a6642 | 13 | #ifndef _IO_IOSAMPLEDM_H_ |
hbujanda | 6:06522f3a6642 | 14 | #define _IO_IOSAMPLEDM_H_ |
hbujanda | 6:06522f3a6642 | 15 | |
hbujanda | 6:06522f3a6642 | 16 | #define MAX_IO_SAMPLE_DM_LEN (2 + 2 * 5) |
hbujanda | 6:06522f3a6642 | 17 | |
hbujanda | 6:06522f3a6642 | 18 | namespace XBeeLib { |
hbujanda | 6:06522f3a6642 | 19 | |
hbujanda | 6:06522f3a6642 | 20 | /** Class to handle the incoming IO Data Samples in ZigBee modules */ |
hbujanda | 6:06522f3a6642 | 21 | class IOSampleDM { |
hbujanda | 6:06522f3a6642 | 22 | public: |
hbujanda | 6:06522f3a6642 | 23 | /** Class constructor |
hbujanda | 6:06522f3a6642 | 24 | * @param raw_data The IO Sample data, as returned by an "IS" command response or in the IoSampleRxZBDM (0x92) frames |
hbujanda | 6:06522f3a6642 | 25 | * @param size size (in bytes) of raw_data. |
hbujanda | 6:06522f3a6642 | 26 | */ |
hbujanda | 6:06522f3a6642 | 27 | IOSampleDM(const uint8_t* const raw_data = NULL, size_t size = 0); |
hbujanda | 6:06522f3a6642 | 28 | |
hbujanda | 6:06522f3a6642 | 29 | /** Class destructor */ |
hbujanda | 6:06522f3a6642 | 30 | ~IOSampleDM(); |
hbujanda | 6:06522f3a6642 | 31 | |
hbujanda | 6:06522f3a6642 | 32 | /** get_dio - read the value of a DIO configured as digital input |
hbujanda | 6:06522f3a6642 | 33 | * |
hbujanda | 6:06522f3a6642 | 34 | * @param line DIO line being read |
hbujanda | 6:06522f3a6642 | 35 | * @param val pointer where the DIO value read will be stored |
hbujanda | 6:06522f3a6642 | 36 | * @returns |
hbujanda | 6:06522f3a6642 | 37 | * Success if the operation was successful, |
hbujanda | 6:06522f3a6642 | 38 | * Failure otherwise |
hbujanda | 6:06522f3a6642 | 39 | */ |
hbujanda | 6:06522f3a6642 | 40 | RadioStatus get_dio(XBeeDM::IoLine line, DioVal* const dio_value) const; |
hbujanda | 6:06522f3a6642 | 41 | |
hbujanda | 6:06522f3a6642 | 42 | /** get_adc - read the value of the espcified ADC line |
hbujanda | 6:06522f3a6642 | 43 | * |
hbujanda | 6:06522f3a6642 | 44 | * @param line ADC line being read |
hbujanda | 6:06522f3a6642 | 45 | * @param val pointer where the value read from the ADC will be stored |
hbujanda | 6:06522f3a6642 | 46 | * @returns |
hbujanda | 6:06522f3a6642 | 47 | * Success if the operation was successful, |
hbujanda | 6:06522f3a6642 | 48 | * Failure otherwise |
hbujanda | 6:06522f3a6642 | 49 | */ |
hbujanda | 6:06522f3a6642 | 50 | RadioStatus get_adc(XBeeDM::IoLine line, uint16_t* const val) const; |
hbujanda | 6:06522f3a6642 | 51 | |
hbujanda | 6:06522f3a6642 | 52 | /** is_valid - checks if the IOSampleDM object has at least one DIO or ADC sample. |
hbujanda | 6:06522f3a6642 | 53 | * @returns true if valid, false otherwise |
hbujanda | 6:06522f3a6642 | 54 | */ |
hbujanda | 6:06522f3a6642 | 55 | inline bool is_valid() |
hbujanda | 6:06522f3a6642 | 56 | { |
hbujanda | 6:06522f3a6642 | 57 | return _digital_mask != 0 || _analog_mask != 0; |
hbujanda | 6:06522f3a6642 | 58 | } |
hbujanda | 6:06522f3a6642 | 59 | |
hbujanda | 6:06522f3a6642 | 60 | protected: |
hbujanda | 6:06522f3a6642 | 61 | uint16_t _digital_mask; |
hbujanda | 6:06522f3a6642 | 62 | uint8_t _analog_mask; |
hbujanda | 6:06522f3a6642 | 63 | uint8_t _sampled_data[MAX_IO_SAMPLE_DM_LEN]; |
hbujanda | 6:06522f3a6642 | 64 | uint8_t _sampled_data_size; |
hbujanda | 6:06522f3a6642 | 65 | |
hbujanda | 6:06522f3a6642 | 66 | inline uint16_t get_digital_channels(void) const; |
hbujanda | 6:06522f3a6642 | 67 | }; |
hbujanda | 6:06522f3a6642 | 68 | |
hbujanda | 6:06522f3a6642 | 69 | } /* namespace XBeeLib */ |
hbujanda | 6:06522f3a6642 | 70 | |
hbujanda | 6:06522f3a6642 | 71 | #endif /* _IO_IOSAMPLEDM_H_ */ |