Document button entities (#31750)

This commit is contained in:
Erik Montnemery 2024-03-13 13:06:45 +01:00 committed by GitHub
parent 19b428baf7
commit 0d705076cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4,12 +4,14 @@ description: How to use Lutron Homeworks Series 4 & 8 with Home Assistant.
ha_category: ha_category:
- Hub - Hub
- Binary sensor - Binary sensor
- Button
- Light - Light
ha_release: 0.85 ha_release: 0.85
ha_iot_class: Local Push ha_iot_class: Local Push
ha_domain: homeworks ha_domain: homeworks
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
- button
- light - light
ha_integration_type: integration ha_integration_type: integration
--- ---
@ -20,7 +22,7 @@ Only a subset of the Homeworks system is supported - lights and keypads.
Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another integration [lutron](/integrations/lutron/) which handles Lutron RadioRA 2 systems. Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another integration [lutron](/integrations/lutron/) which handles Lutron RadioRA 2 systems.
Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). It's also possible to add binary sensor entities which indicate if a keypad LED is lit. Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). It's also possible to add binary sensor entities which indicate if a keypad LED is lit and button entities which can be used to trigger the actions bound to a keypad button.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}