jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

PwmOut.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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