Inheritance diagram for Mycila::BurstFireDimmer:

Collaboration diagram for Mycila::BurstFireDimmer:

Public Member Functions
void	setPin (gpio_num_t pin)
	Set the GPIO pin to use for the dimmer.
gpio_num_t	getPin () const
	Get the GPIO pin used for the dimmer.
void	setSemiPeriod (uint16_t semiPeriod)
	Set the semi-period of the grid frequency in us. It cannot be zero and it is required for proper dimmer operation.
uint16_t	getSemiPeriod () const
	Get the semi-period of the grid frequency in us.
virtual void	begin ()
	Enable a dimmer on a specific GPIO pin.
virtual void	end ()
	Disable the dimmer.
virtual const char *	type () const
Public Member Functions inherited from Mycila::Dimmer
void	setDutyCycleLimit (float limit)
	Set the power duty cycle limit of the dimmer. The duty cycle will be clamped to this limit.
void	setDutyCycleMin (float min)
	Duty remapping (equivalent to Shelly Dimmer remapping feature). Useful to calibrate the dimmer when using for example a PWM signal to 0-10V analog convertor connected to a voltage regulator which is only working in a specific voltage range like 1-8V.
void	setDutyCycleMax (float max)
	Duty remapping (equivalent to Shelly Dimmer remapping feature). Useful to calibrate the dimmer when using for example a PWM signal to 0-10V analog convertor connected to a voltage regulator which is only working in a specific voltage range like 1-8V.
float	getDutyCycleLimit () const
	Get the power duty cycle limit of the dimmer.
float	getDutyCycleMin () const
	Get the remapped "0" of the dimmer duty cycle.
float	getDutyCycleMax () const
	Get the remapped "1" of the dimmer duty cycle.
void	enablePowerLUT (bool enable, uint16_t semiPeriod=0)
	Enable or disable the use of power LUT for dimmer curve The power LUT provides a non-linear dimming curve that is more aligned with human perception of brightness. If disabled, a linear dimming curve will be used.
bool	isPowerLUTEnabled () const
	Check if the power LUT is enabled.
uint16_t	getPowerLUTSemiPeriod () const
	Get the semi-period in us used for the power LUT calculations. If LUT is disabled, returns 0.
bool	isEnabled () const
	Check if the dimmer is enabled (if it was able to initialize correctly)
bool	isOnline () const
	Returns true if the dimmer is marked online.
void	setOnline (bool online)
	Set the online status of the dimmer.
void	on ()
	Turn on the dimmer at full power.
void	off ()
	Turn off the dimmer.
bool	isOff () const
	Check if the dimmer is off.
bool	isOn () const
	Check if the dimmer is on.
bool	isOnAtFullPower () const
	Check if the dimmer is on at full power.
bool	setDutyCycle (float dutyCycle)
	Set the power duty.
float	getDutyCycle () const
	Get the power duty cycle configured for the dimmer by teh user.
float	getDutyCycleMapped () const
	Get the remapped power duty cycle from the currently user set duty cycle.
float	getDutyCycleFire () const
	Get the real firing duty cycle applied to the dimmer in the range [0, 1].

Static Public Member Functions
static void	onZeroCross (int16_t delayUntilZero, void *args)

Protected Member Functions
virtual bool	_apply ()

Additional Inherited Members
Static Protected Member Functions inherited from Mycila::Dimmer
static uint16_t	_lookupFiringDelay (float dutyCycle, uint16_t semiPeriod)
static float	_contrain (float amt, float low, float high)
Protected Attributes inherited from Mycila::Dimmer
bool	_enabled = false
bool	_online = false
float	_dutyCycle = 0.0f
float	_dutyCycleFire = 0.0f
float	_dutyCycleLimit = 1.0f
float	_dutyCycleMin = 0.0f
float	_dutyCycleMax = 1.0f
bool	_powerLUTEnabled = false
uint16_t	_semiPeriod = 0

