ELEC-C7222
Libraries for ELEC C7222 Course Work
Loading...
Searching...
No Matches
c7222::PwmOut::Config Struct Reference

Configuration structure for PWM output setup. More...

#include <pwm.hpp>

Collaboration diagram for c7222::PwmOut::Config:
Collaboration graph

Public Member Functions

 Config (uint32_t pin)
 Create config with a pin number.
 
bool Validate () const
 Validate configuration.
 

Public Attributes

uint32_t pin_
 GPIO pin number.
 
float period_us {1000.0f}
 PWM period in microseconds.
 
float duty_cycle {0.0f}
 Duty cycle fraction [0.0, 1.0].
 
bool enabled {true}
 Enable PWM output on init.
 
bool active_low {false}
 Invert PWM output polarity when true (active-low).
 

Detailed Description

Configuration structure for PWM output setup.

Constructor & Destructor Documentation

◆ Config()

c7222::PwmOut::Config::Config ( uint32_t  pin)
explicit

Create config with a pin number.

Parameters
pinGPIO number (non-negative).

Member Function Documentation

◆ Validate()

bool c7222::PwmOut::Config::Validate ( ) const

Validate configuration.

Returns
true if configuration is valid.

Member Data Documentation

◆ active_low

bool c7222::PwmOut::Config::active_low {false}

Invert PWM output polarity when true (active-low).

◆ duty_cycle

float c7222::PwmOut::Config::duty_cycle {0.0f}

Duty cycle fraction [0.0, 1.0].

◆ enabled

bool c7222::PwmOut::Config::enabled {true}

Enable PWM output on init.

◆ period_us

float c7222::PwmOut::Config::period_us {1000.0f}

PWM period in microseconds.

◆ pin_

uint32_t c7222::PwmOut::Config::pin_

GPIO pin number.


The documentation for this struct was generated from the following file: