Documentation for KNX component #3298
Conversation
|
@Julius2342, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @daBONDi and @tiktok7 to be potential reviewers. |
|
Quick look at the documentation and found a couple of spelling & grammar issues. |
|
@frenck : thank you very much. Will also read it again later today. |
There was a problem hiding this comment.
@Julius2342 Could you please take a look at my comments? Don't worry, they are all pretty minor 😸
| #significant_bit: 2 | ||
| ``` | ||
|
|
||
| * **name** (*Optional*): A name for this devices used within Home Assistant. |
There was a problem hiding this comment.
Spelling & Grammar:
devices->device
| ``` | ||
|
|
||
| * **name** (*Optional*): A name for this devices used within Home Assistant. | ||
| * **address**: KNX group address of binary sensor |
There was a problem hiding this comment.
Spelling & Grammar:
of binary sensor->of the binary sensor
| * **device_class**: (Optional) HASS device class e.g. "motion" | ||
| * **significant_bit**: (Optional) Specify which significant bit of the KNX value should be used. Default is 1. | ||
|
|
||
| You can also attach actions to binary sensors (e.g. to switch on a light when a switch was pressed). In this example I switch on one light when the button was pressed once and two others when the button was pressed a second time. |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
e.g.->(e.g., to switch - Missing comma after
example->In this example, I switch on - Please remove reference to documentation author, since the author is unknown to the reader;
I switch on one light. (In generic, avoid:I,mine, etc).
| service: homeassistant.turn_on | ||
| ``` | ||
|
|
||
| - **name** (*Optional*): A name for this devices used within Home Assistant. |
There was a problem hiding this comment.
Spelling & Grammar:
devices->device
| ``` | ||
|
|
||
| - **name** (*Optional*): A name for this devices used within Home Assistant. | ||
| - **counter**: (*Optional*) Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for 3 times button pressed. Defaults to 1. |
There was a problem hiding this comment.
Spelling & Grammar:
To 3 for 3 times->To 3 for three times
| ``` | ||
|
|
||
| Configuration variables: | ||
| * **name** (*Optional*): A name for this devices used within Home Assistant. |
There was a problem hiding this comment.
Spelling & Grammar:
this devices->this device
| ``` | ||
|
|
||
| Configuration variables: | ||
| * **name** (*Optional*): A name for this devices used within Home Assistant. | ||
| * **address**: KNX group address of sensor |
There was a problem hiding this comment.
Spelling & Grammar:
of sensor->of the sensor
| ``` | ||
| * **name** (*Optional*): A name for this devices used within Home Assistant. |
There was a problem hiding this comment.
Spelling & Grammar:
this devices->this device
| ``` | ||
| * **name** (*Optional*): A name for this devices used within Home Assistant. | ||
| * **address**: KNX group address for switching switch on/off |
There was a problem hiding this comment.
Spelling & Grammar:
switching switch on/off->switching the switch on/off
| - **name** (*Optional*): A name for this devices used within Home assistant | ||
| - **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel | ||
| - **state_address** (*Optional*): Some KNX devices can change their state internally without any messages on the KXN bus, e.g. if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. | ||
| Some KNX devices can change their state internally without any messages on the KXN bus, e.g. if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
e.g.->bus, e.g., if you
|
@frenck : fixed all requested changes. Thank you very much! |
|
Thanks, @Julius2342! 🥇 |
Description:
Pull request in home-assistant (if applicable): home-assistant/core#8725