Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/PwmOut.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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