mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/drivers/AnalogIn.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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