航空研究会 / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed by -deleted-

PwmOut.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:
18:b3c9f16cbb96
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 - 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 0:82220227f4fa 34 */
simon.ford@mbed.co.uk 0:82220227f4fa 35 class PwmOut : 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
rolf.meyer@arm.com 11:1c1ebd0324fa 39 /* Constructor: PwmOut
rolf.meyer@arm.com 11:1c1ebd0324fa 40 * Create a PwmOut connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 41 *
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * pin - PwmOut pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 44 */
rolf.meyer@arm.com 11:1c1ebd0324fa 45 PwmOut(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 ouput duty-cycle, 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 * value - A floating-point value representing the output duty-cycle,
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 on 0%) and 1.0f (representing on 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
rolf.meyer@arm.com 11:1c1ebd0324fa 58 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 59 * Return the current output duty-cycle setting, measured as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 60 *
simon.ford@mbed.co.uk 0:82220227f4fa 61 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 62 * returns - A floating-point value representing the current duty-cycle being output on the pin,
rolf.meyer@arm.com 11:1c1ebd0324fa 63 * measured as a percentage. The returned value will lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 64 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 65 *
rolf.meyer@arm.com 11:1c1ebd0324fa 66 * Note:
rolf.meyer@arm.com 11:1c1ebd0324fa 67 * This value may not match exactly the value set by a previous <write>.
rolf.meyer@arm.com 11:1c1ebd0324fa 68 */
simon.ford@mbed.co.uk 0:82220227f4fa 69 float read();
rolf.meyer@arm.com 11:1c1ebd0324fa 70
rolf.meyer@arm.com 11:1c1ebd0324fa 71 /* Function: period
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * Set the PWM period, specified in seconds (float)
rolf.meyer@arm.com 11:1c1ebd0324fa 73 */
rolf.meyer@arm.com 11:1c1ebd0324fa 74 void period(float seconds);
simon.ford@mbed.co.uk 0:82220227f4fa 75
rolf.meyer@arm.com 11:1c1ebd0324fa 76 /* Function: period_ms
rolf.meyer@arm.com 11:1c1ebd0324fa 77 * Set the PWM period, specified in milli-seconds (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 78 */
rolf.meyer@arm.com 11:1c1ebd0324fa 79 void period_ms(int ms);
simon.ford@mbed.co.uk 5:62573be585e9 80
rolf.meyer@arm.com 11:1c1ebd0324fa 81 /* Function: period_us
rolf.meyer@arm.com 11:1c1ebd0324fa 82 * Set the PWM period, specified in micro-seconds (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 83 */
rolf.meyer@arm.com 11:1c1ebd0324fa 84 void period_us(int us);
simon.ford@mbed.co.uk 5:62573be585e9 85
rolf.meyer@arm.com 11:1c1ebd0324fa 86 /* Function: pulsewidth
rolf.meyer@arm.com 11:1c1ebd0324fa 87 * Set the PWM pulsewidth, specified in seconds (float)
rolf.meyer@arm.com 11:1c1ebd0324fa 88 */
rolf.meyer@arm.com 11:1c1ebd0324fa 89 void pulsewidth(float seconds);
rolf.meyer@arm.com 11:1c1ebd0324fa 90
rolf.meyer@arm.com 11:1c1ebd0324fa 91 /* Function: pulsewidth_ms
rolf.meyer@arm.com 11:1c1ebd0324fa 92 * Set the PWM pulsewidth, specified in milli-seconds (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 93 */
rolf.meyer@arm.com 11:1c1ebd0324fa 94 void pulsewidth_ms(int ms);
rolf.meyer@arm.com 11:1c1ebd0324fa 95
rolf.meyer@arm.com 11:1c1ebd0324fa 96 /* Function: pulsewidth_us
rolf.meyer@arm.com 11:1c1ebd0324fa 97 * Set the PWM pulsewidth, specified in micro-seconds (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 98 */
rolf.meyer@arm.com 11:1c1ebd0324fa 99 void pulsewidth_us(int us);
simon.ford@mbed.co.uk 0:82220227f4fa 100
rolf.meyer@arm.com 11:1c1ebd0324fa 101 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 102 /* Function: operator=
rolf.meyer@arm.com 11:1c1ebd0324fa 103 * A operator shorthand for <write()>
rolf.meyer@arm.com 11:1c1ebd0324fa 104 */
rolf.meyer@arm.com 11:1c1ebd0324fa 105 PwmOut& operator= (float value);
rolf.meyer@arm.com 11:1c1ebd0324fa 106 PwmOut& operator= (PwmOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 107
rolf.meyer@arm.com 11:1c1ebd0324fa 108 /* Function: operator float()
rolf.meyer@arm.com 11:1c1ebd0324fa 109 * An operator shorthand for <read()>
rolf.meyer@arm.com 11:1c1ebd0324fa 110 */
rolf.meyer@arm.com 11:1c1ebd0324fa 111 operator float();
rolf.meyer@arm.com 11:1c1ebd0324fa 112 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 113
rolf.meyer@arm.com 11:1c1ebd0324fa 114 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 115 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 116 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 117 #endif
simon.ford@mbed.co.uk 5:62573be585e9 118
simon.ford@mbed.co.uk 0:82220227f4fa 119 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 120
rolf.meyer@arm.com 11:1c1ebd0324fa 121 PWMName _pwm;
rolf.meyer@arm.com 11:1c1ebd0324fa 122
simon.ford@mbed.co.uk 0:82220227f4fa 123 };
simon.ford@mbed.co.uk 0:82220227f4fa 124
rolf.meyer@arm.com 11:1c1ebd0324fa 125 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 126
simon.ford@mbed.co.uk 1:6b7f447ca868 127 #endif