Exposing action_brightness_delta to allow better blueprints #8369

TheUnlimited64 · 2024-11-24T11:58:35Z

This enables home assistant users to have a better dimming experience using automations like, therefore zha is not needed anymore for smooth dimming experience.

[https://github.com/TheUnlimited64/tuya_smart_knob_blueprint](url)

Only issue currently (atleast with mine) is that there seems to be a cooldown after ~2s. If I dimm long enough it stops receiving. But I'm not sure how to mitigate it.

This enables the home assistant community to access the action_brightness_delta value inside blueprints and therefore have a much more pleasing dimming experience than before.

Koenkk · 2024-11-24T20:54:24Z

This expose should not always be present, since it is only there when the simulated_brightness option is activated. I would add it here instead: https://github.com/Koenkk/zigbee2mqtt/blob/69f728295224c06ce509eb3afdf611b37ca8fa37/lib/extension/homeassistant.ts#L1535 ( if (isDevice && entity.options.simulated_brightness) {

TheUnlimited64 · 2024-11-24T21:06:56Z

@Koenkk thats a great Idea! Wasn't really sure how the exposing works, but I'm digging deaper. Is there maybe a dev docs? I already have an additional feature for this and potentially more sensors in mind.

But I'm very pleased that I can overwrite pretty much everything with a custom converter, makes developing/testing a breeze :)

Tomorrow or in a few days I'll add it when I figured everything out and put it in the right place

…kely)

TheUnlimited64 · 2024-11-28T16:36:19Z

Hi @Koenkk,

I've updated my PR with a new feature implementation called simulated_color_temperature.
The implementation is more straightforward compared to simulated_brightness as my sensor
doesn't provide a command_stop functionality, so the interval would be useless currently.

Additionally, I'd appreciate some guidance on implementing the exposure in homeassistant.ts.
I'm not entirely clear on the exposure line's functionality, which is preventing me from
implementing the correct exposure method.

Could you please provide some direction on this?

Thanks!

Koenkk · 2024-11-29T19:40:45Z

src/converters/fromZigbee.ts

@@ -1424,6 +1425,22 @@ const converters1 = {
                payload.action_transition_time = msg.data.transtime / 100;
            }

