Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/AnalogIn.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

Who changed what in which revision?

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