DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/AnalogOut.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

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