CustomCluster for Lixee ZLinkee Manuf. Spec failed to read attributes

[kikili]

Hi all, I'm very new and try to define a custom cluster for reading the manufacturer specific attributes of the Zlinkee from Lixee (documented here : https://github.com/fairecasoimeme/Zlinky_TIC)
I'm using zha_toolkit in home assistant to test and query those attributes.
If I don't change the lixee.zlinky zhaquirk then I can read those attributes values with no issues, but as soon as I modify the quirk to replace the cluster (id: 0xFF66) I got a Status.UNSUPPORTED_ATTRIBUTE
Can someone tell me what I'm doing wrong ? I don't understand !

Many thanks

Here is the trace of the error

2022-02-02 16:15:39 INFO (MainThread) [custom_components.zha_toolkit] Running ZHA Toolkit service: <ServiceCall zha_toolkit.execute (c:ec1413a142d201389c927a992388b364): command=attr_read, ieee=00:15:8d:00:05:d2:9a:9d, cluster=65382, attribute=0>
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit.utils] Parameters '{'command': 'attr_read', 'ieee': '00:15:8d:00:05:d2:9a:9d', 'cluster': 65382, 'attribute': 0}'
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit.utils] OUT csvout
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit] 'ieee' parameter: '00:15:8d:00:05:d2:9a:9d' -> IEEE Addr: '00:15:8d:00:05:d2:9a:9d'
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit] module is <module 'custom_components.zha_toolkit' from '/config/custom_components/zha_toolkit/__init__.py'>
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit.utils] Endpoint 1 found for cluster '65382'
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit.zcl_attr] Request attr read [0]
2022-02-02 16:15:39 DEBUG (MainThread) [zigpy.zcl] [0xda65:1:0xff66] ZCL deserialize: <ZCLHeader frame_control=<FrameControl frame_type=GLOBAL_COMMAND manufacturer_specific=True is_reply=True disable_default_response=True> manufacturer=4151 tsn=171 command_id=Command.Read_Attributes_rsp>
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit.zcl_attr] Reading attr result (attrs, status): ({}, {0: <Status.UNSUPPORTED_ATTRIBUTE: 134>})
2022-02-02 16:15:39 DEBUG (MainThread) [custom_components.zha_toolkit] event_data {'ieee_org': '00:15:8d:00:05:d2:9a:9d', 'ieee': '00:15:8d:00:05:d2:9a:9d', 'command': 'attr_read', 'start_time': '2022-02-02T15:15:39.358061+00:00', 'errors': ['KeyError(0)'], 'params': {'cmd_id': None, 'endpoint_id': 1, 'cluster_id': 65382, 'attr_id': 0, 'attr_type': None, 'attr_val': None, 'code': None, 'min_interval': None, 'max_interval': None, 'reportable_change': None, 'dir': 0, 'manf': None, 'tries': 1, 'expect_reply': True, 'args': [], 'state_id': None, 'state_attr': None, 'allow_create': False, 'event_success': None, 'event_fail': None, 'event_done': None, 'read_before_write': True, 'read_after_write': True, 'write_if_equal': False, 'csvfile': None, 'csvlabel': None}, 'write_is_equal': False, 'result_read': ({}, {0: <Status.UNSUPPORTED_ATTRIBUTE: 134>}), 'success': False}

Here is the code of the modified quirk

"""Quirk for ZLinky_TIC."""
from zigpy.profiles import zha
from zigpy.quirks import CustomCluster, CustomDevice
from zigpy.zcl.clusters.general import Basic, GreenPowerProxy, Identify, Ota
from zigpy.zcl.clusters.homeautomation import ElectricalMeasurement, MeterIdentification
from zigpy.zcl.clusters.smartenergy import Metering
import zigpy.types as t
import zigpy.zcl

from zhaquirks.const import (
    DEVICE_TYPE,
    ENDPOINTS,
    INPUT_CLUSTERS,
    MODELS_INFO,
    OUTPUT_CLUSTERS,
    PROFILE_ID,
)
from zhaquirks.lixee import LIXEE

HIST_MONO="Historique Mono"
STD_MONO="Standard Mono"
HIST_TRI="Historique Tri"
STD_TRI="Standard Tri"
STD_MONO_PROD="Standard Mono Prod"
STD_TRI_PROD="Historique Mono Prod"

