Class representing a Zigbee Pilot Wire Control endpoint. This class extends the ZigbeeEP class to implement a custom cluster for controlling pilot-wire electric heaters via Zigbee. More...

#include <ZigbeePilotWireControl.h>

Inheritance diagram for ZigbeePilotWireControl:

Collaboration diagram for ZigbeePilotWireControl:

Public Member Functions
	ZigbeePilotWireControl (uint8_t endpoint)
	Constructor for ZigbeePilotWireControl.

	ZigbeePilotWireControl (uint8_t endpoint, float tempMin, float tempMax)
	Constructor for ZigbeePilotWireControl with temperature measurement. This constructor enables the temperature measurement cluster. The metering cluster is disabled. You must call begin(float currentTemperature) after constructing the object to initialize the endpoint.

	ZigbeePilotWireControl (uint8_t endpoint, uint32_t meteringMultiplier)
	Constructor for ZigbeePilotWireControl with metering. This constructor enables the metering cluster. The temperature measurement cluster is disabled. You must call begin() after constructing the object to initialize the endpoint.

	ZigbeePilotWireControl (uint8_t endpoint, float tempMin, float tempMax, uint32_t meteringMultiplier)
	Constructor for ZigbeePilotWireControl with temperature measurement and metering. This constructor enables both the temperature measurement and metering clusters. You must call begin(float currentTemperature) after constructing the object to initialize the endpoint.

void	onPilotWireModeChange (void(*callback)(ZigbeePilotWireMode mode))
	Set a callback function to be called when the Pilot Wire mode changes. This function must be called to register a callback that will be invoked before to call begin().

bool	begin ()
	Initialize the ZigbeePilotWireControl endpoint and create clusters. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode and adds the endpoint to the Zigbee stack.

bool	begin (float currentTemperature)
	Initialize the ZigbeePilotWireControl endpoint with temperature measurement. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Temperature Measurement and adds the endpoint to the Zigbee stack.

bool	begin (int32_t currentPower, uint32_t meteringMultiplier=0)
	Initialize the ZigbeePilotWireControl endpoint with metering. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Metering and adds the endpoint to the Zigbee stack.

bool	begin (float currentTemperature, int32_t currentPower, uint32_t meteringMultiplier=0)
	Initialize the ZigbeePilotWireControl endpoint with temperature measurement and metering. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Temperature Measurement, Metering and adds the endpoint to the Zigbee stack.

ZigbeePilotWireMode	pilotWireMode () const
	Get the current Pilot Wire mode.

bool	powerState () const
	Get the current power state.

bool	setPilotWireMode (ZigbeePilotWireMode mode)
	Set the Pilot Wire mode. This method updates the Pilot Wire mode attribute and notifies the application of the mode change via the registered callback function.

bool	reportPilotModeAndOnOff ()
	Report the current Pilot Wire mode and On/Off attributes to the Zigbee network. This method call the callback to notify the application of the current mode, and updates the Pilot Wire mode and On/Off attributes in the Zigbee stack.

bool	setTemperature (float value)
	Set the temperature value for the temperature measurement cluster.

float	temperature () const
	Get the current temperature value.

float	temperatureMin () const
	Get the minimum temperature value.

float	temperatureMax () const
	Get the maximum temperature value.

bool	setTemperatureReporting (uint16_t min_interval, uint16_t max_interval, float delta)
	Set the reporting interval for the temperature measurement cluster.

bool	reportTemperature ()
	Report the current temperature value to the Zigbee network. The reporting is configured via setTemperatureReporting(), so this method can be used to force a report outside of the configured intervals.

bool	setEnergyWh (uint64_t summation_wh)
	Set the summation delivered attribute in the metering cluster.

uint64_t	energyWh () const
	Get the current summation delivered value.

bool	reportEnergyWh ()
	Report the current summation delivered value to the Zigbee network. The reporting is configured via setEnergyWhReporting(), so this method can be used to force a report outside of the configured intervals.

bool	setEnergyWhReporting (uint16_t min_interval, uint16_t max_interval, float delta)
	Set the reporting interval for the summation delivered attribute in the metering cluster.

bool	setPowerW (int32_t demand_w)
	Set the electric power attribute in the metering cluster.

int32_t	powerW () const
	Get the current electric power value.

bool	reportPowerW ()
	Report the current electric power value to the Zigbee network. The reporting is configured via setPowerWReporting(), so this method can be used to force a report outside of the configured intervals.

