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@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

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