Christopher Haster / mbed-hal

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.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/PwmOut.h@20:fbc6173aa5b2, 2016-04-06 (annotated)

Committer:
Christopher Haster
Date:
Wed Apr 06 09:41:33 2016 -0500
Revision:
20:fbc6173aa5b2
Parent:
0:9c59db1fbc9e 
Added Binder class for statically allocated function binding

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:9c59db1fbc9e 1 /* mbed Microcontroller Library
screamer 0:9c59db1fbc9e 2 * Copyright (c) 2006-2013 ARM Limited
screamer 0:9c59db1fbc9e 3 *
screamer 0:9c59db1fbc9e 4 * Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:9c59db1fbc9e 5 * you may not use this file except in compliance with the License.
screamer 0:9c59db1fbc9e 6 * You may obtain a copy of the License at
screamer 0:9c59db1fbc9e 7 *
screamer 0:9c59db1fbc9e 8 * http://www.apache.org/licenses/LICENSE-2.0
screamer 0:9c59db1fbc9e 9 *
screamer 0:9c59db1fbc9e 10 * Unless required by applicable law or agreed to in writing, software
screamer 0:9c59db1fbc9e 11 * distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:9c59db1fbc9e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:9c59db1fbc9e 13 * See the License for the specific language governing permissions and
screamer 0:9c59db1fbc9e 14 * limitations under the License.
screamer 0:9c59db1fbc9e 15 */
screamer 0:9c59db1fbc9e 16 #ifndef MBED_PWMOUT_H
screamer 0:9c59db1fbc9e 17 #define MBED_PWMOUT_H
screamer 0:9c59db1fbc9e 18
screamer 0:9c59db1fbc9e 19 #include "platform.h"
screamer 0:9c59db1fbc9e 20
screamer 0:9c59db1fbc9e 21 #if DEVICE_PWMOUT
screamer 0:9c59db1fbc9e 22 #include "pwmout_api.h"
screamer 0:9c59db1fbc9e 23
screamer 0:9c59db1fbc9e 24 namespace mbed {
screamer 0:9c59db1fbc9e 25
screamer 0:9c59db1fbc9e 26 /** A pulse-width modulation digital output
screamer 0:9c59db1fbc9e 27 *
screamer 0:9c59db1fbc9e 28 * Example
screamer 0:9c59db1fbc9e 29 * @code
screamer 0:9c59db1fbc9e 30 * // Fade a led on.
screamer 0:9c59db1fbc9e 31 * #include "mbed.h"
screamer 0:9c59db1fbc9e 32 *
screamer 0:9c59db1fbc9e 33 * PwmOut led(LED1);
screamer 0:9c59db1fbc9e 34 *
screamer 0:9c59db1fbc9e 35 * int main() {
screamer 0:9c59db1fbc9e 36 * while(1) {
screamer 0:9c59db1fbc9e 37 * led = led + 0.01;
screamer 0:9c59db1fbc9e 38 * wait(0.2);
screamer 0:9c59db1fbc9e 39 * if(led == 1.0) {
screamer 0:9c59db1fbc9e 40 * led = 0;
screamer 0:9c59db1fbc9e 41 * }
screamer 0:9c59db1fbc9e 42 * }
screamer 0:9c59db1fbc9e 43 * }
screamer 0:9c59db1fbc9e 44 * @endcode
screamer 0:9c59db1fbc9e 45 *
screamer 0:9c59db1fbc9e 46 * @note
screamer 0:9c59db1fbc9e 47 * On the LPC1768 and LPC2368, the PWMs all share the same
screamer 0:9c59db1fbc9e 48 * period - if you change the period for one, you change it for all.
screamer 0:9c59db1fbc9e 49 * Although routines that change the period maintain the duty cycle
screamer 0:9c59db1fbc9e 50 * for its PWM, all other PWMs will require their duty cycle to be
screamer 0:9c59db1fbc9e 51 * refreshed.
screamer 0:9c59db1fbc9e 52 */
screamer 0:9c59db1fbc9e 53 class PwmOut {
screamer 0:9c59db1fbc9e 54
screamer 0:9c59db1fbc9e 55 public:
screamer 0:9c59db1fbc9e 56
screamer 0:9c59db1fbc9e 57 /** Create a PwmOut connected to the specified pin
screamer 0:9c59db1fbc9e 58 *
screamer 0:9c59db1fbc9e 59 * @param pin PwmOut pin to connect to
screamer 0:9c59db1fbc9e 60 */
screamer 0:9c59db1fbc9e 61 PwmOut(PinName pin) {
screamer 0:9c59db1fbc9e 62 pwmout_init(&_pwm, pin);
screamer 0:9c59db1fbc9e 63 }
screamer 0:9c59db1fbc9e 64
screamer 0:9c59db1fbc9e 65 /** Set the ouput duty-cycle, specified as a percentage (float)
screamer 0:9c59db1fbc9e 66 *
screamer 0:9c59db1fbc9e 67 * @param value A floating-point value representing the output duty-cycle,
screamer 0:9c59db1fbc9e 68 * specified as a percentage. The value should lie between
screamer 0:9c59db1fbc9e 69 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
screamer 0:9c59db1fbc9e 70 * Values outside this range will be saturated to 0.0f or 1.0f.
screamer 0:9c59db1fbc9e 71 */
screamer 0:9c59db1fbc9e 72 void write(float value) {
screamer 0:9c59db1fbc9e 73 pwmout_write(&_pwm, value);
screamer 0:9c59db1fbc9e 74 }
screamer 0:9c59db1fbc9e 75
screamer 0:9c59db1fbc9e 76 /** Return the current output duty-cycle setting, measured as a percentage (float)
screamer 0:9c59db1fbc9e 77 *
screamer 0:9c59db1fbc9e 78 * @returns
screamer 0:9c59db1fbc9e 79 * A floating-point value representing the current duty-cycle being output on the pin,
screamer 0:9c59db1fbc9e 80 * measured as a percentage. The returned value will lie between
screamer 0:9c59db1fbc9e 81 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
screamer 0:9c59db1fbc9e 82 *
screamer 0:9c59db1fbc9e 83 * @note
screamer 0:9c59db1fbc9e 84 * This value may not match exactly the value set by a previous <write>.
screamer 0:9c59db1fbc9e 85 */
screamer 0:9c59db1fbc9e 86 float read() {
screamer 0:9c59db1fbc9e 87 return pwmout_read(&_pwm);
screamer 0:9c59db1fbc9e 88 }
screamer 0:9c59db1fbc9e 89
screamer 0:9c59db1fbc9e 90 /** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
screamer 0:9c59db1fbc9e 91 *
screamer 0:9c59db1fbc9e 92 * @note
screamer 0:9c59db1fbc9e 93 * The resolution is currently in microseconds; periods smaller than this
screamer 0:9c59db1fbc9e 94 * will be set to zero.
screamer 0:9c59db1fbc9e 95 */
screamer 0:9c59db1fbc9e 96 void period(float seconds) {
screamer 0:9c59db1fbc9e 97 pwmout_period(&_pwm, seconds);
screamer 0:9c59db1fbc9e 98 }
screamer 0:9c59db1fbc9e 99
screamer 0:9c59db1fbc9e 100 /** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
screamer 0:9c59db1fbc9e 101 */
screamer 0:9c59db1fbc9e 102 void period_ms(int ms) {
screamer 0:9c59db1fbc9e 103 pwmout_period_ms(&_pwm, ms);
screamer 0:9c59db1fbc9e 104 }
screamer 0:9c59db1fbc9e 105
screamer 0:9c59db1fbc9e 106 /** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
screamer 0:9c59db1fbc9e 107 */
screamer 0:9c59db1fbc9e 108 void period_us(int us) {
screamer 0:9c59db1fbc9e 109 pwmout_period_us(&_pwm, us);
screamer 0:9c59db1fbc9e 110 }
screamer 0:9c59db1fbc9e 111
screamer 0:9c59db1fbc9e 112 /** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
screamer 0:9c59db1fbc9e 113 */
screamer 0:9c59db1fbc9e 114 void pulsewidth(float seconds) {
screamer 0:9c59db1fbc9e 115 pwmout_pulsewidth(&_pwm, seconds);
screamer 0:9c59db1fbc9e 116 }
screamer 0:9c59db1fbc9e 117
screamer 0:9c59db1fbc9e 118 /** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
screamer 0:9c59db1fbc9e 119 */
screamer 0:9c59db1fbc9e 120 void pulsewidth_ms(int ms) {
screamer 0:9c59db1fbc9e 121 pwmout_pulsewidth_ms(&_pwm, ms);
screamer 0:9c59db1fbc9e 122 }
screamer 0:9c59db1fbc9e 123
screamer 0:9c59db1fbc9e 124 /** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
screamer 0:9c59db1fbc9e 125 */
screamer 0:9c59db1fbc9e 126 void pulsewidth_us(int us) {
screamer 0:9c59db1fbc9e 127 pwmout_pulsewidth_us(&_pwm, us);
screamer 0:9c59db1fbc9e 128 }
screamer 0:9c59db1fbc9e 129
screamer 0:9c59db1fbc9e 130 #ifdef MBED_OPERATORS
screamer 0:9c59db1fbc9e 131 /** A operator shorthand for write()
screamer 0:9c59db1fbc9e 132 */
screamer 0:9c59db1fbc9e 133 PwmOut& operator= (float value) {
screamer 0:9c59db1fbc9e 134 write(value);
screamer 0:9c59db1fbc9e 135 return *this;
screamer 0:9c59db1fbc9e 136 }
screamer 0:9c59db1fbc9e 137
screamer 0:9c59db1fbc9e 138 PwmOut& operator= (PwmOut& rhs) {
screamer 0:9c59db1fbc9e 139 write(rhs.read());
screamer 0:9c59db1fbc9e 140 return *this;
screamer 0:9c59db1fbc9e 141 }
screamer 0:9c59db1fbc9e 142
screamer 0:9c59db1fbc9e 143 /** An operator shorthand for read()
screamer 0:9c59db1fbc9e 144 */
screamer 0:9c59db1fbc9e 145 operator float() {
screamer 0:9c59db1fbc9e 146 return read();
screamer 0:9c59db1fbc9e 147 }
screamer 0:9c59db1fbc9e 148 #endif
screamer 0:9c59db1fbc9e 149
screamer 0:9c59db1fbc9e 150 protected:
screamer 0:9c59db1fbc9e 151 pwmout_t _pwm;
screamer 0:9c59db1fbc9e 152 };
screamer 0:9c59db1fbc9e 153
screamer 0:9c59db1fbc9e 154 } // namespace mbed
screamer 0:9c59db1fbc9e 155
screamer 0:9c59db1fbc9e 156 #endif
screamer 0:9c59db1fbc9e 157
screamer 0:9c59db1fbc9e 158 #endif
screamer 0:9c59db1fbc9e 159