class ZLinkyTICMetering(CustomCluster, Metering):
    """ZLinky_TIC custom metring cluster."""

    # ZLinky_TIC reports current_summ_delivered in Wh
    # Home Assistant expects kWh (1kWh = 1000 Wh)
    MULTIPLIER = 0x0301
    DIVISOR = 0x0302
    _CONSTANT_ATTRIBUTES = {MULTIPLIER: 1, DIVISOR: 1000}

LINKY_MODE=0x0300
LINKY_OPTARIF=0x0000
LINKY_DEMAIN=0x0001
LINKY_HHPHC=0x0002

class ZLinkyModes(t.enum3):
    """ZLinky MODES enum"""

    HIST_MONO = 0x00
    STD_MONO = 0x01
    HIST_TRI = 0x02
    STD_TRI = 0x03
    STD_MONO_PROD = 0x05
    STD_TRI_PROD = 0x07

class ZlinkySpecificInfos(CustomCluster):
    cluster_id = 0xFF66
    attributes = {
        LINKY_MODE: ("MODE", ZLinkyModes),
        LINKY_OPTARIF: ("OPTARIF", t.LimitedCharString(4)),
        #LINKY_DEMAIN: ("DEMAIN",t.CharacterString),
        #LINKY_HHPHC: ("HHPHC",t.uint8_t)
    }

class ZLinkyTIC(CustomDevice):
    """ZLinky_TIC from LiXee."""

    signature = {
        MODELS_INFO: [(LIXEE, "ZLinky_TIC")],
        ENDPOINTS: {
            1: {
                PROFILE_ID: zha.PROFILE_ID,
                DEVICE_TYPE: zha.DeviceType.METER_INTERFACE,
                INPUT_CLUSTERS: [
                    Basic.cluster_id,
                    Identify.cluster_id,
                    Metering.cluster_id,
                    MeterIdentification.cluster_id,
                    ElectricalMeasurement.cluster_id,
                    ZlinkySpecificInfos.cluster_id,  # Manufacturer Specific
                ],
                OUTPUT_CLUSTERS: [Ota.cluster_id],
            },
            242: {
                PROFILE_ID: 41440,
                DEVICE_TYPE: 0x0061,
                INPUT_CLUSTERS: [GreenPowerProxy.cluster_id],
                OUTPUT_CLUSTERS: [GreenPowerProxy.cluster_id],
            },
        },
    }
    replacement = {
        ENDPOINTS: {
            1: {
                PROFILE_ID: zha.PROFILE_ID,
                DEVICE_TYPE: zha.DeviceType.METER_INTERFACE,
                INPUT_CLUSTERS: [
                    Basic.cluster_id,
                    Identify.cluster_id,
                    ZLinkyTICMetering,
                    MeterIdentification.cluster_id,
                    ElectricalMeasurement.cluster_id,
                    ZlinkySpecificInfos,  # Manufacturer Specific
                ],
                OUTPUT_CLUSTERS: [Ota.cluster_id],
            },
            242: {
                PROFILE_ID: 41440,
                DEVICE_TYPE: 0x0061,
                INPUT_CLUSTERS: [GreenPowerProxy.cluster_id],
                OUTPUT_CLUSTERS: [GreenPowerProxy.cluster_id],
            },
        },
    }

Here is the stack trace when the cluster 0xFF66 is not replaced in the quirk

2022-02-02 16:08:47 DEBUG (MainThread) [custom_components.zha_toolkit] 'ieee' parameter: '00:15:8d:00:05:d2:9a:9d' -> IEEE Addr: '00:15:8d:00:05:d2:9a:9d'
2022-02-02 16:08:47 DEBUG (MainThread) [custom_components.zha_toolkit] module is <module 'custom_components.zha_toolkit' from '/config/custom_components/zha_toolkit/__init__.py'>
2022-02-02 16:08:47 DEBUG (MainThread) [custom_components.zha_toolkit.utils] Endpoint 1 found for cluster '65382'
2022-02-02 16:08:47 DEBUG (MainThread) [custom_components.zha_toolkit.zcl_attr] Request attr read [0]
2022-02-02 16:08:50 DEBUG (MainThread) [zigpy.zcl] [0xda65:1:0xff66] ZCL deserialize: <ZCLHeader frame_control=<FrameControl frame_type=GLOBAL_COMMAND manufacturer_specific=False is_reply=True disable_default_response=True> manufacturer=None tsn=170 command_id=Command.Read_Attributes_rsp>
2022-02-02 16:08:50 DEBUG (MainThread) [custom_components.zha_toolkit.zcl_attr] Reading attr result (attrs, status): ({0: 'BBR('}, {})
2022-02-02 16:08:50 DEBUG (MainThread) [custom_components.zha_toolkit] event_data {'ieee_org': '00:15:8d:00:05:d2:9a:9d', 'ieee': '00:15:8d:00:05:d2:9a:9d', 'command': 'attr_read', 'start_time': '2022-02-02T15:08:47.477851+00:00', 'errors': [], 'params': {'cmd_id': None, 'endpoint_id': 1, 'cluster_id': 65382, 'attr_id': 0, 'attr_type': None, 'attr_val': None, 'code': None, 'min_interval': None, 'max_interval': None, 'reportable_change': None, 'dir': 0, 'manf': None, 'tries': 1, 'expect_reply': True, 'args': [], 'state_id': None, 'state_attr': None, 'allow_create': False, 'event_success': None, 'event_fail': None, 'event_done': None, 'read_before_write': True, 'read_after_write': True, 'write_if_equal': False, 'csvfile': None, 'csvlabel': None}, 'write_is_equal': False, 'result_read': ({0: 'BBR('}, {}), 'success': True}

