Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/AnalogOut.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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