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