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@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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