MycilaDimmerThyristor.h

// SPDX-License-Identifier: MIT
/*
 * Copyright (C) 2023-2025 Mathieu Carbou
 */
#pragma once
 
#include "MycilaDimmer.h"
#include <driver/gptimer_types.h>
 
namespace Mycila {
  class ThyristorDimmer : public Dimmer {
    public:
      virtual ~ThyristorDimmer() { end(); }

      void setPin(gpio_num_t pin) { _pin = pin; }

      gpio_num_t getPin() const { return _pin; }

      void setSemiPeriod(uint16_t semiPeriod) {
        if (semiPeriod == 0) {
          ESP_LOGE("Thyristor", "setSemiPeriod: semiPeriod must be > 0");
        }
        assert(semiPeriod > 0);
        _semiPeriod = semiPeriod;
      }

      uint16_t getSemiPeriod() const { return _semiPeriod; }

      uint16_t getFiringDelay() const { return _delay > _semiPeriod ? _semiPeriod : _delay; }

      float getPhaseAngle() const { return _delay >= _semiPeriod ? 180 : 180 * _delay / _semiPeriod; }

      void begin() override;

      void end() override;
 
      const char* type() const override { return "thyristor"; }
 
      bool calculateMetrics(Metrics& metrics, float gridVoltage, float loadResistance) const override {
        return isEnabled() && _calculatePhaseControlMetrics(metrics, _dutyCycleFire, gridVoltage, loadResistance);
      }

      static void onZeroCross(int16_t delayUntilZero, void* args);
 
#ifdef MYCILA_JSON_SUPPORT
      void toJson(const JsonObject& root) const override {
        Dimmer::toJson(root);
        root["dimmer_pin"] = _pin;
        root["dimmer_semi_period"] = _semiPeriod;
        root["dimmer_firing_delay"] = getFiringDelay();
        root["dimmer_firing_angle"] = getPhaseAngle();
      }
#endif
 
    protected:
      bool _apply() override {
        if (!_online || !_semiPeriod || _dutyCycleFire == 0) {
          _delay = UINT16_MAX;
          return _enabled;
        }
        if (_dutyCycleFire == 1) {
          _delay = 0;
          return _enabled;
        }
        _delay = (1.0f - _dutyCycleFire) * static_cast<float>(_semiPeriod);
        return _enabled;
      }
 
      bool _calculateHarmonics(float* array, size_t n) const override {
        return _calculatePhaseControlHarmonics(_dutyCycleFire, array, n);
      }
 
    private:
      gpio_num_t _pin = GPIO_NUM_NC;
      uint16_t _delay = UINT16_MAX; // this is the next firing delay to apply
 
      static bool _fireTimerISR(gptimer_handle_t timer, const gptimer_alarm_event_data_t* event, void* arg);
      static void _registerDimmer(Mycila::ThyristorDimmer* dimmer);
      static void _unregisterDimmer(Mycila::ThyristorDimmer* dimmer);
  };
} // namespace Mycila