Moes ZHT-S03 Thermostat Setup In Home Assistant
Hey everyone! I'm here to share my experience integrating the Moes ZHT-S03 wall thermostat (model TS0601) with Home Assistant using the ZHA (Zigbee Home Automation) integration. I ran into a few snags, but I've got a custom quirk working now, and I'm hoping to get some help with the scheduling part. Let's dive in!
Problem Description: Unveiling the Challenge
My journey began with a brand-new Moes Tuya thermostat I snagged from AliExpress. My Home Assistant setup, which is awesome, wasn't immediately recognizing it through ZHA. The device was showing up as TS0601 _TZE204_zxkwaztm. This wasn't ideal because out-of-the-box support was missing.
To get things rolling, I tweaked an existing tuya_thermostat.py file. This custom quirk allows the device to function, but the schedule configuration has me a bit stumped. I am still new to Home Assistant and ZHA development, so this is where I'm hoping the community can lend a hand. The main aim is to get this thermostat fully integrated so that it can be controlled using schedules.
Screenshots/Video: Visual Aids for Clarity
[Here, I'd include any screenshots or videos that illustrate the device, its interface, or any specific issues I'm facing. Visual aids are super helpful!]
Solution Description: Aiming for Seamless ZHA Integration
The ultimate goal is to have this thermostat fully integrated directly into ZHA. This means it should be recognized and function correctly without the need for custom modifications. The core of the solution involves developing or refining a quirk that correctly interprets the device's data and controls.
To achieve this, the community's input and collaboration is crucial. I'm particularly interested in any suggestions on how to manage the schedule functionality, as that's the area where I need the most assistance. A well-integrated thermostat would let users set up automation based on temperature changes, time of day, or other sensor input.
Diagnostics Information: Providing the Technical Details
[I've included the diagnostic information that was generated when I tried to set up the thermostat. This JSON file will help any developer understand the device's capabilities and how it communicates. This also helps those working on the custom quirk to understand how the device is responding to commands.]
Device Signature: Decoding the Device's Identity
Here's the device signature. This JSON is like the device's fingerprint, detailing its capabilities and what it can do:
{
"node_descriptor": {
"logical_type": 2,
"complex_descriptor_available": 0,
"user_descriptor_available": 0,
"reserved": 0,
"aps_flags": 0,
"frequency_band": 8,
"mac_capability_flags": 128,
"manufacturer_code": 4417,
"maximum_buffer_size": 66,
"maximum_incoming_transfer_size": 66,
"server_mask": 10752,
"maximum_outgoing_transfer_size": 66,
"descriptor_capability_field": 0
},
"endpoints": {
"1": {
"profile_id": "0x0104",
"device_type": "0x0051",
"input_clusters": [
"0x0000",
"0x0004",
"0x0005",
"0x0201",
"0xef00"
],
"output_clusters": [
"0x000a",
"0x0019"
]
}
},
"manufacturer": "_TZE204_zxkwaztm",
"model": "TS0601",
"class": "zigpy.quirks.v2.CustomDeviceV2"
}
This signature is super useful for developers to understand the device. It specifies things like the manufacturer, model, supported clusters (which are like features), and other important details.
Logs: Tracking the Device's Behavior
[Here, I'd provide any relevant logs from Home Assistant. Logs are the best way to understand how a device is communicating with Home Assistant and what issues it might be experiencing. They are super important for troubleshooting.]
[Paste the logs here]
Custom Quirk: My Current Implementation
Here's the custom quirk I've written. This is where I've made changes to get the thermostat working. It handles the specifics of how the device communicates and how it responds to commands.
"""Tuya TS0601 Thermostat."""
import copy
from zigpy.quirks.v2 import BinarySensorDeviceClass, EntityType
from zigpy.quirks.v2.homeassistant import (
UnitOfElectricCurrent,
UnitOfElectricPotential,
UnitOfEnergy,
UnitOfPower,
UnitOfTemperature,
)
from zigpy.quirks.v2.homeassistant.sensor import SensorDeviceClass, SensorStateClass
from zigpy.types import t
from zigpy.zcl import foundation
from zigpy.zcl.clusters.hvac import RunningState, Thermostat
from zhaquirks.tuya import TUYA_SET_TIME, TuyaTimePayload
from zhaquirks.tuya.builder import TuyaQuirkBuilder
from zhaquirks.tuya.mcu import TuyaAttributesCluster, TuyaMCUCluster
class RegulatorPeriod(t.enum8):
"""Tuya regulator period enum."""
_15_min = 0x00
_30_min = 0x01
_45_min = 0x02
_60_min = 0x03
_90_min = 0x04
class ThermostatMode(t.enum8):
"""Tuya thermostat mode."""
Regulator = 0x00
Thermostat = 0x01
class PresetModeV01(t.enum8):
"""Tuya preset mode v01 enum."""
Manual = 0x00
Home = 0x01
Away = 0x02
class PresetModeV02(t.enum8):
"""Tuya preset mode v02 enum."""
Manual = 0x00
Auto = 0x01
Temporary_Manual = 0x02
class PresetModeV03(t.enum8):
"""Tuya preset mode v03 enum."""
Auto = 0x00
Manual = 0x01
Temporary_Manual = 0x02
class PresetModeV04(t.enum8):
"""Tuya preset mode v03 enum."""
Schedule = 0x00
Manual = 0x01
class RunningStateV01(t.enum8):
"""Tuya running state v01 enum."""
Idle = 0x00
Heat = 0x01
Cool = 0x02
class SensorMode(t.enum8):
"""Tuya sensor mode enum."""
Air = 0x00
Floor = 0x01
Both = 0x02
class BacklightMode(t.enum8):
"""Tuya backlight mode enum."""
Off = 0x00
Low = 0x01
Medium = 0x02
High = 0x03
class WorkingDayV01(t.enum8):
"""Tuya Working day v01 enum."""
Disabled = 0x00
Six_One = 0x01
Five_Two = 0x02
Seven = 0x03
class WorkingDayV02(t.enum8):
"""Tuya Working day v02 enum."""
Disabled = 0x00
Lundi_Vendredi = 0x01
Lundi_Samedi = 0x02
Lundi_Dimanche = 0x03
class TuyaThermostat(Thermostat, TuyaAttributesCluster):
"""Tuya local thermostat cluster."""
_CONSTANT_ATTRIBUTES = {
Thermostat.AttributeDefs.ctrl_sequence_of_oper.id: Thermostat.ControlSequenceOfOperation.Heating_Only
}
def __init__(self, *args, **kwargs):
"""Init a TuyaThermostat cluster."""
super().__init__(*args, **kwargs)
self.add_unsupported_attribute(
Thermostat.AttributeDefs.setpoint_change_source.id
)
self.add_unsupported_attribute(
Thermostat.AttributeDefs.setpoint_change_source_timestamp.id
)
self.add_unsupported_attribute(Thermostat.AttributeDefs.pi_heating_demand.id)
# Previously mapped, marking as explicitly unsupported.
self.add_unsupported_attribute(
Thermostat.AttributeDefs.local_temperature_calibration.id
)
class NoManufTimeNoVersionRespTuyaMCUCluster(TuyaMCUCluster):
"""Tuya Manufacturer Cluster with set_time mod."""
# Deepcopy required to override 'set_time', without, it will revert
server_commands = copy.deepcopy(TuyaMCUCluster.server_commands)
server_commands.update(
{
TUYA_SET_TIME: foundation.ZCLCommandDef(
"set_time",
{"time": TuyaTimePayload},
False,
is_manufacturer_specific=False,
),
}
)
def handle_mcu_version_response(
self, payload: TuyaMCUCluster.MCUVersion
) -> foundation.Status:
"""Handle MCU version response."""
return foundation.Status.SUCCESS
(
TuyaQuirkBuilder("_TZE204_p3lqqy2r", "TS0601")
.tuya_dp(
dp_id=1,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.system_mode.name,
converter=lambda x: {
True: Thermostat.SystemMode.Heat,
False: Thermostat.SystemMode.Off,
}[x],
dp_converter=lambda x: {
Thermostat.SystemMode.Heat: True,
Thermostat.SystemMode.Off: False,
}[x],
)
.tuya_enum(
dp_id=2,
attribute_name="preset_mode",
enum_class=PresetModeV01,
translation_key="preset_mode",
fallback_name="Preset mode",
)
.tuya_dp(
dp_id=16,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.occupied_heating_setpoint.name,
converter=lambda x: x * 100,
dp_converter=lambda x: x // 100,
)
.tuya_dp(
dp_id=24,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature.name,
converter=lambda x: x * 100,
)
.tuya_number(
dp_id=28,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature_calibration.name,
type=t.int32s,
min_value=-9,
max_value=9,
unit=UnitOfTemperature.CELSIUS,
step=1,
translation_key="local_temperature_calibration",
fallback_name="Local temperature calibration",
)
.tuya_switch(
dp_id=30,
attribute_name="child_lock",
translation_key="child_lock",
fallback_name="Child lock",
)
.tuya_sensor(
dp_id=101,
attribute_name="local_temperature_floor",
type=t.int16s,
device_class=SensorDeviceClass.TEMPERATURE,
state_class=SensorStateClass.MEASUREMENT,
unit=UnitOfTemperature.CELSIUS,
translation_key="local_temperature_floor",
fallback_name="Floor temperature",
)
.tuya_enum(
dp_id=102,
attribute_name="temperature_sensor_select",
enum_class=SensorMode,
translation_key="sensor_mode",
fallback_name="Sensor mode",
)
.tuya_dp(
dp_id=104,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.running_state.name,
converter=lambda x: RunningState.Heat_State_On if x else RunningState.Idle,
)
.tuya_binary_sensor(
dp_id=106,
attribute_name="window_detection",
translation_key="window_detection",
fallback_name="Open window detection",
)
.tuya_dp(
dp_id=107,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.max_heat_setpoint_limit.name,
converter=lambda x: x * 100,
dp_converter=lambda x: x // 100,
)
.tuya_enum(
dp_id=108,
attribute_name="thermostat_mode",
enum_class=ThermostatMode,
translation_key="thermostat_mode",
fallback_name="Thermostat mode",
)
.tuya_enum(
dp_id=109,
attribute_name="regulator_period",
enum_class=RegulatorPeriod,
translation_key="regulator_period",
fallback_name="Regulator period",
)
.tuya_number(
dp_id=110,
attribute_name="regulator_set_point",
type=t.uint16_t,
unit=UnitOfTemperature.CELSIUS,
min_value=0,
max_value=100,
step=1,
translation_key="regulator_set_point",
fallback_name="Regulator set point",
)
.adds(TuyaThermostat)
.tuya_sensor(
dp_id=120,
attribute_name="current",
type=t.int16s,
divisor=10,
device_class=SensorDeviceClass.CURRENT,
state_class=SensorStateClass.MEASUREMENT,
unit=UnitOfElectricCurrent.AMPERE,
fallback_name="Current",
)
.tuya_sensor(
dp_id=121,
attribute_name="voltage",
type=t.int16s,
device_class=SensorDeviceClass.VOLTAGE,
state_class=SensorStateClass.MEASUREMENT,
unit=UnitOfElectricPotential.VOLT,
fallback_name="Voltage",
)
.tuya_sensor(
dp_id=122,
attribute_name="power",
type=t.int16s,
device_class=SensorDeviceClass.POWER,
state_class=SensorStateClass.MEASUREMENT,
unit=UnitOfPower.WATT,
fallback_name="Power",
)
.tuya_sensor(
dp_id=123,
attribute_name="energy",
type=t.int16s,
divisor=100,
device_class=SensorDeviceClass.ENERGY,
state_class=SensorStateClass.TOTAL,
unit=UnitOfEnergy.KILO_WATT_HOUR,
fallback_name="Energy",
)
.skip_configuration()
.add_to_registry()
)
# Tuya ZWT198/ZWT100-BH Avatto wall thermostat
base_avatto_quirk = (
TuyaQuirkBuilder()
.tuya_dp(
dp_id=1,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.system_mode.name,
converter=lambda x: {
True: Thermostat.SystemMode.Heat,
False: Thermostat.SystemMode.Off,
}[x],
dp_converter=lambda x: {
Thermostat.SystemMode.Heat: True,
Thermostat.SystemMode.Off: False,
}[x],
)
.tuya_dp(
dp_id=2,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.occupied_heating_setpoint.name,
converter=lambda x: x * 10,
dp_converter=lambda x: x // 10,
)
.tuya_dp(
dp_id=3,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature.name,
converter=lambda x: x * 10,
)
.tuya_switch(
dp_id=9,
attribute_name="child_lock",
translation_key="child_lock",
fallback_name="Child lock",
)
.tuya_binary_sensor(
dp_id=11,
attribute_name="fault_alarm",
entity_type=EntityType.STANDARD,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="fault_alarm",
fallback_name="Fault alarm",
)
.tuya_dp(
dp_id=15,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.max_heat_setpoint_limit.name,
converter=lambda x: x * 10,
dp_converter=lambda x: x // 10,
)
.tuya_number(
dp_id=19,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature_calibration.name,
type=t.int32s,
min_value=-9.9,
max_value=9.9,
unit=UnitOfTemperature.CELSIUS,
step=0.1,
multiplier=0.1,
translation_key="local_temperature_calibration",
fallback_name="Local temperature calibration",
)
.tuya_dp(
dp_id=101,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.running_state.name,
converter=lambda x: RunningState.Heat_State_On if x else RunningState.Idle,
)
.tuya_switch(
dp_id=102,
attribute_name="frost_protection",
translation_key="frost_protection",
fallback_name="Frost protection",
)
.tuya_switch(
dp_id=103,
attribute_name="factory_reset",
translation_key="factory_reset",
fallback_name="Factory reset",
)
.tuya_enum(
dp_id=106,
attribute_name="temperature_sensor_select",
enum_class=SensorMode,
translation_key="sensor_mode",
fallback_name="Sensor mode",
)
.tuya_number(
dp_id=107,
attribute_name="deadzone_temperature",
type=t.uint16_t,
unit=UnitOfTemperature.CELSIUS,
min_value=0.1,
max_value=10,
step=0.1,
translation_key="deadzone_temperature",
fallback_name="Deadzone temperature",
)
# 109 ZWT198 schedule, skipped
.tuya_enum(
dp_id=110,
attribute_name="backlight_mode",
enum_class=BacklightMode,
translation_key="backlight_mode",
fallback_name="Backlight mode",
)
.adds(TuyaThermostat)
.skip_configuration()
)
(
base_avatto_quirk.clone()
.applies_to("_TZE204_lzriup1j", "TS0601")
.tuya_enum(
dp_id=4,
attribute_name="preset_mode",
enum_class=PresetModeV02,
translation_key="preset_mode",
fallback_name="Preset mode",
)
.tuya_enum(
dp_id=104,
attribute_name="working_day",
enum_class=WorkingDayV02,
translation_key="working_day",
fallback_name="Working day",
)
.add_to_registry(replacement_cluster=NoManufTimeNoVersionRespTuyaMCUCluster)
)
(
base_avatto_quirk.clone()
.applies_to("_TZE200_viy9ihs7", "TS0601")
.tuya_enum(
dp_id=4,
attribute_name="preset_mode",
enum_class=PresetModeV03,
translation_key="preset_mode",
fallback_name="Preset mode",
)
.tuya_enum(
dp_id=104,
attribute_name="working_day",
enum_class=WorkingDayV01,
translation_key="working_day",
fallback_name="Working day",
)
.add_to_registry(replacement_cluster=NoManufTimeNoVersionRespTuyaMCUCluster)
)
(
base_avatto_quirk.clone()
.applies_to("_TZE204_xnbkhhdr", "TS0601")
.applies_to("_TZE284_xnbkhhdr", "TS0601")
.tuya_enum(
dp_id=4,
attribute_name="preset_mode",
enum_class=PresetModeV03,
translation_key="preset_mode",
fallback_name="Preset mode",
)
.tuya_enum(
dp_id=104,
attribute_name="working_day",
enum_class=WorkingDayV02,
translation_key="working_day",
fallback_name="Working day",
)
.add_to_registry(replacement_cluster=NoManufTimeNoVersionRespTuyaMCUCluster)
)
(
TuyaQuirkBuilder("_TZE200_aoclfnxz", "TS0601")
.applies_to("_TZE200_ztvwu4nk", "TS0601")
.applies_to("_TZE204_5toc8efa", "TS0601")
.applies_to("_TZE200_5toc8efa", "TS0601")
.applies_to("_TZE200_ye5jkfsb", "TS0601")
.applies_to("_TZE204_aoclfnxz", "TS0601")
.applies_to("_TZE200_u9bfwha0", "TS0601")
.applies_to("_TZE204_u9bfwha0", "TS0601")
.tuya_dp(
dp_id=1,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.system_mode.name,
converter=lambda x: {
0x01: Thermostat.SystemMode.Heat,
0x00: Thermostat.SystemMode.Off,
}[x],
dp_converter=lambda x: {
Thermostat.SystemMode.Heat: 0x01,
Thermostat.SystemMode.Off: 0x00,
}[x],
)
.tuya_switch(
dp_id=2,
attribute_name="manual_mode",
translation_key="manual_mode",
on_value=0,
off_value=1,
fallback_name="Manual mode",
)
.tuya_switch(
dp_id=3,
attribute_name="schedule_mode",
on_value=0,
off_value=1,
translation_key="schedule_mode",
fallback_name="Schedule mode",
)
.tuya_dp(
dp_id=16,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.occupied_heating_setpoint.name,
converter=lambda x: x * 100,
dp_converter=lambda x: x // 100,
)
.tuya_dp(
dp_id=24,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature.name,
converter=lambda x: x * 10,
)
.tuya_dp(
dp_id=36,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.running_state.name,
converter=lambda x: RunningState.Heat_State_On if not x else RunningState.Idle,
)
.tuya_switch(
dp_id=40,
attribute_name="child_lock",
translation_key="child_lock",
fallback_name="Child lock",
)
.adds(TuyaThermostat)
.skip_configuration()
.add_to_registry()
)
(
TuyaQuirkBuilder("_TZE204_zxkwaztm", "TS0601")
.tuya_dp(
dp_id=1,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.system_mode.name,
converter=lambda x: {
0x01: Thermostat.SystemMode.Heat,
0x00: Thermostat.SystemMode.Off,
}[x],
dp_converter=lambda x: {
Thermostat.SystemMode.Heat: 0x01,
Thermostat.SystemMode.Off: 0x00,
}[x],
)
.tuya_enum(
dp_id=2,
attribute_name="preset_mode",
enum_class=PresetModeV04,
translation_key="preset_mode",
fallback_name="Preset mode",
)
.tuya_switch(
dp_id=10,
attribute_name="frost_protection",
translation_key="frost_protection",
fallback_name="Frost protection",
)
.tuya_dp(
dp_id=16,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.occupied_heating_setpoint.name,
converter=lambda x: x * 10,
dp_converter=lambda x: x // 10,
)
.tuya_dp(
dp_id=24,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature.name,
converter=lambda x: x * 10,
)
.tuya_dp(
dp_id=36,
ep_attribute=TuyaThermostat.ep_attribute,
attribute_name=TuyaThermostat.AttributeDefs.running_state.name,
#converter=lambda x: RunningState.Heat_State_On if not x else RunningState.Idle,
converter=lambda x: RunningState.Idle if not x else RunningState.Heat_State_On,
)
.tuya_switch(
dp_id=40,
attribute_name="child_lock",
translation_key="child_lock",
fallback_name="Child lock",
)
.tuya_number(
dp_id=109,
attribute_name=TuyaThermostat.AttributeDefs.local_temperature_calibration.name,
type=t.int32s,
min_value=-9.9,
max_value=9.9,
unit=UnitOfTemperature.CELSIUS,
step=0.1,
multiplier=0.1,
translation_key="local_temperature_calibration",
fallback_name="Local temperature calibration",
)
.tuya_number(
dp_id=112,
attribute_name="regulator_set_point",
type=t.uint16_t,
unit=UnitOfTemperature.CELSIUS,
min_value=0,
max_value=100,
step=1,
translation_key="regulator_set_point",
fallback_name="Regulator set point",
)
.tuya_enum(
dp_id=31,
attribute_name="working_day",
enum_class=WorkingDayV02,
translation_key="working_day",
fallback_name="Working day",
)
.adds(TuyaThermostat)
.skip_configuration()
.add_to_registry()
)
This is what I've used so far. I've made some adjustments to get basic functionality working, but the schedule is still not cooperating.
Additional Information: What I Still Need
I'm particularly interested in guidance on the following:
- Schedule Configuration: How can I correctly implement and configure the scheduling features of this thermostat within ZHA? Are there specific data points or clusters I need to focus on?
- Testing: What's the best way to test the custom quirk and ensure it's working correctly? Are there any specific Home Assistant tools or techniques that can help?
- Best Practices: Any general tips on developing ZHA quirks would be appreciated!
Thanks in advance for your help, guys! Any suggestions are welcome!