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@4:5d1359a283bc, 2008-11-27 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Nov 27 16:23:24 2008 +0000
Revision:
4:5d1359a283bc
Parent:
1:6b7f447ca868
Child:
5:62573be585e9
New version of framework: vectors, environment, platform, base and file system

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - PwmOut
simon.ford@mbed.co.uk 0:82220227f4fa 2 * Copyright (c) 2007-2008, sford
simon.ford@mbed.co.uk 0:82220227f4fa 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_PWMOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_PWMOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
simon.ford@mbed.co.uk 0:82220227f4fa 8 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 9
simon.ford@mbed.co.uk 0:82220227f4fa 10 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 11
simon.ford@mbed.co.uk 0:82220227f4fa 12 /* Class: PwmOut
simon.ford@mbed.co.uk 0:82220227f4fa 13 * A pulse-width modulation digital output
simon.ford@mbed.co.uk 0:82220227f4fa 14 */
simon.ford@mbed.co.uk 0:82220227f4fa 15 class PwmOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 16
simon.ford@mbed.co.uk 0:82220227f4fa 17 public:
simon.ford@mbed.co.uk 0:82220227f4fa 18
simon.ford@mbed.co.uk 0:82220227f4fa 19 /* Group: Configuration Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 20
simon.ford@mbed.co.uk 0:82220227f4fa 21 /* Constructor: PwmOut
simon.ford@mbed.co.uk 0:82220227f4fa 22 * Create a PwmOut connected to the specified pin
simon.ford@mbed.co.uk 0:82220227f4fa 23 *
simon.ford@mbed.co.uk 0:82220227f4fa 24 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 25 * pin - PwmOut pin to connect to (21-26)
simon.ford@mbed.co.uk 0:82220227f4fa 26 */
simon.ford@mbed.co.uk 4:5d1359a283bc 27 PwmOut(int pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 28
simon.ford@mbed.co.uk 0:82220227f4fa 29 /* Group: Access Methods (Analog-like) */
simon.ford@mbed.co.uk 0:82220227f4fa 30
simon.ford@mbed.co.uk 0:82220227f4fa 31 /* Function: write
simon.ford@mbed.co.uk 0:82220227f4fa 32 * Set the ouput duty-cycle, specified as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 33 *
simon.ford@mbed.co.uk 0:82220227f4fa 34 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 35 * percent - A floating-point value representing the output duty-cycle,
simon.ford@mbed.co.uk 0:82220227f4fa 36 * specified as a percentage. The value should lie between
simon.ford@mbed.co.uk 0:82220227f4fa 37 * 0.0f (representing 0v / on 0%) and 1.0f (representing 3.3v / on 100%).
simon.ford@mbed.co.uk 0:82220227f4fa 38 * Values outside this range will be saturated to 0.0f or 1.0f.
simon.ford@mbed.co.uk 0:82220227f4fa 39 */
simon.ford@mbed.co.uk 0:82220227f4fa 40 void write(float percent);
simon.ford@mbed.co.uk 0:82220227f4fa 41
simon.ford@mbed.co.uk 0:82220227f4fa 42 /* Function: write_v
simon.ford@mbed.co.uk 0:82220227f4fa 43 * Set the output duty-cycle, specified in volts (float)
simon.ford@mbed.co.uk 0:82220227f4fa 44 *
simon.ford@mbed.co.uk 0:82220227f4fa 45 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 46 * v - A floating-point value representing the output duty-cycle,
simon.ford@mbed.co.uk 0:82220227f4fa 47 * specified in volts. The value should lie between
simon.ford@mbed.co.uk 0:82220227f4fa 48 * 0.0f (representing 0v / 0% on) and 3.3f (representing 3.3v / 100% on).
simon.ford@mbed.co.uk 0:82220227f4fa 49 * Values outside this range will be saturated to 0.0f or 3.3f.
simon.ford@mbed.co.uk 0:82220227f4fa 50 */
simon.ford@mbed.co.uk 0:82220227f4fa 51 void write_v(float v);
simon.ford@mbed.co.uk 0:82220227f4fa 52
simon.ford@mbed.co.uk 0:82220227f4fa 53 /* Function: write_mv
simon.ford@mbed.co.uk 0:82220227f4fa 54 * Set the output duty-cycle, specified in mili-volts (int)
simon.ford@mbed.co.uk 0:82220227f4fa 55 *
simon.ford@mbed.co.uk 0:82220227f4fa 56 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 57 * mv - An integer value representing the output duty-cycle,
simon.ford@mbed.co.uk 0:82220227f4fa 58 * specified in milli-volts. The value should lie between
simon.ford@mbed.co.uk 0:82220227f4fa 59 * 0 (representing 0v / 0% on) and 3300 (representing 3.3v / 100% on).
simon.ford@mbed.co.uk 0:82220227f4fa 60 * Values outside this range will be saturated to 0 or 3300.
simon.ford@mbed.co.uk 0:82220227f4fa 61 */
simon.ford@mbed.co.uk 0:82220227f4fa 62 void write_mv(int mv);
simon.ford@mbed.co.uk 0:82220227f4fa 63
simon.ford@mbed.co.uk 0:82220227f4fa 64 /* Function: read
simon.ford@mbed.co.uk 0:82220227f4fa 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:
simon.ford@mbed.co.uk 0:82220227f4fa 68 * returns - A floating-point value representing the current duty-cycle being output on the pin,
simon.ford@mbed.co.uk 0:82220227f4fa 69 * measured as a percentage. The returned value will lie between
simon.ford@mbed.co.uk 0:82220227f4fa 70 * 0.0f (representing 0v / 0% on) and 1.0f (representing 3.3v / 100% on).
simon.ford@mbed.co.uk 0:82220227f4fa 71 *
simon.ford@mbed.co.uk 0:82220227f4fa 72 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 73 * This value may not match exactly the value set by a previous <write>.
simon.ford@mbed.co.uk 0:82220227f4fa 74 */
simon.ford@mbed.co.uk 0:82220227f4fa 75 float read();
simon.ford@mbed.co.uk 0:82220227f4fa 76
simon.ford@mbed.co.uk 0:82220227f4fa 77 /* Group: Access Methods (Pulse-width) */
simon.ford@mbed.co.uk 0:82220227f4fa 78
simon.ford@mbed.co.uk 0:82220227f4fa 79 /* Function: period
simon.ford@mbed.co.uk 0:82220227f4fa 80 * Set the PWM period, specified in seconds (float)
simon.ford@mbed.co.uk 0:82220227f4fa 81 *
simon.ford@mbed.co.uk 0:82220227f4fa 82 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 83 * This is common to all PwmOut's, so changing it on one will change them all
simon.ford@mbed.co.uk 0:82220227f4fa 84 */
simon.ford@mbed.co.uk 0:82220227f4fa 85 void period(float seconds);
simon.ford@mbed.co.uk 0:82220227f4fa 86
simon.ford@mbed.co.uk 0:82220227f4fa 87 /* Function: pulsewidth
simon.ford@mbed.co.uk 0:82220227f4fa 88 * Set the PWM pulsewidth, specified in seconds (float)
simon.ford@mbed.co.uk 0:82220227f4fa 89 */
simon.ford@mbed.co.uk 0:82220227f4fa 90 void pulsewidth(float seconds);
simon.ford@mbed.co.uk 0:82220227f4fa 91
simon.ford@mbed.co.uk 0:82220227f4fa 92 /* Function: period_ms
simon.ford@mbed.co.uk 0:82220227f4fa 93 * Set the PWM period, specified in milli-seconds (int)
simon.ford@mbed.co.uk 0:82220227f4fa 94 *
simon.ford@mbed.co.uk 0:82220227f4fa 95 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 96 * This is common to all PwmOut's, so changing it on one will change them all
simon.ford@mbed.co.uk 0:82220227f4fa 97 */
simon.ford@mbed.co.uk 0:82220227f4fa 98 void period_ms(int ms);
simon.ford@mbed.co.uk 0:82220227f4fa 99
simon.ford@mbed.co.uk 0:82220227f4fa 100 /* Function: pulsewidth_ms
simon.ford@mbed.co.uk 0:82220227f4fa 101 * Set the PWM pulsewidth, specified in milli-seconds (int)
simon.ford@mbed.co.uk 0:82220227f4fa 102 */
simon.ford@mbed.co.uk 0:82220227f4fa 103 void pulsewidth_ms(int ms);
simon.ford@mbed.co.uk 0:82220227f4fa 104
simon.ford@mbed.co.uk 0:82220227f4fa 105 /* Function: period_us
simon.ford@mbed.co.uk 0:82220227f4fa 106 * Set the PWM period, specified in micro-seconds (int)
simon.ford@mbed.co.uk 0:82220227f4fa 107 *
simon.ford@mbed.co.uk 0:82220227f4fa 108 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 109 * This is common to all PwmOut's, so changing it on one will change them all
simon.ford@mbed.co.uk 0:82220227f4fa 110 */
simon.ford@mbed.co.uk 0:82220227f4fa 111 void period_us(int us);
simon.ford@mbed.co.uk 0:82220227f4fa 112
simon.ford@mbed.co.uk 0:82220227f4fa 113 /* Function: pulsewidth_us
simon.ford@mbed.co.uk 0:82220227f4fa 114 * Set the PWM pulsewidth, specified in micro-seconds (int)
simon.ford@mbed.co.uk 0:82220227f4fa 115 */
simon.ford@mbed.co.uk 0:82220227f4fa 116 void pulsewidth_us(int us);
simon.ford@mbed.co.uk 0:82220227f4fa 117
simon.ford@mbed.co.uk 0:82220227f4fa 118 /* Group: Access Method Shorthand */
simon.ford@mbed.co.uk 0:82220227f4fa 119
simon.ford@mbed.co.uk 0:82220227f4fa 120 /* Function: operator=
simon.ford@mbed.co.uk 0:82220227f4fa 121 * A shorthand for <write>
simon.ford@mbed.co.uk 0:82220227f4fa 122 */
simon.ford@mbed.co.uk 0:82220227f4fa 123 PwmOut& operator= (float percent);
simon.ford@mbed.co.uk 0:82220227f4fa 124 PwmOut& operator= (PwmOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 125
simon.ford@mbed.co.uk 0:82220227f4fa 126 /* Function: operator float()
simon.ford@mbed.co.uk 0:82220227f4fa 127 * A shorthand for <read>
simon.ford@mbed.co.uk 0:82220227f4fa 128 */
simon.ford@mbed.co.uk 0:82220227f4fa 129 operator float();
simon.ford@mbed.co.uk 4:5d1359a283bc 130
simon.ford@mbed.co.uk 4:5d1359a283bc 131 virtual const struct rpc_method *rpc_methods();
simon.ford@mbed.co.uk 0:82220227f4fa 132
simon.ford@mbed.co.uk 0:82220227f4fa 133 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 134
simon.ford@mbed.co.uk 0:82220227f4fa 135 int _id;
simon.ford@mbed.co.uk 0:82220227f4fa 136 };
simon.ford@mbed.co.uk 0:82220227f4fa 137
simon.ford@mbed.co.uk 0:82220227f4fa 138 }
simon.ford@mbed.co.uk 0:82220227f4fa 139
simon.ford@mbed.co.uk 1:6b7f447ca868 140 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 141