Fawwaz Nadzmy / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/AnalogIn.h@636:de8f3520e5c1, 2016-12-21 (annotated)

Committer:
fwndz
Date:
Wed Dec 21 12:47:52 2016 +0000
Revision:
636:de8f3520e5c1
Parent:
13:0645d8841f51 
init

Who changed what in which revision?

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