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