mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Updated documentation for KNX platform (#4575)
* Documentation for https://github.com/home-assistant/home-assistant/pull/11978 * typo
This commit is contained in:
parent
b1714a5bfc
commit
7c0ac4661f
@ -25,6 +25,7 @@ binary_sensor:
|
||||
address: '6/0/2'
|
||||
device_class: 'motion'
|
||||
#significant_bit: 2
|
||||
#reset_after: 100
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
@ -33,6 +34,7 @@ Configuration variables:
|
||||
- **address**: KNX group address 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.
|
||||
- **reset_after** (Optional): Reset back to OFF state after specified milliseconds.
|
||||
|
||||
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
|
||||
|
||||
|
@ -31,6 +31,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Light](/components/light.knx)
|
||||
- [Thermostat](/components/climate.knx)
|
||||
- [Notify](/components/notify.knx)
|
||||
- [Scene](/components/scene.knx)
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
@ -83,7 +84,6 @@ knx:
|
||||
- **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
|
||||
- **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
|
||||
- **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior.
|
||||
- **time_address** (*Optional*): Broadcast current local time to KNX bus with configured group address.
|
||||
|
||||
### {% linkable_title Services %}
|
||||
|
||||
@ -98,6 +98,27 @@ Service Data: {"address": "1/0/15", "payload": 0}
|
||||
* **address**: KNX group address
|
||||
* **payload**: Payload, either an integer or an array of integers
|
||||
|
||||
### {% linkable_title Exposing sensor values or time to knx bus %}
|
||||
|
||||
KNX component is able to expose time or sensor values to KNX bus. The component will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address:
|
||||
|
||||
```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'
|
||||
```
|
||||
|
||||
* **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 necessarry for types time and datetime.
|
||||
* **address**: KNX group address.
|
||||
|
||||
|
||||
### {% linkable_title Known issues %}
|
||||
|
||||
|
34
source/_components/scene.knx.markdown
Normal file
34
source/_components/scene.knx.markdown
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
layout: page
|
||||
title: "KNX Scene"
|
||||
description: "Instructions on how to integrate KNX Scenes into Home Assistant."
|
||||
date: 2018-02-03 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: knx.png
|
||||
ha_category: Scene
|
||||
ha_release: "0.63"
|
||||
---
|
||||
|
||||
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).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
scene:
|
||||
- name: Romantic
|
||||
platform: knx
|
||||
address: 8/8/8
|
||||
scene_number: 23
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **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.
|
||||
|
||||
|
@ -34,5 +34,5 @@ sensor:
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **address**: KNX group address of the sensor.
|
||||
- **type** (Optional): "percent", "temperature", "illuminance", "speed_ms", "current".
|
||||
- **type** (Optional): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed".
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user