nguyen nam / SRC_STM32F7

SPKT

Dependents:   Player

api/AnalogIn.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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