Improve Legrand 064882 cable outlet heat mode #3031

piitaya · 2024-03-11T12:15:15Z

Proposed change

Following #2807

Pilot wire mode has been renamed to heat mode.
Enum for device_mode has been removed as it's not used.
The value is now exposed and you can read and write the cluster of the attribute. This will allow the creation of a climate entity in ZHA to control the heat mode.

Additional information

A PR has be open in Home Assistant Core to add the support using climate entity : home-assistant/core#113059

To use the climate entity, user will needed to pass the device in wire pilot mode by toggling the new switch entity : wire pilot mode

Checklist

The changes are tested and work correctly
pre-commit checks pass / the code has been formatted using Black
Tests have been added to verify that the new code works

codecov · 2024-03-11T12:17:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.94%. Comparing base (86fafd6) to head (144fe4c).
Report is 9 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3031      +/-   ##
==========================================
+ Coverage   87.86%   87.94%   +0.08%     
==========================================
  Files         301      301              
  Lines        9219     9249      +30     
==========================================
+ Hits         8100     8134      +34     
+ Misses       1119     1115       -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zhaquirks/legrand/cable_outlet.py

dmulcahey · 2024-03-11T13:30:39Z

After the cluster changes are cleaned up we should look at converting this to a v2 quirk instead which would remove the need to open a PR in HA.

zhaquirks/legrand/cable_outlet.py

dmulcahey · 2024-03-11T14:08:37Z

After the cluster changes are cleaned up we should look at converting this to a v2 quirk instead which would remove the need to open a PR in HA.

legrand.patch

piitaya · 2024-03-11T14:54:49Z

@dmulcahey How does it work with translation_key ? Where the translations file should be located?

dmulcahey · 2024-03-11T14:58:55Z

@dmulcahey How does it work with translation_key ? Where the translations file should be located?

Translations will default to the attribute name. Strings.json will still need a HA PR

piitaya · 2024-03-11T16:12:25Z

I updated to quirk v2.
I didn't add the enum to create the select entity because of multiple reason :

entity_type seems to not work with standard. Also, why is it called entity_type instead of entity_category? Standard is not a category, the category should be set to None instead.
the ZCL select entity replace _ by spaces in Home Assistant that make hard the usage of entity translations. IMO, it should convert the enum in lowercase and keep the _.
What do you think @dmulcahey?

I also have an issue with tests

dmulcahey · 2024-03-11T17:08:28Z

tests will pass after the Zigpy bump I think.

TheJulianJES · 2024-03-11T18:10:04Z

entity_type seems to not work with standard. Also, why is it called entity_type instead of entity_category? Standard is not a category, the category should be set to None instead

Yeah, some classes like ZCLEnumSelectEntity (in ZHA) override the entity category if it's None for now.
The main use case is to provide config entities via quirks v2. I think this would be the first case where we'd have a select entity that's not a config entity.
#3030 even mentions that this device could provide a climate entity in HA. This is not possible via quirks v2, but might be worth considering?
FYI, the metadata and entity type is matched a ZHA class here.

the ZCL select entity replace _ by spaces in Home Assistant that make hard the usage of entity translations. IMO, it should convert the enum in lowercase and keep the _.

Yeah, the enum states aren't translatable at the moment. There's this PR: home-assistant/core#109309, but I see some issues with state restoration when coming from an old version (due to _/ ) for ZHAEnumSelectEntity (used for non-ZCL stuff like IasWd).
That would need to be addressed (and the test for quirks v2 to see if translation keys are provided would need to be expanded).
It's still something I plan on looking at/working on, but the enums (split between quirks and ZHA atm) would all stay the same at least. Like you mentioned, ZHA would just lower-case them for the translation keys.

I also have an issue with tests

A helper for creating a quirk v2 device is added with #3032

piitaya · 2024-03-11T18:22:09Z

#3030 even mentions that this device could provide a climate entity in HA. This is not possible via quirks v2, but might be worth considering?

Yes I was considering this too. I'm not sure my python level is enough for that but I can give a try 🙂 As I know, there is no standard attribute for the preset in the thermostat cluster right?

The idea is to map the 6 heat mode into 2 hvac modes and 5 presets :

heat - splitted into 5 presets :
- comfort preset
- comfort-1 preset
- comfort-2 preset
- eco preset
- away preset
off

I already did something similar in my home assistant qubino custom component : https://github.com/piitaya/home-assistant-qubino-wire-pilot

TheJulianJES · 2024-03-11T18:37:57Z

Yes I was considering this too. [...] As I know, there is no standard attribute for the preset in the thermostat cluster right?

