Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/AnalogOut.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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