Dimmer Class Reference

Class that provides a dimmer. More...

#include <cs_Dimmer.h>

Public Member Functions
void	init (const boards_config_t &board)
bool	hasDimmer ()
	Returns true when this board has a dimmer. More...
void	start ()
	Start dimmer. More...
bool	set (uint8_t intensity, bool fade)
	Set dimmer intensity. More...
void	setSoftOnSpeed (uint8_t speed)
	Change the soft of speed. More...

Private Member Functions
	TYPIFY (STATE_SOFT_ON_SPEED) _softOnSpeed
void	enable ()

Private Attributes
uint32_t	_hardwareBoard
uint8_t	_pinEnableDimmer
bool	_hasDimmer = false
bool	_initialized = false
bool	_started = false
bool	_enabled = false

Detailed Description

Class that provides a dimmer.

• Determines whether to start on zero crossing.
• Controls dimmer enable GPIO.
• TODO: take care of synchronizing with net frequency

Member Function Documentation

enable()

void Dimmer::enable ( )

private

hasDimmer()

bool Dimmer::hasDimmer

(

)

Returns true when this board has a dimmer.

init()

void Dimmer::init

(

const boards_config_t &

board

)

set()

bool Dimmer::set	(	uint8_t	intensity,
		bool	fade
	)

Set dimmer intensity.

Parameters

[in]	intensity	Intensity value to set: 0-100.
[in]	fade	Whether to fade towards the new intensity. False will set it immediately.

Returns

true on success.

setSoftOnSpeed()

void Dimmer::setSoftOnSpeed

(

uint8_t

speed

)

Change the soft of speed.

TODO: remove this function again once we have a nice default value.

start()

void Dimmer::start

(

)

Start dimmer.

To be called once there is enough power to enable the dimmer.

TYPIFY()

Dimmer::TYPIFY ( STATE_SOFT_ON_SPEED  )

private

Member Data Documentation

_enabled

bool Dimmer::_enabled = false

private

_hardwareBoard

uint32_t Dimmer::_hardwareBoard

private

_hasDimmer

bool Dimmer::_hasDimmer = false

private

_initialized

bool Dimmer::_initialized = false

private

_pinEnableDimmer

uint8_t Dimmer::_pinEnableDimmer

private

_started

bool Dimmer::_started = false

private

---

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

• source/include/drivers/cs_Dimmer.h