Correct, at least not one that's mapped to HA presets for the "generic thermostat implementation" in ZHA.
Some thermostats are implemented like this for presets: homeassistant/components/zha/climate.py#L578-L667 (and further below are some other examples).
The "comfort -1" and "comfort -2" presets might be an issue though (since they don't seem to exist in HA)?

(Also, other devices like the Aqara E1 thermostat currently just implements the preset mode (manual, auto, away) as a config select entity. Of course, it would be better if it were added to the climate entity though.)

luke7101 · 2024-03-11T20:26:17Z

#3030 even mentions that this device could provide a climate entity in HA. This is not possible via quirks v2, but might be worth considering?

Yes I was considering this too. I'm not sure my python level is enough for that but I can give a try 🙂 As I know, there is no standard attribute for the preset in the thermostat cluster right?

The idea is to map the 6 heat mode into 2 hvac modes and 5 presets :

heat - splitted into 5 presets :

comfort preset

comfort-1 preset

comfort-2 preset

eco preset

away preset

off

I already did something similar in my home assistant qubino custom component : https://github.com/piitaya/home-assistant-qubino-wire-pilot

Just my 2 cents :
pilot wire has 6 modes: comfort, comfort-1, comfort-2, eco, away and off (in my experience comfort-1 and -2 aren't used very often)
The off order is a "soft off" ie the heater stops heating but it's still powered.

Legrand 064882 cable outlet provides a "hard off" state, by toggling the switch in standard mode, that completely turns off the power (ie no power on the L wire)

It's a big advantage compared to the other devices I tried because, for example:

you can completely switch off the power over summer to prevent your kids to turn the heater on unintentionally, convenient if the heater doesn't have a physical switch
you can avoid electric smog when you don't absolutely need to heat (heaters have huge electric field >100V/m at 30 cm) still present in the soft off pilot wire state, and if you would like to turn it off automatically in the inter-season without toggling the circuit breaker once or twice a day !

What I'm trying to say is that you maybe should keep the 2 different off modes, mapping it for example like that;

heat - splitted into 4 (or 6 presets ?) :
- comfort preset
- comfort-1 preset?
- comfort-2 preset?
- eco preset
- away preset
- off preset (soft off)
off (hard off mode)

zhaquirks/legrand/cable_outlet.py

piitaya · 2024-03-22T16:15:46Z

I removed the thermostat cluster, the zha climate integration uses the manufacturer cluster.

dmulcahey · 2024-03-26T11:43:53Z

zhaquirks/legrand/wire_pilot.py

+            attr_def = self.find_attribute(attr)
+            attr_id = attr_def.id
+            if attr_id == WIRE_PILOT_MODE_ATTR:
+                attrs[0x0000] = [0x02, 0x00] if value else [0x01, 0x00]


0x0000 -> LegrandCluster.AttributeDefs.device_mode.id

What do the byte arrays represent? We should name them at a minimum.

I don't really known why it uses array instead of boolean. My assumption is that legrand is using same attribute for various devices.

dmulcahey · 2024-03-26T11:45:16Z

zhaquirks/legrand/wire_pilot.py

+            type=t.data16,
+            is_manufacturer_specific=True,
+        )
+        led_dark = ZCLAttributeDef(


What does this do and should it have some sort of config entity in the quirk?

It was here before so I didn't touched it. I will look in details and I may provide a config switch for those attributes if it makes sense in another PR.

dmulcahey · 2024-03-26T11:45:44Z

zhaquirks/legrand/wire_pilot.py

+            type=t.Bool,
+            is_manufacturer_specific=True,
+        )
+        led_on = ZCLAttributeDef(


should we add a switch config entity for this to the quirk below?

luke7101 · 2024-04-12T11:59:37Z

Hi, will this PR be merged some day, or is there a way to test its current progress ?
Thanks!

piitaya · 2024-04-12T15:22:43Z

I need to write tests in ha core but I don't have much time at the moment. I keep you updated 😊

luke7101 · 2024-04-15T12:42:44Z

Great ! Thanks 😉

piitaya mentioned this pull request Mar 11, 2024

Add climate entity for Legrand 064882 cable outlet home-assistant/core#113059

Draft

20 tasks

piitaya marked this pull request as draft March 11, 2024 12:21

piitaya force-pushed the heat_mode_legrand_outlet branch from dd6f739 to 2de7ca9 Compare March 11, 2024 12:23

dmulcahey reviewed Mar 11, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

dmulcahey reviewed Mar 11, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

dmulcahey reviewed Mar 11, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

dmulcahey reviewed Mar 11, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

bemble mentioned this pull request Mar 11, 2024

[IMPROVEMENT] convert Legrand 064882 cable outlet to climate entity instead of switch #3030

Open

piitaya force-pushed the heat_mode_legrand_outlet branch from a3f72de to 37ef827 Compare March 11, 2024 14:35

piitaya force-pushed the heat_mode_legrand_outlet branch from 4058bd2 to 78d691c Compare March 11, 2024 18:06

piitaya added 8 commits March 11, 2024 19:12

Fix heat mode for legrand outlet

2cd60fe

Use AttributeDefs and ServerCommandDefs

b83fbdd

Add tests

114f27c

Fix name

1f7b88a

Update case for enum

50ac382

Use quirk v2

13b13cc

Add entity

6d82c18

Update test to use v2 quirks

f2176fb

piitaya force-pushed the heat_mode_legrand_outlet branch from 78d691c to f2176fb Compare March 11, 2024 18:13

piitaya added 3 commits March 13, 2024 12:27

Format code

261a4b1

Add climate entity

973a072

Add enum back

cfe94ba

dmulcahey reviewed Mar 14, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

dmulcahey reviewed Mar 14, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

dmulcahey reviewed Mar 14, 2024

View reviewed changes

zhaquirks/legrand/cable_outlet.py Outdated Show resolved Hide resolved

piitaya added 3 commits March 14, 2024 20:26

Use attributes def and don't use bus

7720212

Remove thermostat

25875ca

Remove enum

5adb0d6

piitaya marked this pull request as ready for review March 15, 2024 09:19

piitaya added 3 commits March 15, 2024 10:52

Add device mode

be6bbfc

Remove init

033a90c

Add write device mode test

6f2f1e4

piitaya force-pushed the heat_mode_legrand_outlet branch from a2a4f9c to 6f2f1e4 Compare March 15, 2024 21:53

piitaya added 3 commits March 18, 2024 17:21

Rename cable outlet to wire pilot

7523f37

Add thermostat with heat_mode attribute

52584ad

Add thermostat system mode

8003a14

piitaya marked this pull request as draft March 19, 2024 09:53

piitaya added 4 commits March 19, 2024 18:07

Remove unreachable code

5664eb7

Improve test coverage

9518cbd

Add update attrs tests

c1d541b

Remove thermostat cluster

f452498

piitaya marked this pull request as ready for review March 19, 2024 20:02

dmulcahey requested changes Mar 26, 2024

View reviewed changes

piitaya added 2 commits March 26, 2024 17:46

Use attribute def

9fca2ac

Use attribute def

144fe4c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Legrand 064882 cable outlet heat mode #3031

Improve Legrand 064882 cable outlet heat mode #3031

piitaya commented Mar 11, 2024 •

edited

codecov bot commented Mar 11, 2024 •

edited

dmulcahey commented Mar 11, 2024 •

edited

dmulcahey commented Mar 11, 2024

piitaya commented Mar 11, 2024

dmulcahey commented Mar 11, 2024

piitaya commented Mar 11, 2024 •

edited

dmulcahey commented Mar 11, 2024

TheJulianJES commented Mar 11, 2024 •

edited

piitaya commented Mar 11, 2024 •

edited

TheJulianJES commented Mar 11, 2024 •

edited

luke7101 commented Mar 11, 2024

piitaya commented Mar 22, 2024

dmulcahey Mar 26, 2024

dmulcahey Mar 26, 2024

piitaya Mar 26, 2024

dmulcahey Mar 26, 2024

piitaya Mar 26, 2024

dmulcahey Mar 26, 2024

luke7101 commented Apr 12, 2024

piitaya commented Apr 12, 2024

luke7101 commented Apr 15, 2024

Improve Legrand 064882 cable outlet heat mode #3031

Are you sure you want to change the base?

Improve Legrand 064882 cable outlet heat mode #3031

Conversation

piitaya commented Mar 11, 2024 • edited

Proposed change

Additional information

Checklist

codecov bot commented Mar 11, 2024 • edited

Codecov Report

dmulcahey commented Mar 11, 2024 • edited

dmulcahey commented Mar 11, 2024

piitaya commented Mar 11, 2024

dmulcahey commented Mar 11, 2024

piitaya commented Mar 11, 2024 • edited

dmulcahey commented Mar 11, 2024

TheJulianJES commented Mar 11, 2024 • edited

piitaya commented Mar 11, 2024 • edited

TheJulianJES commented Mar 11, 2024 • edited

luke7101 commented Mar 11, 2024

piitaya commented Mar 22, 2024

dmulcahey Mar 26, 2024

Choose a reason for hiding this comment

dmulcahey Mar 26, 2024

Choose a reason for hiding this comment

piitaya Mar 26, 2024

Choose a reason for hiding this comment

dmulcahey Mar 26, 2024

Choose a reason for hiding this comment

piitaya Mar 26, 2024

Choose a reason for hiding this comment

dmulcahey Mar 26, 2024

Choose a reason for hiding this comment

luke7101 commented Apr 12, 2024

piitaya commented Apr 12, 2024

luke7101 commented Apr 15, 2024

piitaya commented Mar 11, 2024 •

edited

codecov bot commented Mar 11, 2024 •

edited

dmulcahey commented Mar 11, 2024 •

edited

piitaya commented Mar 11, 2024 •

edited

TheJulianJES commented Mar 11, 2024 •

edited

piitaya commented Mar 11, 2024 •

edited

TheJulianJES commented Mar 11, 2024 •

edited