MycilaJSY 13.0.0
Arduino / ESP32 library for the JSY1031, JSY-MK-163, JSY-MK-193, JSY-MK-194, JSY-MK-227, JSY-MK-229, JSY-MK-333 families single-phase and three-phase AC bidirectional meters from Shenzhen Jiansiyan Technologies Co, Ltd.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
Mycila::PWMDimmer Class Reference

PWM based dimmer implementation for voltage regulators controlled by a PWM signal to 0-10V analog convertor. More...

#include <MycilaDimmerPWM.h>

Inheritance diagram for Mycila::PWMDimmer:
Inheritance graph
[legend]
Collaboration diagram for Mycila::PWMDimmer:
Collaboration graph
[legend]

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 setFrequency (uint32_t frequency)
 Set the PWM frequency in Hz.
uint32_t getFrequency () const
 Get the PWM frequency in Hz.
void setResolution (uint8_t resolution)
 Set the PWM resolution in bits.
uint8_t getResolution () const
 Get the PWM resolution in bits.
void begin () override
 Enable a dimmer on a specific GPIO pin.
void end () override
 Disable the dimmer.
const char * type () const override
bool calculateMetrics (Metrics &metrics, float gridVoltage, float loadResistance) const override
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 (conduction duty cycle) applied to the dimmer in the range [0, 1].
bool calculateHarmonics (float *array, size_t n) const

Protected Member Functions

bool _apply () override
bool _calculateHarmonics (float *array, size_t n) const override

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)
static bool _calculatePhaseControlHarmonics (float dutyCycleFire, float *array, size_t n)
static bool _calculatePhaseControlMetrics (Metrics &metrics, float dutyCycleFire, float gridVoltage, float loadResistance)
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

PWM based dimmer implementation for voltage regulators controlled by a PWM signal to 0-10V analog convertor.

Definition at line 16 of file MycilaDimmerPWM.h.

Constructor & Destructor Documentation

◆ ~PWMDimmer()

virtual Mycila::PWMDimmer::~PWMDimmer ( )
inlinevirtual

Definition at line 18 of file MycilaDimmerPWM.h.

Member Function Documentation

◆ _apply()

bool Mycila::PWMDimmer::_apply ( )
inlineoverrideprotectedvirtual

Reimplemented from Mycila::Dimmer.

Definition at line 86 of file MycilaDimmerPWM.h.

◆ _calculateHarmonics()

bool Mycila::PWMDimmer::_calculateHarmonics ( float * array,
size_t n ) const
inlineoverrideprotectedvirtual

Reimplemented from Mycila::Dimmer.

Definition at line 94 of file MycilaDimmerPWM.h.

◆ begin()

void Mycila::PWMDimmer::begin ( )
overridevirtual

Enable a dimmer on a specific GPIO pin.

Warning
Dimmer won't be enabled if pin is invalid
Dimmer won't be activated until the ZCD is enabled

Reimplemented from Mycila::Dimmer.

Definition at line 24 of file MycilaDimmerPWM.cpp.

◆ calculateMetrics()

bool Mycila::PWMDimmer::calculateMetrics ( Metrics & metrics,
float gridVoltage,
float loadResistance ) const
inlineoverridevirtual

Reimplemented from Mycila::Dimmer.

Definition at line 67 of file MycilaDimmerPWM.h.

◆ end()

void Mycila::PWMDimmer::end ( )
overridevirtual

Disable the dimmer.

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

Reimplemented from Mycila::Dimmer.

Definition at line 49 of file MycilaDimmerPWM.cpp.

◆ getFrequency()

uint32_t Mycila::PWMDimmer::getFrequency ( ) const
inline

Get the PWM frequency in Hz.

Definition at line 38 of file MycilaDimmerPWM.h.

◆ getPin()

gpio_num_t Mycila::PWMDimmer::getPin ( ) const
inline

Get the GPIO pin used for the dimmer.

Definition at line 28 of file MycilaDimmerPWM.h.

◆ getResolution()

uint8_t Mycila::PWMDimmer::getResolution ( ) const
inline

Get the PWM resolution in bits.

Definition at line 48 of file MycilaDimmerPWM.h.

◆ setFrequency()

void Mycila::PWMDimmer::setFrequency ( uint32_t frequency)
inline

Set the PWM frequency in Hz.

Definition at line 33 of file MycilaDimmerPWM.h.

◆ setPin()

void Mycila::PWMDimmer::setPin ( gpio_num_t pin)
inline

Set the GPIO pin to use for the dimmer.

Definition at line 23 of file MycilaDimmerPWM.h.

◆ setResolution()

void Mycila::PWMDimmer::setResolution ( uint8_t resolution)
inline

Set the PWM resolution in bits.

Definition at line 43 of file MycilaDimmerPWM.h.

◆ type()

const char * Mycila::PWMDimmer::type ( ) const
inlineoverridevirtual

Reimplemented from Mycila::Dimmer.

Definition at line 65 of file MycilaDimmerPWM.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0