Elijah Stanger-Jones / mbed-dev-f303

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.

drivers/AnalogOut.h@2:4364577b5ad8, 2020-11-09 (annotated)

Committer:
elijahsj
Date:
Mon Nov 09 00:33:19 2020 -0500
Revision:
2:4364577b5ad8
Parent:
1:8a094db1347f 
copied mbed library

Who changed what in which revision?

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