Rahul Dahiya / Mbed OS STM32F7 Ethernet

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:fb8047b156bb, 2020-01-15 (annotated)

Committer:
rahul_dahiya
Date:
Wed Jan 15 15:57:15 2020 +0530
Revision:
0:fb8047b156bb
STM32F7 LWIP

Who changed what in which revision?

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