EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/AnalogIn.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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