test test test
snake-test/mbed/drivers/AnalogOut.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?
User | Revision | Line number | New 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_ANALOGOUT_H |
mohamedmoawya | 0:e4c5e6ec922e | 17 | #define MBED_ANALOGOUT_H |
mohamedmoawya | 0:e4c5e6ec922e | 18 | |
mohamedmoawya | 0:e4c5e6ec922e | 19 | #include "platform/platform.h" |
mohamedmoawya | 0:e4c5e6ec922e | 20 | |
mohamedmoawya | 0:e4c5e6ec922e | 21 | #if defined (DEVICE_ANALOGOUT) || defined(DOXYGEN_ONLY) |
mohamedmoawya | 0:e4c5e6ec922e | 22 | |
mohamedmoawya | 0:e4c5e6ec922e | 23 | #include "hal/analogout_api.h" |
mohamedmoawya | 0:e4c5e6ec922e | 24 | #include "platform/PlatformMutex.h" |
mohamedmoawya | 0:e4c5e6ec922e | 25 | |
mohamedmoawya | 0:e4c5e6ec922e | 26 | namespace mbed { |
mohamedmoawya | 0:e4c5e6ec922e | 27 | /** \addtogroup drivers */ |
mohamedmoawya | 0:e4c5e6ec922e | 28 | |
mohamedmoawya | 0:e4c5e6ec922e | 29 | /** An analog output, used for setting the voltage on a pin |
mohamedmoawya | 0:e4c5e6ec922e | 30 | * |
mohamedmoawya | 0:e4c5e6ec922e | 31 | * @note Synchronization level: Thread safe |
mohamedmoawya | 0:e4c5e6ec922e | 32 | * |
mohamedmoawya | 0:e4c5e6ec922e | 33 | * Example: |
mohamedmoawya | 0:e4c5e6ec922e | 34 | * @code |
mohamedmoawya | 0:e4c5e6ec922e | 35 | * // Make a sawtooth output |
mohamedmoawya | 0:e4c5e6ec922e | 36 | * |
mohamedmoawya | 0:e4c5e6ec922e | 37 | * #include "mbed.h" |
mohamedmoawya | 0:e4c5e6ec922e | 38 | * |
mohamedmoawya | 0:e4c5e6ec922e | 39 | * AnalogOut tri(p18); |
mohamedmoawya | 0:e4c5e6ec922e | 40 | * int main() { |
mohamedmoawya | 0:e4c5e6ec922e | 41 | * while(1) { |
mohamedmoawya | 0:e4c5e6ec922e | 42 | * tri = tri + 0.01; |
mohamedmoawya | 0:e4c5e6ec922e | 43 | * wait_us(1); |
mohamedmoawya | 0:e4c5e6ec922e | 44 | * if(tri == 1) { |
mohamedmoawya | 0:e4c5e6ec922e | 45 | * tri = 0; |
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 AnalogOut { |
mohamedmoawya | 0:e4c5e6ec922e | 53 | |
mohamedmoawya | 0:e4c5e6ec922e | 54 | public: |
mohamedmoawya | 0:e4c5e6ec922e | 55 | |
mohamedmoawya | 0:e4c5e6ec922e | 56 | /** Create an AnalogOut connected to the specified pin |
mohamedmoawya | 0:e4c5e6ec922e | 57 | * |
mohamedmoawya | 0:e4c5e6ec922e | 58 | * @param pin AnalogOut pin to connect to |
mohamedmoawya | 0:e4c5e6ec922e | 59 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 60 | AnalogOut(PinName pin) |
mohamedmoawya | 0:e4c5e6ec922e | 61 | { |
mohamedmoawya | 0:e4c5e6ec922e | 62 | analogout_init(&_dac, pin); |
mohamedmoawya | 0:e4c5e6ec922e | 63 | } |
mohamedmoawya | 0:e4c5e6ec922e | 64 | |
mohamedmoawya | 0:e4c5e6ec922e | 65 | /** Set the output voltage, specified as a percentage (float) |
mohamedmoawya | 0:e4c5e6ec922e | 66 | * |
mohamedmoawya | 0:e4c5e6ec922e | 67 | * @param value A floating-point value representing the output voltage, |
mohamedmoawya | 0:e4c5e6ec922e | 68 | * specified as a percentage. The value should lie between |
mohamedmoawya | 0:e4c5e6ec922e | 69 | * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%). |
mohamedmoawya | 0:e4c5e6ec922e | 70 | * Values outside this range will be saturated to 0.0f or 1.0f. |
mohamedmoawya | 0:e4c5e6ec922e | 71 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 72 | void write(float value) |
mohamedmoawya | 0:e4c5e6ec922e | 73 | { |
mohamedmoawya | 0:e4c5e6ec922e | 74 | lock(); |
mohamedmoawya | 0:e4c5e6ec922e | 75 | analogout_write(&_dac, value); |
mohamedmoawya | 0:e4c5e6ec922e | 76 | unlock(); |
mohamedmoawya | 0:e4c5e6ec922e | 77 | } |
mohamedmoawya | 0:e4c5e6ec922e | 78 | |
mohamedmoawya | 0:e4c5e6ec922e | 79 | /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF] |
mohamedmoawya | 0:e4c5e6ec922e | 80 | * |
mohamedmoawya | 0:e4c5e6ec922e | 81 | * @param value 16-bit unsigned short representing the output voltage, |
mohamedmoawya | 0:e4c5e6ec922e | 82 | * normalized to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v) |
mohamedmoawya | 0:e4c5e6ec922e | 83 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 84 | void write_u16(unsigned short value) |
mohamedmoawya | 0:e4c5e6ec922e | 85 | { |
mohamedmoawya | 0:e4c5e6ec922e | 86 | lock(); |
mohamedmoawya | 0:e4c5e6ec922e | 87 | analogout_write_u16(&_dac, value); |
mohamedmoawya | 0:e4c5e6ec922e | 88 | unlock(); |
mohamedmoawya | 0:e4c5e6ec922e | 89 | } |
mohamedmoawya | 0:e4c5e6ec922e | 90 | |
mohamedmoawya | 0:e4c5e6ec922e | 91 | /** Return the current output voltage setting, measured as a percentage (float) |
mohamedmoawya | 0:e4c5e6ec922e | 92 | * |
mohamedmoawya | 0:e4c5e6ec922e | 93 | * @returns |
mohamedmoawya | 0:e4c5e6ec922e | 94 | * A floating-point value representing the current voltage being output on the pin, |
mohamedmoawya | 0:e4c5e6ec922e | 95 | * measured as a percentage. The returned value will lie between |
mohamedmoawya | 0:e4c5e6ec922e | 96 | * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%). |
mohamedmoawya | 0:e4c5e6ec922e | 97 | * |
mohamedmoawya | 0:e4c5e6ec922e | 98 | * @note |
mohamedmoawya | 0:e4c5e6ec922e | 99 | * This value may not match exactly the value set by a previous write(). |
mohamedmoawya | 0:e4c5e6ec922e | 100 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 101 | float read() |
mohamedmoawya | 0:e4c5e6ec922e | 102 | { |
mohamedmoawya | 0:e4c5e6ec922e | 103 | lock(); |
mohamedmoawya | 0:e4c5e6ec922e | 104 | float ret = analogout_read(&_dac); |
mohamedmoawya | 0:e4c5e6ec922e | 105 | unlock(); |
mohamedmoawya | 0:e4c5e6ec922e | 106 | return ret; |
mohamedmoawya | 0:e4c5e6ec922e | 107 | } |
mohamedmoawya | 0:e4c5e6ec922e | 108 | |
mohamedmoawya | 0:e4c5e6ec922e | 109 | /** An operator shorthand for write() |
mohamedmoawya | 0:e4c5e6ec922e | 110 | * \sa AnalogOut::write() |
mohamedmoawya | 0:e4c5e6ec922e | 111 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 112 | AnalogOut &operator= (float percent) |
mohamedmoawya | 0:e4c5e6ec922e | 113 | { |
mohamedmoawya | 0:e4c5e6ec922e | 114 | // Underlying write call is thread safe |
mohamedmoawya | 0:e4c5e6ec922e | 115 | write(percent); |
mohamedmoawya | 0:e4c5e6ec922e | 116 | return *this; |
mohamedmoawya | 0:e4c5e6ec922e | 117 | } |
mohamedmoawya | 0:e4c5e6ec922e | 118 | |
mohamedmoawya | 0:e4c5e6ec922e | 119 | /** An operator shorthand for write() |
mohamedmoawya | 0:e4c5e6ec922e | 120 | * \sa AnalogOut::write() |
mohamedmoawya | 0:e4c5e6ec922e | 121 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 122 | AnalogOut &operator= (AnalogOut &rhs) |
mohamedmoawya | 0:e4c5e6ec922e | 123 | { |
mohamedmoawya | 0:e4c5e6ec922e | 124 | // Underlying write call is thread safe |
mohamedmoawya | 0:e4c5e6ec922e | 125 | write(rhs.read()); |
mohamedmoawya | 0:e4c5e6ec922e | 126 | return *this; |
mohamedmoawya | 0:e4c5e6ec922e | 127 | } |
mohamedmoawya | 0:e4c5e6ec922e | 128 | |
mohamedmoawya | 0:e4c5e6ec922e | 129 | /** An operator shorthand for read() |
mohamedmoawya | 0:e4c5e6ec922e | 130 | * \sa AnalogOut::read() |
mohamedmoawya | 0:e4c5e6ec922e | 131 | */ |
mohamedmoawya | 0:e4c5e6ec922e | 132 | operator float() |
mohamedmoawya | 0:e4c5e6ec922e | 133 | { |
mohamedmoawya | 0:e4c5e6ec922e | 134 | // Underlying read call is thread safe |
mohamedmoawya | 0:e4c5e6ec922e | 135 | return read(); |
mohamedmoawya | 0:e4c5e6ec922e | 136 | } |
mohamedmoawya | 0:e4c5e6ec922e | 137 | |
mohamedmoawya | 0:e4c5e6ec922e | 138 | virtual ~AnalogOut() |
mohamedmoawya | 0:e4c5e6ec922e | 139 | { |
mohamedmoawya | 0:e4c5e6ec922e | 140 | // Do nothing |
mohamedmoawya | 0:e4c5e6ec922e | 141 | } |
mohamedmoawya | 0:e4c5e6ec922e | 142 | |
mohamedmoawya | 0:e4c5e6ec922e | 143 | protected: |
mohamedmoawya | 0:e4c5e6ec922e | 144 | #if !defined(DOXYGEN_ONLY) |
mohamedmoawya | 0:e4c5e6ec922e | 145 | virtual void lock() |
mohamedmoawya | 0:e4c5e6ec922e | 146 | { |
mohamedmoawya | 0:e4c5e6ec922e | 147 | _mutex.lock(); |
mohamedmoawya | 0:e4c5e6ec922e | 148 | } |
mohamedmoawya | 0:e4c5e6ec922e | 149 | |
mohamedmoawya | 0:e4c5e6ec922e | 150 | virtual void unlock() |
mohamedmoawya | 0:e4c5e6ec922e | 151 | { |
mohamedmoawya | 0:e4c5e6ec922e | 152 | _mutex.unlock(); |
mohamedmoawya | 0:e4c5e6ec922e | 153 | } |
mohamedmoawya | 0:e4c5e6ec922e | 154 | |
mohamedmoawya | 0:e4c5e6ec922e | 155 | dac_t _dac; |
mohamedmoawya | 0:e4c5e6ec922e | 156 | PlatformMutex _mutex; |
mohamedmoawya | 0:e4c5e6ec922e | 157 | #endif //!defined(DOXYGEN_ONLY) |
mohamedmoawya | 0:e4c5e6ec922e | 158 | }; |
mohamedmoawya | 0:e4c5e6ec922e | 159 | |
mohamedmoawya | 0:e4c5e6ec922e | 160 | } // namespace mbed |
mohamedmoawya | 0:e4c5e6ec922e | 161 | |
mohamedmoawya | 0:e4c5e6ec922e | 162 | #endif |
mohamedmoawya | 0:e4c5e6ec922e | 163 | |
mohamedmoawya | 0:e4c5e6ec922e | 164 | #endif |