Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/AnalogOut.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
valeyev 0:e056ac8fecf8 1 /* mbed Microcontroller Library
valeyev 0:e056ac8fecf8 2 * Copyright (c) 2006-2013 ARM Limited
valeyev 0:e056ac8fecf8 3 *
valeyev 0:e056ac8fecf8 4 * Licensed under the Apache License, Version 2.0 (the "License");
valeyev 0:e056ac8fecf8 5 * you may not use this file except in compliance with the License.
valeyev 0:e056ac8fecf8 6 * You may obtain a copy of the License at
valeyev 0:e056ac8fecf8 7 *
valeyev 0:e056ac8fecf8 8 * http://www.apache.org/licenses/LICENSE-2.0
valeyev 0:e056ac8fecf8 9 *
valeyev 0:e056ac8fecf8 10 * Unless required by applicable law or agreed to in writing, software
valeyev 0:e056ac8fecf8 11 * distributed under the License is distributed on an "AS IS" BASIS,
valeyev 0:e056ac8fecf8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
valeyev 0:e056ac8fecf8 13 * See the License for the specific language governing permissions and
valeyev 0:e056ac8fecf8 14 * limitations under the License.
valeyev 0:e056ac8fecf8 15 */
valeyev 0:e056ac8fecf8 16 #ifndef MBED_ANALOGOUT_H
valeyev 0:e056ac8fecf8 17 #define MBED_ANALOGOUT_H
valeyev 0:e056ac8fecf8 18
valeyev 0:e056ac8fecf8 19 #include "platform/platform.h"
valeyev 0:e056ac8fecf8 20
valeyev 0:e056ac8fecf8 21 #if defined (DEVICE_ANALOGOUT) || defined(DOXYGEN_ONLY)
valeyev 0:e056ac8fecf8 22
valeyev 0:e056ac8fecf8 23 #include "hal/analogout_api.h"
valeyev 0:e056ac8fecf8 24 #include "platform/PlatformMutex.h"
valeyev 0:e056ac8fecf8 25
valeyev 0:e056ac8fecf8 26 namespace mbed {
valeyev 0:e056ac8fecf8 27 /** \addtogroup drivers */
valeyev 0:e056ac8fecf8 28
valeyev 0:e056ac8fecf8 29 /** An analog output, used for setting the voltage on a pin
valeyev 0:e056ac8fecf8 30 *
valeyev 0:e056ac8fecf8 31 * @note Synchronization level: Thread safe
valeyev 0:e056ac8fecf8 32 *
valeyev 0:e056ac8fecf8 33 * Example:
valeyev 0:e056ac8fecf8 34 * @code
valeyev 0:e056ac8fecf8 35 * // Make a sawtooth output
valeyev 0:e056ac8fecf8 36 *
valeyev 0:e056ac8fecf8 37 * #include "mbed.h"
valeyev 0:e056ac8fecf8 38 *
valeyev 0:e056ac8fecf8 39 * AnalogOut tri(p18);
valeyev 0:e056ac8fecf8 40 * int main() {
valeyev 0:e056ac8fecf8 41 * while(1) {
valeyev 0:e056ac8fecf8 42 * tri = tri + 0.01;
valeyev 0:e056ac8fecf8 43 * wait_us(1);
valeyev 0:e056ac8fecf8 44 * if(tri == 1) {
valeyev 0:e056ac8fecf8 45 * tri = 0;
valeyev 0:e056ac8fecf8 46 * }
valeyev 0:e056ac8fecf8 47 * }
valeyev 0:e056ac8fecf8 48 * }
valeyev 0:e056ac8fecf8 49 * @endcode
valeyev 0:e056ac8fecf8 50 * @ingroup drivers
valeyev 0:e056ac8fecf8 51 */
valeyev 0:e056ac8fecf8 52 class AnalogOut {
valeyev 0:e056ac8fecf8 53
valeyev 0:e056ac8fecf8 54 public:
valeyev 0:e056ac8fecf8 55
valeyev 0:e056ac8fecf8 56 /** Create an AnalogOut connected to the specified pin
valeyev 0:e056ac8fecf8 57 *
valeyev 0:e056ac8fecf8 58 * @param pin AnalogOut pin to connect to
valeyev 0:e056ac8fecf8 59 */
valeyev 0:e056ac8fecf8 60 AnalogOut(PinName pin) {
valeyev 0:e056ac8fecf8 61 analogout_init(&_dac, pin);
valeyev 0:e056ac8fecf8 62 }
valeyev 0:e056ac8fecf8 63
valeyev 0:e056ac8fecf8 64 /** Set the output voltage, specified as a percentage (float)
valeyev 0:e056ac8fecf8 65 *
valeyev 0:e056ac8fecf8 66 * @param value A floating-point value representing the output voltage,
valeyev 0:e056ac8fecf8 67 * specified as a percentage. The value should lie between
valeyev 0:e056ac8fecf8 68 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
valeyev 0:e056ac8fecf8 69 * Values outside this range will be saturated to 0.0f or 1.0f.
valeyev 0:e056ac8fecf8 70 */
valeyev 0:e056ac8fecf8 71 void write(float value) {
valeyev 0:e056ac8fecf8 72 lock();
valeyev 0:e056ac8fecf8 73 analogout_write(&_dac, value);
valeyev 0:e056ac8fecf8 74 unlock();
valeyev 0:e056ac8fecf8 75 }
valeyev 0:e056ac8fecf8 76
valeyev 0:e056ac8fecf8 77 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
valeyev 0:e056ac8fecf8 78 *
valeyev 0:e056ac8fecf8 79 * @param value 16-bit unsigned short representing the output voltage,
valeyev 0:e056ac8fecf8 80 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
valeyev 0:e056ac8fecf8 81 */
valeyev 0:e056ac8fecf8 82 void write_u16(unsigned short value) {
valeyev 0:e056ac8fecf8 83 lock();
valeyev 0:e056ac8fecf8 84 analogout_write_u16(&_dac, value);
valeyev 0:e056ac8fecf8 85 unlock();
valeyev 0:e056ac8fecf8 86 }
valeyev 0:e056ac8fecf8 87
valeyev 0:e056ac8fecf8 88 /** Return the current output voltage setting, measured as a percentage (float)
valeyev 0:e056ac8fecf8 89 *
valeyev 0:e056ac8fecf8 90 * @returns
valeyev 0:e056ac8fecf8 91 * A floating-point value representing the current voltage being output on the pin,
valeyev 0:e056ac8fecf8 92 * measured as a percentage. The returned value will lie between
valeyev 0:e056ac8fecf8 93 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
valeyev 0:e056ac8fecf8 94 *
valeyev 0:e056ac8fecf8 95 * @note
valeyev 0:e056ac8fecf8 96 * This value may not match exactly the value set by a previous write().
valeyev 0:e056ac8fecf8 97 */
valeyev 0:e056ac8fecf8 98 float read() {
valeyev 0:e056ac8fecf8 99 lock();
valeyev 0:e056ac8fecf8 100 float ret = analogout_read(&_dac);
valeyev 0:e056ac8fecf8 101 unlock();
valeyev 0:e056ac8fecf8 102 return ret;
valeyev 0:e056ac8fecf8 103 }
valeyev 0:e056ac8fecf8 104
valeyev 0:e056ac8fecf8 105 /** An operator shorthand for write()
valeyev 0:e056ac8fecf8 106 * \sa AnalogOut::write()
valeyev 0:e056ac8fecf8 107 */
valeyev 0:e056ac8fecf8 108 AnalogOut& operator= (float percent) {
valeyev 0:e056ac8fecf8 109 // Underlying write call is thread safe
valeyev 0:e056ac8fecf8 110 write(percent);
valeyev 0:e056ac8fecf8 111 return *this;
valeyev 0:e056ac8fecf8 112 }
valeyev 0:e056ac8fecf8 113
valeyev 0:e056ac8fecf8 114 /** An operator shorthand for write()
valeyev 0:e056ac8fecf8 115 * \sa AnalogOut::write()
valeyev 0:e056ac8fecf8 116 */
valeyev 0:e056ac8fecf8 117 AnalogOut& operator= (AnalogOut& rhs) {
valeyev 0:e056ac8fecf8 118 // Underlying write call is thread safe
valeyev 0:e056ac8fecf8 119 write(rhs.read());
valeyev 0:e056ac8fecf8 120 return *this;
valeyev 0:e056ac8fecf8 121 }
valeyev 0:e056ac8fecf8 122
valeyev 0:e056ac8fecf8 123 /** An operator shorthand for read()
valeyev 0:e056ac8fecf8 124 * \sa AnalogOut::read()
valeyev 0:e056ac8fecf8 125 */
valeyev 0:e056ac8fecf8 126 operator float() {
valeyev 0:e056ac8fecf8 127 // Underlying read call is thread safe
valeyev 0:e056ac8fecf8 128 return read();
valeyev 0:e056ac8fecf8 129 }
valeyev 0:e056ac8fecf8 130
valeyev 0:e056ac8fecf8 131 virtual ~AnalogOut() {
valeyev 0:e056ac8fecf8 132 // Do nothing
valeyev 0:e056ac8fecf8 133 }
valeyev 0:e056ac8fecf8 134
valeyev 0:e056ac8fecf8 135 protected:
valeyev 0:e056ac8fecf8 136
valeyev 0:e056ac8fecf8 137 virtual void lock() {
valeyev 0:e056ac8fecf8 138 _mutex.lock();
valeyev 0:e056ac8fecf8 139 }
valeyev 0:e056ac8fecf8 140
valeyev 0:e056ac8fecf8 141 virtual void unlock() {
valeyev 0:e056ac8fecf8 142 _mutex.unlock();
valeyev 0:e056ac8fecf8 143 }
valeyev 0:e056ac8fecf8 144
valeyev 0:e056ac8fecf8 145 dac_t _dac;
valeyev 0:e056ac8fecf8 146 PlatformMutex _mutex;
valeyev 0:e056ac8fecf8 147 };
valeyev 0:e056ac8fecf8 148
valeyev 0:e056ac8fecf8 149 } // namespace mbed
valeyev 0:e056ac8fecf8 150
valeyev 0:e056ac8fecf8 151 #endif
valeyev 0:e056ac8fecf8 152
valeyev 0:e056ac8fecf8 153 #endif