Yihui Xiong / BLE_NODE_TEST

Test code for Grove Node BLE

Dependencies:   BLE_API nRF51822

Fork of BLE_LoopbackUART by Bluetooth Low Energy

mbed-src/api/AnalogIn.h@10:22480ac31879, 2014-11-27 (annotated)

Committer:
yihui
Date:
Thu Nov 27 09:30:36 2014 +0000
Revision:
10:22480ac31879
Parent:
9:05f0b5a3a70a 
change to new revision hardware

Who changed what in which revision?

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