bool	setPowerWReporting (uint16_t min_interval, uint16_t max_interval, float delta)
	Set the reporting interval for the electric power attribute in the metering cluster.

bool	setMeteringStatus (uint8_t status)
	Set the metering status attribute in the metering cluster.

uint8_t	meteringStatus () const
	Get the current metering status value.

bool	reportAttributes ()
	Report the current attributes to the Zigbee network. This method updates the Pilot Wire mode, On/Off, temperature (if enabled) and metering (if enabled) attributes in the Zigbee stack.

void	enableNvs (bool enable)
	Enable or disable restore mode. When restore mode is enabled, the Pilot Wire mode is restored from NVS on startup.

bool	isNvsEnabled () const
	Check if restore mode is enabled.

	~ZigbeePilotWireControl ()
	Destructor for ZigbeePilotWireControl. Cleans up resources and ends NVS preferences.

void	end ()
	End the ZigbeePilotWireControl and clean up resources. This method should be called to properly release resources used by the ZigbeePilotWireControl instance.

void	printClusterInfo (Print &out=Serial)
	Print the cluster information of the ZigbeePilotWireControl endpoint. This method outputs the cluster details to the specified Print object for debugging purposes.

Protected Member Functions
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 Member Functions
void	pilotWireModeChanged ()

Private Attributes
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

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

Detailed Description

Class representing a Zigbee Pilot Wire Control endpoint. This class extends the ZigbeeEP class to implement a custom cluster for controlling pilot-wire electric heaters via Zigbee.

Definition at line 98 of file ZigbeePilotWireControl.h.

Constructor & Destructor Documentation

◆ ZigbeePilotWireControl() [1/4]

ZigbeePilotWireControl::ZigbeePilotWireControl ( uint8_t endpoint )

Constructor for ZigbeePilotWireControl.

Temperature measurement and metering clusters are disabled. You must call begin() after constructing the object to initialize the endpoint.

Parameters

endpoint The Zigbee endpoint number to use for this device.

◆ ZigbeePilotWireControl() [2/4]

ZigbeePilotWireControl::ZigbeePilotWireControl	(	uint8_t	endpoint,
		float	tempMin,
		float	tempMax
	)

Constructor for ZigbeePilotWireControl with temperature measurement. This constructor enables the temperature measurement cluster. The metering cluster is disabled. You must call begin(float currentTemperature) after constructing the object to initialize the endpoint.

Parameters

endpoint	The Zigbee endpoint number to use for this device.
tempMin	The minimum temperature value for the temperature measurement cluster in degrees Celsius.
tempMax	The maximum temperature value for the temperature measurement cluster in degrees Celsius.

◆ ZigbeePilotWireControl() [3/4]

ZigbeePilotWireControl::ZigbeePilotWireControl	(	uint8_t	endpoint,
		uint32_t	meteringMultiplier
	)

Constructor for ZigbeePilotWireControl with metering. This constructor enables the metering cluster. The temperature measurement cluster is disabled. You must call begin() after constructing the object to initialize the endpoint.

Parameters

endpoint	The Zigbee endpoint number to use for this device.
meteringMultiplier	The multiplier value for the metering cluster, must be non-zero to enable metering. This value must be updated whis begin(uint32_t meteringMultiplier).

◆ ZigbeePilotWireControl() [4/4]

ZigbeePilotWireControl::ZigbeePilotWireControl	(	uint8_t	endpoint,
		float	tempMin,
		float	tempMax,
		uint32_t	meteringMultiplier
	)

Constructor for ZigbeePilotWireControl with temperature measurement and metering. This constructor enables both the temperature measurement and metering clusters. You must call begin(float currentTemperature) after constructing the object to initialize the endpoint.

Parameters

endpoint	The Zigbee endpoint number to use for this device.
tempMin	The minimum temperature value for the temperature measurement cluster in degrees Celsius.
tempMax	The maximum temperature value for the temperature measurement cluster in degrees Celsius.
meteringMultiplier	The multiplier value for the metering cluster, must be non-zero to enable metering. This value must be updated whis begin(float currentTemperature, uint32_t meteringMultiplier).

◆ ~ZigbeePilotWireControl()

ZigbeePilotWireControl::~ZigbeePilotWireControl ( )

inline

Destructor for ZigbeePilotWireControl. Cleans up resources and ends NVS preferences.

Definition at line 398 of file ZigbeePilotWireControl.h.

References end().

Here is the call graph for this function:

Member Function Documentation

◆ begin() [1/4]

bool ZigbeePilotWireControl::begin ( )

