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.

AnalogOut.h@123:b0220dba8be7, 2016-08-12 (annotated)

Committer:
Kojto
Date:
Fri Aug 12 13:04:35 2016 +0200
Revision:
123:b0220dba8be7
Parent:
122:f9eeca106725 
Release 123 of the mbed library



Changes:

- new targets: nucleo_f207zg, beetle, nrf51_dk, hexiwear,

 nuvoton nuc472, vk rz a1h

- ST - fix timer interrupt handler, sleep api fix

- NXP - lpc15xx us ticker fix

- Nordic - analogin fixes, LF clock init addition, enable i2c async

Who changed what in which revision?

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