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