Initialize the ZigbeePilotWireControl endpoint and create clusters. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode and adds the endpoint to the Zigbee stack.

Returns: true if the initialization was successful, false otherwise.

Note: This method must be called before to add the endpoint to the Zigbee core.

◆ begin() [2/4]

bool ZigbeePilotWireControl::begin ( float currentTemperature )

Initialize the ZigbeePilotWireControl endpoint with temperature measurement. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Temperature Measurement and adds the endpoint to the Zigbee stack.

Parameters

currentTemperature The initial temperature value for the temperature measurement cluster in degrees Celsius.

Returns: true if the initialization was successful, false otherwise.

Note: This method must be called before to add the endpoint to the Zigbee core.

◆ begin() [3/4]

bool ZigbeePilotWireControl::begin	(	float	currentTemperature,
		int32_t	currentPower,
		uint32_t	meteringMultiplier = `0`
	)

Initialize the ZigbeePilotWireControl endpoint with temperature measurement and metering. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Temperature Measurement, Metering and adds the endpoint to the Zigbee stack.

Parameters

currentTemperature	The initial temperature value for the temperature measurement cluster in degrees Celsius.
currentPower	The initial instantaneous power demand value for the metering cluster in watts (W).
meteringMultiplier	The multiplier value for the metering cluster, this value was set in the constructor. If meteringMultiplier is zero, no change is made to the value set in the constructor.

Returns: true if the initialization was successful, false otherwise.

Note: This method must be called before to add the endpoint to the Zigbee core.

◆ begin() [4/4]

bool ZigbeePilotWireControl::begin	(	int32_t	currentPower,
		uint32_t	meteringMultiplier = `0`
	)

Initialize the ZigbeePilotWireControl endpoint with metering. This method sets up the necessary clusters for Pilot Wire Control, including On/Off, Pilot Wire mode, Metering and adds the endpoint to the Zigbee stack.

Parameters

currentPower	The initial instantaneous power demand value for the metering cluster in watts (W).
meteringMultiplier	The multiplier value for the metering cluster, this value was set in the constructor. If meteringMultiplier is zero, no change is made to the value set in the constructor.

Returns: true if the initialization was successful, false otherwise.

Note: This method must be called before to add the endpoint to the Zigbee core.

◆ createMeteringCluster()

bool ZigbeePilotWireControl::createMeteringCluster	(	int32_t	currentPower,
		uint32_t	meteringMultiplier
	)

protected

◆ createPilotWireCluster()

bool ZigbeePilotWireControl::createPilotWireCluster ( )

protected

◆ createTemperatureMeasurementCluster()

bool ZigbeePilotWireControl::createTemperatureMeasurementCluster ( float currentTemperature )

protected

◆ enableNvs()

void ZigbeePilotWireControl::enableNvs ( bool enable )

inline

Enable or disable restore mode. When restore mode is enabled, the Pilot Wire mode is restored from NVS on startup.

Parameters

enable true to enable restore mode, false to disable.

Note: This setting is persisted in NVS.

Definition at line 381 of file ZigbeePilotWireControl.h.

References _nvs_enabled, and _prefs.

◆ end()

void ZigbeePilotWireControl::end ( )

inline

End the ZigbeePilotWireControl and clean up resources. This method should be called to properly release resources used by the ZigbeePilotWireControl instance.

Definition at line 406 of file ZigbeePilotWireControl.h.

References _prefs.

Referenced by ~ZigbeePilotWireControl().

◆ energyWh()

uint64_t ZigbeePilotWireControl::energyWh ( ) const

Get the current summation delivered value.

Returns: The current summation delivered value in watt-hours (Wh).

◆ isNvsEnabled()

bool ZigbeePilotWireControl::isNvsEnabled ( ) const

inline

Check if restore mode is enabled.

Returns: true if restore mode is enabled, false otherwise.

Definition at line 390 of file ZigbeePilotWireControl.h.

References _nvs_enabled.

◆ meteringStatus()

uint8_t ZigbeePilotWireControl::meteringStatus ( ) const

inline

Get the current metering status value.

Returns: The current metering status (bitmap U8 in ZCL).

Definition at line 363 of file ZigbeePilotWireControl.h.

References _metering_cfg.

◆ onPilotWireModeChange()

void ZigbeePilotWireControl::onPilotWireModeChange ( void(*)(ZigbeePilotWireMode mode) callback )

inline

Set a callback function to be called when the Pilot Wire mode changes. This function must be called to register a callback that will be invoked before to call begin().

