PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/drivers/AnalogIn.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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