Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

AnalogIn.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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