Parameters

callback A function pointer to the callback function. The callback function should have the following signature: void callback(ZigbeePilotWireMode mode); The mode parameter will contain the new Pilot Wire mode. This function is used to notify the application of mode changes.

Warning: This is the only place where the mode change, after the zigbee network is established, the user must use setPilotWireMode() to change mode.

Definition at line 155 of file ZigbeePilotWireControl.h.

References _on_mode_change.

◆ pilotWireMode()

ZigbeePilotWireMode ZigbeePilotWireControl::pilotWireMode ( ) const

inline

Get the current Pilot Wire mode.

Returns: The current Pilot Wire mode as a ZigbeePilotWireMode enum value.

Definition at line 208 of file ZigbeePilotWireControl.h.

References _current_mode.

◆ pilotWireModeChanged()

void ZigbeePilotWireControl::pilotWireModeChanged ( )

private

◆ powerState()

bool ZigbeePilotWireControl::powerState ( ) const

inline

Get the current power state.

Returns: true if the power is ON, false if OFF. true if mode is PILOTWIRE_MODE_OFF, false otherwise.

Definition at line 216 of file ZigbeePilotWireControl.h.

References _current_state.

◆ powerW()

int32_t ZigbeePilotWireControl::powerW ( ) const

Get the current electric power value.

Returns: The current electric power value in watts (W).

◆ printClusterInfo()

void ZigbeePilotWireControl::printClusterInfo ( Print & out = Serial )

Print the cluster information of the ZigbeePilotWireControl endpoint. This method outputs the cluster details to the specified Print object for debugging purposes.

Parameters

out	The Print object to output the cluster information to. Defaults to Serial.

◆ reportAttribute()

bool ZigbeePilotWireControl::reportAttribute	(	uint16_t	cluster_id,
		uint16_t	attr_id,
		uint16_t	manuf_code = `ESP_ZB_ZCL_ATTR_NON_MANUFACTURER_SPECIFIC`
	)

protected

◆ reportAttributes()

bool ZigbeePilotWireControl::reportAttributes ( )

Report the current attributes to the Zigbee network. This method updates the Pilot Wire mode, On/Off, temperature (if enabled) and metering (if enabled) attributes in the Zigbee stack.

Returns: true if the attributes were reported successfully, false otherwise.

◆ reportEnergyWh()

bool ZigbeePilotWireControl::reportEnergyWh ( )

Report the current summation delivered value to the Zigbee network. The reporting is configured via setEnergyWhReporting(), so this method can be used to force a report outside of the configured intervals.

Returns: true if the energy was reported successfully, false otherwise.

◆ reportPilotModeAndOnOff()

bool ZigbeePilotWireControl::reportPilotModeAndOnOff ( )

Report the current Pilot Wire mode and On/Off attributes to the Zigbee network. This method call the callback to notify the application of the current mode, and updates the Pilot Wire mode and On/Off attributes in the Zigbee stack.

◆ reportPowerW()

bool ZigbeePilotWireControl::reportPowerW ( )

Report the current electric power value to the Zigbee network. The reporting is configured via setPowerWReporting(), so this method can be used to force a report outside of the configured intervals.

Returns: true if the power was reported successfully, false otherwise.

◆ reportTemperature()

bool ZigbeePilotWireControl::reportTemperature ( )

Report the current temperature value to the Zigbee network. The reporting is configured via setTemperatureReporting(), so this method can be used to force a report outside of the configured intervals.

Returns: true if the temperature was reported successfully, false otherwise.

◆ setEnergyWh()

bool ZigbeePilotWireControl::setEnergyWh ( uint64_t summation_wh )

Set the summation delivered attribute in the metering cluster.

Parameters

summation_wh The total energy delivered in watt-hours (Wh). uint48_t value. if isNvsEnabled() is true, this value is stored in NVS and restored on startup.

Returns: true if the attribute was set successfully, false otherwise.

◆ setEnergyWhReporting()

bool ZigbeePilotWireControl::setEnergyWhReporting	(	uint16_t	min_interval,
		uint16_t	max_interval,
		float	delta
	)

Set the reporting interval for the summation delivered attribute in the metering cluster.

Parameters

min_interval	The minimum reporting interval in seconds. This is the shortest time between reports even if the energy changes.
max_interval	The maximum reporting interval in seconds. This is the longest time between reports even if the energy does not change.
delta	The energy change delta in watt-hours (Wh). This is the minimum change in energy that triggers a report.

