kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

AnalogIn.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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