MOES TS004F _TZ3000_ja5osu5g

[Soylor]

This is a Single Button with dimming capabilities but identified with only ON/OFF in ZHA.
It's integrated with zigbee2mqtt (https://www.zigbee2mqtt.io/devices/ERS-10TZBVB-AA.html)

MOES Model number: ERS-10TZBVB-AA

Coul'd it be integrated in ZHA with dimming capabilities and double-click detection?

[MattWestb]

I have making one quirk and we have getting nearly all working OK
Command / Action mode with the searing lings and using the commands in device automation (DA) or action using clicks for automatons.
The final quirk is not released then the last was not fixed but its looks some user have fixing the lats DA but its not tested for making one PR for it.

Read more #1697 and pleas help testing the quirk so we can getting it in next HA.

[CRCinAU]

Has anything happened with this as yet?

I just got one that's very similar (if not the same), and I just get a single switch in HA when using ZHA...

Device signature:

{
  "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=4742, maximum_buffer_size=66, maximum_incoming_transfer_size=66, server_mask=10752, maximum_outgoing_transfer_size=66, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
  "endpoints": {
    "1": {
      "profile_id": "0x0104",
      "device_type": "0x0000",
      "input_clusters": [
        "0x0000",
        "0x0001",
        "0x0003",
        "0x0004",
        "0x0006",
        "0x1000",
        "0xe001"
      ],
      "output_clusters": [
        "0x0003",
        "0x0004",
        "0x0006",
        "0x0008",
        "0x000a",
        "0x0019",
        "0x1000"
      ]
    }
  },
  "manufacturer": "_TZ3000_ja5osu5g",
  "model": "TS004F",
  "class": "zigpy.device.Device"
}

[CRCinAU]

Looking at the comments, it looks like this might be a different device...

It's a single button device that I think only supports single press, double press, and long press - but then also can change to scene mode.

Would this be the same as the "Tuya Smart (Single) Knob device."? or would 'knob' here indicate that it has some kind of rotary encoder?

[MattWestb]

Its 95% one single and its being added in ZHA but with other device type as you can see here:

zha-device-handlers/zhaquirks/tuya/ts004f.py

