Document Lutron Homeworks config flow (#31735)

* Document Lutron Homeworks config flow

* tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Erik Montnemery 2024-03-05 14:48:36 +01:00 committed by GitHub
parent 8d307ed4c8
commit 4a877f20fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -20,65 +20,6 @@ Lutron has created many systems over the years, each with their own unique inter
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).
## Configuration
{% include integrations/config_flow.md %}
The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` integration must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file:
``` yaml
# Example configuration.yaml entry
homeworks:
host: IP_ADDRESS
port: 4001
dimmers:
- addr: "[02:08:01:01]"
name: "Foyer Sconces"
- addr: "[02:08:01:02]"
name: "Foyer Downlights"
rate: 2
keypads:
- addr: "[02:08:02:01]"
name: "Foyer Keypad"
```
{% configuration %}
host:
description: The IP address of the ethernet to serial adapter. It is assumed that the adapter has been preconfigured.
required: true
type: string
port:
description: The port of the ethernet to serial adapter.
required: true
type: integer
dimmers:
description: List of dimmers.
required: false
type: list
keys:
addr:
description: The unique address of the dimmer on the controller. The quotes, brackets, and number formatting must be of the form `"[##:##:##:##]"`.
required: true
type: string
name:
description: The name of the sensor will be the title of the button +`"_"` + the name of the keypad/
required: true
type: string
rate:
description: The amount of time (in seconds) for the light to transition to a new brightness level.
required: false
type: float
default: 1
keypads:
description: List of keypads.
required: false
type: list
keys:
addr:
description: The unique address of the keypad on the controller. The quotes, brackets, and number formatting must be of the form `"[##:##:##:##]"`.
required: true
type: string
name:
description: The name of the keypad.
required: true
type: string
{% endconfiguration %}
The protocol for automatically extracting device information from the controller isn't documented. Lights and keypads need to be added manually. This is done by configuring the integration after it has been added.