Returns: true if the reporting interval was set successfully, false otherwise.

◆ setMeteringStatus()

bool ZigbeePilotWireControl::setMeteringStatus ( uint8_t status )

Set the metering status attribute in the metering cluster.

Parameters

status The metering status (bitmap U8 in ZCL). bit 6 Service Disconnect Open: Set to true when the service have been disconnected to this premises. bit 5 Leak Detect: Set to true when a leak has been detected. bit 4 Power Quality: Set to true if a power quality event has been detected such as a low voltage, high voltage. bit 3 Power Failure: Set to true during a power outage. bit 2 Tamper Detect: Set to true if a tamper event has been detected. bit 1 Low Battery: Set to true when the battery needs maintenance. bit 0 Check Meter: Set to true when a non fatal problem has been detected on the meter such as a measurement error, memory error, and self check error.

Returns: true if the attribute was set successfully, false otherwise.

◆ setPilotWireMode()

bool ZigbeePilotWireControl::setPilotWireMode ( ZigbeePilotWireMode mode )

Set the Pilot Wire mode. This method updates the Pilot Wire mode attribute and notifies the application of the mode change via the registered callback function.

Parameters

mode	The new Pilot Wire mode to set.

Returns: true if the mode was set successfully, false otherwise.

Note: this method will invoke the callback function registered via onPilotWireModeChange() and report the attribute change to the Zigbee network with reportAttributes(). So, this is not necessarily to call reportAttributes() after calling this method.

◆ setPowerW()

bool ZigbeePilotWireControl::setPowerW ( int32_t demand_w )

Set the electric power attribute in the metering cluster.

Parameters

demand_w The instantaneous power demand in watts (W). uint24_t value representing -8388608 to 8388607 W.

Returns: true if the attribute was set successfully, false otherwise.

◆ setPowerWReporting()

bool ZigbeePilotWireControl::setPowerWReporting	(	uint16_t	min_interval,
		uint16_t	max_interval,
		float	delta
	)

Set the reporting interval for the electric power attribute in the metering cluster.

Parameters

min_interval	The minimum reporting interval in seconds. This is the shortest time between reports even if the power changes.
max_interval	The maximum reporting interval in seconds. This is the longest time between reports even if the power does not change.
delta	The power change delta in watts (W). This is the minimum change in power that triggers a report.

Returns: true if the reporting interval was set successfully, false otherwise.

◆ setReporting()

