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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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