PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/AnalogOut.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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