Skip to content

Commit

Permalink
docs: READEME update about custom key icon behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
Nerwyn committed Aug 3, 2023
1 parent e437462 commit 717cb12
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,13 @@ custom_keys:

Inside each button you may define `icon` and either `key`, `source` or `service`, as you've seen.

| Option | internal function | Description |
| ------------ | -------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| icon | | The icon to show in the button. If empty, the button will be blank. |
| key | `remote.send_command(command=key)` | The key to send to the TV via `remote.send_command` |
| source | `remote.turn_on(activity=source)` | The source to switch to via `remote.turn_on` |
| service | `_hass.callService(domain, service, service_data)` | A string representing service to call. Use the format `domain.service`, e.g. `"light.turn_on"` |
| service_data | passed with `service` | The data to pass to the service. May be an object depending on the service you are using. |
| Option | internal function | Description |
| ------------ | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| icon | | The icon to show in the button. If empty the original key or source icon will be used if it exists, otherwise it will be empty. |
| key | `remote.send_command(command=key)` | The key to send to the TV via `remote.send_command`. |
| source | `remote.turn_on(activity=source)` | The source to switch to via `remote.turn_on`. |
| service | `_hass.callService(domain, service, service_data)` | A string representing service to call. Use the format `domain.service`, e.g. `"light.turn_on"`. |
| service_data | passed with `service` | The data to pass to the service. May be an object depending on the service you are using. |

If an icon is not provided for a custom key or source that overwrites a predefined key or source, the original icon will be used instead.

Expand Down

0 comments on commit 717cb12

Please sign in to comment.