jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated to new style configuration for keyboard_remote.markdown (#7316)

Browse Source
This commit is contained in:
Christoffer Graversen 2018-11-01 13:11:24 +01:00 committed by Franck Nijhof
parent d54499fc21
commit 3b8d84db50
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_components/keyboard_remote.markdown
View File

@ -25,11 +25,20 @@ keyboard_remote:
type: 'key_up'
```
Configuration variables:
- **type** (*Required*): Possible values are `key_up`, `key_down`, and `key_hold`. Be careful, `key_hold` will fire a lot of events.
- **device_descriptor** (*Optional*): Path to the local event input device file that corresponds to the keyboard.
- **device_name** (*Optional*): Name of the keyboard device.
{% configuration %}
type:
description: Possible values are `key_up`, `key_down`, and `key_hold`. Be careful, `key_hold` will fire a lot of events.
required: true
type: string
device_description:
description: Path to the local event input device file that corresponds to the keyboard.
required: false
type: string
device_name:
description: Name of the keyboard device.
required: false
type: string
{% endconfiguration %}
Either `device_name` or `device_descriptor` must be present in the configuration entry. Indicating a device name is useful in case of repeating disconnections and re-connections of the device (for example, a bluetooth keyboard): the local input device file might change, thus breaking the configuration, while the name remains the same.
In case of presence of multiple devices of the same model, `device_descriptor` must be used.