/TARGET_K64F/TARGET_Freescale/TARGET_KPSDK_MCUS/TARGET_KPSDK_CODE/hal/adc/fsl_adc_hal.h substitute line 894 extern } by }
Fork of mbed by
AnalogOut.h@43:e2ed12d17f06, 2012-10-26 (annotated)
- Committer:
- emilmont
- Date:
- Fri Oct 26 17:40:46 2012 +0100
- Revision:
- 43:e2ed12d17f06
- Parent:
- 27:7110ebee3484
- Child:
- 44:24d45a770a51
Update documentation
Who changed what in which revision?
User | Revision | Line number | New 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 | |
emilmont | 43:e2ed12d17f06 | 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: |
emilmont | 43:e2ed12d17f06 | 22 | * @code |
emilmont | 43:e2ed12d17f06 | 23 | * // Make a sawtooth output |
emilmont | 43:e2ed12d17f06 | 24 | * |
emilmont | 43:e2ed12d17f06 | 25 | * #include "mbed.h" |
emilmont | 43:e2ed12d17f06 | 26 | * |
emilmont | 43:e2ed12d17f06 | 27 | * AnalogOut tri(p18); |
emilmont | 43:e2ed12d17f06 | 28 | * int main() { |
emilmont | 43:e2ed12d17f06 | 29 | * while(1) { |
emilmont | 43:e2ed12d17f06 | 30 | * tri = tri + 0.01; |
emilmont | 43:e2ed12d17f06 | 31 | * wait_us(1); |
emilmont | 43:e2ed12d17f06 | 32 | * if(tri == 1) { |
emilmont | 43:e2ed12d17f06 | 33 | * tri = 0; |
emilmont | 43:e2ed12d17f06 | 34 | * } |
emilmont | 43:e2ed12d17f06 | 35 | * } |
emilmont | 43:e2ed12d17f06 | 36 | * } |
emilmont | 43:e2ed12d17f06 | 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 | |
emilmont | 43:e2ed12d17f06 | 43 | /** Create an AnalogOut connected to the specified pin |
emilmont | 43:e2ed12d17f06 | 44 | * |
emilmont | 43:e2ed12d17f06 | 45 | * @param AnalogOut pin to connect to (18) |
emilmont | 43:e2ed12d17f06 | 46 | */ |
emilmont | 43:e2ed12d17f06 | 47 | AnalogOut(PinName pin, const char *name = NULL); |
emilmont | 43:e2ed12d17f06 | 48 | |
emilmont | 43:e2ed12d17f06 | 49 | /** Set the output voltage, specified as a percentage (float) |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 50 | * |
emilmont | 43:e2ed12d17f06 | 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%). |
emilmont | 43:e2ed12d17f06 | 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 | |
emilmont | 43:e2ed12d17f06 | 58 | /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF] |
simon.ford@mbed.co.uk | 5:62573be585e9 | 59 | * |
emilmont | 43:e2ed12d17f06 | 60 | * @param value 16-bit unsigned short representing the output voltage, |
emilmont | 43:e2ed12d17f06 | 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 | |
emilmont | 43:e2ed12d17f06 | 65 | /** Return the current output voltage setting, measured as a percentage (float) |
simon.ford@mbed.co.uk | 0:82220227f4fa | 66 | * |
emilmont | 43:e2ed12d17f06 | 67 | * @returns |
emilmont | 43:e2ed12d17f06 | 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 | * |
emilmont | 43:e2ed12d17f06 | 72 | * @note |
emilmont | 43:e2ed12d17f06 | 73 | * This value may not match exactly the value set by a previous write(). |
emilmont | 43:e2ed12d17f06 | 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 |
emilmont | 43:e2ed12d17f06 | 79 | /** An operator shorthand for write() |
simon.ford@mbed.co.uk | 0:82220227f4fa | 80 | */ |
emilmont | 43:e2ed12d17f06 | 81 | AnalogOut& operator= (float percent); |
emilmont | 43:e2ed12d17f06 | 82 | AnalogOut& operator= (AnalogOut& rhs); |
simon.ford@mbed.co.uk | 0:82220227f4fa | 83 | |
emilmont | 43:e2ed12d17f06 | 84 | /** An operator shorthand for read() |
emilmont | 43:e2ed12d17f06 | 85 | */ |
emilmont | 43:e2ed12d17f06 | 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 | |
emilmont | 43:e2ed12d17f06 | 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 |