Jhon Plantikow / DHT11

DHT11

AnalogIn.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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