zhang boie / mbed-dev-f30333

mbed-dev-f303

drivers/AnalogIn.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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