semf::app::PwmOut Class Reference

Class for using a PWM as an output with permille value handling. More...

#include <pwmout.h>

Inheritance diagram for semf::app::PwmOut:

Collaboration diagram for semf::app::PwmOut:

Public Member Functions
virtual	~PwmOut ()=default
virtual void	enable (bool enable=true)=0
	Enables / disable the PWM output. More...
virtual void	disable (bool disable=true)=0
	Enables / disable the PWM output. More...
virtual bool	isEnabled () const =0
	Current status of the PWM module. More...
virtual void	start ()=0
	Enables the PWM. More...
virtual void	stop ()=0
	Disable the PWM. More...
virtual void	setValue (uint32_t pwm)=0
	Change the PWM value. More...
virtual uint32_t	value () const =0
	Returns the current PWM value. More...
virtual void	setPermille (uint16_t pwm)=0
	Set the PWM value in permille. The pwm value is calculated based on the set maximum value. More...
virtual uint16_t	permille () const =0
	Returns the current PWM value in permille. The PWM value is calculated based on the set maximum value. More...
virtual void	setMaxValue (uint32_t pwm)=0
	Set the maximum value for the PWM. More...
virtual uint32_t	maxValue () const =0
	Returns the maximum possible PWM value. More...
virtual void	setInverted (bool inverted)=0
	To configure whether the PWM should be inverted. This configuration does not become active until the methods setValue(), setEnabled(bool enable) or start() have been called. More...

Detailed Description

Class for using a PWM as an output with permille value handling.

Definition at line 24 of file pwmout.h.

Constructor & Destructor Documentation

~PwmOut()

virtual semf::app::PwmOut::~PwmOut ( )

virtualdefault

Member Function Documentation

disable()

virtual void semf::app::PwmOut::disable ( bool  disable = true )

pure virtual

Enables / disable the PWM output.

Parameters

disable

true: PWM off, false: PWM on.

Implemented in semf::PwmOut.

enable()

virtual void semf::app::PwmOut::enable ( bool  enable = true )

pure virtual

Enables / disable the PWM output.

Parameters

enable

true: PWM on, false: PWM off.

Implemented in semf::PwmOut.

isEnabled()

virtual bool semf::app::PwmOut::isEnabled ( ) const

pure virtual

Current status of the PWM module.

Returns

• true: PWM on,
• false: PWM off.

Implemented in semf::PwmOut.

maxValue()

virtual uint32_t semf::app::PwmOut::maxValue ( ) const

pure virtual

Returns the maximum possible PWM value.

Returns

The maximum possible PWM value.

See also

setMaxValue()

Implemented in semf::PwmOut.

permille()

virtual uint16_t semf::app::PwmOut::permille ( ) const

pure virtual

Returns the current PWM value in permille. The PWM value is calculated based on the set maximum value.

Returns

The PWM value in permille (0 - 1000).

See also

setMaxValue()

Implemented in semf::PwmOut.

setInverted()

virtual void semf::app::PwmOut::setInverted ( bool  inverted )

pure virtual

To configure whether the PWM should be inverted. This configuration does not become active until the methods setValue(), setEnabled(bool enable) or start() have been called.

Parameters

inverted

true: inverted, false: not inverted.

See also

setValue(), setEnabled() and start().

Implemented in semf::PwmOut.

setMaxValue()

virtual void semf::app::PwmOut::setMaxValue ( uint32_t  pwm )

pure virtual

Set the maximum value for the PWM.

Parameters

pwm	The maximum possible PWM value. The minimum value is 1.

Implemented in semf::PwmOut.

setPermille()

virtual void semf::app::PwmOut::setPermille ( uint16_t  pwm )

pure virtual

Set the PWM value in permille. The pwm value is calculated based on the set maximum value.

Parameters

pwm	The PWM value in permille. Valid range is 0 - 1000.

See also

setMaxValue()

Implemented in semf::PwmOut.

setValue()

virtual void semf::app::PwmOut::setValue ( uint32_t  pwm )

pure virtual

Change the PWM value.

Parameters

pwm	the new PWM value.

Implemented in semf::PwmOut.

start()

virtual void semf::app::PwmOut::start ( )

pure virtual

Enables the PWM.

See also

setEnable()

Implemented in semf::PwmOut.

stop()

virtual void semf::app::PwmOut::stop ( )

pure virtual

Disable the PWM.

See also

setEnable()

Implemented in semf::PwmOut.

value()

virtual uint32_t semf::app::PwmOut::value ( ) const

pure virtual

Returns the current PWM value.

Returns

The PWM value.

Implemented in semf::PwmOut.