Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/AnalogIn.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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