takashi kadono
/
Nucleo_446
Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466
mbed-os/drivers/AnalogIn.h@0:8fdf9a60065b, 2018-10-10 (annotated)
- Committer:
- kadonotakashi
- Date:
- Wed Oct 10 00:33:53 2018 +0000
- Revision:
- 0:8fdf9a60065b
how to make mbed librry
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kadonotakashi | 0:8fdf9a60065b | 1 | /* mbed Microcontroller Library |
kadonotakashi | 0:8fdf9a60065b | 2 | * Copyright (c) 2006-2013 ARM Limited |
kadonotakashi | 0:8fdf9a60065b | 3 | * |
kadonotakashi | 0:8fdf9a60065b | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kadonotakashi | 0:8fdf9a60065b | 5 | * you may not use this file except in compliance with the License. |
kadonotakashi | 0:8fdf9a60065b | 6 | * You may obtain a copy of the License at |
kadonotakashi | 0:8fdf9a60065b | 7 | * |
kadonotakashi | 0:8fdf9a60065b | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
kadonotakashi | 0:8fdf9a60065b | 9 | * |
kadonotakashi | 0:8fdf9a60065b | 10 | * Unless required by applicable law or agreed to in writing, software |
kadonotakashi | 0:8fdf9a60065b | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
kadonotakashi | 0:8fdf9a60065b | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kadonotakashi | 0:8fdf9a60065b | 13 | * See the License for the specific language governing permissions and |
kadonotakashi | 0:8fdf9a60065b | 14 | * limitations under the License. |
kadonotakashi | 0:8fdf9a60065b | 15 | */ |
kadonotakashi | 0:8fdf9a60065b | 16 | #ifndef MBED_ANALOGIN_H |
kadonotakashi | 0:8fdf9a60065b | 17 | #define MBED_ANALOGIN_H |
kadonotakashi | 0:8fdf9a60065b | 18 | |
kadonotakashi | 0:8fdf9a60065b | 19 | #include "platform/platform.h" |
kadonotakashi | 0:8fdf9a60065b | 20 | |
kadonotakashi | 0:8fdf9a60065b | 21 | #if defined (DEVICE_ANALOGIN) || defined(DOXYGEN_ONLY) |
kadonotakashi | 0:8fdf9a60065b | 22 | |
kadonotakashi | 0:8fdf9a60065b | 23 | #include "hal/analogin_api.h" |
kadonotakashi | 0:8fdf9a60065b | 24 | #include "platform/SingletonPtr.h" |
kadonotakashi | 0:8fdf9a60065b | 25 | #include "platform/PlatformMutex.h" |
kadonotakashi | 0:8fdf9a60065b | 26 | |
kadonotakashi | 0:8fdf9a60065b | 27 | namespace mbed { |
kadonotakashi | 0:8fdf9a60065b | 28 | /** \addtogroup drivers */ |
kadonotakashi | 0:8fdf9a60065b | 29 | |
kadonotakashi | 0:8fdf9a60065b | 30 | /** An analog input, used for reading the voltage on a pin |
kadonotakashi | 0:8fdf9a60065b | 31 | * |
kadonotakashi | 0:8fdf9a60065b | 32 | * @note Synchronization level: Thread safe |
kadonotakashi | 0:8fdf9a60065b | 33 | * |
kadonotakashi | 0:8fdf9a60065b | 34 | * Example: |
kadonotakashi | 0:8fdf9a60065b | 35 | * @code |
kadonotakashi | 0:8fdf9a60065b | 36 | * // Print messages when the AnalogIn is greater than 50% |
kadonotakashi | 0:8fdf9a60065b | 37 | * |
kadonotakashi | 0:8fdf9a60065b | 38 | * #include "mbed.h" |
kadonotakashi | 0:8fdf9a60065b | 39 | * |
kadonotakashi | 0:8fdf9a60065b | 40 | * AnalogIn temperature(p20); |
kadonotakashi | 0:8fdf9a60065b | 41 | * |
kadonotakashi | 0:8fdf9a60065b | 42 | * int main() { |
kadonotakashi | 0:8fdf9a60065b | 43 | * while(1) { |
kadonotakashi | 0:8fdf9a60065b | 44 | * if(temperature > 0.5) { |
kadonotakashi | 0:8fdf9a60065b | 45 | * printf("Too hot! (%f)", temperature.read()); |
kadonotakashi | 0:8fdf9a60065b | 46 | * } |
kadonotakashi | 0:8fdf9a60065b | 47 | * } |
kadonotakashi | 0:8fdf9a60065b | 48 | * } |
kadonotakashi | 0:8fdf9a60065b | 49 | * @endcode |
kadonotakashi | 0:8fdf9a60065b | 50 | * @ingroup drivers |
kadonotakashi | 0:8fdf9a60065b | 51 | */ |
kadonotakashi | 0:8fdf9a60065b | 52 | class AnalogIn { |
kadonotakashi | 0:8fdf9a60065b | 53 | |
kadonotakashi | 0:8fdf9a60065b | 54 | public: |
kadonotakashi | 0:8fdf9a60065b | 55 | |
kadonotakashi | 0:8fdf9a60065b | 56 | /** Create an AnalogIn, connected to the specified pin |
kadonotakashi | 0:8fdf9a60065b | 57 | * |
kadonotakashi | 0:8fdf9a60065b | 58 | * @param pin AnalogIn pin to connect to |
kadonotakashi | 0:8fdf9a60065b | 59 | */ |
kadonotakashi | 0:8fdf9a60065b | 60 | AnalogIn(PinName pin) |
kadonotakashi | 0:8fdf9a60065b | 61 | { |
kadonotakashi | 0:8fdf9a60065b | 62 | lock(); |
kadonotakashi | 0:8fdf9a60065b | 63 | analogin_init(&_adc, pin); |
kadonotakashi | 0:8fdf9a60065b | 64 | unlock(); |
kadonotakashi | 0:8fdf9a60065b | 65 | } |
kadonotakashi | 0:8fdf9a60065b | 66 | |
kadonotakashi | 0:8fdf9a60065b | 67 | /** Read the input voltage, represented as a float in the range [0.0, 1.0] |
kadonotakashi | 0:8fdf9a60065b | 68 | * |
kadonotakashi | 0:8fdf9a60065b | 69 | * @returns A floating-point value representing the current input voltage, measured as a percentage |
kadonotakashi | 0:8fdf9a60065b | 70 | */ |
kadonotakashi | 0:8fdf9a60065b | 71 | float read() |
kadonotakashi | 0:8fdf9a60065b | 72 | { |
kadonotakashi | 0:8fdf9a60065b | 73 | lock(); |
kadonotakashi | 0:8fdf9a60065b | 74 | float ret = analogin_read(&_adc); |
kadonotakashi | 0:8fdf9a60065b | 75 | unlock(); |
kadonotakashi | 0:8fdf9a60065b | 76 | return ret; |
kadonotakashi | 0:8fdf9a60065b | 77 | } |
kadonotakashi | 0:8fdf9a60065b | 78 | |
kadonotakashi | 0:8fdf9a60065b | 79 | /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF] |
kadonotakashi | 0:8fdf9a60065b | 80 | * |
kadonotakashi | 0:8fdf9a60065b | 81 | * @returns |
kadonotakashi | 0:8fdf9a60065b | 82 | * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value |
kadonotakashi | 0:8fdf9a60065b | 83 | */ |
kadonotakashi | 0:8fdf9a60065b | 84 | unsigned short read_u16() |
kadonotakashi | 0:8fdf9a60065b | 85 | { |
kadonotakashi | 0:8fdf9a60065b | 86 | lock(); |
kadonotakashi | 0:8fdf9a60065b | 87 | unsigned short ret = analogin_read_u16(&_adc); |
kadonotakashi | 0:8fdf9a60065b | 88 | unlock(); |
kadonotakashi | 0:8fdf9a60065b | 89 | return ret; |
kadonotakashi | 0:8fdf9a60065b | 90 | } |
kadonotakashi | 0:8fdf9a60065b | 91 | |
kadonotakashi | 0:8fdf9a60065b | 92 | /** An operator shorthand for read() |
kadonotakashi | 0:8fdf9a60065b | 93 | * |
kadonotakashi | 0:8fdf9a60065b | 94 | * The float() operator can be used as a shorthand for read() to simplify common code sequences |
kadonotakashi | 0:8fdf9a60065b | 95 | * |
kadonotakashi | 0:8fdf9a60065b | 96 | * Example: |
kadonotakashi | 0:8fdf9a60065b | 97 | * @code |
kadonotakashi | 0:8fdf9a60065b | 98 | * float x = volume.read(); |
kadonotakashi | 0:8fdf9a60065b | 99 | * float x = volume; |
kadonotakashi | 0:8fdf9a60065b | 100 | * |
kadonotakashi | 0:8fdf9a60065b | 101 | * if(volume.read() > 0.25) { ... } |
kadonotakashi | 0:8fdf9a60065b | 102 | * if(volume > 0.25) { ... } |
kadonotakashi | 0:8fdf9a60065b | 103 | * @endcode |
kadonotakashi | 0:8fdf9a60065b | 104 | */ |
kadonotakashi | 0:8fdf9a60065b | 105 | operator float() |
kadonotakashi | 0:8fdf9a60065b | 106 | { |
kadonotakashi | 0:8fdf9a60065b | 107 | // Underlying call is thread safe |
kadonotakashi | 0:8fdf9a60065b | 108 | return read(); |
kadonotakashi | 0:8fdf9a60065b | 109 | } |
kadonotakashi | 0:8fdf9a60065b | 110 | |
kadonotakashi | 0:8fdf9a60065b | 111 | virtual ~AnalogIn() |
kadonotakashi | 0:8fdf9a60065b | 112 | { |
kadonotakashi | 0:8fdf9a60065b | 113 | // Do nothing |
kadonotakashi | 0:8fdf9a60065b | 114 | } |
kadonotakashi | 0:8fdf9a60065b | 115 | |
kadonotakashi | 0:8fdf9a60065b | 116 | protected: |
kadonotakashi | 0:8fdf9a60065b | 117 | |
kadonotakashi | 0:8fdf9a60065b | 118 | virtual void lock() |
kadonotakashi | 0:8fdf9a60065b | 119 | { |
kadonotakashi | 0:8fdf9a60065b | 120 | _mutex->lock(); |
kadonotakashi | 0:8fdf9a60065b | 121 | } |
kadonotakashi | 0:8fdf9a60065b | 122 | |
kadonotakashi | 0:8fdf9a60065b | 123 | virtual void unlock() |
kadonotakashi | 0:8fdf9a60065b | 124 | { |
kadonotakashi | 0:8fdf9a60065b | 125 | _mutex->unlock(); |
kadonotakashi | 0:8fdf9a60065b | 126 | } |
kadonotakashi | 0:8fdf9a60065b | 127 | |
kadonotakashi | 0:8fdf9a60065b | 128 | analogin_t _adc; |
kadonotakashi | 0:8fdf9a60065b | 129 | static SingletonPtr<PlatformMutex> _mutex; |
kadonotakashi | 0:8fdf9a60065b | 130 | }; |
kadonotakashi | 0:8fdf9a60065b | 131 | |
kadonotakashi | 0:8fdf9a60065b | 132 | } // namespace mbed |
kadonotakashi | 0:8fdf9a60065b | 133 | |
kadonotakashi | 0:8fdf9a60065b | 134 | #endif |
kadonotakashi | 0:8fdf9a60065b | 135 | |
kadonotakashi | 0:8fdf9a60065b | 136 | #endif |
kadonotakashi | 0:8fdf9a60065b | 137 |