mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/AnalogOut.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
167:e84263d55307
Child:
188:bcfe06ba3d64
mbed-dev library. Release version 163

Who changed what in which revision?

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