Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/AnalogIn.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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