Driver::DIO::Pwm Class Reference

This class defines a generic interface for controlling a simple PWM output signal. More...

Detailed Description

This class defines a generic interface for controlling a simple PWM output signal.

#include <Pwm.h>

Public Member Functions
	Pwm (DriverDioPwmConfig_T pinConfig)
	Constructor Note: the 'pinConfig' struct MUST stay in scope as long as the driver is in scope.
bool	start (size_t initialLogicalDutyCycle)
	Starts the driver.
void	stop ()
	Stops the driver, places the output into a 'safe' state.
void	setDutyCycle (size_t logicalDutyCycle)
	Sets/updates the duty cycle.

Protected Attributes
DriverDioPwmConfig_T	m_pwm
	PWM info.
bool	m_started
	Started flag.

Constructor & Destructor Documentation

Pwm()

Driver::DIO::Pwm::Pwm

(

DriverDioPwmConfig_T

pinConfig

)

Constructor Note: the 'pinConfig' struct MUST stay in scope as long as the driver is in scope.

Member Function Documentation

setDutyCycle()

void Driver::DIO::Pwm::setDutyCycle

(

size_t

logicalDutyCycle

)

Sets/updates the duty cycle.

A value of 0 is 0% duty cycle. A value of OPTION_DRIVER_DIO_PWM_MAX_DUTY_CYCLE_VALUE is 100% duty cycle

start()

bool Driver::DIO::Pwm::start

(

size_t

initialLogicalDutyCycle

)

Starts the driver.

For 'initialLogicalDutyCycle', a value of 0 is 0% duty cycle. A value of OPTION_DRIVER_DIO_PWM_MAX_DUTY_CYCLE_VALUE is 100% duty cycle.

Returns false if an error was encountered

stop()

void Driver::DIO::Pwm::stop

(

)

Stops the driver, places the output into a 'safe' state.

The safe state is defined by the platform

Member Data Documentation

m_pwm

DriverDioPwmConfig_T Driver::DIO::Pwm::m_pwm

protected

PWM info.

m_started

bool Driver::DIO::Pwm::m_started

protected

Started flag.

---

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

• Driver/DIO/Pwm.h