Jhon Plantikow / Dataloger

Dataloger

AnalogIn.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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