Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update E2001_E2002.md to suggest needed setting #2704

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update E2001_E2002.md to suggest needed setting #2704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/devices/E2001_E2002.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ simulated_brightness:
delta: 20 # delta per interval, default = 20
interval: 200 # interval in milliseconds, default = 200
```
**Note:** If the `action` entry does not report all the attributes (brightness, action_brightness_delta, ...) you may need to activate the `Home Assistant legacy entity attributes` setting in `Zigbee2Mqtt Settings` > `Home Assistant integration`.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how setting this option influences the action published. Can you check this again?

Copy link
Author

@HoroTW HoroTW Apr 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for your reply,
Sure, also took screenshots.

I should have been clearer in the pull request here, the observed difference is:
In Home Assistant there is an entry called: sensor.<device_name>_action, this entry has a status and attributes and depending on the option I can see some attributes (or not if disabled).

To observe the difference a restart of home assistant is required as stated on https://www.zigbee2mqtt.io/guide/configuration/homeassistant.html

With the option enabled:
option_enabled

With it disabled:
option_disabled

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not recommended to enable this as it will increase the load on HA a lot

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see - that is a pity, I did not notice any more load on HA - but I am running it on a pretty powerful machine...
What would be the best course of action here - as far as I understand the option, it should not even be necessary to publish the attributes... I was actually suprised that it changed the attributes like that.... could this be a misconfiguration of the device specification or a bug somewhere else... ?
If it is something like that, maybe we can "fix" it so that the attributes are published without the option?

Also, is it already documented that this option significantly increases the load on HA (I think it is worth documenting as I enabled it without thinking it would have a significant impact - I also understood this guide as expecting this option to be enabled by default: https://www.zigbee2mqtt.io/guide/configuration/homeassistant.html#advanced-configuration "default: shown below" ..... and below it is enabled - maybe that needs to be updated as well...)?

I'm happy to do some investigation and/or documentation work if appreciated.

~Horo

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default when nothing is specified in the configuration.yaml is true indeed, but nowadays is set to false for new installations. If you want to use these attributes, the following is recommended: https://www.zigbee2mqtt.io/guide/usage/integrations/home_assistant.html#via-mqtt

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Koenkk Thanks for your previous answers and sorry to bother you again, but I'm still not sure what to do with this issue/PR.

Today I had another friend who bought IKEA switches and wanted to use the "simulated brightness" as described in the documentation (https://www.zigbee2mqtt.io/devices/E2001_E2002.html).

They thought their switch was broken until I pointed out that they need to turn on the legacy entity attributes to use the Simulated Brightness in Home Assistant....

I personally have an automation setup that uses a helper state that represents the "desired state" of a light, and the button only manipulates that state ... So I personally don't need this anymore, but I see people stumbling over this "Simulated Brightness" and don't knowing that they need to enable legacy entity attributes to see it in Home Assistant ....

Maybe I'm not good at describing it... see the links where people are finding out that this setting is needed:

But in the end, if this is something that is not wanted, I think we should close this PR, keeping it open is not really helping the project!

Thank you for your time and this project! 😊

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add some docs on the home assistant integration page on how to use simulated brightness by using mqtt. Then in the simulated brightness option for each device link to this page.


* `legacy`: Set to false to disable the legacy integration (highly recommended), will change structure of the published payload (default true). The value must be `true` or `false`

Expand Down
Loading