Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

drivers/AnalogIn.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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