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@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

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
<> 128:9bcdf88f62b0 21 #if DEVICE_ANALOGOUT
<> 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
<> 128:9bcdf88f62b0 30 /** An analog output, used for setting the voltage on a pin
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * @Note Synchronization level: Thread safe
<> 128:9bcdf88f62b0 33 *
<> 128:9bcdf88f62b0 34 * Example:
<> 128:9bcdf88f62b0 35 * @code
<> 128:9bcdf88f62b0 36 * // Make a sawtooth output
<> 128:9bcdf88f62b0 37 *
<> 128:9bcdf88f62b0 38 * #include "mbed.h"
<> 128:9bcdf88f62b0 39 *
<> 128:9bcdf88f62b0 40 * AnalogOut tri(p18);
<> 128:9bcdf88f62b0 41 * int main() {
<> 128:9bcdf88f62b0 42 * while(1) {
<> 128:9bcdf88f62b0 43 * tri = tri + 0.01;
<> 128:9bcdf88f62b0 44 * wait_us(1);
<> 128:9bcdf88f62b0 45 * if(tri == 1) {
<> 128:9bcdf88f62b0 46 * tri = 0;
<> 128:9bcdf88f62b0 47 * }
<> 128:9bcdf88f62b0 48 * }
<> 128:9bcdf88f62b0 49 * }
<> 128:9bcdf88f62b0 50 * @endcode
<> 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 *
<> 128:9bcdf88f62b0 58 * @param AnalogOut pin to connect to (18)
<> 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()
<> 128:9bcdf88f62b0 106 */
<> 128:9bcdf88f62b0 107 AnalogOut& operator= (float percent) {
<> 128:9bcdf88f62b0 108 // Underlying write call is thread safe
<> 128:9bcdf88f62b0 109 write(percent);
<> 128:9bcdf88f62b0 110 return *this;
<> 128:9bcdf88f62b0 111 }
<> 128:9bcdf88f62b0 112
<> 128:9bcdf88f62b0 113 AnalogOut& operator= (AnalogOut& rhs) {
<> 128:9bcdf88f62b0 114 // Underlying write call is thread safe
<> 128:9bcdf88f62b0 115 write(rhs.read());
<> 128:9bcdf88f62b0 116 return *this;
<> 128:9bcdf88f62b0 117 }
<> 128:9bcdf88f62b0 118
<> 128:9bcdf88f62b0 119 /** An operator shorthand for read()
<> 128:9bcdf88f62b0 120 */
<> 128:9bcdf88f62b0 121 operator float() {
<> 128:9bcdf88f62b0 122 // Underlying read call is thread safe
<> 128:9bcdf88f62b0 123 return read();
<> 128:9bcdf88f62b0 124 }
<> 128:9bcdf88f62b0 125
<> 128:9bcdf88f62b0 126 virtual ~AnalogOut() {
<> 128:9bcdf88f62b0 127 // Do nothing
<> 128:9bcdf88f62b0 128 }
<> 128:9bcdf88f62b0 129
<> 128:9bcdf88f62b0 130 protected:
<> 128:9bcdf88f62b0 131
<> 128:9bcdf88f62b0 132 virtual void lock() {
<> 128:9bcdf88f62b0 133 _mutex.lock();
<> 128:9bcdf88f62b0 134 }
<> 128:9bcdf88f62b0 135
<> 128:9bcdf88f62b0 136 virtual void unlock() {
<> 128:9bcdf88f62b0 137 _mutex.unlock();
<> 128:9bcdf88f62b0 138 }
<> 128:9bcdf88f62b0 139
<> 128:9bcdf88f62b0 140 dac_t _dac;
<> 128:9bcdf88f62b0 141 PlatformMutex _mutex;
<> 128:9bcdf88f62b0 142 };
<> 128:9bcdf88f62b0 143
<> 128:9bcdf88f62b0 144 } // namespace mbed
<> 128:9bcdf88f62b0 145
<> 128:9bcdf88f62b0 146 #endif
<> 128:9bcdf88f62b0 147
<> 128:9bcdf88f62b0 148 #endif
<> 128:9bcdf88f62b0 149
<> 128:9bcdf88f62b0 150 /** @}*/