Gan likun / mbed-dev

00

drivers/AnalogIn.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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