Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/AnalogIn.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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