bool ZigbeePilotWireControl::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`
	)

protected

◆ setTemperature()

bool ZigbeePilotWireControl::setTemperature ( float value )

Set the temperature value for the temperature measurement cluster.

Parameters

temperature The temperature value in degrees Celsius, the resolution is 0.01 degree.

Returns: true if the temperature was set successfully, false otherwise.

◆ setTemperatureReporting()

bool ZigbeePilotWireControl::setTemperatureReporting	(	uint16_t	min_interval,
		uint16_t	max_interval,
		float	delta
	)

Set the reporting interval for the temperature measurement cluster.

Parameters

min_interval	The minimum reporting interval in seconds. This is the shortest time between reports even if the temperature changes.
max_interval	The maximum reporting interval in seconds. This is the longest time between reports even if the temperature does not change.
delta	The temperature change delta in degrees Celsius, the resolution is 0.01 degree. This is the minimum change in temperature that triggers a report.

Returns: true if the reporting interval was set successfully, false otherwise.

◆ temperature()

float ZigbeePilotWireControl::temperature ( ) const

inline

Get the current temperature value.

Returns: The current temperature value in degrees Celsius.

Definition at line 250 of file ZigbeePilotWireControl.h.

References _temperature_value.

◆ temperatureMax()

float ZigbeePilotWireControl::temperatureMax ( ) const

Get the maximum temperature value.

Returns: The maximum temperature value in degrees Celsius. NAN if temperature measurement cluster is not enabled.

◆ temperatureMin()

float ZigbeePilotWireControl::temperatureMin ( ) const

Get the minimum temperature value.

Returns: The minimum temperature value in degrees Celsius. NAN if temperature measurement cluster is not enabled.

◆ zbAttributeSet()

void ZigbeePilotWireControl::zbAttributeSet ( const esp_zb_zcl_set_attr_value_message_t * message )

overrideprotected

Member Data Documentation

◆ _current_mode

uint8_t ZigbeePilotWireControl::_current_mode

private

Definition at line 430 of file ZigbeePilotWireControl.h.

Referenced by pilotWireMode().

◆ _current_state

bool ZigbeePilotWireControl::_current_state

private

Definition at line 434 of file ZigbeePilotWireControl.h.

Referenced by powerState().

◆ _current_state_changed

bool ZigbeePilotWireControl::_current_state_changed

private

Definition at line 435 of file ZigbeePilotWireControl.h.

◆ _divisor

esp_zb_uint24_t ZigbeePilotWireControl::_divisor

private

Definition at line 448 of file ZigbeePilotWireControl.h.

◆ _instantaneousDemand

esp_zb_int24_t ZigbeePilotWireControl::_instantaneousDemand

private

Definition at line 449 of file ZigbeePilotWireControl.h.

◆ _metering_cfg

esp_zb_metering_cluster_cfg_t ZigbeePilotWireControl::_metering_cfg

private

Definition at line 445 of file ZigbeePilotWireControl.h.

Referenced by meteringStatus().

◆ _metering_enabled

bool ZigbeePilotWireControl::_metering_enabled

private

Definition at line 444 of file ZigbeePilotWireControl.h.

◆ _multiplier

esp_zb_uint24_t ZigbeePilotWireControl::_multiplier

private

Definition at line 447 of file ZigbeePilotWireControl.h.

◆ _nvs_enabled

bool ZigbeePilotWireControl::_nvs_enabled

private

Definition at line 436 of file ZigbeePilotWireControl.h.

Referenced by enableNvs(), and isNvsEnabled().

◆ _on_mode_change

void(* ZigbeePilotWireControl::_on_mode_change) (ZigbeePilotWireMode mode)

private

Definition at line 432 of file ZigbeePilotWireControl.h.

Referenced by onPilotWireModeChange().

◆ _prefs

Preferences ZigbeePilotWireControl::_prefs

private

Definition at line 437 of file ZigbeePilotWireControl.h.

Referenced by enableNvs(), and end().

◆ _state_on_mode

uint8_t ZigbeePilotWireControl::_state_on_mode

private

Definition at line 431 of file ZigbeePilotWireControl.h.

◆ _summationDelivered

esp_zb_uint48_t ZigbeePilotWireControl::_summationDelivered

private

Definition at line 446 of file ZigbeePilotWireControl.h.

◆ _temperature_cfg

esp_zb_temperature_meas_cluster_cfg_t ZigbeePilotWireControl::_temperature_cfg

private

Definition at line 440 of file ZigbeePilotWireControl.h.

◆ _temperature_enabled

bool ZigbeePilotWireControl::_temperature_enabled

private

Definition at line 439 of file ZigbeePilotWireControl.h.

◆ _temperature_value

float ZigbeePilotWireControl::_temperature_value

private

Definition at line 441 of file ZigbeePilotWireControl.h.

Referenced by temperature().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZigbeePilotWireControl() [1/4]

◆ ZigbeePilotWireControl() [2/4]

◆ ZigbeePilotWireControl() [3/4]

◆ ZigbeePilotWireControl() [4/4]

◆ ~ZigbeePilotWireControl()

Member Function Documentation

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ createMeteringCluster()

◆ createPilotWireCluster()

◆ createTemperatureMeasurementCluster()

◆ enableNvs()

◆ end()

◆ energyWh()

◆ isNvsEnabled()

◆ meteringStatus()

◆ onPilotWireModeChange()

◆ pilotWireMode()

◆ pilotWireModeChanged()

◆ powerState()

◆ powerW()

◆ printClusterInfo()

◆ reportAttribute()

◆ reportAttributes()

◆ reportEnergyWh()

◆ reportPilotModeAndOnOff()

◆ reportPowerW()

◆ reportTemperature()

◆ setEnergyWh()

◆ setEnergyWhReporting()

◆ setMeteringStatus()

◆ setPilotWireMode()

◆ setPowerW()

◆ setPowerWReporting()

◆ setReporting()

◆ setTemperature()

◆ setTemperatureReporting()

◆ temperature()

◆ temperatureMax()

◆ temperatureMin()

◆ zbAttributeSet()

Member Data Documentation

◆ _current_mode

◆ _current_state

◆ _current_state_changed

◆ _divisor

◆ _instantaneousDemand

◆ _metering_cfg

◆ _metering_enabled

◆ _multiplier

◆ _nvs_enabled

◆ _on_mode_change

◆ _prefs

◆ _state_on_mode

◆ _summationDelivered

◆ _temperature_cfg

◆ _temperature_enabled

◆ _temperature_value