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

PwmOut.h@18:b3c9f16cbb96, 2010-05-17 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Mon May 17 14:18:54 2010 +0000
Revision:
18:b3c9f16cbb96
Parent:
11:1c1ebd0324fa
Child:
27:7110ebee3484
* Digital I/O speed improved

 * Added Port

 * Added OpenDrain mode

 * Fixes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - PwmOut
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford
rolf.meyer@arm.com 11:1c1ebd0324fa 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_PWMOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_PWMOUT_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: PwmOut
simon.ford@mbed.co.uk 0:82220227f4fa 17 * A pulse-width modulation digital output
simon.ford@mbed.co.uk 5:62573be585e9 18 *
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * Example
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * > // Fade a led on.
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > PwmOut led(LED1);
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * >
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 * > led = led + 0.01;
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > wait(0.2);
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > if(led == 1.0) {
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > led = 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 18:b3c9f16cbb96 34 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 * Note that on the LPC1768 and LPC2368, the PWMs all share the same
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 * period - if you change the period for one, you change it for all.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37 * Although routines that change the period maintain the duty cycle
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 * for its PWM, all other PWMs will require their duty cycle to be
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39 * refreshed.
simon.ford@mbed.co.uk 0:82220227f4fa 40 */
simon.ford@mbed.co.uk 0:82220227f4fa 41 class PwmOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 42
simon.ford@mbed.co.uk 0:82220227f4fa 43 public:
simon.ford@mbed.co.uk 0:82220227f4fa 44
rolf.meyer@arm.com 11:1c1ebd0324fa 45 /* Constructor: PwmOut
rolf.meyer@arm.com 11:1c1ebd0324fa 46 * Create a PwmOut connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 47 *
rolf.meyer@arm.com 11:1c1ebd0324fa 48 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * pin - PwmOut pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 50 */
rolf.meyer@arm.com 11:1c1ebd0324fa 51 PwmOut(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 52
rolf.meyer@arm.com 11:1c1ebd0324fa 53 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 54 * Set the ouput duty-cycle, specified as a percentage (float)
rolf.meyer@arm.com 11:1c1ebd0324fa 55 *
rolf.meyer@arm.com 11:1c1ebd0324fa 56 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 57 * value - A floating-point value representing the output duty-cycle,
rolf.meyer@arm.com 11:1c1ebd0324fa 58 * specified as a percentage. The value should lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 59 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * Values outside this range will be saturated to 0.0f or 1.0f.
rolf.meyer@arm.com 11:1c1ebd0324fa 61 */
rolf.meyer@arm.com 11:1c1ebd0324fa 62 void write(float value);
simon.ford@mbed.co.uk 0:82220227f4fa 63
rolf.meyer@arm.com 11:1c1ebd0324fa 64 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 65 * Return the current output duty-cycle setting, measured as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 66 *
simon.ford@mbed.co.uk 0:82220227f4fa 67 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * returns - A floating-point value representing the current duty-cycle 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 on 0%) and 1.0f (representing on 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 71 *
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * Note:
rolf.meyer@arm.com 11:1c1ebd0324fa 73 * This value may not match exactly the value set by a previous <write>.
rolf.meyer@arm.com 11:1c1ebd0324fa 74 */
simon.ford@mbed.co.uk 0:82220227f4fa 75 float read();
rolf.meyer@arm.com 11:1c1ebd0324fa 76
rolf.meyer@arm.com 11:1c1ebd0324fa 77 /* Function: period
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 * Set the PWM period, specified in seconds (float), keeping the
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79 * duty cycle the same.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 * Note:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82 * The resolution is currently in microseconds; periods smaller than this
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83 * will be set to zero.
rolf.meyer@arm.com 11:1c1ebd0324fa 84 */
rolf.meyer@arm.com 11:1c1ebd0324fa 85 void period(float seconds);
simon.ford@mbed.co.uk 0:82220227f4fa 86
rolf.meyer@arm.com 11:1c1ebd0324fa 87 /* Function: period_ms
simon.ford@mbed.co.uk 18:b3c9f16cbb96 88 * Set the PWM period, specified in milli-seconds (int), keeping the
simon.ford@mbed.co.uk 18:b3c9f16cbb96 89 * duty cycle the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 90 */
rolf.meyer@arm.com 11:1c1ebd0324fa 91 void period_ms(int ms);
simon.ford@mbed.co.uk 5:62573be585e9 92
rolf.meyer@arm.com 11:1c1ebd0324fa 93 /* Function: period_us
simon.ford@mbed.co.uk 18:b3c9f16cbb96 94 * Set the PWM period, specified in micro-seconds (int), keeping the
simon.ford@mbed.co.uk 18:b3c9f16cbb96 95 * duty cycle the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 96 */
rolf.meyer@arm.com 11:1c1ebd0324fa 97 void period_us(int us);
simon.ford@mbed.co.uk 5:62573be585e9 98
rolf.meyer@arm.com 11:1c1ebd0324fa 99 /* Function: pulsewidth
simon.ford@mbed.co.uk 18:b3c9f16cbb96 100 * Set the PWM pulsewidth, specified in seconds (float), keeping the
simon.ford@mbed.co.uk 18:b3c9f16cbb96 101 * period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 102 */
rolf.meyer@arm.com 11:1c1ebd0324fa 103 void pulsewidth(float seconds);
rolf.meyer@arm.com 11:1c1ebd0324fa 104
rolf.meyer@arm.com 11:1c1ebd0324fa 105 /* Function: pulsewidth_ms
simon.ford@mbed.co.uk 18:b3c9f16cbb96 106 * Set the PWM pulsewidth, specified in milli-seconds (int), keeping
simon.ford@mbed.co.uk 18:b3c9f16cbb96 107 * the period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 108 */
rolf.meyer@arm.com 11:1c1ebd0324fa 109 void pulsewidth_ms(int ms);
rolf.meyer@arm.com 11:1c1ebd0324fa 110
rolf.meyer@arm.com 11:1c1ebd0324fa 111 /* Function: pulsewidth_us
simon.ford@mbed.co.uk 18:b3c9f16cbb96 112 * Set the PWM pulsewidth, specified in micro-seconds (int), keeping
simon.ford@mbed.co.uk 18:b3c9f16cbb96 113 * the period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 114 */
rolf.meyer@arm.com 11:1c1ebd0324fa 115 void pulsewidth_us(int us);
simon.ford@mbed.co.uk 0:82220227f4fa 116
rolf.meyer@arm.com 11:1c1ebd0324fa 117 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 118 /* Function: operator=
rolf.meyer@arm.com 11:1c1ebd0324fa 119 * A operator shorthand for <write()>
rolf.meyer@arm.com 11:1c1ebd0324fa 120 */
rolf.meyer@arm.com 11:1c1ebd0324fa 121 PwmOut& operator= (float value);
rolf.meyer@arm.com 11:1c1ebd0324fa 122 PwmOut& operator= (PwmOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 123
rolf.meyer@arm.com 11:1c1ebd0324fa 124 /* Function: operator float()
rolf.meyer@arm.com 11:1c1ebd0324fa 125 * An operator shorthand for <read()>
rolf.meyer@arm.com 11:1c1ebd0324fa 126 */
rolf.meyer@arm.com 11:1c1ebd0324fa 127 operator float();
rolf.meyer@arm.com 11:1c1ebd0324fa 128 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 129
rolf.meyer@arm.com 11:1c1ebd0324fa 130 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 131 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 132 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 133 #endif
simon.ford@mbed.co.uk 5:62573be585e9 134
simon.ford@mbed.co.uk 0:82220227f4fa 135 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 136
rolf.meyer@arm.com 11:1c1ebd0324fa 137 PWMName _pwm;
rolf.meyer@arm.com 11:1c1ebd0324fa 138
simon.ford@mbed.co.uk 0:82220227f4fa 139 };
simon.ford@mbed.co.uk 0:82220227f4fa 140
rolf.meyer@arm.com 11:1c1ebd0324fa 141 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 142
simon.ford@mbed.co.uk 1:6b7f447ca868 143 #endif