Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

AnalogOut.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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