[kikili]

Anyone to help me on this, so I can contribute after with a full functional quirk for this.
Soon everyone in France will have a Linky as it is installed by Enedis (the only electricity infrastructure provider) everywhere

[kfran78]

Hi. Maybee this can help you ?
fairecasoimeme/Zlinky_TIC#18 (comment)

[kikili]

Hi kfran78 thanks for the reply and yes it has helped me along some other discussions to setup what I describe above.
But it is just tricks using HACS (and zha.toolkit from it). So I wanted to contribute and update the quirks so all attributes needed for the Zlinky will be available at least using the regular "manage cluster" command. But when I try to setup at least one or two attributes in the quirk, it happens what I described above. And it's there that I don't understand why I get the error Status.UNSUPPORTED_ATTRIBUTE: 134 if I detail an attribute in the quirk and no errors at all if I don't.

[mdeweerd]

As you installed zha-toolkit, I suggest you do a scan_device. You'll get a list of all the properties with their values and attribute types.

[kikili]

I've tried and so far get only the cluster definitions, not all the properties ...

[mdeweerd]

Ok, I guess the device isn't implementing the functions that provide the list of attributes.

[mdeweerd]

When the request fails, the response indicates it's manufacturer specific, and it succeeds when it is not manufacturer specific.

So the cluster attributes should not be accessed as manufacturer specific attributes.

It seems that zigpy is adding the manufacturer specific request type because it was not in your parameters to zha-toolkit.

There is some logic in zigpy adding the manufacturer attribute in some cases - when the attribute is known in the attributes table and listed as a manufacturer attribute, but I do not see why here.

You can add a third value to the parameter definition but that should not change anything as the default is False.

    attributes = {
        LINKY_MODE: ("MODE", ZLinkyModes, False),
        LINKY_OPTARIF: ("OPTARIF", t.LimitedCharString(4), False),
        #LINKY_DEMAIN: ("DEMAIN",t.CharacterString, False),
        #LINKY_HHPHC: ("HHPHC",t.uint8_t, False)
    }

Needs more info/debug. You can also use a more recent version of the zha_toolkit - I don't think it impacts the manufacturer attribute, but there will be a bit more information.

[kikili]

Ok I finally got it. It is actually quite simple (but I had a lot of things to learn as I'm completely new to zha and home assistant). You just have to override the read attribute function ensuring it didn't send a manufacturer code and the property _is_manuf_specific .
here is the code

class ZlinkyCluster (CustomCluster):
    cluster_id = 0xFF66
    _is_manuf_specific=False
    attributes = {
        0x300: ("linky_mode", t.uint8_t),
        0x0000: ("op_tarif", t.LimitedCharString(4)),
    }
    def _read_attributes(
        self, args: List[t.uint16_t], manufacturer: Optional[int] = None
    ):
        return super()._read_attributes(args, manufacturer=None)

[mdeweerd]

I found that CustomClusters designates clusters withing a given range as manufacturer clusters and adds the manufacturer ID to the request automatically when it's set to "None".

So your configuration avoids that.

I have updated zha-toolkit and hope my hack ensures that the manufacturer code is not sent when it's not requested through the zha-toolkit service parameters....

I also opened an issue to ensure that there will be a permanent solution for that. zigpy/zigpy#924 .

[kikili]

I just have now to found how to have those attributes appearing in Home Assistant as proper entities (any hint will be welcome).