Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

AnalogOut.h@120:2eb10e18b8d7, 2016-04-13 (annotated)

Committer:
elijahorr
Date:
Wed Apr 13 12:29:27 2016 +0000
Revision:
120:2eb10e18b8d7
Parent:
65:5798e58a58b1 
V1.1

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 *
bogdanm 65:5798e58a58b1 29 * Example:
bogdanm 65:5798e58a58b1 30 * @code
bogdanm 65:5798e58a58b1 31 * // Make a sawtooth output
bogdanm 65:5798e58a58b1 32 *
bogdanm 65:5798e58a58b1 33 * #include "mbed.h"
bogdanm 65:5798e58a58b1 34 *
bogdanm 65:5798e58a58b1 35 * AnalogOut tri(p18);
bogdanm 65:5798e58a58b1 36 * int main() {
bogdanm 65:5798e58a58b1 37 * while(1) {
bogdanm 65:5798e58a58b1 38 * tri = tri + 0.01;
bogdanm 65:5798e58a58b1 39 * wait_us(1);
bogdanm 65:5798e58a58b1 40 * if(tri == 1) {
bogdanm 65:5798e58a58b1 41 * tri = 0;
bogdanm 65:5798e58a58b1 42 * }
bogdanm 65:5798e58a58b1 43 * }
bogdanm 65:5798e58a58b1 44 * }
bogdanm 65:5798e58a58b1 45 * @endcode
bogdanm 65:5798e58a58b1 46 */
bogdanm 65:5798e58a58b1 47 class AnalogOut {
bogdanm 65:5798e58a58b1 48
bogdanm 65:5798e58a58b1 49 public:
bogdanm 65:5798e58a58b1 50
bogdanm 65:5798e58a58b1 51 /** Create an AnalogOut connected to the specified pin
bogdanm 65:5798e58a58b1 52 *
bogdanm 65:5798e58a58b1 53 * @param AnalogOut pin to connect to (18)
bogdanm 65:5798e58a58b1 54 */
bogdanm 65:5798e58a58b1 55 AnalogOut(PinName pin) {
bogdanm 65:5798e58a58b1 56 analogout_init(&_dac, pin);
bogdanm 65:5798e58a58b1 57 }
bogdanm 65:5798e58a58b1 58
bogdanm 65:5798e58a58b1 59 /** Set the output voltage, specified as a percentage (float)
bogdanm 65:5798e58a58b1 60 *
bogdanm 65:5798e58a58b1 61 * @param value A floating-point value representing the output voltage,
bogdanm 65:5798e58a58b1 62 * specified as a percentage. The value should lie between
bogdanm 65:5798e58a58b1 63 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm 65:5798e58a58b1 64 * Values outside this range will be saturated to 0.0f or 1.0f.
bogdanm 65:5798e58a58b1 65 */
bogdanm 65:5798e58a58b1 66 void write(float value) {
bogdanm 65:5798e58a58b1 67 analogout_write(&_dac, value);
bogdanm 65:5798e58a58b1 68 }
bogdanm 65:5798e58a58b1 69
bogdanm 65:5798e58a58b1 70 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
bogdanm 65:5798e58a58b1 71 *
bogdanm 65:5798e58a58b1 72 * @param value 16-bit unsigned short representing the output voltage,
bogdanm 65:5798e58a58b1 73 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
bogdanm 65:5798e58a58b1 74 */
bogdanm 65:5798e58a58b1 75 void write_u16(unsigned short value) {
bogdanm 65:5798e58a58b1 76 analogout_write_u16(&_dac, value);
bogdanm 65:5798e58a58b1 77 }
bogdanm 65:5798e58a58b1 78
bogdanm 65:5798e58a58b1 79 /** Return the current output voltage setting, measured as a percentage (float)
bogdanm 65:5798e58a58b1 80 *
bogdanm 65:5798e58a58b1 81 * @returns
bogdanm 65:5798e58a58b1 82 * A floating-point value representing the current voltage being output on the pin,
bogdanm 65:5798e58a58b1 83 * measured as a percentage. The returned value will lie between
bogdanm 65:5798e58a58b1 84 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
bogdanm 65:5798e58a58b1 85 *
bogdanm 65:5798e58a58b1 86 * @note
bogdanm 65:5798e58a58b1 87 * This value may not match exactly the value set by a previous write().
bogdanm 65:5798e58a58b1 88 */
bogdanm 65:5798e58a58b1 89 float read() {
bogdanm 65:5798e58a58b1 90 return analogout_read(&_dac);
bogdanm 65:5798e58a58b1 91 }
bogdanm 65:5798e58a58b1 92
bogdanm 65:5798e58a58b1 93 #ifdef MBED_OPERATORS
bogdanm 65:5798e58a58b1 94 /** An operator shorthand for write()
bogdanm 65:5798e58a58b1 95 */
bogdanm 65:5798e58a58b1 96 AnalogOut& operator= (float percent) {
bogdanm 65:5798e58a58b1 97 write(percent);
bogdanm 65:5798e58a58b1 98 return *this;
bogdanm 65:5798e58a58b1 99 }
bogdanm 65:5798e58a58b1 100
bogdanm 65:5798e58a58b1 101 AnalogOut& operator= (AnalogOut& rhs) {
bogdanm 65:5798e58a58b1 102 write(rhs.read());
bogdanm 65:5798e58a58b1 103 return *this;
bogdanm 65:5798e58a58b1 104 }
bogdanm 65:5798e58a58b1 105
bogdanm 65:5798e58a58b1 106 /** An operator shorthand for read()
bogdanm 65:5798e58a58b1 107 */
bogdanm 65:5798e58a58b1 108 operator float() {
bogdanm 65:5798e58a58b1 109 return read();
bogdanm 65:5798e58a58b1 110 }
bogdanm 65:5798e58a58b1 111 #endif
bogdanm 65:5798e58a58b1 112
bogdanm 65:5798e58a58b1 113 protected:
bogdanm 65:5798e58a58b1 114 dac_t _dac;
bogdanm 65:5798e58a58b1 115 };
bogdanm 65:5798e58a58b1 116
bogdanm 65:5798e58a58b1 117 } // namespace mbed
bogdanm 65:5798e58a58b1 118
bogdanm 65:5798e58a58b1 119 #endif
bogdanm 65:5798e58a58b1 120
bogdanm 65:5798e58a58b1 121 #endif