mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

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

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

Who changed what in which revision?

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