PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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