+            if (options.simulated_color_temperature) {
+                const deltaOpts = options.simulated_color_temperature_delta ?? 500;


I assume the delta is in Kelvin, I propose to use mireds here as that is what the ZCL uses.

Did change it to midred

Koenkk · 2024-11-29T19:41:16Z

src/converters/fromZigbee.ts

+                const deltaOpts = options.simulated_color_temperature_delta ?? 500;
+
+                if (globalStore.getValue(msg.endpoint, 'simulated_color_temperature') === undefined) {
+                    let color_temperature = globalStore.getValue(msg.endpoint, 'simulated_color_temperature_temperature', 2000);


Suggested change

let color_temperature = globalStore.getValue(msg.endpoint, 'simulated_color_temperature_temperature', 2000);

let colorTemperature = globalStore.getValue(msg.endpoint, 'simulated_color_temperature_temperature', 2000);

Koenkk · 2024-11-29T19:41:43Z

I'm not entirely clear on the exposure line's functionality, which is preventing me from
implementing the correct exposure method.

Can you clarify it a bit more? Then I can help.

…toring Now no hardcoded min/max values and using midred instead of kelvin

TheUnlimited64 · 2024-11-30T13:16:51Z

Can you clarify it a bit more? Then I can help.

You suggested instead of exposing the additional information action_brightness_step (and therefore also action_color_step_temperature) to expose it with the homeassistant.ts file. But I'm not sure how that would look like.

Also wouldn't hardcoding it be a bad pattern? A more straight forward principle might be better for future solutions, doesn't it? Maybe we could define base exposes but overwrite them at device level? That way an user has control to expose any mqtt data that it needs. What do you think about this solution?

Also whats a bit ugly is that in the options descriptions often says like default is 20. But that 20 is hardcoded into the converter function itself. I did try to think of an solution to set an default at option level but that wouldn't work with the current architecture. Atleast I can't think of a good way of implementing such functionality and it would presuppose that an option is toggleable via the UI (because if they're default values any option would be turned on automatically)

Koenkk · 2024-12-01T20:24:56Z

An alternative would be to dynamically add it to exposes, you cannot always add it there since not everyone is using this option. Then it can be added here:

zigbee-herdsman-converters/src/index.ts

Line 316 in b7877b7

    
           if (definition.exposes && Array.isArray(definition.exposes) && !definition.exposes.find((e) => e.name === 'linkquality')) {

(which would mean prepareDefinition needs to receive the options)

…m options

TheUnlimited64 · 2024-12-30T13:12:46Z

Hi!

I've now pushed my proposal of the additional options properties being spread into the exposes. What do you think? I'm a bit confused that the classes have multiple use cases (option definition and exposes)

TheUnlimited64 · 2024-12-30T13:40:37Z

Also, how could I test my changes with in home assistant? Or do I have to setup zigbee2mqtt within docker myself?

Koenkk · 2024-12-30T13:46:39Z

See https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/blob/master/CONTRIBUTING.md#developing-against-the-home-assistant-container on how to make local changes.

TheUnlimited64 · 2025-01-14T21:38:15Z

Hi!

I've finally had time to implement it and test it. What do you think?

Koenkk · 2025-01-15T19:16:15Z

src/index.ts

@@ -376,6 +384,48 @@ function prepareDefinition(definition: DefinitionWithExtend): Definition {
        }
    }

+    //if options are defined, add them to the exposes


This can be done much easier, see 3d98d3f#diff-47eee2b61258a9d48e4b9104d706a4aeacec2e1baba7d21f34db7d2963357d28R679 as an example

Am I correct, that you're implying that it better should be done by the modernExtendRefactor script, to migrate all definitions to extend a simulated_light base? That sounds to be a great approach, but I'm a bit unsure if it could handle the edge cases like the D1 universal dimmer, that's an example of why this got this complicated, because it acts as a dimmer, but also as a light entity.

Is this what you're intending to push forward, or am I on the wrong track? If not I'll read into the code base and check how to integrate it

Sorry, I meant the changes of src/lib/modernExtend.ts

TheUnlimited64 added 2 commits November 24, 2024 12:29

Exposing action_brightness_delta to allow better blueprints

d871575

This enables the home assistant community to access the action_brightness_delta value inside blueprints and therefore have a much more pleasing dimming experience than before.

prettier fix

9d41716

TheUnlimited64 added 2 commits November 28, 2024 17:20

implemented simulated color temperature, also did notice bug (most li…

98d7e67

…kely)

Found out that interval is cleared on command_stop

e967e38

Koenkk reviewed Nov 29, 2024

View reviewed changes

Made simulated color temperature a bit more advanced, including refac…

6abfc42

…toring Now no hardcoded min/max values and using midred instead of kelvin

TheUnlimited64 marked this pull request as draft November 30, 2024 13:17

TheUnlimited64 and others added 3 commits December 30, 2024 13:53

Added exposes to options, to automatically add additional exposes fro…

a6ddd7a

…m options

Merge branch 'master' into master

14d3406

styling from vscode seems not to be using prettier config?

cd3fde0

TheUnlimited64 force-pushed the master branch from 7a687b2 to cd3fde0 Compare December 30, 2024 13:04

TheUnlimited64 added 2 commits December 30, 2024 14:07

Fixing bug where options are not defined

eff2d3e

styling very strict it seems

d0af122

TheUnlimited64 and others added 3 commits January 4, 2025 21:57

Merge branch 'master' into master

c3dba77

working prototype

63de583

little cleanup

5c91155

Merge branch 'master' into master

3ee5c47

Koenkk reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exposing action_brightness_delta to allow better blueprints #8369

Exposing action_brightness_delta to allow better blueprints #8369

TheUnlimited64 commented Nov 24, 2024

Koenkk commented Nov 24, 2024

TheUnlimited64 commented Nov 24, 2024

TheUnlimited64 commented Nov 28, 2024

Koenkk Nov 29, 2024

TheUnlimited64 Nov 30, 2024

Koenkk Nov 29, 2024

Koenkk commented Nov 29, 2024

TheUnlimited64 commented Nov 30, 2024

Koenkk commented Dec 1, 2024

TheUnlimited64 commented Dec 30, 2024

TheUnlimited64 commented Dec 30, 2024

Koenkk commented Dec 30, 2024

TheUnlimited64 commented Jan 14, 2025

Koenkk Jan 15, 2025

TheUnlimited64 Jan 15, 2025

Koenkk Jan 17, 2025

	let color_temperature = globalStore.getValue(msg.endpoint, 'simulated_color_temperature_temperature', 2000);
	let colorTemperature = globalStore.getValue(msg.endpoint, 'simulated_color_temperature_temperature', 2000);

Exposing action_brightness_delta to allow better blueprints #8369

Are you sure you want to change the base?

Exposing action_brightness_delta to allow better blueprints #8369

Conversation

TheUnlimited64 commented Nov 24, 2024

Koenkk commented Nov 24, 2024

TheUnlimited64 commented Nov 24, 2024

TheUnlimited64 commented Nov 28, 2024

Koenkk Nov 29, 2024

Choose a reason for hiding this comment

TheUnlimited64 Nov 30, 2024

Choose a reason for hiding this comment

Koenkk Nov 29, 2024

Choose a reason for hiding this comment

Koenkk commented Nov 29, 2024

TheUnlimited64 commented Nov 30, 2024

Koenkk commented Dec 1, 2024

TheUnlimited64 commented Dec 30, 2024

TheUnlimited64 commented Dec 30, 2024

Koenkk commented Dec 30, 2024

TheUnlimited64 commented Jan 14, 2025

Koenkk Jan 15, 2025

Choose a reason for hiding this comment

TheUnlimited64 Jan 15, 2025

Choose a reason for hiding this comment

Koenkk Jan 17, 2025

Choose a reason for hiding this comment