Sigve Sebastian Farstad / mbed-src

mbed w/ spi bug fig

Dependents:   display-puck

Fork of mbed-src by mbed official

cpp/AnalogOut.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_ANALOGOUT_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_ANALOGOUT_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_ANALOGOUT
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #include "analogout_api.h"
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 /** An analog output, used for setting the voltage on a pin
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * Example:
mbed_official 0:fd0d7bdfcdc2 36 * @code
mbed_official 0:fd0d7bdfcdc2 37 * // Make a sawtooth output
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 40 *
mbed_official 0:fd0d7bdfcdc2 41 * AnalogOut tri(p18);
mbed_official 0:fd0d7bdfcdc2 42 * int main() {
mbed_official 0:fd0d7bdfcdc2 43 * while(1) {
mbed_official 0:fd0d7bdfcdc2 44 * tri = tri + 0.01;
mbed_official 0:fd0d7bdfcdc2 45 * wait_us(1);
mbed_official 0:fd0d7bdfcdc2 46 * if(tri == 1) {
mbed_official 0:fd0d7bdfcdc2 47 * tri = 0;
mbed_official 0:fd0d7bdfcdc2 48 * }
mbed_official 0:fd0d7bdfcdc2 49 * }
mbed_official 0:fd0d7bdfcdc2 50 * }
mbed_official 0:fd0d7bdfcdc2 51 * @endcode
mbed_official 0:fd0d7bdfcdc2 52 */
mbed_official 0:fd0d7bdfcdc2 53 class AnalogOut {
mbed_official 0:fd0d7bdfcdc2 54
mbed_official 0:fd0d7bdfcdc2 55 public:
mbed_official 0:fd0d7bdfcdc2 56
mbed_official 0:fd0d7bdfcdc2 57 /** Create an AnalogOut connected to the specified pin
mbed_official 0:fd0d7bdfcdc2 58 *
mbed_official 0:fd0d7bdfcdc2 59 * @param AnalogOut pin to connect to (18)
mbed_official 0:fd0d7bdfcdc2 60 */
mbed_official 0:fd0d7bdfcdc2 61 AnalogOut(PinName pin) {
mbed_official 0:fd0d7bdfcdc2 62 analogout_init(&_dac, pin);
mbed_official 0:fd0d7bdfcdc2 63 }
mbed_official 0:fd0d7bdfcdc2 64
mbed_official 0:fd0d7bdfcdc2 65 /** Set the output voltage, specified as a percentage (float)
mbed_official 0:fd0d7bdfcdc2 66 *
mbed_official 0:fd0d7bdfcdc2 67 * @param value A floating-point value representing the output voltage,
mbed_official 0:fd0d7bdfcdc2 68 * specified as a percentage. The value should lie between
mbed_official 0:fd0d7bdfcdc2 69 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
mbed_official 0:fd0d7bdfcdc2 70 * Values outside this range will be saturated to 0.0f or 1.0f.
mbed_official 0:fd0d7bdfcdc2 71 */
mbed_official 0:fd0d7bdfcdc2 72 void write(float value) {
mbed_official 0:fd0d7bdfcdc2 73 analogout_write(&_dac, value);
mbed_official 0:fd0d7bdfcdc2 74 }
mbed_official 0:fd0d7bdfcdc2 75
mbed_official 0:fd0d7bdfcdc2 76 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
mbed_official 0:fd0d7bdfcdc2 77 *
mbed_official 0:fd0d7bdfcdc2 78 * @param value 16-bit unsigned short representing the output voltage,
mbed_official 0:fd0d7bdfcdc2 79 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
mbed_official 0:fd0d7bdfcdc2 80 */
mbed_official 0:fd0d7bdfcdc2 81 void write_u16(unsigned short value) {
mbed_official 0:fd0d7bdfcdc2 82 analogout_write_u16(&_dac, value);
mbed_official 0:fd0d7bdfcdc2 83 }
mbed_official 0:fd0d7bdfcdc2 84
mbed_official 0:fd0d7bdfcdc2 85 /** Return the current output voltage setting, measured as a percentage (float)
mbed_official 0:fd0d7bdfcdc2 86 *
mbed_official 0:fd0d7bdfcdc2 87 * @returns
mbed_official 0:fd0d7bdfcdc2 88 * A floating-point value representing the current voltage being output on the pin,
mbed_official 0:fd0d7bdfcdc2 89 * measured as a percentage. The returned value will lie between
mbed_official 0:fd0d7bdfcdc2 90 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
mbed_official 0:fd0d7bdfcdc2 91 *
mbed_official 0:fd0d7bdfcdc2 92 * @note
mbed_official 0:fd0d7bdfcdc2 93 * This value may not match exactly the value set by a previous write().
mbed_official 0:fd0d7bdfcdc2 94 */
mbed_official 0:fd0d7bdfcdc2 95 float read() {
mbed_official 0:fd0d7bdfcdc2 96 return analogout_read(&_dac);
mbed_official 0:fd0d7bdfcdc2 97 }
mbed_official 0:fd0d7bdfcdc2 98
mbed_official 0:fd0d7bdfcdc2 99 #ifdef MBED_OPERATORS
mbed_official 0:fd0d7bdfcdc2 100 /** An operator shorthand for write()
mbed_official 0:fd0d7bdfcdc2 101 */
mbed_official 0:fd0d7bdfcdc2 102 AnalogOut& operator= (float percent) {
mbed_official 0:fd0d7bdfcdc2 103 write(percent);
mbed_official 0:fd0d7bdfcdc2 104 return *this;
mbed_official 0:fd0d7bdfcdc2 105 }
mbed_official 0:fd0d7bdfcdc2 106
mbed_official 0:fd0d7bdfcdc2 107 AnalogOut& operator= (AnalogOut& rhs) {
mbed_official 0:fd0d7bdfcdc2 108 write(rhs.read());
mbed_official 0:fd0d7bdfcdc2 109 return *this;
mbed_official 0:fd0d7bdfcdc2 110 }
mbed_official 0:fd0d7bdfcdc2 111
mbed_official 0:fd0d7bdfcdc2 112 /** An operator shorthand for read()
mbed_official 0:fd0d7bdfcdc2 113 */
mbed_official 0:fd0d7bdfcdc2 114 operator float() {
mbed_official 0:fd0d7bdfcdc2 115 return read();
mbed_official 0:fd0d7bdfcdc2 116 }
mbed_official 0:fd0d7bdfcdc2 117 #endif
mbed_official 0:fd0d7bdfcdc2 118
mbed_official 0:fd0d7bdfcdc2 119 protected:
mbed_official 0:fd0d7bdfcdc2 120 dac_t _dac;
mbed_official 0:fd0d7bdfcdc2 121 };
mbed_official 0:fd0d7bdfcdc2 122
mbed_official 0:fd0d7bdfcdc2 123 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 124
mbed_official 0:fd0d7bdfcdc2 125 #endif
mbed_official 0:fd0d7bdfcdc2 126
mbed_official 0:fd0d7bdfcdc2 127 #endif