Sukkin Pang / mbed-dev-bin

Initial release

Fork of mbed-dev-bin by Lancaster University

AnalogIn.h@4:85cbef757caa, 2016-09-29 (annotated)

Committer:
pangsk
Date:
Thu Sep 29 15:33:10 2016 +0000
Revision:
4:85cbef757caa
Parent:
0:e1a608bb55e8 
Initial release

Who changed what in which revision?

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