joey shelton / LED_Demo

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.

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

Pwmout hal functions
Functions

Pwmout hal functions

Functions

void pwmout_init (pwmout_t *obj, PinName pin)
 Initialize the pwm out peripheral and configure the pin.
void pwmout_free (pwmout_t *obj)
 Deinitialize the pwmout object.
void pwmout_write (pwmout_t *obj, float percent)
 Set the output duty-cycle in range <0.0f, 1.0f>
float pwmout_read (pwmout_t *obj)
 Read the current float-point output duty-cycle.
void pwmout_period (pwmout_t *obj, float seconds)
 Set the PWM period specified in seconds, keeping the duty cycle the same.
void pwmout_period_ms (pwmout_t *obj, int ms)
 Set the PWM period specified in miliseconds, keeping the duty cycle the same.
void pwmout_period_us (pwmout_t *obj, int us)
 Set the PWM period specified in microseconds, keeping the duty cycle the same.
void pwmout_pulsewidth (pwmout_t *obj, float seconds)
 Set the PWM pulsewidth specified in seconds, keeping the period the same.
void pwmout_pulsewidth_ms (pwmout_t *obj, int ms)
 Set the PWM pulsewidth specified in miliseconds, keeping the period the same.
void pwmout_pulsewidth_us (pwmout_t *obj, int us)
 Set the PWM pulsewidth specified in microseconds, keeping the period the same.

Function Documentation

void pwmout_free ( pwmout_t *  obj )

Deinitialize the pwmout object.

Parameters:
objThe pwmout object
void pwmout_init ( pwmout_t *  obj,
PinName  pin 
)

Initialize the pwm out peripheral and configure the pin.

Parameters:
objThe pwmout object to initialize
pinThe pwmout pin to initialize
void pwmout_period ( pwmout_t *  obj,
float  seconds 
)

Set the PWM period specified in seconds, keeping the duty cycle the same.

Periods smaller than microseconds (the lowest resolution) are set to zero.

Parameters:
objThe pwmout object
secondsThe floating-point seconds period
void pwmout_period_ms ( pwmout_t *  obj,
int  ms 
)

Set the PWM period specified in miliseconds, keeping the duty cycle the same.

Parameters:
objThe pwmout object
msThe milisecond period
void pwmout_period_us ( pwmout_t *  obj,
int  us 
)

Set the PWM period specified in microseconds, keeping the duty cycle the same.

Parameters:
objThe pwmout object
usThe microsecond period
void pwmout_pulsewidth ( pwmout_t *  obj,
float  seconds 
)

Set the PWM pulsewidth specified in seconds, keeping the period the same.

Parameters:
objThe pwmout object
secondsThe floating-point pulsewidth in seconds
void pwmout_pulsewidth_ms ( pwmout_t *  obj,
int  ms 
)

Set the PWM pulsewidth specified in miliseconds, keeping the period the same.

Parameters:
objThe pwmout object
msThe floating-point pulsewidth in miliseconds
void pwmout_pulsewidth_us ( pwmout_t *  obj,
int  us 
)

Set the PWM pulsewidth specified in microseconds, keeping the period the same.

Parameters:
objThe pwmout object
usThe floating-point pulsewidth in microseconds
float pwmout_read ( pwmout_t *  obj )

Read the current float-point output duty-cycle.

Parameters:
objThe pwmout object
Returns:
A floating-point output duty-cycle
void pwmout_write ( pwmout_t *  obj,
float  percent 
)

Set the output duty-cycle in range <0.0f, 1.0f>

Value 0.0f represents 0 percentage, 1.0f represents 100 percent.

Parameters:
objThe pwmout object
percentThe floating-point percentage number
Generated on Tue Jul 12 2022 12:29:03 by  doxygen 1.7.2