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