Jhon Plantikow / mbed

.

Dependents:   RTC

AnalogOut.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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