Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

AnalogIn.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
65:5798e58a58b1 
dgdgr

Who changed what in which revision?

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