Pwm Class Reference

Pico PWM Class. More...

#include <pwm.hpp>

Public Member Functions
	Pwm (uint pin)
	Constructor. More...
	~Pwm ()
	Destructor. More...
uint	getPin () const
	Gets the pin number. More...
uint	getSlice () const
	Gets the slice number of PWM. More...
uint	getChannel () const
	Gets the PWM channel number. More...
void	setFreq (uint32_t freq)
	Sets the PWM frequency. More...
uint32_t	getFreq () const
	Gets the PWM frequency. More...
void	setDuty (float duty)
	Sets the duty cycle of PWM. More...
float	getDuty () const
	Gets the duty cycle. More...
void	start ()
	Enables the PWM on the pin. More...
void	stop ()
	Disables the PWM on the pin. More...
bool	isRunning () const
	Returns if the PWM is enabled on the pin. More...

Static Public Attributes
static constexpr uint32_t	kPwmDefaultFreq = 40'000UL
	PWM default frequency, in Hertz. More...

Detailed Description

Pico PWM Class.

The purpose of this class is to manipulate the PWM on the board.
Note: Each instance of this class controls only one PWM pin.

Constructor & Destructor Documentation

Pwm()

Pwm ( uint  pin )

explicit

Constructor.

Creates a Pwm class instance with kPwmDefaultFreq frequency and zero duty cycle.

Parameters

pin	The pin number.

~Pwm()

~Pwm

(

)

Destructor.

Member Function Documentation

getPin()

uint getPin

(

)

const

Gets the pin number.

Returns

The pin number.

getSlice()

uint getSlice

(

)

const

Gets the slice number of PWM.

Returns

The PWM slice number.

getChannel()

uint getChannel

(

)

const

Gets the PWM channel number.

Returns

The PWM channel number.

setFreq()

void setFreq

(

uint32_t

freq

)

Sets the PWM frequency.

Parameters

freq	PWM frequency, in Hertz. Note: This value must be greater than zero and less than 6.25MHz.

getFreq()

uint32_t getFreq

(

)

const

Gets the PWM frequency.

Returns

The PWM frequency, in Hertz.

setDuty()

void setDuty

(

float

duty

)

Sets the duty cycle of PWM.

Parameters

duty	Duty cycle, in percent (%). Note: This value must be positive and less than/equal 100%.

getDuty()

float getDuty

(

)

const

Gets the duty cycle.

Returns

The duty cycle, in percent (%).

start()

void start

(

)

Enables the PWM on the pin.

Starts the output of the PWM signal on the pin.

stop()

void stop

(

)

Disables the PWM on the pin.

Stops the output of the PWM signal on the pin, and puts its in low state.

isRunning()

bool isRunning

(

)

const

Returns if the PWM is enabled on the pin.

Returns

True if the PWM is enabled, false otherwise.

Member Data Documentation

kPwmDefaultFreq

constexpr uint32_t kPwmDefaultFreq = 40'000UL

staticconstexpr

PWM default frequency, in Hertz.

---

The documentation for this class was generated from the following files:

• pwm.hpp
• pwm.cpp