Steve Kim / mbed-src

mbed library sources(for async_print)

Dependents:   AsyncPrint

Fork of mbed-src by mbed official

api/AnalogIn.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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