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@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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