diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 89e9a0c4129..802b288f4c2 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.knx) - [Scene](/components/scene.knx) -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To use your KNX in your installation, add the following lines to your `configuration.yaml` file: @@ -77,8 +77,8 @@ knx: ```yaml knx: - fire_event: True - fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] + fire_event: True + fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] ``` - **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus @@ -105,21 +105,20 @@ KNX component is able to expose time or sensor values to KNX bus. The component ```yaml # Example configuration.yaml entry knx: - expose: - - type: 'temperature' - entity_id: 'sensor.owm_temperature' - address: '0/0/2' - - type: 'time' - address: '0/0/1' - - type: 'datetime' - address: '0/0/23' + expose: + - type: 'temperature' + entity_id: 'sensor.owm_temperature' + address: '0/0/2' + - type: 'time' + address: '0/0/1' + - type: 'datetime' + address: '0/0/23' ``` * **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). * **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. * **address**: KNX group address. - ### {% linkable_title Known issues %} Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5. diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 4e0e7560801..4a229b62586 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -18,6 +18,8 @@ The `knx` light component is used as in interface to switching/light actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -31,8 +33,8 @@ light: Configuration variables: +- **address** (*Required*): KNX group address for switching the light on and off. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address for switching the light on and off. - **brightness_address** (Optional): KNX group address for dimming light. - **state_address** (*Optional*): separate KNX group address for retrieving the switch state of the light. - **brightness_state_address** (*Optional*): separate KNX group address for retrieving the dimmed state of the light. @@ -41,3 +43,4 @@ Configuration variables: Some KNX devices can change their state internally without any messages on the KNX 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. For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. + diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 78945fc3761..4e81f1e2362 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -17,6 +17,8 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -26,5 +28,8 @@ notify: address: '5/1/10' ``` +Configuration variables: + +* **address** (*Required*): KNX group address of the notification. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address of the notification + diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e77b6571811..c9752de20c3 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -16,6 +16,10 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + +To use your KNX scence in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry scene: @@ -27,8 +31,7 @@ scene: Configuration variables: +- **address** (*Required*): KNX group address of the binary sensor. +- **scene_number** (*Required*): KNX scene number to be activated. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the binary sensor. -- **scene_number** KNX scene number to be activated. - diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index f7e78920229..6e0921c341a 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -17,8 +17,26 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: +```yaml +# Example configuration.yaml entry +sensor: + - platform: knx + name: Heating.Valve1 + address: '2/0/0' +``` + + + +- **address** (*Required*): KNX group address of the sensor. +- **name** (*Optional*): A name for this device used within Home Assistant. +- **type** (*Optional*): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". + +## {% linkable_title Full example %} + ```yaml # Example configuration.yaml entry sensor: @@ -31,8 +49,3 @@ sensor: address: '6/2/1' type: 'temperature' ``` - -- **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the sensor. -- **type** (Optional): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". - diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index dbddf761518..92c04b6e4c2 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -18,6 +18,8 @@ The `knx` switch component is used as in interface to switching actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -26,12 +28,13 @@ switch: name: Kitchen.Coffee address: '1/1/6' ``` + +Configuration variables: + +* **address** (*Required*): KNX group address for switching the switch on/off. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address for switching the switch on/off -* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state. +* **state_address** (*Optional*): separate KNX group address for retrieving the switch state. Some KNX devices can change their state internally without any messages on the KNX 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. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. - -