Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/AnalogIn.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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