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