Lines 322 to 335 in bfbfb48

	class TuyaSmartRemote004FSK(EnchantedDevice):
	"""Tuya Smart (Single) Knob device."""
	signature = {
	# "node_descriptor": "NodeDescriptor(byte1=2, byte2=64, mac_capability_flags=128, manufacturer_code=4098, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=0, *allocate_address=True, *complex_descriptor_available=False, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False, *is_valid=True, *logical_type=<LogicalType.EndDevice: 2>, *user_descriptor_available=False)",
	# SizePrefixedSimpleDescriptor(endpoint=1, profile=260, device_type=260, device_version=1, input_clusters=[0, 1, 3, 4, 6, 4096, 57345], output_clusters=[25, 10, 3, 4, 6, 8, 4096])
	MODELS_INFO: [
	("_TZ3000_kjfzuycl", "TS004F"),
	("_TZ3000_ja5osu5g", "TS004F"),
	],
	ENDPOINTS: {
	1: {
	PROFILE_ID: zha.PROFILE_ID,
	DEVICE_TYPE: zha.DeviceType.DIMMER_SWITCH,

And the device type is different as you can see device_type=260 but the endping/cluster looks the same.

[CRCinAU]

Ok, reading between the lines, I created a ts004f.py in /config/zha_quirks and added it to configuration.yaml...

I used the following:

"""Tuya TS004F devices."""
from __future__ import annotations

from zigpy.profiles import zha
from zigpy.zcl.clusters.general import (
    Basic,
    Groups,
    Identify,
    LevelControl,
    OnOff,
    Ota,
    PowerConfiguration,
    Scenes,
    Time,
)
from zigpy.zcl.clusters.lighting import Color
from zigpy.zcl.clusters.lightlink import LightLink

from zhaquirks.const import (
    ALT_SHORT_PRESS,
    BUTTON,
    BUTTON_1,
    BUTTON_2,
    BUTTON_3,
    BUTTON_4,
    CLUSTER_ID,
    COMMAND,
    COMMAND_MOVE,
    COMMAND_MOVE_SATURATION,
    COMMAND_OFF,
    COMMAND_ON,
    COMMAND_STEP,
    COMMAND_STOP,
    COMMAND_STOP_MOVE_STEP,
    COMMAND_TOGGLE,
    DEVICE_TYPE,
    DIM_DOWN,
    DIM_UP,
    DOUBLE_PRESS,
    ENDPOINT_ID,
    ENDPOINTS,
    INPUT_CLUSTERS,
    LEFT,
    LONG_PRESS,
    LONG_RELEASE,
    MODEL,
    MODELS_INFO,
    OUTPUT_CLUSTERS,
    PARAMS,
    PROFILE_ID,
    RIGHT,
    ROTATED,
    ROTATED_FAST,
    ROTATED_SLOW,
    SHORT_PRESS,
    TURN_OFF,
    TURN_ON,
)
from zhaquirks.tuya import (
    EnchantedDevice,
    TuyaNoBindPowerConfigurationCluster,
    TuyaSmartRemoteOnOffCluster,
    TuyaZBExternalSwitchTypeCluster,
)

class TuyaSmartRemote004FSK(EnchantedDevice):
    """Tuya Smart (Single) Knob device."""

    signature = {
        # "node_descriptor": "NodeDescriptor(byte1=2, byte2=64, mac_capability_flags=128, manufacturer_code=4098, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=0, *allocate_address=True, *complex_descriptor_available=False, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False, *is_valid=True, *logical_type=<LogicalType.EndDevice: 2>, *user_descriptor_available=False)",
        # SizePrefixedSimpleDescriptor(endpoint=1, profile=260, device_type=260, device_version=1, input_clusters=[0, 1, 3, 4, 6, 4096, 57345], output_clusters=[25, 10, 3, 4, 6, 8, 4096])
        MODELS_INFO: [
            ("_TZ3000_kjfzuycl", "TS004F"),
            ("_TZ3000_ja5osu5g", "TS004F"),
        ],
        ENDPOINTS: {
            1: {
                PROFILE_ID: zha.PROFILE_ID,
                DEVICE_TYPE: 0x0000,
                INPUT_CLUSTERS: [
                    Basic.cluster_id,
                    PowerConfiguration.cluster_id,
                    Identify.cluster_id,
                    Groups.cluster_id,
                    OnOff.cluster_id,
                    LightLink.cluster_id,
                    TuyaZBExternalSwitchTypeCluster.cluster_id,
                ],
                OUTPUT_CLUSTERS: [
                    Ota.cluster_id,
                    Time.cluster_id,
                    Identify.cluster_id,
                    Groups.cluster_id,
                    OnOff.cluster_id,
                    LevelControl.cluster_id,
                    LightLink.cluster_id,
                ],
            },
        },
    }

    replacement = {
        ENDPOINTS: {
            1: {
                PROFILE_ID: zha.PROFILE_ID,
                DEVICE_TYPE: zha.DeviceType.NON_COLOR_CONTROLLER,
                INPUT_CLUSTERS: [
                    Basic.cluster_id,
                    TuyaNoBindPowerConfigurationCluster,
                    Identify.cluster_id,
                    Groups.cluster_id,  # Is needed for adding group then binding is not working.
                    LightLink.cluster_id,
                    TuyaZBExternalSwitchTypeCluster,
                ],
                OUTPUT_CLUSTERS: [
                    Ota.cluster_id,
                    Time.cluster_id,
                    Identify.cluster_id,
                    Groups.cluster_id,
                    TuyaSmartRemoteOnOffCluster,
                    LevelControl.cluster_id,
                    Color.cluster_id,
                    LightLink.cluster_id,
                ],
            },
        },
    }

    device_automation_triggers = {
        (SHORT_PRESS, BUTTON): {COMMAND: COMMAND_ON, ENDPOINT_ID: 1, CLUSTER_ID: 6},
        (DOUBLE_PRESS, BUTTON): {COMMAND: COMMAND_OFF, ENDPOINT_ID: 1, CLUSTER_ID: 6},
        (LONG_PRESS, BUTTON): {COMMAND: COMMAND_STEP, ENDPOINT_ID: 1, CLUSTER_ID: 8},
        (LONG_RELEASE, BUTTON): {COMMAND: COMMAND_STOP, ENDPOINT_ID: 1, CLUSTER_ID: 8},
        (ALT_SHORT_PRESS, BUTTON): {
            ENDPOINT_ID: 1,
            CLUSTER_ID: 8,
            PARAMS: {
                "transition_time": 1,
                "options_mask": None,
                "options_override": None,
            },
        },
        (SHORT_PRESS, BUTTON_1): {ENDPOINT_ID: 1, COMMAND: SHORT_PRESS},
        (LONG_PRESS, BUTTON_1): {ENDPOINT_ID: 1, COMMAND: LONG_PRESS},
        (DOUBLE_PRESS, BUTTON_1): {ENDPOINT_ID: 1, COMMAND: DOUBLE_PRESS},
    }

Now it comes up as Quirk: ts004f.TuyaSmartRemote004FSK - and I get press events perfectly.

Nice!

Any chance of that being added for the next release?

[MattWestb]

Great work done !!

You can making one PR for adding it to main ZHA but do it like one new device class like class TuyaSmartRemote004FSKV2(EnchantedDevice): and then the maintainers can commit on it and if all is going well its being in the next HA.

[CRCinAU]

Great work done !!

You can making one PR for adding it to main ZHA but do it like one new device class like class TuyaSmartRemote004FSKV2(EnchantedDevice): and then the maintainers can commit on it and if all is going well its being in the next HA.

Done.

Added here: #3153

[mehuman]

I'm running HA 2024.8.1 but I'm getting errant messages on some single presses. Double presses work fine. When doing a single press I will sometimes get 2 messages in the logbook:

Steam Button Move To Color Temp event was fired with parameters: {'color_temp_mireds': 188, 'transition_time': 1, 'options_mask': None, 'options_override': None}
10:59:17 AM - Now
Steam Button Move To Level event was fired with parameters: {'level': 255, 'transition_time': 1, 'options_mask': None, 'options_override': None}
10:59:16 AM - Now

If I do a double press first and then a single it always seems to report correctly.

Steam Button Remote Button Short Press - Button event was fired
11:00:12 AM - Now
Steam Button Remote Button Double Press - Button event was fired
11:00:10 AM - Now