Detailed Description

Definition at line 11 of file MycilaDimmerBurstFire.h.

Constructor & Destructor Documentation

◆ ~BurstFireDimmer()

virtual Mycila::BurstFireDimmer::~BurstFireDimmer ( )

inlinevirtual

Definition at line 13 of file MycilaDimmerBurstFire.h.

Member Function Documentation

◆ _apply()

virtual bool Mycila::BurstFireDimmer::_apply ( )

inlineprotectedvirtual

Implements Mycila::Dimmer.

Definition at line 91 of file MycilaDimmerBurstFire.h.

◆ begin()

void Mycila::BurstFireDimmer::begin ( )

virtual

Enable a dimmer on a specific GPIO pin.

Warning: Dimmer won't be enabled if pin is invalid

Implements Mycila::Dimmer.

Definition at line 65 of file MycilaDimmerBurstFire.cpp.

◆ end()

void Mycila::BurstFireDimmer::end ( )

virtual

Disable the dimmer.

Warning: Dimmer won't be destroyed but won't turn on anymore even is a duty cycle is set.

Implements Mycila::Dimmer.

Definition at line 85 of file MycilaDimmerBurstFire.cpp.

◆ getPin()

gpio_num_t Mycila::BurstFireDimmer::getPin ( ) const

inline

Get the GPIO pin used for the dimmer.

Definition at line 23 of file MycilaDimmerBurstFire.h.

◆ getSemiPeriod()

uint16_t Mycila::BurstFireDimmer::getSemiPeriod ( ) const

inline

Get the semi-period of the grid frequency in us.

Definition at line 39 of file MycilaDimmerBurstFire.h.

◆ onZeroCross()

void ARDUINO_ISR_ATTR Mycila::BurstFireDimmer::onZeroCross	(	int16_t	delayUntilZero,
		void *	args )

static

Optional: Integration with a Zero-Cross Detection (ZCD) system

Callback to be called when a zero-crossing event is detected.

This is optional when using standard (sync) Solid State Relays (SSR) that only activate or deactivate when the AC voltage crosses zero. This is usually the behavior of most SSRs available on the market.

If you are using a Random Solid State Relay (SSR) or a TRIAC that can be triggered at any point in the AC cycle, then you need to set this callback so that the library knows when to fire and stop the SSR/TRIAC.

When using MycilaPulseAnalyzer library, this callback can be registered like this:

pulseAnalyzer.onZeroCross(Mycila::Dimmer::onZeroCross);

When using your own ISR with the RobotDyn ZCD, you can call this method with delayUntilZero == 200 since the length of the ZCD pulse is about 400 us.
When using your own ISR with the ZCd from Daniel S, you can call this method with delayUntilZero == 550 since the length of the ZCD pulse is about 1100 us.

Definition at line 96 of file MycilaDimmerBurstFire.cpp.

◆ setPin()

void Mycila::BurstFireDimmer::setPin ( gpio_num_t pin )

inline

Set the GPIO pin to use for the dimmer.

Definition at line 18 of file MycilaDimmerBurstFire.h.

◆ setSemiPeriod()

void Mycila::BurstFireDimmer::setSemiPeriod ( uint16_t semiPeriod )

inline

Set the semi-period of the grid frequency in us. It cannot be zero and it is required for proper dimmer operation.

Definition at line 28 of file MycilaDimmerBurstFire.h.

◆ type()

virtual const char * Mycila::BurstFireDimmer::type ( ) const

inlinevirtual

Implements Mycila::Dimmer.

Definition at line 55 of file MycilaDimmerBurstFire.h.

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

src/MycilaDimmerBurstFire.h
src/MycilaDimmerBurstFire.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BurstFireDimmer()

Member Function Documentation

◆ _apply()

◆ begin()

◆ end()

◆ getPin()

◆ getSemiPeriod()

◆ onZeroCross()

◆ setPin()

◆ setSemiPeriod()

◆ type()