Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/AnalogIn.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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