ZigbeePilotWireControl.h

 
#pragma once
 
#include <soc/soc_caps.h>
#include <sdkconfig.h>
 
#if ! CONFIG_ZB_ENABLED
#error "This library requires Zigbee support to be enabled in sdkconfig"
#endif  // CONFIG_ZB_ENABLED
 
#include <ZigbeeEP.h>
#include <ha/esp_zigbee_ha_standard.h>
#include <Preferences.h>
 
#ifndef PILOT_WIRE_MANUF_NAME
#define PILOT_WIRE_MANUF_NAME   "EpsilonRT"
#endif
 
#ifndef PILOT_WIRE_MODEL_NAME
#define PILOT_WIRE_MODEL_NAME   "ERT-MPZ-03"
#endif
 
#ifndef PILOT_WIRE_MANUF_CODE
#define PILOT_WIRE_MANUF_CODE   0x1234
#endif
 
#define PILOT_WIRE_CLUSTER_ID   0xFC00
 
#define PILOT_WIRE_MODE_ATTR_ID 0x0000
 
enum ZigbeePilotWireMode : uint8_t {
  PILOTWIRE_MODE_OFF = 0, 
  PILOTWIRE_MODE_COMFORT, 
  PILOTWIRE_MODE_ECO, 
  PILOTWIRE_MODE_FROST_PROTECTION, 
  PILOTWIRE_MODE_COMFORT_MINUS_1, 
  PILOTWIRE_MODE_COMFORT_MINUS_2 
};
 
const ZigbeePilotWireMode PILOTWIRE_MODE_MIN = PILOTWIRE_MODE_OFF;
 
const ZigbeePilotWireMode PILOTWIRE_MODE_MAX = PILOTWIRE_MODE_COMFORT_MINUS_2;
 
const uint8_t PILOTWIRE_MODE_COUNT = (PILOTWIRE_MODE_COMFORT_MINUS_2 - PILOTWIRE_MODE_OFF + 1);
 
class ZigbeePilotWireControl : public ZigbeeEP {
  public:
    ZigbeePilotWireControl (uint8_t endpoint);
 
    ZigbeePilotWireControl (uint8_t endpoint, float tempMin, float tempMax);
 
    ZigbeePilotWireControl (uint8_t endpoint, uint32_t meteringMultiplier);
 
    ZigbeePilotWireControl (uint8_t endpoint, float tempMin, float tempMax, uint32_t meteringMultiplier);
 
    void onPilotWireModeChange (void (*callback) (ZigbeePilotWireMode mode)) {
      _on_mode_change = callback;
    }
 
    bool begin ();
 
    bool begin (float currentTemperature);
 
    bool begin (int32_t currentPower, uint32_t meteringMultiplier = 0);
 
    bool begin (float currentTemperature, int32_t currentPower, uint32_t meteringMultiplier = 0);
 
    ZigbeePilotWireMode pilotWireMode() const {
      return  static_cast<ZigbeePilotWireMode> (_current_mode);
    }
 
    bool powerState() const {
      return _current_state;
    }
 
    bool setPilotWireMode (ZigbeePilotWireMode mode);
 
    bool reportPilotModeAndOnOff ();
 
    bool setTemperature (float value);
 
    float temperature() const {
      return _temperature_value;
    }
 
    float temperatureMin() const;
 
    float temperatureMax() const;
 
    bool setTemperatureReporting (uint16_t min_interval, uint16_t max_interval, float delta);
 
    bool reportTemperature();
 
    bool setEnergyWh (uint64_t summation_wh);
 
    uint64_t energyWh() const;
 
    bool reportEnergyWh();
 
    bool setEnergyWhReporting (uint16_t min_interval, uint16_t max_interval, float delta);
 
    bool setPowerW (int32_t demand_w);
 
    int32_t powerW() const;
 
    bool reportPowerW();
 
    bool setPowerWReporting (uint16_t min_interval, uint16_t max_interval, float delta);
 
    bool setMeteringStatus (uint8_t status);
 
    uint8_t meteringStatus() const {
      return _metering_cfg.status;
    }
 
    bool reportAttributes();
 
    void enableNvs (bool enable) {
      _nvs_enabled = enable;
      _prefs.putBool ("restore", enable);
    }
 
    bool isNvsEnabled() const {
      return _nvs_enabled;
    }
 
    ~ZigbeePilotWireControl() {
      end();
    }
 
    void end() {
      _prefs.end();
    }
 
    void printClusterInfo (Print &out = Serial);
 
  protected:
    void zbAttributeSet (const esp_zb_zcl_set_attr_value_message_t *message) override;
    bool setReporting (uint16_t cluster_id, uint16_t attr_id,
                       uint16_t min_interval, uint16_t max_interval, float delta,
                       uint16_t manuf_code = ESP_ZB_ZCL_ATTR_NON_MANUFACTURER_SPECIFIC);
    bool reportAttribute (uint16_t cluster_id, uint16_t attr_id, uint16_t manuf_code = ESP_ZB_ZCL_ATTR_NON_MANUFACTURER_SPECIFIC);
    bool createPilotWireCluster();
    bool createTemperatureMeasurementCluster (float currentTemperature);
    bool createMeteringCluster (int32_t currentPower, uint32_t meteringMultiplier);
 
  private:
    void pilotWireModeChanged();
 
    uint8_t _current_mode;
    uint8_t _state_on_mode;
    void (*_on_mode_change) (ZigbeePilotWireMode mode);
 
    bool _current_state;
    bool _current_state_changed;
    bool _nvs_enabled;
    Preferences _prefs;
 
    bool _temperature_enabled;
    esp_zb_temperature_meas_cluster_cfg_t _temperature_cfg;
    float _temperature_value;
 
    // Member variables for Simple Metering cluster (0x0702)
    bool _metering_enabled;
    esp_zb_metering_cluster_cfg_t _metering_cfg;
    esp_zb_uint48_t _summationDelivered;
    esp_zb_uint24_t _multiplier;
    esp_zb_uint24_t _divisor;
    esp_zb_int24_t _instantaneousDemand;
};