Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

PwmOut.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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