Skip to content

Instantly share code, notes, and snippets.

@andi242

andi242/ts0601_trv_sas.py

Created December 5, 2023 17:14
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save andi242/37c52daf601dd649bb3932b94334cf6c to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save andi242/37c52daf601dd649bb3932b94334cf6c to your computer and use it in GitHub Desktop.
Download ZIP
zha hama _TZE200_h4cgnbzg custom quirk
Raw
ts0601_trv_sas.py
"""Saswell (Tuya whitelabel) 88teujp thermostat valve quirk."""
import logging
from zigpy.profiles import zha
import zigpy.types as t
from zigpy.zcl import foundation
from zigpy.zcl.clusters.general import (
AnalogOutput,
Basic,
Groups,
Identify,
Ota,
Scenes,
Time,
)
from zigpy.zcl.clusters.hvac import Thermostat
from zhaquirks import Bus, LocalDataCluster
from zhaquirks.const import (
DEVICE_TYPE,
ENDPOINTS,
INPUT_CLUSTERS,
MODELS_INFO,
OUTPUT_CLUSTERS,
PROFILE_ID,
)
from zhaquirks.tuya import (
TuyaManufClusterAttributes,
TuyaPowerConfigurationCluster,
TuyaThermostat,
TuyaThermostatCluster,
)
_LOGGER = logging.getLogger(__name__)
SASWELL_HEATING_SETPOINT_ATTR = 0x0267
SASWELL_STATE_ATTR = 0x0165
SASWELL_LOCAL_TEMP_ATTR = 0x0266
SASWELL_BATTERY_LOW_ATTR = 0x0569
SASWELL_SCHEDULE_ENABLE_ATTR = 0x016C
SASWELL_TEMPERATURE_CALIBRATION_ATTR = 0x021B # temperature calibration in degrees
CTRL_SEQ_OF_OPER_ATTR = 0x001B
MIN_HEAT_SETPOINT_ATTR = 0x0015
MAX_HEAT_SETPOINT_ATTR = 0x0016
class ManufacturerThermostatCluster(TuyaManufClusterAttributes):
"""Tuya manufacturer specific cluster."""
class State(t.enum8):
"""State option."""
Off = 0x00
On = 0x01
class BatteryState(t.enum8):
"""Battery state option."""
Normal = 0x00
Low = 0x01
class ScheduleState(t.enum8):
"""Schedule state option."""
Disabled = 0x00
Enabled = 0x01
attributes = TuyaManufClusterAttributes.attributes.copy()
attributes.update(
{
SASWELL_STATE_ATTR: ("state", State, True),
SASWELL_HEATING_SETPOINT_ATTR: ("heating_setpoint", t.uint32_t, True),
SASWELL_LOCAL_TEMP_ATTR: ("local_temperature", t.uint32_t, True),
SASWELL_BATTERY_LOW_ATTR: ("battery_state", BatteryState, True),
SASWELL_SCHEDULE_ENABLE_ATTR: ("schedule_enabled", ScheduleState, True),
SASWELL_TEMPERATURE_CALIBRATION_ATTR: (
"temperature_calibration",
t.int32s,
True,
),
}
)
TEMPERATURE_ATTRS = {
SASWELL_HEATING_SETPOINT_ATTR: "occupied_heating_setpoint",
SASWELL_LOCAL_TEMP_ATTR: "local_temperature",
}
async def write_attributes(self, attributes, manufacturer=None):
"""Overwrite to force manufacturer code."""
return await super().write_attributes(
attributes, manufacturer=foundation.ZCLHeader.NO_MANUFACTURER_ID
)
def _update_attribute(self, attrid, value):
super()._update_attribute(attrid, value)
if attrid in self.TEMPERATURE_ATTRS:
self.endpoint.device.thermostat_bus.listener_event(
"temperature_change",
self.TEMPERATURE_ATTRS[attrid],
value * 10,
)
elif attrid == SASWELL_STATE_ATTR:
self.endpoint.device.thermostat_bus.listener_event(
"system_mode_reported", value
)
elif attrid == SASWELL_BATTERY_LOW_ATTR:
# this device doesn't have battery level reporting, only battery low alert
# when the alert is active (1) we report 0% and 100% otherwise (0)
self.endpoint.device.battery_bus.listener_event(
"battery_change", 0 if value == 1 else 100
)
elif attrid == (SASWELL_TEMPERATURE_CALIBRATION_ATTR):
self.endpoint.device.temperature_calibration_bus.listener_event(
"set_value", value
)
class ThermostatCluster(TuyaThermostatCluster):
"""Thermostat cluster."""
_CONSTANT_ATTRIBUTES = {
MIN_HEAT_SETPOINT_ATTR: 500,
MAX_HEAT_SETPOINT_ATTR: 3000,
CTRL_SEQ_OF_OPER_ATTR: Thermostat.ControlSequenceOfOperation.Heating_Only, # the device supports heating mode
}
def system_mode_reported(self, value):
"""Handle reported system mode."""
if value == 1:
self._update_attribute(
self.attributes_by_name["system_mode"].id, Thermostat.SystemMode.Heat
)
self._update_attribute(
self.attributes_by_name["running_mode"].id, Thermostat.RunningMode.Heat
)
_LOGGER.debug("reported system_mode: heat")
else:
self._update_attribute(
self.attributes_by_name["system_mode"].id, Thermostat.SystemMode.Off
)
self._update_attribute(
self.attributes_by_name["running_mode"].id, Thermostat.RunningMode.Off
)
_LOGGER.debug("reported system_mode: off")
def map_attribute(self, attribute, value):
"""Map standardized attribute value to dict of manufacturer values."""
if attribute == "occupied_heating_setpoint":
# centidegree to decidegree
return {SASWELL_HEATING_SETPOINT_ATTR: round(value / 10)}
if attribute == "system_mode":
# this quirk does not support programmig modes so we force the schedule mode to be always off
# more details: https://github.com/zigpy/zha-device-handlers/issues/1815
if value == self.SystemMode.Off:
return {SASWELL_STATE_ATTR: 0, SASWELL_SCHEDULE_ENABLE_ATTR: 0}
if value == self.SystemMode.Heat:
return {SASWELL_STATE_ATTR: 1, SASWELL_SCHEDULE_ENABLE_ATTR: 0}
class TuyaTemperatureOffset(LocalDataCluster, AnalogOutput):
"""AnalogOutput cluster for setting temperature offset."""
def __init__(self, *args, **kwargs):
"""Init."""
super().__init__(*args, **kwargs)
self.endpoint.device.temperature_calibration_bus.add_listener(self)
self._update_attribute(
self.attributes_by_name["description"].id, "Temperature Offset"
)
self._update_attribute(self.attributes_by_name["max_present_value"].id, 6)
self._update_attribute(self.attributes_by_name["min_present_value"].id, -6)
self._update_attribute(self.attributes_by_name["resolution"].id, 1)
self._update_attribute(self.attributes_by_name["application_type"].id, 0x0009)
self._update_attribute(self.attributes_by_name["engineering_units"].id, 62)
def set_value(self, value):
"""Set new temperature offset value."""
self._update_attribute(self.attributes_by_name["present_value"].id, value)
def get_value(self):
"""Get current temperature offset value."""
return self._attr_cache.get(self.attributes_by_name["present_value"].id)
async def write_attributes(self, attributes, manufacturer=None):
"""Modify value before passing it to the set_data tuya command."""
for attrid, value in attributes.items():
if isinstance(attrid, str):
attrid = self.attributes_by_name[attrid].id
if attrid not in self.attributes:
self.error("%d is not a valid attribute id", attrid)
continue
self._update_attribute(attrid, value)
if attrid == 0x0055: # `present_value`
await self.endpoint.tuya_manufacturer.write_attributes(
{SASWELL_TEMPERATURE_CALIBRATION_ATTR: value}, manufacturer=None
)
return ([foundation.WriteAttributesStatusRecord(foundation.Status.SUCCESS)],)
class Thermostat_TYST11_c88teujp(TuyaThermostat):
"""Saswell 88teujp thermostat valve."""
def __init__(self, *args, **kwargs):
"""Init device."""
self.temperature_calibration_bus = Bus()
super().__init__(*args, **kwargs)
signature = {
MODELS_INFO: [
("_TYST11_KGbxAXL2", "GbxAXL2"),
("_TYST11_c88teujp", "88teujp"),
("_TYST11_azqp6ssj", "zqp6ssj"),
("_TYST11_yw7cahqs", "w7cahqs"),
("_TYST11_9gvruqf5", "gvruqf5"),
("_TYST11_zuhszj9s", "uhszj9s"),
("_TYST11_caj4jz0i", "aj4jz0i"),
],
ENDPOINTS: {
# <SimpleDescriptor endpoint=1 profile=260 device_type=0
# device_version=0
# input_clusters=[0, 3]
# output_clusters=[3, 25]>
1: {
PROFILE_ID: zha.PROFILE_ID,
DEVICE_TYPE: zha.DeviceType.ON_OFF_SWITCH,
INPUT_CLUSTERS: [
Basic.cluster_id,
Identify.cluster_id,
],
OUTPUT_CLUSTERS: [
Identify.cluster_id,
Ota.cluster_id,
],
}
},
}
replacement = {
ENDPOINTS: {
1: {
PROFILE_ID: zha.PROFILE_ID,
DEVICE_TYPE: zha.DeviceType.THERMOSTAT,
INPUT_CLUSTERS: [
Basic.cluster_id,
TuyaPowerConfigurationCluster,
Identify.cluster_id,
ThermostatCluster,
ManufacturerThermostatCluster,
TuyaTemperatureOffset,
],
OUTPUT_CLUSTERS: [
Identify.cluster_id,
Ota.cluster_id,
],
}
},
}
class Thermostat_TZE200_c88teujp(TuyaThermostat):
"""Saswell 88teujp thermostat valve."""
def __init__(self, *args, **kwargs):
"""Init device."""
self.temperature_calibration_bus = Bus()
super().__init__(*args, **kwargs)
signature = {
MODELS_INFO: [
("_TZE200_c88teujp", "TS0601"),
("_TZE200_azqp6ssj", "TS0601"),
("_TZE200_yw7cahqs", "TS0601"),
("_TZE200_9gvruqf5", "TS0601"),
("_TZE200_zuhszj9s", "TS0601"),
("_TZE200_zr9c0day", "TS0601"),
("_TZE200_0dvm9mva", "TS0601"),
("_TZE200_h4cgnbzg", "TS0601"),
("_TZE200_exfrnlow", "TS0601"),
("_TZE200_9m4kmbfu", "TS0601"),
("_TZE200_3yp57tby", "TS0601"),
],
ENDPOINTS: {
# <SimpleDescriptor endpoint=1 profile=260 device_type=81
# device_version=0
# input_clusters=[0, 4, 5, 61184]
# output_clusters=[10, 25]>
1: {
PROFILE_ID: zha.PROFILE_ID,
DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
INPUT_CLUSTERS: [
Basic.cluster_id,
Groups.cluster_id,
Scenes.cluster_id,
TuyaManufClusterAttributes.cluster_id,
],
OUTPUT_CLUSTERS: [Time.cluster_id, Ota.cluster_id],
}
},
}
replacement = {
ENDPOINTS: {
1: {
PROFILE_ID: zha.PROFILE_ID,
DEVICE_TYPE: zha.DeviceType.THERMOSTAT,
INPUT_CLUSTERS: [
Basic.cluster_id,
TuyaPowerConfigurationCluster,
Groups.cluster_id,
Scenes.cluster_id,
ThermostatCluster,
ManufacturerThermostatCluster,
TuyaTemperatureOffset,
],
OUTPUT_CLUSTERS: [Time.cluster_id, Ota.cluster_id],
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment