Mistake on this page?
Report an issue in GitHub or email us
Modules | Functions
Pwmout hal functions

Defined behavior

More...

Modules

 GPIO IRQ HAL tests
 The Pwmout HAL tests ensure driver conformance to defined behaviour.
 

Functions

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

Detailed Description

Defined behavior

Undefined behavior

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
const PinMap* pwmout_pinmap ( void  )

Get the pins that support PWM.

Return a PinMap array of pins that support PWM. The array is terminated with {NC, NC, 0}.

Returns
PinMap array
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
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.