Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/AnalogIn.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dgabino 0:c76361bd82e8 1 /* mbed Microcontroller Library
dgabino 0:c76361bd82e8 2 * Copyright (c) 2006-2013 ARM Limited
dgabino 0:c76361bd82e8 3 *
dgabino 0:c76361bd82e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
dgabino 0:c76361bd82e8 5 * you may not use this file except in compliance with the License.
dgabino 0:c76361bd82e8 6 * You may obtain a copy of the License at
dgabino 0:c76361bd82e8 7 *
dgabino 0:c76361bd82e8 8 * http://www.apache.org/licenses/LICENSE-2.0
dgabino 0:c76361bd82e8 9 *
dgabino 0:c76361bd82e8 10 * Unless required by applicable law or agreed to in writing, software
dgabino 0:c76361bd82e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
dgabino 0:c76361bd82e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dgabino 0:c76361bd82e8 13 * See the License for the specific language governing permissions and
dgabino 0:c76361bd82e8 14 * limitations under the License.
dgabino 0:c76361bd82e8 15 */
dgabino 0:c76361bd82e8 16 #ifndef MBED_ANALOGIN_H
dgabino 0:c76361bd82e8 17 #define MBED_ANALOGIN_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include "platform.h"
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #if DEVICE_ANALOGIN
dgabino 0:c76361bd82e8 22
dgabino 0:c76361bd82e8 23 #include "analogin_api.h"
dgabino 0:c76361bd82e8 24 #include "SingletonPtr.h"
dgabino 0:c76361bd82e8 25 #include "PlatformMutex.h"
dgabino 0:c76361bd82e8 26
dgabino 0:c76361bd82e8 27 namespace mbed {
dgabino 0:c76361bd82e8 28
dgabino 0:c76361bd82e8 29 /** An analog input, used for reading the voltage on a pin
dgabino 0:c76361bd82e8 30 *
dgabino 0:c76361bd82e8 31 * @Note Synchronization level: Thread safe
dgabino 0:c76361bd82e8 32 *
dgabino 0:c76361bd82e8 33 * Example:
dgabino 0:c76361bd82e8 34 * @code
dgabino 0:c76361bd82e8 35 * // Print messages when the AnalogIn is greater than 50%
dgabino 0:c76361bd82e8 36 *
dgabino 0:c76361bd82e8 37 * #include "mbed.h"
dgabino 0:c76361bd82e8 38 *
dgabino 0:c76361bd82e8 39 * AnalogIn temperature(p20);
dgabino 0:c76361bd82e8 40 *
dgabino 0:c76361bd82e8 41 * int main() {
dgabino 0:c76361bd82e8 42 * while(1) {
dgabino 0:c76361bd82e8 43 * if(temperature > 0.5) {
dgabino 0:c76361bd82e8 44 * printf("Too hot! (%f)", temperature.read());
dgabino 0:c76361bd82e8 45 * }
dgabino 0:c76361bd82e8 46 * }
dgabino 0:c76361bd82e8 47 * }
dgabino 0:c76361bd82e8 48 * @endcode
dgabino 0:c76361bd82e8 49 */
dgabino 0:c76361bd82e8 50 class AnalogIn {
dgabino 0:c76361bd82e8 51
dgabino 0:c76361bd82e8 52 public:
dgabino 0:c76361bd82e8 53
dgabino 0:c76361bd82e8 54 /** Create an AnalogIn, connected to the specified pin
dgabino 0:c76361bd82e8 55 *
dgabino 0:c76361bd82e8 56 * @param pin AnalogIn pin to connect to
dgabino 0:c76361bd82e8 57 * @param name (optional) A string to identify the object
dgabino 0:c76361bd82e8 58 */
dgabino 0:c76361bd82e8 59 AnalogIn(PinName pin) {
dgabino 0:c76361bd82e8 60 lock();
dgabino 0:c76361bd82e8 61 analogin_init(&_adc, pin);
dgabino 0:c76361bd82e8 62 unlock();
dgabino 0:c76361bd82e8 63 }
dgabino 0:c76361bd82e8 64
dgabino 0:c76361bd82e8 65 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
dgabino 0:c76361bd82e8 66 *
dgabino 0:c76361bd82e8 67 * @returns A floating-point value representing the current input voltage, measured as a percentage
dgabino 0:c76361bd82e8 68 */
dgabino 0:c76361bd82e8 69 float read() {
dgabino 0:c76361bd82e8 70 lock();
dgabino 0:c76361bd82e8 71 float ret = analogin_read(&_adc);
dgabino 0:c76361bd82e8 72 unlock();
dgabino 0:c76361bd82e8 73 return ret;
dgabino 0:c76361bd82e8 74 }
dgabino 0:c76361bd82e8 75
dgabino 0:c76361bd82e8 76 /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
dgabino 0:c76361bd82e8 77 *
dgabino 0:c76361bd82e8 78 * @returns
dgabino 0:c76361bd82e8 79 * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
dgabino 0:c76361bd82e8 80 */
dgabino 0:c76361bd82e8 81 unsigned short read_u16() {
dgabino 0:c76361bd82e8 82 lock();
dgabino 0:c76361bd82e8 83 unsigned short ret = analogin_read_u16(&_adc);
dgabino 0:c76361bd82e8 84 unlock();
dgabino 0:c76361bd82e8 85 return ret;
dgabino 0:c76361bd82e8 86 }
dgabino 0:c76361bd82e8 87
dgabino 0:c76361bd82e8 88 /** An operator shorthand for read()
dgabino 0:c76361bd82e8 89 *
dgabino 0:c76361bd82e8 90 * The float() operator can be used as a shorthand for read() to simplify common code sequences
dgabino 0:c76361bd82e8 91 *
dgabino 0:c76361bd82e8 92 * Example:
dgabino 0:c76361bd82e8 93 * @code
dgabino 0:c76361bd82e8 94 * float x = volume.read();
dgabino 0:c76361bd82e8 95 * float x = volume;
dgabino 0:c76361bd82e8 96 *
dgabino 0:c76361bd82e8 97 * if(volume.read() > 0.25) { ... }
dgabino 0:c76361bd82e8 98 * if(volume > 0.25) { ... }
dgabino 0:c76361bd82e8 99 * @endcode
dgabino 0:c76361bd82e8 100 */
dgabino 0:c76361bd82e8 101 operator float() {
dgabino 0:c76361bd82e8 102 // Underlying call is thread safe
dgabino 0:c76361bd82e8 103 return read();
dgabino 0:c76361bd82e8 104 }
dgabino 0:c76361bd82e8 105
dgabino 0:c76361bd82e8 106 virtual ~AnalogIn() {
dgabino 0:c76361bd82e8 107 // Do nothing
dgabino 0:c76361bd82e8 108 }
dgabino 0:c76361bd82e8 109
dgabino 0:c76361bd82e8 110 protected:
dgabino 0:c76361bd82e8 111
dgabino 0:c76361bd82e8 112 virtual void lock() {
dgabino 0:c76361bd82e8 113 _mutex->lock();
dgabino 0:c76361bd82e8 114 }
dgabino 0:c76361bd82e8 115
dgabino 0:c76361bd82e8 116 virtual void unlock() {
dgabino 0:c76361bd82e8 117 _mutex->unlock();
dgabino 0:c76361bd82e8 118 }
dgabino 0:c76361bd82e8 119
dgabino 0:c76361bd82e8 120 analogin_t _adc;
dgabino 0:c76361bd82e8 121 static SingletonPtr<PlatformMutex> _mutex;
dgabino 0:c76361bd82e8 122 };
dgabino 0:c76361bd82e8 123
dgabino 0:c76361bd82e8 124 } // namespace mbed
dgabino 0:c76361bd82e8 125
dgabino 0:c76361bd82e8 126 #endif
dgabino 0:c76361bd82e8 127
dgabino 0:c76361bd82e8 128 #endif