Gan likun / mbed-dev11

1232

drivers/AnalogIn.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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