mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/drivers/AnalogOut.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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