mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/AnalogOut.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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