Add Kira component documentation #2603
Conversation
| ha_release: 0.45 | ||
| --- | ||
|
|
||
| The `kira` component is the main component to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. |
There was a problem hiding this comment.
I would suggest you keep the name in the description and this the same.
source/_components/kira.markdown
Outdated
|
|
||
| The `kira` component is the main component to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. | ||
|
|
||
| An empty configuration will create a sensor using the default port that Kira modules use (UDP port 65432). |
There was a problem hiding this comment.
Suggest some rewording since configuration is in general the whole of the config file and can cause some confusion for non native English speakers.
If anything I would suggest that you skip this line instead since the example configuration is commonly copy and pasted as a start for most new users.
You cover later after the code snippet why and how so that explains it rather well anyway.
source/_components/kira.markdown
Outdated
| Configuration variables: | ||
| - **name** (*Required*): The name of this code | ||
| - **code** (*Required*): The data for this code (see below) | ||
| - **device** (*Optional*): The device this code is associated with. defualt is "unknown". |
There was a problem hiding this comment.
Spelling: default instead of defualt
source/_components/kira.markdown
Outdated
| ``` | ||
|
|
||
| Configuration variables: | ||
| - **name** (*Required*): The name of this code |
source/_components/kira.markdown
Outdated
|
|
||
| Configuration variables: | ||
| - **name** (*Required*): The name of this code | ||
| - **code** (*Required*): The data for this code (see below) |
source/_components/kira.markdown
Outdated
|
|
||
| ### {% linkable_title Code Types %} | ||
|
|
||
| When creating an entry in kira_codes.yaml, a few different kinds of codes can be used. |
There was a problem hiding this comment.
wrap kira_codes.yaml in ` to get kira_codes.yaml
source/_components/kira.markdown
Outdated
| - **pronto**: Pronto codes are supported. | ||
| - **nec**: If the device uses NEC IR codes and the manufacturer has published them, they can be used here. | ||
|
|
||
| **NOTE**: NEC codes by themselves do not contain enough information to construct an IR sequence for sending--so codes of this type are receive-only (usable by sensors but not remotes). |
There was a problem hiding this comment.
"sending--so" unsure what you where going for here.
source/_components/kira.markdown
Outdated
| layout: page | ||
| title: "Kira" | ||
| description: "Instructions how to integrate Keene Electronics IR-IP modules (Kira) into Home Assistant." | ||
| date: 2017-5-7 00:00 |
There was a problem hiding this comment.
date should be 2017-05-07 00:00
|
Thanks for the feedback! |
|
home-assistant/core#7479 has been merged into dev. |
Description:
Pull request in home-assistant (if applicable): home-assistant/core#7479