Anand Tamariya / 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 mbed official

PwmOut.h@55:d722ed6a4237, 2013-01-16 (annotated)

Committer:
emilmont
Date:
Wed Jan 16 12:56:34 2013 +0000
Revision:
55:d722ed6a4237
Parent:
54:71b101360fb9
Child:
59:0883845fe643
Include "sleep_api.h" in "mbed.h"

Add initial IAR toolchain support

LPC I2C: better handling of status

Add sleep mode support for the LPC1768

Correct GCC "__semihost" definition

Correct GCC "_isatty" retargeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
simon.ford@mbed.co.uk 0:82220227f4fa 22 #ifndef MBED_PWMOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 23 #define MBED_PWMOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 27:7110ebee3484 26
emilmont 27:7110ebee3484 27 #if DEVICE_PWMOUT
emilmont 44:24d45a770a51 28 #include "pwmout_api.h"
simon.ford@mbed.co.uk 0:82220227f4fa 29
simon.ford@mbed.co.uk 0:82220227f4fa 30 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 31
emilmont 43:e2ed12d17f06 32 /** A pulse-width modulation digital output
simon.ford@mbed.co.uk 5:62573be585e9 33 *
rolf.meyer@arm.com 11:1c1ebd0324fa 34 * Example
emilmont 43:e2ed12d17f06 35 * @code
emilmont 43:e2ed12d17f06 36 * // Fade a led on.
emilmont 43:e2ed12d17f06 37 * #include "mbed.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 *
emilmont 43:e2ed12d17f06 39 * PwmOut led(LED1);
emilmont 55:d722ed6a4237 40 *
emilmont 43:e2ed12d17f06 41 * int main() {
emilmont 43:e2ed12d17f06 42 * while(1) {
emilmont 43:e2ed12d17f06 43 * led = led + 0.01;
emilmont 43:e2ed12d17f06 44 * wait(0.2);
emilmont 43:e2ed12d17f06 45 * if(led == 1.0) {
emilmont 43:e2ed12d17f06 46 * led = 0;
emilmont 43:e2ed12d17f06 47 * }
emilmont 43:e2ed12d17f06 48 * }
emilmont 43:e2ed12d17f06 49 * }
emilmont 43:e2ed12d17f06 50 * @endcode
emilmont 43:e2ed12d17f06 51 *
emilmont 43:e2ed12d17f06 52 * @note
emilmont 43:e2ed12d17f06 53 * On the LPC1768 and LPC2368, the PWMs all share the same
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 * period - if you change the period for one, you change it for all.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 * Although routines that change the period maintain the duty cycle
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56 * for its PWM, all other PWMs will require their duty cycle to be
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 * refreshed.
simon.ford@mbed.co.uk 0:82220227f4fa 58 */
emilmont 44:24d45a770a51 59 class PwmOut {
simon.ford@mbed.co.uk 0:82220227f4fa 60
simon.ford@mbed.co.uk 0:82220227f4fa 61 public:
simon.ford@mbed.co.uk 0:82220227f4fa 62
emilmont 43:e2ed12d17f06 63 /** Create a PwmOut connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 64 *
emilmont 43:e2ed12d17f06 65 * @param pin PwmOut pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 66 */
emilmont 44:24d45a770a51 67 PwmOut(PinName pin) {
emilmont 44:24d45a770a51 68 pwmout_init(&_pwm, pin);
emilmont 44:24d45a770a51 69 }
simon.ford@mbed.co.uk 0:82220227f4fa 70
emilmont 43:e2ed12d17f06 71 /** Set the ouput duty-cycle, specified as a percentage (float)
rolf.meyer@arm.com 11:1c1ebd0324fa 72 *
emilmont 55:d722ed6a4237 73 * @param value A floating-point value representing the output duty-cycle,
rolf.meyer@arm.com 11:1c1ebd0324fa 74 * specified as a percentage. The value should lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 75 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
emilmont 44:24d45a770a51 76 * Values outside this range will be saturated to 0.0f or 1.0f.
rolf.meyer@arm.com 11:1c1ebd0324fa 77 */
emilmont 44:24d45a770a51 78 void write(float value) {
emilmont 44:24d45a770a51 79 pwmout_write(&_pwm, value);
emilmont 44:24d45a770a51 80 }
simon.ford@mbed.co.uk 0:82220227f4fa 81
emilmont 43:e2ed12d17f06 82 /** Return the current output duty-cycle setting, measured as a percentage (float)
simon.ford@mbed.co.uk 0:82220227f4fa 83 *
emilmont 43:e2ed12d17f06 84 * @returns
emilmont 55:d722ed6a4237 85 * A floating-point value representing the current duty-cycle being output on the pin,
rolf.meyer@arm.com 11:1c1ebd0324fa 86 * measured as a percentage. The returned value will lie between
rolf.meyer@arm.com 11:1c1ebd0324fa 87 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
rolf.meyer@arm.com 11:1c1ebd0324fa 88 *
emilmont 43:e2ed12d17f06 89 * @note
emilmont 44:24d45a770a51 90 * This value may not match exactly the value set by a previous <write>.
rolf.meyer@arm.com 11:1c1ebd0324fa 91 */
emilmont 44:24d45a770a51 92 float read() {
emilmont 44:24d45a770a51 93 return pwmout_read(&_pwm);
emilmont 44:24d45a770a51 94 }
emilmont 55:d722ed6a4237 95
emilmont 43:e2ed12d17f06 96 /** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 97 *
emilmont 43:e2ed12d17f06 98 * @note
emilmont 44:24d45a770a51 99 * The resolution is currently in microseconds; periods smaller than this
emilmont 44:24d45a770a51 100 * will be set to zero.
rolf.meyer@arm.com 11:1c1ebd0324fa 101 */
emilmont 44:24d45a770a51 102 void period(float seconds) {
emilmont 44:24d45a770a51 103 pwmout_period(&_pwm, seconds);
emilmont 44:24d45a770a51 104 }
simon.ford@mbed.co.uk 0:82220227f4fa 105
emilmont 43:e2ed12d17f06 106 /** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 107 */
emilmont 44:24d45a770a51 108 void period_ms(int ms) {
emilmont 44:24d45a770a51 109 pwmout_period_ms(&_pwm, ms);
emilmont 44:24d45a770a51 110 }
simon.ford@mbed.co.uk 5:62573be585e9 111
emilmont 43:e2ed12d17f06 112 /** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 113 */
emilmont 44:24d45a770a51 114 void period_us(int us) {
emilmont 44:24d45a770a51 115 pwmout_period_us(&_pwm, us);
emilmont 44:24d45a770a51 116 }
simon.ford@mbed.co.uk 5:62573be585e9 117
emilmont 43:e2ed12d17f06 118 /** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 119 */
emilmont 44:24d45a770a51 120 void pulsewidth(float seconds) {
emilmont 44:24d45a770a51 121 pwmout_pulsewidth(&_pwm, seconds);
emilmont 44:24d45a770a51 122 }
rolf.meyer@arm.com 11:1c1ebd0324fa 123
emilmont 43:e2ed12d17f06 124 /** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 125 */
emilmont 44:24d45a770a51 126 void pulsewidth_ms(int ms) {
emilmont 44:24d45a770a51 127 pwmout_pulsewidth_ms(&_pwm, ms);
emilmont 44:24d45a770a51 128 }
rolf.meyer@arm.com 11:1c1ebd0324fa 129
emilmont 43:e2ed12d17f06 130 /** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
rolf.meyer@arm.com 11:1c1ebd0324fa 131 */
emilmont 44:24d45a770a51 132 void pulsewidth_us(int us) {
emilmont 44:24d45a770a51 133 pwmout_pulsewidth_us(&_pwm, us);
emilmont 44:24d45a770a51 134 }
simon.ford@mbed.co.uk 0:82220227f4fa 135
rolf.meyer@arm.com 11:1c1ebd0324fa 136 #ifdef MBED_OPERATORS
emilmont 43:e2ed12d17f06 137 /** A operator shorthand for write()
rolf.meyer@arm.com 11:1c1ebd0324fa 138 */
emilmont 44:24d45a770a51 139 PwmOut& operator= (float value) {
emilmont 44:24d45a770a51 140 write(value);
emilmont 44:24d45a770a51 141 return *this;
emilmont 44:24d45a770a51 142 }
emilmont 55:d722ed6a4237 143
emilmont 44:24d45a770a51 144 PwmOut& operator= (PwmOut& rhs) {
emilmont 44:24d45a770a51 145 write(rhs.read());
emilmont 44:24d45a770a51 146 return *this;
emilmont 44:24d45a770a51 147 }
emilmont 55:d722ed6a4237 148
emilmont 43:e2ed12d17f06 149 /** An operator shorthand for read()
rolf.meyer@arm.com 11:1c1ebd0324fa 150 */
emilmont 44:24d45a770a51 151 operator float() {
emilmont 44:24d45a770a51 152 return read();
emilmont 44:24d45a770a51 153 }
rolf.meyer@arm.com 11:1c1ebd0324fa 154 #endif
simon.ford@mbed.co.uk 5:62573be585e9 155
simon.ford@mbed.co.uk 0:82220227f4fa 156 protected:
emilmont 44:24d45a770a51 157 pwmout_t _pwm;
simon.ford@mbed.co.uk 0:82220227f4fa 158 };
simon.ford@mbed.co.uk 0:82220227f4fa 159
rolf.meyer@arm.com 11:1c1ebd0324fa 160 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 161
simon.ford@mbed.co.uk 1:6b7f447ca868 162 #endif
emilmont 27:7110ebee3484 163
emilmont 27:7110ebee3484 164 #endif