Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

PwmOut.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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