[Device Support Request] PC311-Z-TY Single-Phase Power Clamp Zigbee model 'TS0601' and manufacturer name '_TZE200_rks0sgb7

[lepalom]

Problem description

I would like to kindly ask to support this device:

[PC311-Z-TY Single-Phase Power Clamp Zigbee] (https://es.aliexpress.com/item/1005005931365212.html)

This device is the same commented here, in the zigbee2mqtt project.

Solution description

Fully integrated in HA.

Screenshots/Video

No response

Device signature

Device signature

{
  "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.Router: 1>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.FullFunctionDevice|MainsPowered|RxOnWhenIdle|AllocateAddress: 142>, manufacturer_code=4098, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=False, *is_full_function_device=True, *is_mains_powered=True, *is_receiver_on_when_idle=True, *is_router=True, *is_security_capable=False)",
  "endpoints": {
    "1": {
      "profile_id": "0x0104",
      "device_type": "0x0051",
      "input_clusters": [
        "0x0000",
        "0x0004",
        "0x0005",
        "0xef00",
        "0xff66"
      ],
      "output_clusters": [
        "0x000a",
        "0x0019"
      ]
    }
  },
  "manufacturer": "_TZE200_rks0sgb7",
  "model": "TS0601",
  "class": "zigpy.device.Device"
}

Diagnostic information

Diagnostic information

{
  "home_assistant": {
    "installation_type": "Home Assistant Supervised",
    "version": "2023.10.3",
    "dev": false,
    "hassio": true,
    "virtualenv": false,
    "python_version": "3.11.5",
    "docker": true,
    "arch": "armv7l",
    "timezone": "Europe/Andorra",
    "os_name": "Linux",
    "os_version": "5.10.0-25-armmp",
    "supervisor": "2023.10.0",
    "host_os": "Debian GNU/Linux 11 (bullseye)",
    "docker_version": "24.0.6",
    "chassis": "",
    "run_as_root": true
  },
  "custom_components": {
    "sunspec": {
      "version": "0.0.25",
      "requirements": [
        "pysunspec2==1.0.8"
      ]
    },
    "edata": {
      "version": "2023.06.3",
      "requirements": [
        "e-data==1.1.5",
        "python-dateutil>=2.8.2"
      ]
    },
    "hacs": {
      "version": "1.32.1",
      "requirements": [
        "aiogithubapi>=22.10.1"
      ]
    },
    "template_sensor": {
      "version": "v1.0.0",
      "requirements": []
    },
    "local_sofar_inverter": {
      "version": "0.0.1",
      "requirements": []
    },
    "solarman": {
      "version": "1.0.0",
      "requirements": [
        "pyyaml"
      ]
    }
  },
  "integration_manifest": {
    "domain": "zha",
    "name": "Zigbee Home Automation",
    "after_dependencies": [
      "onboarding",
      "usb"
    ],
    "codeowners": [
      "@dmulcahey",
      "@adminiuga",
      "@puddly"
    ],
    "config_flow": true,
    "dependencies": [
      "file_upload"
    ],
    "documentation": "https://www.home-assistant.io/integrations/zha",
    "iot_class": "local_polling",
    "loggers": [
      "aiosqlite",
      "bellows",
      "crccheck",
      "pure_pcapy3",
      "zhaquirks",
      "zigpy",
      "zigpy_deconz",
      "zigpy_xbee",
      "zigpy_zigate",
      "zigpy_znp",
      "universal_silabs_flasher"
    ],
    "requirements": [
      "bellows==0.36.5",
      "pyserial==3.5",
      "pyserial-asyncio==0.6",
      "zha-quirks==0.0.104",
      "zigpy-deconz==0.21.1",
      "zigpy==0.57.2",
      "zigpy-xbee==0.18.3",
      "zigpy-zigate==0.11.0",
      "zigpy-znp==0.11.5",
      "universal-silabs-flasher==0.0.14",
      "pyserial-asyncio-fast==0.11"
    ],
    "usb": [
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*2652*",
        "known_devices": [
          "slae.sh cc2652rb stick"
        ]
      },
      {
        "vid": "1A86",
        "pid": "55D4",
        "description": "*sonoff*plus*",
        "known_devices": [
          "sonoff zigbee dongle plus v2"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*sonoff*plus*",
        "known_devices": [
          "sonoff zigbee dongle plus"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*tubeszb*",
        "known_devices": [
          "TubesZB Coordinator"
        ]
      },
      {
        "vid": "1A86",
        "pid": "7523",
        "description": "*tubeszb*",
        "known_devices": [
          "TubesZB Coordinator"
        ]
      },
      {
        "vid": "1A86",
        "pid": "7523",
        "description": "*zigstar*",
        "known_devices": [
          "ZigStar Coordinators"
        ]
      },
      {
        "vid": "1CF1",
        "pid": "0030",
        "description": "*conbee*",
        "known_devices": [
          "Conbee II"
        ]
      },
      {
        "vid": "10C4",
        "pid": "8A2A",
        "description": "*zigbee*",
        "known_devices": [
          "Nortek HUSBZB-1"
        ]
      },
      {
        "vid": "0403",
        "pid": "6015",
        "description": "*zigate*",
        "known_devices": [
          "ZiGate+"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*zigate*",
        "known_devices": [
          "ZiGate"
        ]
      },
      {
        "vid": "10C4",
        "pid": "8B34",
        "description": "*bv 2010/10*",
        "known_devices": [
          "Bitron Video AV2010/10"
        ]
      }
    ],
    "zeroconf": [
      {
        "type": "_esphomelib._tcp.local.",
        "name": "tube*"
      },
      {
        "type": "_zigate-zigbee-gateway._tcp.local.",
        "name": "*zigate*"
      },
      {
        "type": "_zigstar_gw._tcp.local.",
        "name": "*zigstar*"
      },
      {
        "type": "_uzg-01._tcp.local.",
        "name": "uzg-01*"
      },
      {
        "type": "_slzb-06._tcp.local.",
        "name": "slzb-06*"
      }
    ],
    "is_built_in": true
  },
  "data": {
    "ieee": "**REDACTED**",
    "nwk": 15828,
    "manufacturer": "_TZE200_rks0sgb7",
    "model": "TS0601",
    "name": "_TZE200_rks0sgb7 TS0601",
    "quirk_applied": false,
    "quirk_class": "zigpy.device.Device",
    "manufacturer_code": 4098,
    "power_source": "Mains",
    "lqi": 255,
    "rssi": -65,
    "last_seen": "2023-10-15T20:04:46",
    "available": true,
    "device_type": "Router",
    "signature": {
      "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.Router: 1>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.FullFunctionDevice|MainsPowered|RxOnWhenIdle|AllocateAddress: 142>, manufacturer_code=4098, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=False, *is_full_function_device=True, *is_mains_powered=True, *is_receiver_on_when_idle=True, *is_router=True, *is_security_capable=False)",
      "endpoints": {
        "1": {
          "profile_id": "0x0104",
          "device_type": "0x0051",
          "input_clusters": [
            "0x0000",
            "0x0004",
            "0x0005",
            "0xef00",
            "0xff66"
          ],
          "output_clusters": [
            "0x000a",
            "0x0019"
          ]
        }
      },
      "manufacturer": "_TZE200_rks0sgb7",
      "model": "TS0601"
    },
    "active_coordinator": false,
    "entities": [],
    "neighbors": [
      {
        "device_type": "Coordinator",
        "rx_on_when_idle": "On",
        "relationship": "Sibling",
        "extended_pan_id": "**REDACTED**",
        "ieee": "**REDACTED**",
        "nwk": "0x0000",
        "permit_joining": "Unknown",
        "depth": "0",
        "lqi": "159"
      },
      {
        "device_type": "Router",
        "rx_on_when_idle": "On",
        "relationship": "Sibling",
        "extended_pan_id": "**REDACTED**",
        "ieee": "**REDACTED**",
        "nwk": "0x44A6",
        "permit_joining": "Unknown",
        "depth": "15",
        "lqi": "26"
      },
      {
        "device_type": "Router",
        "rx_on_when_idle": "On",
        "relationship": "Sibling",
        "extended_pan_id": "**REDACTED**",
        "ieee": "**REDACTED**",
        "nwk": "0x816A",
        "permit_joining": "Unknown",
        "depth": "15",
        "lqi": "123"
      },
      {
        "device_type": "Router",
        "rx_on_when_idle": "On",
        "relationship": "Parent",
        "extended_pan_id": "**REDACTED**",
        "ieee": "**REDACTED**",
        "nwk": "0xE50B",
        "permit_joining": "Unknown",
        "depth": "15",
        "lqi": "245"
      }
    ],
    "routes": [
      {
        "dest_nwk": "0x0000",
        "route_status": "Active",
        "memory_constrained": false,
        "many_to_one": true,
        "route_record_required": false,
        "next_hop": "0x0000"
      }
    ],
    "endpoint_names": [
      {
        "name": "SMART_PLUG"
      }
    ],
    "user_given_name": "Mesurador Quadre El\u00e8ctric TS0601",
    "device_reg_id": "f87029d1f630706adc199937f095b52a",
    "area_id": "entrada",
    "cluster_details": {
      "1": {
        "device_type": {
          "name": "SMART_PLUG",
          "id": 81
        },
        "profile_id": 260,
        "in_clusters": {
          "0x0000": {
            "endpoint_attribute": "basic",
            "attributes": {
              "0x0004": {
                "attribute_name": "manufacturer",
                "value": "_TZE200_rks0sgb7"
              },
              "0x0005": {
                "attribute_name": "model",
                "value": "TS0601"
              }
            },
            "unsupported_attributes": {}
          },
          "0x0004": {
            "endpoint_attribute": "groups",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0005": {
            "endpoint_attribute": "scenes",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0xef00": {
            "endpoint_attribute": null,
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0xff66": {
            "endpoint_attribute": "manufacturer_specific",
            "attributes": {},
            "unsupported_attributes": {}
          }
        },
        "out_clusters": {
          "0x0019": {
            "endpoint_attribute": "ota",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x000a": {
            "endpoint_attribute": "time",
            "attributes": {},
            "unsupported_attributes": {}
          }
        }
      }
    }
  }
}

Logs

No response

Custom quirk

In Koenkk/zigbee2mqtt#18734 they have configured it.

Additional information

No response

[KPfff]

Got in the email from vladii07 an attempt at mapping values with external converter. Not so proficient in github - just posting my findings.

Tested it as I have exactly the device as linked above.

My comments are added to initial comments like this "- comment"

`const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const extend = require('zigbee-herdsman-converters/lib/extend');
const tuya = require('zigbee-herdsman-converters/lib/tuya');
const utils = require('zigbee-herdsman-converters/lib/utils');
const e = exposes.presets;
const ea = exposes.access;
const {Buffer} = require('buffer');

const valueConverter = {
divideBy10: tuya.valueConverterBasic.divideBy(10),
divideBy100: tuya.valueConverterBasic.divideBy(100),
divideBy1000: tuya.valueConverterBasic.divideBy(1000),
};

const definition = {
fingerprint: [
{
modelID: 'TS0601',
manufacturerName: '_TZE200_rks0sgb7',
},
],
model: 'TS0601_Bidirectional_Energy_Meter_with_80A_Current_Clamp',
vendor: 'TuYa',
description: 'Bidirectional Energy Meter with 80A Current Clamp',
fromZigbee: [tuya.fz.datapoints],
toZigbee: [tuya.tz.datapoints],
onEvent: tuya.onEventSetTime,
configure: tuya.configureMagicPacket,
whiteLabel: [ tuya.whitelabel('Tuya', 'PC311-Z-TY', 'Bidirectional Energy Meter with 80A Current Clamp', ['_TZE200_rks0sgb7']), ],
// whiteLabel: [{vendor: 'EARU', model: 'PC311-Z-TY'}],
exposes: [ //only report data
e.ac_frequency(),
exposes.numeric('total_power_A', ea.STATE).withUnit('W').withDescription('Total power A'),
exposes.numeric('total_power_B', ea.STATE).withUnit('W').withDescription('Total power B'),
exposes.numeric('total_power_AB', ea.STATE).withUnit('W').withDescription('Total power AB'),// - description corrected
exposes.numeric('voltage', ea.STATE).withUnit('V').withDescription('Voltage'),
exposes.numeric('current_A', ea.STATE).withUnit('A').withDescription('Current A'),
exposes.numeric('current_B', ea.STATE).withUnit('A').withDescription('Current B'),
exposes.numeric('current_AB', ea.STATE).withUnit('A').withDescription('Total Current'),
exposes.numeric('power_factor_A', ea.STATE).withUnit('%').withDescription('Instantaneous measured power factor A'),
exposes.numeric('power_factor_B', ea.STATE).withUnit('%').withDescription('Instantaneous measured power factor B'),
exposes.numeric('power_direction A', ea.STATE).withDescription('Power direction A 0/1 for forward/reverse'),
exposes.numeric('power_direction B', ea.STATE).withDescription('Power direction B 0/1 for forward/reverse'),
exposes.numeric('energy_forward_A', ea.STATE).withUnit('kWh').withDescription('Total energy A forward'),
exposes.numeric('energy_forward_B', ea.STATE).withUnit('kWh').withDescription('Total energy B forward'),
exposes.numeric('update_frequency', ea.STATE).withUnit('sec').withDescription('Update frequency'),
],

meta:{
tuyaDatapoints: [//only report data
[104, 'ac_frequency', tuya.valueConverter.raw],//known ok - not ok. always 0
[108, 'total_power_A', tuya.valueConverter.raw],//known ok - no divide needed, corrected to raw
[111, 'total_power_B', tuya.valueConverter.raw],//known ok - no divide needed, corrected to raw
[102, 'total_power_AB', tuya.valueConverter.divideBy10],//not ok, always 0
[106, 'voltage', tuya.valueConverter.divideBy10],//known ok - ok
[107, 'current_A', tuya.valueConverter.divideBy1000],//known ok - ok
[110, 'current_B', tuya.valueConverter.divideBy1000],//known ok- ok
[105, 'current_AB', tuya.valueConverter.divideBy1000],//known ok - ok with a ~second delay
[109, 'power_factor_A', tuya.valueConverter.raw],//known ok - ok
[112, 'power_factor_B', tuya.valueConverter.raw],//known ok - ok
[113, 'power_direction A', tuya.valueConverter.raw],//known ok - not ok. seems to show frequency as value is always 50
[114, 'power_direction B', tuya.valueConverter.raw],//known ok - not ok. always null
[101, 'energy_forward_A', tuya.valueConverter.divideBy100],//known ok - seems ok
[103, 'energy_forward_B', tuya.valueConverter.divideBy100],//known ok - seems ok
[113, 'update_frequency' , tuya.valueConverter.raw],//might be ok? - not ok. shows null
],
},
};

module.exports = definition;`

[KPfff]

[103, 'energy_forward_B', tuya.valueConverter.divideBy100], - tested by comparing to another device, OK

[KPfff]

Details:

• I own double clamp Zigbee version from here https://es.aliexpress.com/item/1005005931365212.html
• Reporting tested and working on my local mains!
• Checked multiple DPs to find right ones, didn't find any more DPs with any values reported
• Reverse energy tested by installing clamps backwards
• Power readings goes negative with reverse load (see screenshot)
• Summed "AB" values are coming with a delay and are not always 1+1 accurate
• Reporting frequency seems to be fixed at once per second

NOTE: Readings accuracy is directly impacted by distance from other wires!!! One clamp was left without wire passing through, just wire next to it and it was showing 7W consumption.

Working converter below:

const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const extend = require('zigbee-herdsman-converters/lib/extend');
const tuya = require('zigbee-herdsman-converters/lib/tuya');
const utils = require('zigbee-herdsman-converters/lib/utils');
const e = exposes.presets;
const ea = exposes.access;
const {Buffer} = require('buffer');

const valueConverter = {
divideBy10: tuya.valueConverterBasic.divideBy(10),
divideBy100: tuya.valueConverterBasic.divideBy(100),
divideBy1000: tuya.valueConverterBasic.divideBy(1000),
};

const definition = {
fingerprint: [
{
modelID: 'TS0601',
manufacturerName: '_TZE200_rks0sgb7',
},
],
model: 'TS0601_Bidirectional_Energy_Meter_with_80A_Current_Clamp',
vendor: 'TuYa',
description: 'Bidirectional Energy Meter with 80A Current Clamp',
fromZigbee: [tuya.fz.datapoints],
toZigbee: [tuya.tz.datapoints],
onEvent: tuya.onEventSetTime,
configure: tuya.configureMagicPacket,
whiteLabel: [ tuya.whitelabel('Tuya', 'PC311-Z-TY', 'Bidirectional Energy Meter with 80A Current Clamp', ['_TZE200_rks0sgb7']), ],
// whiteLabel: [{vendor: 'EARU', model: 'PC311-Z-TY'}],
exposes: [ //only report data
e.ac_frequency(),
exposes.numeric('total_power_A', ea.STATE).withUnit('W').withDescription('Total power A'),
exposes.numeric('total_power_B', ea.STATE).withUnit('W').withDescription('Total power B'),
exposes.numeric('total_power_AB', ea.STATE).withUnit('W').withDescription('Total power AB'),
exposes.numeric('voltage', ea.STATE).withUnit('V').withDescription('Voltage'),
exposes.numeric('current_A', ea.STATE).withUnit('A').withDescription('Current A'),
exposes.numeric('current_B', ea.STATE).withUnit('A').withDescription('Current B'),
exposes.numeric('current_AB', ea.STATE).withUnit('A').withDescription('Total Current'),
exposes.numeric('power_factor_A', ea.STATE).withUnit('%').withDescription('Instantaneous measured power factor A'),
exposes.numeric('power_factor_B', ea.STATE).withUnit('%').withDescription('Instantaneous measured power factor B'),
exposes.numeric('energy_reverse_A', ea.STATE).withUnit('kWh').withDescription('Total energy A reverse'),
exposes.numeric('energy_reverse_B', ea.STATE).withUnit('kWh').withDescription('Total energy B reverse'),
exposes.numeric('energy_reverse_AB', ea.STATE).withUnit('kWh').withDescription('Total energy AB reverse'),
exposes.numeric('energy_forward_A', ea.STATE).withUnit('kWh').withDescription('Total energy A forward'),
exposes.numeric('energy_forward_B', ea.STATE).withUnit('kWh').withDescription('Total energy B forward'),
exposes.numeric('energy_forward_AB', ea.STATE).withUnit('kWh').withDescription('Total energy AB forward'),
],

meta:{
tuyaDatapoints: [//only report data
[113, 'ac_frequency', tuya.valueConverter.raw],
[108, 'total_power_A', tuya.valueConverter.raw],
[111, 'total_power_B', tuya.valueConverter.raw],
[9, 'total_power_AB', tuya.valueConverter.raw],
[106, 'voltage', tuya.valueConverter.divideBy10],
[107, 'current_A', tuya.valueConverter.divideBy1000],
[110, 'current_B', tuya.valueConverter.divideBy1000],
[105, 'current_AB', tuya.valueConverter.divideBy1000],
[109, 'power_factor_A', tuya.valueConverter.raw],
[112, 'power_factor_B', tuya.valueConverter.raw],
[102, 'energy_reverse_A', tuya.valueConverter.divideBy100],
[104, 'energy_reverse_B', tuya.valueConverter.divideBy100],
[2, 'energy_reverse_AB', tuya.valueConverter.divideBy100],
[101, 'energy_forward_A', tuya.valueConverter.divideBy100],
[103, 'energy_forward_B', tuya.valueConverter.divideBy100],
[1, 'energy_forward_AB' , tuya.valueConverter.divideBy100],
],
},
};

module.exports = definition;

[lepalom]

@KPfff Can you guide me to test this configuration? I have updated HA but I still have the old configuration.

[KPfff]

@lepalom, Are you familiar with setting up external converters?

1. You need File editor - I use the "File editor" from Add-on Store
2. Open file editor and navigate to /config/zigbee2mqtt folder
3. Create file with .js extension. E.g., I named mine "earu-pc311-z-ty.js" (IMPORTANT - don't use capital letters in the file name!)
4. Once file is created click on it in editor and copy paste converter from above, save the file.
5. Go to Zigbee2MQTT add-on => Settings => External converters => Add the file with the same name, e.g. "earu-pc311-z-ty.js"
6. Restart Zigbee2MQTT add-on

If the device is still reporting old values then try removing it and adding it again. (Worst case force remove and pair once again)

Note: Mind you that any historical data will not be brought over - it is like adding new device.

Hope it helps :)

[jmuf]

@KPfff: many thanks for this investigation. I guess that part of the issue is that not everybody is using zigbee2mqtt. To convert your findings to a zha-device-handlers "quirk" means writing a small python module similar to ts0601_din_power.py.
While the TUYA datapoint identifiers (107: current_A etc) hopefully are the same (and can be copied from your code), the structure is quite different.

[jmuf]

Work-in-progress "quirk":

• gets loaded,
• Zigbee "manage device" sees the custom cluster,
• but does not load any data ( all values are null)
  • even for stuff like 'frequency' (0x71) which does not get translated
• _update_attribute() is not even called (no logging)

ts0601_sp_clamp_power.py.txt

[robertstumberger]

Hi guys,
I have the same meter, PC311-Z-TY Single-Phase Power Clamp Zigbee model 'TS0601' and manufacturer name '_TZE200_rks0sgb7 but with two Clamps...

And of course I would ask for your help ;-)
And I use ZHA.
i need help how "quirk"

[lepalom]

@KPfff thanks a lot. Well, my problem is that I'm not using zigbee2mqtt. Now I have understood the problem. I have seen that there are like two big families to manage a zigbee devices: ZHA integration and zigbee2mptt.

I have been using ZHA and I would like to test zigbee2mqtt, but I have to migrate all the devices. I will see.

[robertstumberger]

Ok,
I managed to give a "quirk" to work, but incorrectly, I assume

What am I doing wrong? Please help :-(

[robertstumberger]

Work-in-progress "quirk":

* gets loaded,

* Zigbee "manage device" sees the custom cluster,

* **but** does not load any data ( all values are null)
  
  * even for stuff like 'frequency' (0x71) which does not get translated

* `_update_attribute()` is not even called (no logging)

ts0601_sp_clamp_power.py.txt

@jmuf Are you working on "quirk" for ZHA?

[jmuf]

I had a look but am stuck, no idea whether the "attributes" from @KPfff have been correctly put in place in this code, or whether something basic is missing (this is my first attempt at a "quirk").

[robertstumberger]

Do we have someone who could check - validate this?
Is there any other way I can help?
As you can see from the picture above, the "quirk" was accepted, but unfortunately nothing happened, even after a reboot.