my fork
Fork of mbed by
AnalogIn.h@54:71b101360fb9, 2013-01-08 (annotated)
- Committer:
- emilmont
- Date:
- Tue Jan 08 12:46:36 2013 +0000
- Revision:
- 54:71b101360fb9
- Parent:
- 44:24d45a770a51
- Child:
- 55:d722ed6a4237
Support "stream as file" use case
Unify binary libraries
Update copyright
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
emilmont | 44:24d45a770a51 | 1 | /* mbed Microcontroller Library |
emilmont | 54:71b101360fb9 | 2 | * Copyright (c) 2006-2013 ARM Limited |
emilmont | 44:24d45a770a51 | 3 | * |
emilmont | 44:24d45a770a51 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
emilmont | 44:24d45a770a51 | 5 | * of this software and associated documentation files (the "Software"), to deal |
emilmont | 44:24d45a770a51 | 6 | * in the Software without restriction, including without limitation the rights |
emilmont | 44:24d45a770a51 | 7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
emilmont | 44:24d45a770a51 | 8 | * copies of the Software, and to permit persons to whom the Software is |
emilmont | 44:24d45a770a51 | 9 | * furnished to do so, subject to the following conditions: |
emilmont | 44:24d45a770a51 | 10 | * |
emilmont | 44:24d45a770a51 | 11 | * The above copyright notice and this permission notice shall be included in |
emilmont | 44:24d45a770a51 | 12 | * all copies or substantial portions of the Software. |
emilmont | 44:24d45a770a51 | 13 | * |
emilmont | 44:24d45a770a51 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
emilmont | 44:24d45a770a51 | 15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
emilmont | 44:24d45a770a51 | 16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
emilmont | 44:24d45a770a51 | 17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
emilmont | 44:24d45a770a51 | 18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
emilmont | 44:24d45a770a51 | 19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
emilmont | 44:24d45a770a51 | 20 | * SOFTWARE. |
emilmont | 44:24d45a770a51 | 21 | */ |
simon.ford@mbed.co.uk | 0:82220227f4fa | 22 | #ifndef MBED_ANALOGIN_H |
simon.ford@mbed.co.uk | 0:82220227f4fa | 23 | #define MBED_ANALOGIN_H |
simon.ford@mbed.co.uk | 0:82220227f4fa | 24 | |
emilmont | 44:24d45a770a51 | 25 | #include "platform.h" |
emilmont | 27:7110ebee3484 | 26 | |
emilmont | 27:7110ebee3484 | 27 | #if DEVICE_ANALOGIN |
emilmont | 27:7110ebee3484 | 28 | |
emilmont | 44:24d45a770a51 | 29 | #include "analogin_api.h" |
simon.ford@mbed.co.uk | 0:82220227f4fa | 30 | |
simon.ford@mbed.co.uk | 0:82220227f4fa | 31 | namespace mbed { |
simon.ford@mbed.co.uk | 0:82220227f4fa | 32 | |
emilmont | 44:24d45a770a51 | 33 | /** An analog input, used for reading the voltage on a pin |
simon.ford@mbed.co.uk | 5:62573be585e9 | 34 | * |
simon.ford@mbed.co.uk | 5:62573be585e9 | 35 | * Example: |
emilmont | 43:e2ed12d17f06 | 36 | * @code |
emilmont | 43:e2ed12d17f06 | 37 | * // Print messages when the AnalogIn is greater than 50% |
emilmont | 43:e2ed12d17f06 | 38 | * |
emilmont | 43:e2ed12d17f06 | 39 | * #include "mbed.h" |
emilmont | 43:e2ed12d17f06 | 40 | * |
emilmont | 43:e2ed12d17f06 | 41 | * AnalogIn temperature(p20); |
emilmont | 43:e2ed12d17f06 | 42 | * |
emilmont | 43:e2ed12d17f06 | 43 | * int main() { |
emilmont | 43:e2ed12d17f06 | 44 | * while(1) { |
emilmont | 43:e2ed12d17f06 | 45 | * if(temperature > 0.5) { |
emilmont | 44:24d45a770a51 | 46 | * printf("Too hot! (%f)", temperature.read()); |
emilmont | 43:e2ed12d17f06 | 47 | * } |
emilmont | 43:e2ed12d17f06 | 48 | * } |
emilmont | 43:e2ed12d17f06 | 49 | * } |
emilmont | 43:e2ed12d17f06 | 50 | * @endcode |
simon.ford@mbed.co.uk | 0:82220227f4fa | 51 | */ |
emilmont | 44:24d45a770a51 | 52 | class AnalogIn { |
simon.ford@mbed.co.uk | 0:82220227f4fa | 53 | |
simon.ford@mbed.co.uk | 0:82220227f4fa | 54 | public: |
simon.ford@mbed.co.uk | 0:82220227f4fa | 55 | |
emilmont | 43:e2ed12d17f06 | 56 | /** Create an AnalogIn, connected to the specified pin |
simon.ford@mbed.co.uk | 5:62573be585e9 | 57 | * |
emilmont | 43:e2ed12d17f06 | 58 | * @param pin AnalogIn pin to connect to |
emilmont | 43:e2ed12d17f06 | 59 | * @param name (optional) A string to identify the object |
simon.ford@mbed.co.uk | 5:62573be585e9 | 60 | */ |
emilmont | 44:24d45a770a51 | 61 | AnalogIn(PinName pin) { |
emilmont | 44:24d45a770a51 | 62 | analogin_init(&_adc, pin); |
emilmont | 44:24d45a770a51 | 63 | } |
emilmont | 43:e2ed12d17f06 | 64 | |
emilmont | 43:e2ed12d17f06 | 65 | /** Read the input voltage, represented as a float in the range [0.0, 1.0] |
simon.ford@mbed.co.uk | 5:62573be585e9 | 66 | * |
emilmont | 43:e2ed12d17f06 | 67 | * @returns A floating-point value representing the current input voltage, measured as a percentage |
simon.ford@mbed.co.uk | 5:62573be585e9 | 68 | */ |
emilmont | 44:24d45a770a51 | 69 | float read() { |
emilmont | 44:24d45a770a51 | 70 | return analogin_read(&_adc); |
emilmont | 44:24d45a770a51 | 71 | } |
simon.ford@mbed.co.uk | 5:62573be585e9 | 72 | |
emilmont | 43:e2ed12d17f06 | 73 | /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF] |
simon.ford@mbed.co.uk | 5:62573be585e9 | 74 | * |
emilmont | 43:e2ed12d17f06 | 75 | * @returns |
emilmont | 43:e2ed12d17f06 | 76 | * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value |
simon.ford@mbed.co.uk | 5:62573be585e9 | 77 | */ |
emilmont | 44:24d45a770a51 | 78 | unsigned short read_u16() { |
emilmont | 44:24d45a770a51 | 79 | return analogin_read_u16(&_adc); |
emilmont | 44:24d45a770a51 | 80 | } |
simon.ford@mbed.co.uk | 5:62573be585e9 | 81 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 82 | #ifdef MBED_OPERATORS |
emilmont | 43:e2ed12d17f06 | 83 | /** An operator shorthand for read() |
simon.ford@mbed.co.uk | 5:62573be585e9 | 84 | * |
emilmont | 43:e2ed12d17f06 | 85 | * The float() operator can be used as a shorthand for read() to simplify common code sequences |
simon.ford@mbed.co.uk | 5:62573be585e9 | 86 | * |
simon.ford@mbed.co.uk | 5:62573be585e9 | 87 | * Example: |
emilmont | 43:e2ed12d17f06 | 88 | * @code |
emilmont | 43:e2ed12d17f06 | 89 | * float x = volume.read(); |
emilmont | 43:e2ed12d17f06 | 90 | * float x = volume; |
emilmont | 43:e2ed12d17f06 | 91 | * |
emilmont | 43:e2ed12d17f06 | 92 | * if(volume.read() > 0.25) { ... } |
emilmont | 43:e2ed12d17f06 | 93 | * if(volume > 0.25) { ... } |
emilmont | 43:e2ed12d17f06 | 94 | * @endcode |
simon.ford@mbed.co.uk | 0:82220227f4fa | 95 | */ |
emilmont | 44:24d45a770a51 | 96 | operator float() { |
emilmont | 44:24d45a770a51 | 97 | return read(); |
emilmont | 44:24d45a770a51 | 98 | } |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 99 | #endif |
simon.ford@mbed.co.uk | 5:62573be585e9 | 100 | |
simon.ford@mbed.co.uk | 0:82220227f4fa | 101 | protected: |
emilmont | 44:24d45a770a51 | 102 | analogin_t _adc; |
simon.ford@mbed.co.uk | 0:82220227f4fa | 103 | }; |
simon.ford@mbed.co.uk | 0:82220227f4fa | 104 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 105 | } // namespace mbed |
simon.ford@mbed.co.uk | 0:82220227f4fa | 106 | |
simon.ford@mbed.co.uk | 1:6b7f447ca868 | 107 | #endif |
emilmont | 27:7110ebee3484 | 108 | |
emilmont | 27:7110ebee3484 | 109 | #endif |