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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
170:e95d10626187
Release 155 of the mbed library.

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