Skip to content

Commit

Permalink
Mention Stream Deck + support and rerender table in README (#188)
Browse files Browse the repository at this point in the history
  • Loading branch information
basnijholt authored Jun 9, 2024
1 parent 7d6497f commit 1a3738a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ With this Python script, you can control your Home Assistant instance via a Stre
- 🏠 Runs from same machine as Home Assistant
- 🚀 Template support for advanced customization
- 💤 Automatically sync state of `entity_id` to turn display on/off
- 🎛️ (NEW!) Stream Deck Plus with dial support

[[ToC](#books-table-of-contents)]

Expand Down Expand Up @@ -310,6 +311,7 @@ Each button can take the following configuration
|:----------------|:-------------------------------|:----------|:---------------|
| `name` | The name of the page. | | `str` |
| `buttons` | A list of buttons on the page. | | `List[Button]` |
| `dials` | A list of dials on the page. | | `List[Dial]` |

<!-- OUTPUT:END -->

Expand All @@ -326,6 +328,7 @@ Each button can take the following configuration
| Variable name | Allow template | Description | Default | Type |
|:------------------------|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:----------------------------------------------------------------------------------------------------------------|
| `entity_id` | ✅ | The `entity_id` that this button controls. This entitity will be passed to the `service` when the button is pressed. The button is re-rendered whenever the state of this entity changes. | | `Optional[str]` |
| `linked_entity` | ✅ | A secondary entity_id that is used for updating images and states | | `Optional[str]` |
| `service` | ✅ | The `service` that will be called when the button is pressed. | | `Optional[str]` |
| `service_data` | ✅ | The `service_data` that will be passed to the `service` when the button is pressed. If empty, the `entity_id` will be passed. | | `Optional[Mapping[str, Any]]` |
| `target` | ✅ | The `target` that will be passed to the `service` when the button is pressed. | | `Optional[Mapping[str, Any]]` |
Expand Down

0 comments on commit 1a3738a

Please sign in to comment.