Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

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

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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