Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/PwmOut.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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