PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/PwmOut.h@0:aa3fc5ad02f7, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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