Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/AnalogIn.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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