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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/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 *
ommpy 0:d383e2dee0f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 5 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 6 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 9 *
ommpy 0:d383e2dee0f7 10 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 13 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 14 * limitations under the License.
ommpy 0:d383e2dee0f7 15 */
ommpy 0:d383e2dee0f7 16 #ifndef MBED_ANALOGIN_H
ommpy 0:d383e2dee0f7 17 #define MBED_ANALOGIN_H
ommpy 0:d383e2dee0f7 18
ommpy 0:d383e2dee0f7 19 #include "platform.h"
ommpy 0:d383e2dee0f7 20
ommpy 0:d383e2dee0f7 21 #if DEVICE_ANALOGIN
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #include "analogin_api.h"
ommpy 0:d383e2dee0f7 24
ommpy 0:d383e2dee0f7 25 namespace mbed {
ommpy 0:d383e2dee0f7 26
ommpy 0:d383e2dee0f7 27 /** An analog input, used for reading the voltage on a pin
ommpy 0:d383e2dee0f7 28 *
ommpy 0:d383e2dee0f7 29 * Example:
ommpy 0:d383e2dee0f7 30 * @code
ommpy 0:d383e2dee0f7 31 * // Print messages when the AnalogIn is greater than 50%
ommpy 0:d383e2dee0f7 32 *
ommpy 0:d383e2dee0f7 33 * #include "mbed.h"
ommpy 0:d383e2dee0f7 34 *
ommpy 0:d383e2dee0f7 35 * AnalogIn temperature(p20);
ommpy 0:d383e2dee0f7 36 *
ommpy 0:d383e2dee0f7 37 * int main() {
ommpy 0:d383e2dee0f7 38 * while(1) {
ommpy 0:d383e2dee0f7 39 * if(temperature > 0.5) {
ommpy 0:d383e2dee0f7 40 * printf("Too hot! (%f)", temperature.read());
ommpy 0:d383e2dee0f7 41 * }
ommpy 0:d383e2dee0f7 42 * }
ommpy 0:d383e2dee0f7 43 * }
ommpy 0:d383e2dee0f7 44 * @endcode
ommpy 0:d383e2dee0f7 45 */
ommpy 0:d383e2dee0f7 46 class AnalogIn {
ommpy 0:d383e2dee0f7 47
ommpy 0:d383e2dee0f7 48 public:
ommpy 0:d383e2dee0f7 49
ommpy 0:d383e2dee0f7 50 /** Create an AnalogIn, connected to the specified pin
ommpy 0:d383e2dee0f7 51 *
ommpy 0:d383e2dee0f7 52 * @param pin AnalogIn pin to connect to
ommpy 0:d383e2dee0f7 53 * @param name (optional) A string to identify the object
ommpy 0:d383e2dee0f7 54 */
ommpy 0:d383e2dee0f7 55 AnalogIn(PinName pin) {
ommpy 0:d383e2dee0f7 56 analogin_init(&_adc, pin);
ommpy 0:d383e2dee0f7 57 }
ommpy 0:d383e2dee0f7 58
ommpy 0:d383e2dee0f7 59 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
ommpy 0:d383e2dee0f7 60 *
ommpy 0:d383e2dee0f7 61 * @returns A floating-point value representing the current input voltage, measured as a percentage
ommpy 0:d383e2dee0f7 62 */
ommpy 0:d383e2dee0f7 63 float read() {
ommpy 0:d383e2dee0f7 64 return analogin_read(&_adc);
ommpy 0:d383e2dee0f7 65 }
ommpy 0:d383e2dee0f7 66
ommpy 0:d383e2dee0f7 67 /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
ommpy 0:d383e2dee0f7 68 *
ommpy 0:d383e2dee0f7 69 * @returns
ommpy 0:d383e2dee0f7 70 * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
ommpy 0:d383e2dee0f7 71 */
ommpy 0:d383e2dee0f7 72 unsigned short read_u16() {
ommpy 0:d383e2dee0f7 73 return analogin_read_u16(&_adc);
ommpy 0:d383e2dee0f7 74 }
ommpy 0:d383e2dee0f7 75
ommpy 0:d383e2dee0f7 76 #ifdef MBED_OPERATORS
ommpy 0:d383e2dee0f7 77 /** An operator shorthand for read()
ommpy 0:d383e2dee0f7 78 *
ommpy 0:d383e2dee0f7 79 * The float() operator can be used as a shorthand for read() to simplify common code sequences
ommpy 0:d383e2dee0f7 80 *
ommpy 0:d383e2dee0f7 81 * Example:
ommpy 0:d383e2dee0f7 82 * @code
ommpy 0:d383e2dee0f7 83 * float x = volume.read();
ommpy 0:d383e2dee0f7 84 * float x = volume;
ommpy 0:d383e2dee0f7 85 *
ommpy 0:d383e2dee0f7 86 * if(volume.read() > 0.25) { ... }
ommpy 0:d383e2dee0f7 87 * if(volume > 0.25) { ... }
ommpy 0:d383e2dee0f7 88 * @endcode
ommpy 0:d383e2dee0f7 89 */
ommpy 0:d383e2dee0f7 90 operator float() {
ommpy 0:d383e2dee0f7 91 return read();
ommpy 0:d383e2dee0f7 92 }
ommpy 0:d383e2dee0f7 93 #endif
ommpy 0:d383e2dee0f7 94
ommpy 0:d383e2dee0f7 95 protected:
ommpy 0:d383e2dee0f7 96 analogin_t _adc;
ommpy 0:d383e2dee0f7 97 };
ommpy 0:d383e2dee0f7 98
ommpy 0:d383e2dee0f7 99 } // namespace mbed
ommpy 0:d383e2dee0f7 100
ommpy 0:d383e2dee0f7 101 #endif
ommpy 0:d383e2dee0f7 102
ommpy 0:d383e2dee0f7 103 #endif