Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

AnalogOut.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
5:62573be585e9
Child:
27:7110ebee3484
A shiny new version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - AnalogOut
simon.ford@mbed.co.uk 5:62573be585e9 2 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 5:62573be585e9 3 * sford
simon.ford@mbed.co.uk 5:62573be585e9 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_ANALOGOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_ANALOGOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 13
simon.ford@mbed.co.uk 0:82220227f4fa 14 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 15
simon.ford@mbed.co.uk 0:82220227f4fa 16 /* Class: AnalogOut
simon.ford@mbed.co.uk 0:82220227f4fa 17 * An analog output, used for setting the voltage on a pin
rolf.meyer@arm.com 11:1c1ebd0324fa 18 *
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * > // Make a sawtooth output
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > AnalogOut tri(p18);
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * > while(1) {
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * > tri = tri + 0.01;
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > wait_us(1);
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > if(tri == 1) {
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > tri = 0;
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 34 */
simon.ford@mbed.co.uk 0:82220227f4fa 35 class AnalogOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 36
simon.ford@mbed.co.uk 0:82220227f4fa 37 public:
simon.ford@mbed.co.uk 0:82220227f4fa 38
simon.ford@mbed.co.uk 0:82220227f4fa 39 /* Constructor: AnalogOut
simon.ford@mbed.co.uk 0:82220227f4fa 40 * Create an AnalogOut connected to the specified pin
simon.ford@mbed.co.uk 0:82220227f4fa 41 *
simon.ford@mbed.co.uk 0:82220227f4fa 42 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 43 * pin - AnalogOut pin to connect to (18)
simon.ford@mbed.co.uk 0:82220227f4fa 44 */
rolf.meyer@arm.com 11:1c1ebd0324fa 45 AnalogOut(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 46
rolf.meyer@arm.com 11:1c1ebd0324fa 47 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 48 * Set the output voltage, specified as a percentage (float)
rolf.meyer@arm.com 11:1c1ebd0324fa 49 *
rolf.meyer@arm.com 11:1c1ebd0324fa 50 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 51 * percent - A floating-point value representing the output voltage,
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * specified as a percentage. The value should lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 53 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 54 * Values outside this range will be saturated to 0.0f or 1.0f.
rolf.meyer@arm.com 11:1c1ebd0324fa 55 */
rolf.meyer@arm.com 11:1c1ebd0324fa 56 void write(float value);
simon.ford@mbed.co.uk 0:82220227f4fa 57
simon.ford@mbed.co.uk 5:62573be585e9 58 /* Function: write_u16
simon.ford@mbed.co.uk 5:62573be585e9 59 * Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
simon.ford@mbed.co.uk 5:62573be585e9 60 *
simon.ford@mbed.co.uk 5:62573be585e9 61 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 62 * value - 16-bit unsigned short representing the output voltage,
simon.ford@mbed.co.uk 5:62573be585e9 63 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
simon.ford@mbed.co.uk 5:62573be585e9 64 */
simon.ford@mbed.co.uk 5:62573be585e9 65 void write_u16(unsigned short value);
simon.ford@mbed.co.uk 5:62573be585e9 66
simon.ford@mbed.co.uk 0:82220227f4fa 67 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * Return the current output voltage setting, measured as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 69 *
simon.ford@mbed.co.uk 0:82220227f4fa 70 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 71 * returns - A floating-point value representing the current voltage being output on the pin,
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * measured as a percentage. The returned value will lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 73 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 74 *
rolf.meyer@arm.com 11:1c1ebd0324fa 75 * Note:
rolf.meyer@arm.com 11:1c1ebd0324fa 76 * This value may not match exactly the value set by a previous <write>.
rolf.meyer@arm.com 11:1c1ebd0324fa 77 */
simon.ford@mbed.co.uk 0:82220227f4fa 78 float read();
simon.ford@mbed.co.uk 0:82220227f4fa 79
rolf.meyer@arm.com 11:1c1ebd0324fa 80
rolf.meyer@arm.com 11:1c1ebd0324fa 81 #ifdef MBED_OPERATORS
simon.ford@mbed.co.uk 0:82220227f4fa 82 /* Function: operator=
simon.ford@mbed.co.uk 5:62573be585e9 83 * An operator shorthand for <write()>
simon.ford@mbed.co.uk 0:82220227f4fa 84 */
simon.ford@mbed.co.uk 0:82220227f4fa 85 AnalogOut& operator= (float percent);
simon.ford@mbed.co.uk 0:82220227f4fa 86 AnalogOut& operator= (AnalogOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 87
simon.ford@mbed.co.uk 0:82220227f4fa 88 /* Function: operator float()
rolf.meyer@arm.com 11:1c1ebd0324fa 89 * An operator shorthand for <read()>
rolf.meyer@arm.com 11:1c1ebd0324fa 90 */
simon.ford@mbed.co.uk 0:82220227f4fa 91 operator float();
rolf.meyer@arm.com 11:1c1ebd0324fa 92 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 95 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 96 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 97 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 98
rolf.meyer@arm.com 11:1c1ebd0324fa 99 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 100
rolf.meyer@arm.com 11:1c1ebd0324fa 101 DACName _dac;
simon.ford@mbed.co.uk 5:62573be585e9 102
simon.ford@mbed.co.uk 0:82220227f4fa 103 };
simon.ford@mbed.co.uk 0:82220227f4fa 104
rolf.meyer@arm.com 11:1c1ebd0324fa 105 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 106
simon.ford@mbed.co.uk 1:6b7f447ca868 107 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 108