Vladimir Vana / mbed

pro vyuku PSS v Jecne

PwmOut.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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