Theo/Ludo/Joe / ER2_Labyrinthe_V3

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:   mbed

ER2_Robot/mbed/drivers/AnalogIn.h@4:31025db8e579, 2019-06-24 (annotated)

Committer:
joehatier
Date:
Mon Jun 24 12:37:09 2019 +0000
Revision:
4:31025db8e579
Parent:
0:1a801a2a7b4b 
laby;

Who changed what in which revision?

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