Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
gr-peach-opencv-project-sd-card
by 
the do
PwmOut Class Reference
[Drivers]
A pulse-width modulation digital output. More...
#include <PwmOut.h>
Public Member Functions | |
| PwmOut (PinName pin) | |
| Create a PwmOut connected to the specified pin. | |
| void | write (float value) |
| Set the ouput duty-cycle, specified as a percentage (float) | |
| float | read () |
| Return the current output duty-cycle setting, measured as a percentage (float) | |
| void | period (float seconds) |
| Set the PWM period, specified in seconds (float), keeping the duty cycle the same. | |
| void | period_ms (int ms) |
| Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same. | |
| void | period_us (int us) |
| Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same. | |
| void | pulsewidth (float seconds) |
| Set the PWM pulsewidth, specified in seconds (float), keeping the period the same. | |
| void | pulsewidth_ms (int ms) |
| Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same. | |
| void | pulsewidth_us (int us) |
| Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same. | |
| PwmOut & | operator= (float value) |
| A operator shorthand for write() | |
| PwmOut & | operator= (PwmOut &rhs) |
| A operator shorthand for write() | |
| operator float () | |
| An operator shorthand for read() | |
Detailed Description
A pulse-width modulation digital output.
- Note:
- Synchronization level: Interrupt safe
Example
// Fade a led on. #include "mbed.h" PwmOut led(LED1); int main() { while(1) { led = led + 0.01; wait(0.2); if(led == 1.0) { led = 0; } } }
Definition at line 51 of file PwmOut.h.
Constructor & Destructor Documentation
| PwmOut | ( | PinName | pin ) |
Member Function Documentation
| PwmOut& operator= | ( | float | value ) |
| void period | ( | float | seconds ) |
Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
- Parameters:
-
seconds Change the period of a PWM signal in seconds (float) without modifying the duty cycle
- Note:
- The resolution is currently in microseconds; periods smaller than this will be set to zero.
| void period_ms | ( | int | ms ) |
| void period_us | ( | int | us ) |
| void pulsewidth | ( | float | seconds ) |
| void pulsewidth_ms | ( | int | ms ) |
| void pulsewidth_us | ( | int | us ) |
| float read | ( | void | ) |
Return the current output duty-cycle setting, measured as a percentage (float)
- Returns:
- A floating-point value representing the current duty-cycle being output on the pin, measured as a percentage. The returned value will lie between 0.0f (representing on 0%) and 1.0f (representing on 100%).
- Note:
- This value may not match exactly the value set by a previous write().
| void write | ( | float | value ) |
Set the ouput duty-cycle, specified as a percentage (float)
- Parameters:
-
value A floating-point value representing the output duty-cycle, specified as a percentage. The value should lie between 0.0f (representing on 0%) and 1.0f (representing on 100%). Values outside this range will be saturated to 0.0f or 1.0f.
Generated on Tue Jul 12 2022 14:48:02 by
1.7.2