mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/AnalogIn.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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