First Last / mbed-src

mbed library sources

Fork of mbed-src by mbed official

cpp/AnalogIn.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_ANALOGIN_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_ANALOGIN_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_ANALOGIN
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #include "analogin_api.h"
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 /** An analog input, used for reading the voltage on a pin
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * Example:
mbed_official 0:fd0d7bdfcdc2 36 * @code
mbed_official 0:fd0d7bdfcdc2 37 * // Print messages when the AnalogIn is greater than 50%
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 40 *
mbed_official 0:fd0d7bdfcdc2 41 * AnalogIn temperature(p20);
mbed_official 0:fd0d7bdfcdc2 42 *
mbed_official 0:fd0d7bdfcdc2 43 * int main() {
mbed_official 0:fd0d7bdfcdc2 44 * while(1) {
mbed_official 0:fd0d7bdfcdc2 45 * if(temperature > 0.5) {
mbed_official 0:fd0d7bdfcdc2 46 * printf("Too hot! (%f)", temperature.read());
mbed_official 0:fd0d7bdfcdc2 47 * }
mbed_official 0:fd0d7bdfcdc2 48 * }
mbed_official 0:fd0d7bdfcdc2 49 * }
mbed_official 0:fd0d7bdfcdc2 50 * @endcode
mbed_official 0:fd0d7bdfcdc2 51 */
mbed_official 0:fd0d7bdfcdc2 52 class AnalogIn {
mbed_official 0:fd0d7bdfcdc2 53
mbed_official 0:fd0d7bdfcdc2 54 public:
mbed_official 0:fd0d7bdfcdc2 55
mbed_official 0:fd0d7bdfcdc2 56 /** Create an AnalogIn, connected to the specified pin
mbed_official 0:fd0d7bdfcdc2 57 *
mbed_official 0:fd0d7bdfcdc2 58 * @param pin AnalogIn pin to connect to
mbed_official 0:fd0d7bdfcdc2 59 * @param name (optional) A string to identify the object
mbed_official 0:fd0d7bdfcdc2 60 */
mbed_official 0:fd0d7bdfcdc2 61 AnalogIn(PinName pin) {
mbed_official 0:fd0d7bdfcdc2 62 analogin_init(&_adc, pin);
mbed_official 0:fd0d7bdfcdc2 63 }
mbed_official 0:fd0d7bdfcdc2 64
mbed_official 0:fd0d7bdfcdc2 65 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
mbed_official 0:fd0d7bdfcdc2 66 *
mbed_official 0:fd0d7bdfcdc2 67 * @returns A floating-point value representing the current input voltage, measured as a percentage
mbed_official 0:fd0d7bdfcdc2 68 */
mbed_official 0:fd0d7bdfcdc2 69 float read() {
mbed_official 0:fd0d7bdfcdc2 70 return analogin_read(&_adc);
mbed_official 0:fd0d7bdfcdc2 71 }
mbed_official 0:fd0d7bdfcdc2 72
mbed_official 0:fd0d7bdfcdc2 73 /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
mbed_official 0:fd0d7bdfcdc2 74 *
mbed_official 0:fd0d7bdfcdc2 75 * @returns
mbed_official 0:fd0d7bdfcdc2 76 * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
mbed_official 0:fd0d7bdfcdc2 77 */
mbed_official 0:fd0d7bdfcdc2 78 unsigned short read_u16() {
mbed_official 0:fd0d7bdfcdc2 79 return analogin_read_u16(&_adc);
mbed_official 0:fd0d7bdfcdc2 80 }
mbed_official 0:fd0d7bdfcdc2 81
mbed_official 0:fd0d7bdfcdc2 82 #ifdef MBED_OPERATORS
mbed_official 0:fd0d7bdfcdc2 83 /** An operator shorthand for read()
mbed_official 0:fd0d7bdfcdc2 84 *
mbed_official 0:fd0d7bdfcdc2 85 * The float() operator can be used as a shorthand for read() to simplify common code sequences
mbed_official 0:fd0d7bdfcdc2 86 *
mbed_official 0:fd0d7bdfcdc2 87 * Example:
mbed_official 0:fd0d7bdfcdc2 88 * @code
mbed_official 0:fd0d7bdfcdc2 89 * float x = volume.read();
mbed_official 0:fd0d7bdfcdc2 90 * float x = volume;
mbed_official 0:fd0d7bdfcdc2 91 *
mbed_official 0:fd0d7bdfcdc2 92 * if(volume.read() > 0.25) { ... }
mbed_official 0:fd0d7bdfcdc2 93 * if(volume > 0.25) { ... }
mbed_official 0:fd0d7bdfcdc2 94 * @endcode
mbed_official 0:fd0d7bdfcdc2 95 */
mbed_official 0:fd0d7bdfcdc2 96 operator float() {
mbed_official 0:fd0d7bdfcdc2 97 return read();
mbed_official 0:fd0d7bdfcdc2 98 }
mbed_official 0:fd0d7bdfcdc2 99 #endif
mbed_official 0:fd0d7bdfcdc2 100
mbed_official 0:fd0d7bdfcdc2 101 protected:
mbed_official 0:fd0d7bdfcdc2 102 analogin_t _adc;
mbed_official 0:fd0d7bdfcdc2 103 };
mbed_official 0:fd0d7bdfcdc2 104
mbed_official 0:fd0d7bdfcdc2 105 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 106
mbed_official 0:fd0d7bdfcdc2 107 #endif
mbed_official 0:fd0d7bdfcdc2 108
mbed_official 0:fd0d7bdfcdc2 109 #endif