Vladimir Vana / mbed

pro vyuku PSS v Jecne

AnalogOut.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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