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@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1
Child:
123:b0220dba8be7
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

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"
bogdanm 65:5798e58a58b1 24
bogdanm 65:5798e58a58b1 25 namespace mbed {
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 /** An analog output, used for setting the voltage on a pin
bogdanm 65:5798e58a58b1 28 *
Kojto 122:f9eeca106725 29 * @Note Synchronization level: Thread safe
Kojto 122:f9eeca106725 30 *
bogdanm 65:5798e58a58b1 31 * Example:
bogdanm 65:5798e58a58b1 32 * @code
bogdanm 65:5798e58a58b1 33 * // Make a sawtooth output
bogdanm 65:5798e58a58b1 34 *
bogdanm 65:5798e58a58b1 35 * #include "mbed.h"
bogdanm 65:5798e58a58b1 36 *
bogdanm 65:5798e58a58b1 37 * AnalogOut tri(p18);
bogdanm 65:5798e58a58b1 38 * int main() {
bogdanm 65:5798e58a58b1 39 * while(1) {
bogdanm 65:5798e58a58b1 40 * tri = tri + 0.01;
bogdanm 65:5798e58a58b1 41 * wait_us(1);
bogdanm 65:5798e58a58b1 42 * if(tri == 1) {
bogdanm 65:5798e58a58b1 43 * tri = 0;
bogdanm 65:5798e58a58b1 44 * }
bogdanm 65:5798e58a58b1 45 * }
bogdanm 65:5798e58a58b1 46 * }
bogdanm 65:5798e58a58b1 47 * @endcode
bogdanm 65:5798e58a58b1 48 */
bogdanm 65:5798e58a58b1 49 class AnalogOut {
bogdanm 65:5798e58a58b1 50
bogdanm 65:5798e58a58b1 51 public:
bogdanm 65:5798e58a58b1 52
bogdanm 65:5798e58a58b1 53 /** Create an AnalogOut connected to the specified pin
bogdanm 65:5798e58a58b1 54 *
bogdanm 65:5798e58a58b1 55 * @param AnalogOut pin to connect to (18)
bogdanm 65:5798e58a58b1 56 */
bogdanm 65:5798e58a58b1 57 AnalogOut(PinName pin) {
bogdanm 65:5798e58a58b1 58 analogout_init(&_dac, pin);
bogdanm 65:5798e58a58b1 59 }
bogdanm 65:5798e58a58b1 60
bogdanm 65:5798e58a58b1 61 /** Set the output voltage, specified as a percentage (float)
bogdanm 65:5798e58a58b1 62 *
bogdanm 65:5798e58a58b1 63 * @param value A floating-point value representing the output voltage,
bogdanm 65:5798e58a58b1 64 * specified as a percentage. The value should lie between
bogdanm 65:5798e58a58b1 65 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm 65:5798e58a58b1 66 * Values outside this range will be saturated to 0.0f or 1.0f.
bogdanm 65:5798e58a58b1 67 */
bogdanm 65:5798e58a58b1 68 void write(float value) {
Kojto 122:f9eeca106725 69 lock();
bogdanm 65:5798e58a58b1 70 analogout_write(&_dac, value);
Kojto 122:f9eeca106725 71 unlock();
bogdanm 65:5798e58a58b1 72 }
bogdanm 65:5798e58a58b1 73
bogdanm 65:5798e58a58b1 74 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
bogdanm 65:5798e58a58b1 75 *
bogdanm 65:5798e58a58b1 76 * @param value 16-bit unsigned short representing the output voltage,
bogdanm 65:5798e58a58b1 77 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 void write_u16(unsigned short value) {
Kojto 122:f9eeca106725 80 lock();
bogdanm 65:5798e58a58b1 81 analogout_write_u16(&_dac, value);
Kojto 122:f9eeca106725 82 unlock();
bogdanm 65:5798e58a58b1 83 }
bogdanm 65:5798e58a58b1 84
bogdanm 65:5798e58a58b1 85 /** Return the current output voltage setting, measured as a percentage (float)
bogdanm 65:5798e58a58b1 86 *
bogdanm 65:5798e58a58b1 87 * @returns
bogdanm 65:5798e58a58b1 88 * A floating-point value representing the current voltage being output on the pin,
bogdanm 65:5798e58a58b1 89 * measured as a percentage. The returned value will lie between
bogdanm 65:5798e58a58b1 90 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm 65:5798e58a58b1 91 *
bogdanm 65:5798e58a58b1 92 * @note
bogdanm 65:5798e58a58b1 93 * This value may not match exactly the value set by a previous write().
bogdanm 65:5798e58a58b1 94 */
bogdanm 65:5798e58a58b1 95 float read() {
Kojto 122:f9eeca106725 96 lock();
Kojto 122:f9eeca106725 97 float ret = analogout_read(&_dac);
Kojto 122:f9eeca106725 98 unlock();
Kojto 122:f9eeca106725 99 return ret;
bogdanm 65:5798e58a58b1 100 }
bogdanm 65:5798e58a58b1 101
bogdanm 65:5798e58a58b1 102 #ifdef MBED_OPERATORS
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 #endif
bogdanm 65:5798e58a58b1 124
Kojto 122:f9eeca106725 125 virtual ~AnalogOut() {
Kojto 122:f9eeca106725 126 // Do nothing
Kojto 122:f9eeca106725 127 }
Kojto 122:f9eeca106725 128
bogdanm 65:5798e58a58b1 129 protected:
Kojto 122:f9eeca106725 130
Kojto 122:f9eeca106725 131 virtual void lock() {
Kojto 122:f9eeca106725 132 _mutex.lock();
Kojto 122:f9eeca106725 133 }
Kojto 122:f9eeca106725 134
Kojto 122:f9eeca106725 135 virtual void unlock() {
Kojto 122:f9eeca106725 136 _mutex.unlock();
Kojto 122:f9eeca106725 137 }
Kojto 122:f9eeca106725 138
bogdanm 65:5798e58a58b1 139 dac_t _dac;
Kojto 122:f9eeca106725 140 PlatformMutex _mutex;
bogdanm 65:5798e58a58b1 141 };
bogdanm 65:5798e58a58b1 142
bogdanm 65:5798e58a58b1 143 } // namespace mbed
bogdanm 65:5798e58a58b1 144
bogdanm 65:5798e58a58b1 145 #endif
bogdanm 65:5798e58a58b1 146
bogdanm 65:5798e58a58b1 147 #endif