Rahul Dahiya / Mbed OS STM32F7 Ethernet

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.

mbed-os/drivers/AnalogOut.h@0:fb8047b156bb, 2020-01-15 (annotated)

Committer:
rahul_dahiya
Date:
Wed Jan 15 15:57:15 2020 +0530
Revision:
0:fb8047b156bb
STM32F7 LWIP

Who changed what in which revision?

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