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-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2020-09-24 16:46:51 +02:00
commit c69644ae58
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
37 changed files with 1210 additions and 998 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Gemfile.lock
View File

@ -20,7 +20,7 @@ GEM
compass-import-once (1.0.5)
sass (>= 3.2, < 3.5)
concurrent-ruby (1.1.7)
em-websocket (0.5.1)
em-websocket (0.5.2)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)

4
_config.yml
View File

@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 115
current_patch_version: 1
date_released: 2020-09-18
current_patch_version: 2
date_released: 2020-09-19
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

2
source/_docs/automation/trigger.markdown
View File

@ -479,7 +479,7 @@ automation:
You can run this automation by sending an HTTP POST request to `http://your-home-assistant:8123/api/webhook/some_hook_id`. Here is an example using the **curl** command line program, with an empty data payload:
```shell
curl -d "" https://your-home-assistant:8123/api/webhook/some_hook_id
curl -X POST https://your-home-assistant:8123/api/webhook/some_hook_id
```
Webhook endpoints don't require authentication, other than knowing a valid webhook ID. You can send a data payload, either as encoded form data or JSON data. The payload is available in an automation template as either `trigger.json` or `trigger.data`. URL query parameters are available in the template as `trigger.query`. Remember to use an HTTPS URL if you've secured your Home Assistant installation with SSL/TLS.

10
source/_docs/installation.markdown
View File

@ -53,8 +53,8 @@ The only installation methods that allow you to use Home Assistant Add-ons is us
**Method**|**You have**|**Recommended for**
:-----|:-----|:-----
[Home Assistant](/hassio/installation/)|Raspberry Pi<br>VM|Anybody
[Docker](/docs/installation/docker/)|Docker|Anybody already running Docker
[Home Assistant OS](/hassio/installation/)|[A supported platform](/hassio/installation/)|Anybody
[Home Assistant Container](/docs/installation/docker/)|Docker|Anybody already running Docker
## Alternative installs
@ -62,9 +62,9 @@ If you use these install methods, we assume that you know how to manage and admi
**Method**|**You have**|**Recommended for**
:-----|:-----|:-----
[venv<BR>(as another user)](/docs/installation/raspberry-pi/)|Any Linux, Python 3.7 or later|Those familiar with their operating system
[venv<BR>(as your user)](/docs/installation/virtualenv/)|Any Python 3.7 or later|Developers
[Supervised](https://github.com/home-assistant/supervised-installer) | [Requirements](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md#supported-operating-system-system-dependencies-and-versions) | Those very familiar with their operating system
[Home Assistant Core](/docs/installation/raspberry-pi/)|Any Linux, Python 3.7.1 or later|Those familiar with their operating system
[Home Assistant Supervised](https://github.com/home-assistant/supervised-installer) | [Requirements](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md#supported-operating-system-system-dependencies-and-versions) | Those very familiar with their operating system
[venv<BR>(as your user)](/docs/installation/virtualenv/)|Any Python 3.7.1 or later|**Developers**
## Community provided guides

2
source/_docs/installation/raspberry-pi.markdown
View File

@ -41,7 +41,7 @@ sudo apt-get upgrade -y
Install the dependencies.
```bash
sudo apt-get install python3 python3-dev python3-venv python3-pip libffi-dev libssl-dev autoconf build-essential
sudo apt-get install python3 python3-dev python3-venv python3-pip libffi-dev libssl-dev autoconf build-essential libopenjp2-7
```
Add an account for Home Assistant Core called `homeassistant`.

2
source/_docs/installation/virtualenv.markdown
View File

@ -12,7 +12,7 @@ It's recommended when installing Python packages that you use a [virtual environ
This is a generic guide for running Home Assistant under Python. We recommend to use [our recommended installation guides](/docs/installation/#recommended). The steps below may be shorter but some users find difficulty when applying updates and may run into issues.
Before you begin the guide below, ensure that you have a *so-called standard* build environment that includes things like `make`, `gcc`, `python3`, including Python 3 `setuptools` and `pip` modules. Less obvious is the need to install `openssl-dev` (for opensslv.h) and `libffi-dev` (for cffi.h) for things to build later on.
Before you begin the guide below, ensure that you have a *so-called standard* build environment that includes things like `make`, `gcc`, `python3`, including Python 3 `setuptools` and `pip` modules. Less obvious is the need to install `openssl-dev` (for opensslv.h), `libffi-dev` (for cffi.h) for things to build later on, `libopenjp2-7` and `libtiff5` needed for the frontend.
</div>

2
source/_docs/scripts/service-calls.markdown
View File

@ -42,7 +42,7 @@ A full list of the parameters for a service can be found on the documentation pa
You can use [templating] support to dynamically choose which service to call. For example, you can call a certain service based on if a light is on.
```yaml
service_template: >
service: >
{% raw %}{% if states('sensor.temperature') | float > 15 %}
switch.turn_on
{% else %}

4
source/_integrations/airvisual.markdown
View File

@ -37,7 +37,9 @@ The integration can communicate to Node/Pro units over the local network. You wi
## Configuration
To enable the integration and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
Home Assistant offers AirVisual Node/Pro Unit integration through **Configuration -> Integrations -> AirVisual**. Choose "Integration Type: AirVisual Node/Pro" and follow the instructions to get it set up.
The Cloud API integration can be done via the Integrations UI at **Configuration -> Integrations -> AirVisual** (Choose "Integration Type: Geographical Location") or via YAML. To enable the integration and gather data via latitude/longitude using YAML, add the following lines to your `configuration.yaml` file:
```yaml
airvisual:

94
source/_integrations/binary_sensor.knx.markdown
View File

@ -1,94 +0,0 @@
---
title: "KNX Binary Sensor"
description: "Instructions on how to setup the KNX binary sensors within Home Assistant."
ha_category:
- Binary Sensor
ha_release: 0.24
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
## Configuration
To use your binary sensors please add the relevant configuration to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
binary_sensor:
- name: sensor1
state_address: '6/0/2'
```
{% configuration %}
state_address:
description: KNX group address of the binary sensor. *DPT 1*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false
type: [boolean, string, integer]
default: True
device_class:
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false
type: string
reset_after:
description: Reset back to OFF state after specified milliseconds.
required: false
type: integer
{% endconfiguration %}
### Automation actions
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.
```yaml
# Example configuration.yaml entry
knx:
binary_sensor:
- name: Livingroom.3Switch3
state_address: '5/0/26'
automation:
- counter: 1
hook: 'on'
action:
- entity_id: light.hue_color_lamp_1
service: homeassistant.turn_on
- counter: 2
hook: 'on'
action:
- entity_id: light.hue_bloom_1
service: homeassistant.turn_on
- entity_id: light.hue_bloom_2
service: homeassistant.turn_on
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
type: string
counter:
description: Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed.
required: false
type: integer
default: 1
hook:
description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off".
required: false
type: string
default: "on"
action:
description: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
required: false
type: list
{% endconfiguration %}

2
source/_integrations/broadlink.markdown
View File

@ -288,7 +288,7 @@ First get or learn all the remotes you want to add to Home Assistant in e-Contro
1. Download
Get the script from [here](https://github.com/NightRang3r/Broadlink-e-control-db-dump).
Get the script from [here](https://github.com/clach04/Broadlink-e-control-db-dump).
2. Dump the data from the app

231
source/_integrations/climate.knx.markdown
View File

@ -1,231 +0,0 @@
---
title: "KNX Climate"
description: "Instructions on how to integrate KNX thermostats with Home Assistant."
ha_category:
- Climate
ha_release: 0.25
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` climate platform is used as an interface to KNX thermostats and room controllers.
To use your KNX thermostats in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
operation_mode_state_address: '5/1/6'
```
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
```
If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp`
attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address`
to the configuration in this case.:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/2'
target_temperature_address: '5/1/4'
target_temperature_state_address: '5/1/1'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
operation_mode_standby_address: '5/1/9'
min_temp: 7.0
max_temp: 32.0
```
`setpoint_shift_mode` allows the two following DPTs to be used:
- DPT6.002 (for 1 byte signed integer)
- DPT9.002 (for 2 byte float)
Example:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
setpoint_shift_mode: 'DPT9002'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
operation_mode_state_address: '5/1/6'
```
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified.
If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant.
The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`:
- 0 (cooling)
- 1 (heating)
The following values are valid for the `hvac_mode` attribute:
- Off (maps internally to HVAC_MODE_OFF within Home Assistant)
- Auto (maps internally to HVAC_MODE_AUTO within Home Assistant)
- Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant)
- Cool (maps internally to HVAC_MDOE_COOL within Home Assistant)
- Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant)
- Dry (maps internally to HVAC_MODE_DRY within Home Assistant)
The following presets are valid for the `preset_mode` attribute:
- Comfort (maps internally to PRESET_COMFORT within Home Assistant)
- Standby (maps internally to PRESET_AWAY within Home Assistant)
- Night (maps internally to PRESET_SLEEP within Home Assistant)
- Frost Protection (maps internally to PRESET_ECO within Home Assistant)
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Climate
type: string
temperature_address:
description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001*
required: true
type: string
temperature_step:
description: Defines the step size in Kelvin for each step of setpoint_shift.
required: false
type: float
default: 0.1
target_temperature_address:
description: KNX group address for setting target temperature. *DPT 9.001*
required: false
type: string
target_temperature_state_address:
description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001*
required: true
type: string
setpoint_shift_address:
description: KNX address for setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode*
required: false
type: string
setpoint_shift_state_address:
description: KNX address for reading setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode*
required: false
type: string
setpoint_shift_mode:
description: Defines the internal device DPT used.
required: false
default: 0.5
type: string
default: DPT6010
setpoint_shift_min:
description: Minimum value of setpoint shift.
required: false
default: -6
type: float
setpoint_shift_max:
description: Maximum value of setpoint shift.
required: false
default: 6
type: float
operation_mode_address:
description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102*
required: false
type: string
operation_mode_state_address:
description: KNX address for reading operation mode. *DPT 20.102*
required: false
type: string
controller_status_address:
description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3).
required: false
type: string
controller_status_state_address:
description: KNX address for reading HVAC controller status.
required: false
type: string
controller_mode_address:
description: KNX address for setting HVAC controller modes. *DPT 20.105*
required: false
type: string
controller_mode_state_address:
description: KNX address for reading HVAC Control Mode. *DPT 20.105*
required: false
type: string
heat_cool_address:
description: KNX address for switching between heat/cool mode. *DPT 1.100*
required: false
type: string
heat_cool_state_address:
description: KNX address for reading heat/cool mode. *DPT 1.100*
required: false
type: string
operation_mode_frost_protection_address:
description: KNX address for switching on/off frost/heat protection mode. *DPT 1*
required: false
type: string
operation_mode_night_address:
description: KNX address for switching on/off night mode. *DPT 1*
required: false
type: string
operation_mode_comfort_address:
description: KNX address for switching on/off comfort mode. *DPT 1*
required: false
type: string
operation_mode_standby_address:
description: KNX address for switching on/off standby mode. *DPT 1*
required: false
type: string
operation_modes:
description: Overrides the supported operation modes. Provide the supported `hvac_mode` and `preset_mode` values for your device.
required: false
type: list
on_off_address:
description: KNX address for switching the climate device on/off. *DPT 1*
required: false
type: string
on_off_invert:
description: Value for switching the climate device on/off is inverted.
required: false
default: false
type: boolean
on_off_state_address:
description: KNX address for gathering the current state (on/off) of the climate device. *DPT 1*
required: false
type: string
min_temp:
description: Override the minimum temperature.
required: false
type: float
max_temp:
description: Override the maximum temperature.
required: false
type: float
{% endconfiguration %}

83
source/_integrations/cover.knx.markdown
View File

@ -1,83 +0,0 @@
---
title: "KNX Cover"
description: "Instructions on how to integrate KNX covers with Home Assistant."
ha_category:
- Cover
ha_release: 0.48
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` cover platform is used as an interface to KNX covers.
To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
cover:
- name: "Kitchen.Shutter"
move_long_address: '3/0/0'
move_short_address: '3/0/1'
stop_address: '3/0/4'
position_address: '3/0/3'
position_state_address: '3/0/2'
travelling_time_down: 51
travelling_time_up: 61
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Cover
type: string
move_long_address:
description: KNX group address for moving the cover full up or down. *DPT 1*
required: false
type: string
move_short_address:
description: KNX group address for moving the cover short time up or down. *DPT 1*
required: false
type: string
stop_address:
description: KNX group address for stopping the current movement from the cover. *DPT 1*
required: false
type: string
position_address:
description: KNX group address for moving the cover to the dedicated position. *DPT 5.001*
required: false
type: string
position_state_address:
description: Separate KNX group address for requesting the current position of the cover. *DPT 5.001*
required: false
type: string
angle_address:
description: KNX group address for moving the cover to the dedicated angle. *DPT 5.001*
required: false
type: string
angle_state_address:
description: Separate KNX group address for requesting the current angle of cover. *DPT 5.001*
required: false
type: string
travelling_time_down:
description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
travelling_time_up:
description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
invert_position:
description: Set this to true if your actuator report fully closed as 0% in KNX.
required: false
default: false
type: boolean
invert_angle:
description: Set this to true if your actuator reports tilt fully closed as 0% in KNX.
required: false
default: false
type: boolean
{% endconfiguration %}

2
source/_integrations/google_assistant.markdown
View File

@ -53,7 +53,7 @@ You will need to create a service account [Create Service account key](https://c
<img src='/images/integrations/google_assistant/accountlinking.png' alt='Screenshot: Account linking'>
3. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App.
3. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App. If you don't see this option, go to the `Test` tab instead, click on the `Settings` button in the top right below the header, and ensure `On device testing` is enabled (if it isn't, enable it).
4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below.
5. (Note that app versions may be slightly different.) Open the Google Home app and go to `Settings`.
6. Click `Add...`, `+ Set up or add`, `+ Set up device`, and click `Have something already setup?`. You should have `[test] your app name` listed under 'Add new'. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.

2
source/_integrations/html5.markdown
View File

@ -103,7 +103,7 @@ The `html5` platform can only function if all of the following requirements are
Assuming you have already configured the platform:
1. Open Home Assistant in Chrome or Firefox.
2. Load profile page by clicking on the badge next to the Home Assistant title in the sidebar. Assuming you have met all the [requirements](#requirements) above then you should see a new slider for Push Notifications. If the slider is greyed out, ensure you are viewing Home Assistant via its external HTTPS address. If the slider is not visible, ensure you are not in the user configuration (Sidebar, Configuration, Users, View User).
2. Load profile page by clicking on the badge next to the Home Assistant title in the sidebar. Assuming you have met all the [requirements](#requirements) above then you should see a new slider for Push Notifications. If the slider is greyed out, ensure you are viewing Home Assistant via its external HTTPS address (and that you have configured the `notify` HTML5 integration in Home Assistant). If the slider is not visible, ensure you are not in the user configuration (Sidebar, Configuration, Users, View User).
3. Slide it to the on position.
4. Name the device you're using in the alert that appears.
5. Within a few seconds you should be prompted to allow notifications from Home Assistant.

2
source/_integrations/huawei_lte.markdown
View File

@ -164,5 +164,7 @@ Devices we know to be working with this integration based on the [documentation
- Huawei B525s-23a
- Huawei E5186s-22a
- Huawei B618
- Huawei B529s-23a
- Huawei B535s
This is not a complete list. The integration can probably connect to other Huawei LTE devices running similar firmware.

4
source/_integrations/influxdb.markdown
View File

@ -122,7 +122,7 @@ exclude:
required: false
entity_globs:
type: [string, list]
description: Include all entities matching a listed pattern.
description: Exclude all entities matching a listed pattern.
required: false
domains:
type: [string, list]
@ -139,7 +139,7 @@ include:
required: false
entity_globs:
type: [string, list]
description: Exclude all entities matching a listed pattern.
description: Include all entities matching a listed pattern.
required: false
domains:
type: [string, list]

927
source/_integrations/knx.markdown
View File

@ -3,6 +3,15 @@ title: KNX
description: Instructions on how to integrate KNX components with Home Assistant.
ha_category:
- Hub
- Binary Sensor
- Climate
- Cover
- Light
- Notify
- Scene
- Sensor
- Switch
- Weather
ha_release: 0.24
ha_iot_class: Local Push
ha_codeowners:
@ -24,16 +33,15 @@ Please note, the `knx` platform does not support KNX Secure.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/integrations/binary_sensor.knx)
- [Climate](/integrations/climate.knx)
- [Cover](/integrations/cover.knx)
- [Light](/integrations/light.knx)
- [Notify](/integrations/notify.knx)
- [Scene](/integrations/scene.knx)
- [Sensor](/integrations/sensor.knx)
- [Switch](/integrations/switch.knx)
- [Weather](/integrations/weather.knx)
- [Binary Sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- [Light](#light)
- [Notify](#notify)
- [Scene](#scene)
- [Sensor](#sensor)
- [Switch](#switch)
- [Weather](#weather)
## Basic Configuration
@ -223,3 +231,902 @@ address:
type: string
required: true
{% endconfiguration %}
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
## Binary Sensor
To use your binary sensors please add the relevant configuration to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
binary_sensor:
- name: sensor1
state_address: '6/0/2'
```
{% configuration %}
state_address:
description: KNX group address of the binary sensor. *DPT 1*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false
type: [boolean, string, integer]
default: True
device_class:
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false
type: string
reset_after:
description: Reset back to OFF state after specified milliseconds.
required: false
type: integer
{% endconfiguration %}
### Automation actions
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.
```yaml
# Example configuration.yaml entry
knx:
binary_sensor:
- name: Livingroom.3Switch3
state_address: '5/0/26'
automation:
- counter: 1
hook: 'on'
action:
- entity_id: light.hue_color_lamp_1
service: homeassistant.turn_on
- counter: 2
hook: 'on'
action:
- entity_id: light.hue_bloom_1
service: homeassistant.turn_on
- entity_id: light.hue_bloom_2
service: homeassistant.turn_on
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
type: string
counter:
description: Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed.
required: false
type: integer
default: 1
hook:
description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off".
required: false
type: string
default: "on"
action:
description: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
required: false
type: list
{% endconfiguration %}
## Climate
The `knx` climate platform is used as an interface to KNX thermostats and room controllers.
To use your KNX thermostats in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
operation_mode_state_address: '5/1/6'
```
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
```
If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp`
attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address`
to the configuration in this case.:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/2'
target_temperature_address: '5/1/4'
target_temperature_state_address: '5/1/1'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
operation_mode_standby_address: '5/1/9'
min_temp: 7.0
max_temp: 32.0
```
`setpoint_shift_mode` allows the two following DPTs to be used:
- DPT6.002 (for 1 byte signed integer)
- DPT9.002 (for 2 byte float)
Example:
```yaml
# Example configuration.yaml entry
knx:
climate:
- name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
setpoint_shift_mode: 'DPT9002'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
operation_mode_state_address: '5/1/6'
```
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified.
If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant.
The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`:
- 0 (cooling)
- 1 (heating)
The following values are valid for the `hvac_mode` attribute:
- Off (maps internally to HVAC_MODE_OFF within Home Assistant)
- Auto (maps internally to HVAC_MODE_AUTO within Home Assistant)
- Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant)
- Cool (maps internally to HVAC_MDOE_COOL within Home Assistant)
- Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant)
- Dry (maps internally to HVAC_MODE_DRY within Home Assistant)
The following presets are valid for the `preset_mode` attribute:
- Comfort (maps internally to PRESET_COMFORT within Home Assistant)
- Standby (maps internally to PRESET_AWAY within Home Assistant)
- Night (maps internally to PRESET_SLEEP within Home Assistant)
- Frost Protection (maps internally to PRESET_ECO within Home Assistant)
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Climate
type: string
temperature_address:
description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001*
required: true
type: string
temperature_step:
description: Defines the step size in Kelvin for each step of setpoint_shift.
required: false
type: float
default: 0.1
target_temperature_address:
description: KNX group address for setting target temperature. *DPT 9.001*
required: false
type: string
target_temperature_state_address:
description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001*
required: true
type: string
setpoint_shift_address:
description: KNX address for setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode*
required: false
type: string
setpoint_shift_state_address:
description: KNX address for reading setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode*
required: false
type: string
setpoint_shift_mode:
description: Defines the internal device DPT used.
required: false
default: 0.5
type: string
default: DPT6010
setpoint_shift_min:
description: Minimum value of setpoint shift.
required: false
default: -6
type: float
setpoint_shift_max:
description: Maximum value of setpoint shift.
required: false
default: 6
type: float
operation_mode_address:
description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102*
required: false
type: string
operation_mode_state_address:
description: KNX address for reading operation mode. *DPT 20.102*
required: false
type: string
controller_status_address:
description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3).
required: false
type: string
controller_status_state_address:
description: KNX address for reading HVAC controller status.
required: false
type: string
controller_mode_address:
description: KNX address for setting HVAC controller modes. *DPT 20.105*
required: false
type: string
controller_mode_state_address:
description: KNX address for reading HVAC Control Mode. *DPT 20.105*
required: false
type: string
heat_cool_address:
description: KNX address for switching between heat/cool mode. *DPT 1.100*
required: false
type: string
heat_cool_state_address:
description: KNX address for reading heat/cool mode. *DPT 1.100*
required: false
type: string
operation_mode_frost_protection_address:
description: KNX address for switching on/off frost/heat protection mode. *DPT 1*
required: false
type: string
operation_mode_night_address:
description: KNX address for switching on/off night mode. *DPT 1*
required: false
type: string
operation_mode_comfort_address:
description: KNX address for switching on/off comfort mode. *DPT 1*
required: false
type: string
operation_mode_standby_address:
description: KNX address for switching on/off standby mode. *DPT 1*
required: false
type: string
operation_modes:
description: Overrides the supported operation modes. Provide the supported `hvac_mode` and `preset_mode` values for your device.
required: false
type: list
on_off_address:
description: KNX address for switching the climate device on/off. *DPT 1*
required: false
type: string
on_off_invert:
description: Value for switching the climate device on/off is inverted.
required: false
default: false
type: boolean
on_off_state_address:
description: KNX address for gathering the current state (on/off) of the climate device. *DPT 1*
required: false
type: string
min_temp:
description: Override the minimum temperature.
required: false
type: float
max_temp:
description: Override the maximum temperature.
required: false
type: float
{% endconfiguration %}
## Cover
The `knx` cover platform is used as an interface to KNX covers.
To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
cover:
- name: "Kitchen.Shutter"
move_long_address: '3/0/0'
move_short_address: '3/0/1'
stop_address: '3/0/4'
position_address: '3/0/3'
position_state_address: '3/0/2'
travelling_time_down: 51
travelling_time_up: 61
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Cover
type: string
move_long_address:
description: KNX group address for moving the cover full up or down. *DPT 1*
required: false
type: string
move_short_address:
description: KNX group address for moving the cover short time up or down. *DPT 1*
required: false
type: string
stop_address:
description: KNX group address for stopping the current movement from the cover. *DPT 1*
required: false
type: string
position_address:
description: KNX group address for moving the cover to the dedicated position. *DPT 5.001*
required: false
type: string
position_state_address:
description: Separate KNX group address for requesting the current position of the cover. *DPT 5.001*
required: false
type: string
angle_address:
description: KNX group address for moving the cover to the dedicated angle. *DPT 5.001*
required: false
type: string
angle_state_address:
description: Separate KNX group address for requesting the current angle of cover. *DPT 5.001*
required: false
type: string
travelling_time_down:
description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
travelling_time_up:
description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
invert_position:
description: Set this to true if your actuator report fully closed as 0% in KNX.
required: false
default: false
type: boolean
invert_angle:
description: Set this to true if your actuator reports tilt fully closed as 0% in KNX.
required: false
default: false
type: boolean
{% endconfiguration %}
## Light
The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as:
- switching actuators
- dimming actuators
- LED controllers
- DALI gateways
### Configuration
To use your KNX light in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
light:
- name: 'kitchen'
address: '1/0/9'
```
{% configuration %}
address:
description: KNX group address for switching the light on and off. *DPT 1.001*
required: true
type: string
state_address:
description: KNX group address for retrieving the switch state of the light. *DPT 1.001*
required: false
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
brightness_address:
description: KNX group address for setting the brightness of the light in percent (absolute dimming). *DPT 5.001*
required: false
type: string
brightness_state_address:
description: KNX group address for retrieving the brightness of the light in percent. *DPT 5.001*
required: false
type: string
color_address:
description: KNX group address for setting the RGB color of the light. *DPT 232.600*
required: false
type: string
color_state_address:
description: KNX group address for retrieving the RGB color of the light. *DPT 232.600*
required: false
type: string
rgbw_address:
description: KNX group address for setting the RGBW color of the light. *DPT 251.600*
required: false
type: string
rgbw_state_address:
description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600*
required: false
type: string
color_temperature_address:
description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode*
required: false
type: string
color_temperature_state_address:
description: KNX group address for retrieving the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode*
required: false
type: string
color_temperature_mode:
description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
required: false
type: string
default: absolute
min_kelvin:
description: Warmest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*)
required: false
type: integer
default: 2700
max_kelvin:
description: Coldest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*)
required: false
type: integer
default: 6000
{% endconfiguration %}
Many KNX devices can change their state internally without a message to the switch address on the KNX bus, e.g., if you configure a scene or 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` (in most cases from the light actuator), it will overwrite the state of the switch object.
For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set `state_address` to the same value as `address`.
*Note on tunable white:* Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior.
## Extended configuration example
```yaml
knx:
light:
# dimmable light
- name: Bedroom-Light-1
address: '1/0/9'
state_address: '1/1/9'
brightness_address: '1/2/9'
brightness_state_address: '1/3/9'
#
# RGB light
- name: Bathroom-Light-1
address: '1/0/9'
state_address: '1/1/9'
brightness_address: '1/2/9'
brightness_state_address: '1/3/9'
color_address: '1/4/9'
color_state_address: '1/5/9'
#
# tunable white light
- name: Office-Light-1
address: '1/0/21'
state_address: '1/1/21'
brightness_address: '1/2/21'
brightness_state_address: '1/3/21'
color_temperature_address: '1/4/21'
color_temperature_state_address: '1/5/21'
color_temperature_mode: absolute
min_kelvin: 2550
max_kelvin: 6200
#
# actuator without dedicated state communication object
- name: Cellar-Light-1
address: '1/0/5'
state_address: '1/0/5'
```
## Notify
The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices.
### Configuration
To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
notify:
- name: Alarm
address: '5/1/10'
```
{% configuration %}
address:
description: KNX group address of the notification. *DPT 16.000*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
{% endconfiguration %}
The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes.
## Scene
### Configuration
To use your KNX scene in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
scene:
- name: Romantic
address: 8/8/8
scene_number: 23
```
{% configuration %}
address:
description: KNX group address for the scene. *DPT 17.001*
required: true
type: string
scene_number:
description: KNX scene number to be activated. ( 1 ... 64 )
required: true
type: integer
name:
description: A name for this device used within Home Assistant.
required: false
type: string
{% endconfiguration %}
## Sensor
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors.
Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
### Configuration
To use your KNX sensor in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
```
In order to actively read the sensor data from the bus all 30 seconds you can add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
sync_state: expire 30
```
{% configuration %}
state_address:
description: KNX group address of the sensor.
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false
type: [boolean, string, integer]
default: True
type:
description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly.
required: true
type: string
{% endconfiguration %}
| KNX DPT | type | size in byte | range | unit |
|--------:|-------------------------------|-------------:|:--------------------------:|----------------|
| 5.001 | percent | 1 | 0 ... 100 | % |
| 5.003 | angle | 1 | 0 ... 360 | ° |
| 5.004 | percentU8 | 1 | 0 ... 255 | % |
| 5.010 | pulse | 1 | 0 ... 255 | |
| 5.010 | 1byte_unsigned | 1 | 0 ... 255 | |
| 6.001 | percentV8 | 1 | -128 ... 127 | % |
| 6.010 | counter_pulses | 1 | -128 ... 127 | counter pulses |
| 7.001 | 2byte_unsigned | 2 | 0 ... 65535 | pulses |
| 7.002 | time_period_msec | 2 | 0 ... 65535 | ms |
| 7.003 | time_period_10msec | 2 | 0 ... 65535 | ms |
| 7.004 | time_period_100msec | 2 | 0 ... 65535 | ms |
| 7.005 | time_period_sec | 2 | 0 ... 65535 | s |
| 7.006 | time_period_min | 2 | 0 ... 65535 | min |
| 7.007 | time_period_hrs | 2 | 0 ... 65535 | h |
| 7.011 | length_mm | 2 | 0 ... 65535 | mm |
| 7.012 | current | 2 | 0 ... 65535 | mA |
| 7.013 | brightness | 2 | 0 ... 65535 | lx |
| 7.600 | color_temperature | 2 | 0 ... 65535 | K |
| 8.001 | 2byte_signed | 2 | -32768 ... 32767 | pulses |
| 8.002 | delta_time_ms | 2 | -32768 ... 32767 | ms |
| 8.005 | delta_time_sec | 2 | -32768 ... 32767 | s |
| 8.006 | delta_time_min | 2 | -32768 ... 32767 | min |
| 8.007 | delta_time_hrs | 2 | -32768 ... 32767 | h |
| 8.010 | percentV16 | 2 | -32768 ... 32767 | % |
| 8.011 | rotation_angle | 2 | -32768 ... 32767 | ° |
| 9.* | enthalpy | 2 | -671088.64 ... 670760.96 | H |
| 9.001 | temperature | 2 | -273 ... 670760 | °C |
| 9.002 | temperature_difference_2byte | 2 | -670760 ... 670760 | K |
| 9.003 | temperature_a | 2 | -670760 ... 670760 | K/h |
| 9.004 | illuminance | 2 | 0 ... 670760 | lx |
| 9.005 | wind_speed_ms | 2 | 0 ... 670760 | m/s |
| 9.006 | pressure_2byte | 2 | 0 ... 670760 | Pa |
| 9.007 | humidity | 2 | 0 ... 670760 | % |
| 9.008 | ppm | 2 | -671088.64 ... 670760.96 | ppm |
| 9.010 | time_1 | 2 | -670760 ... 670760 | s |
| 9.011 | time_2 | 2 | -670760 ... 670760 | ms |
| 9.020 | voltage | 2 | -671088.64 ... 670760.96 | mV |
| 9.022 | power_density | 2 | -671088.64 ... 670760.96 | W/m² |
| 9.023 | kelvin_per_percent | 2 | -671088.64 ... 670760.96 | K/% |
| 9.024 | power_2byte | 2 | -671088.64 ... 670760.96 | kW |
| 9.025 | volume_flow | 2 | -671088.64 ... 670760.96 | l/h |
| 9.026 | rain_amount | 2 | -671088.64 ... 670760.96 | l/m² |
| 9.027 | temperature_f | 2 | -459.6 ... 670760 | °F |
| 9.028 | wind_speed_kmh | 2 | 0 ... 670760 | km/h |
| 12.*** | 4byte_unsigned | 4 | 0 ... 4294967295 | |
| 13.*** | 4byte_signed | 4 | -2147483648 ... 2147483647 | |
| 13.002 | flow_rate_m3h | 4 | -2147483648 ... 2147483647 | m³/h |
| 13.010 | active_energy | 4 | -2147483648 ... 2147483647 | Wh |
| 13.011 | apparant_energy | 4 | -2147483648 ... 2147483647 | VAh |
| 13.012 | reactive_energy | 4 | -2147483648 ... 2147483647 | VARh |
| 13.013 | active_energy_kwh | 4 | -2147483648 ... 2147483647 | kWh |
| 13.014 | apparant_energy_kvah | 4 | -2147483648 ... 2147483647 | kVAh |
| 13.015 | reactive_energy_kvarh | 4 | -2147483648 ... 2147483647 | kVARh |
| 13.100 | long_delta_timesec | 4 | -2147483648 ... 2147483647 | s |
| 14.000 | acceleration | 4 | | m/s² |
| 14.*** | 4byte_float | 4 | | |
| 14.001 | acceleration_angular | 4 | | rad/s² |
| 14.002 | activation_energy | 4 | | J/mol |
| 14.003 | activity | 4 | | s⁻¹ |
| 14.004 | mol | 4 | | mol |
| 14.005 | amplitude | 4 | | |
| 14.006 | angle_rad | 4 | | rad |
| 14.007 | angle_deg | 4 | | ° |
| 14.008 | angular_momentum | 4 | | J s |
| 14.009 | angular_velocity | 4 | | rad/s |
| 14.010 | area | 4 | | m² |
| 14.011 | capacitance | 4 | | F |
| 14.012 | charge_density_surface | 4 | | C/m² |
| 14.013 | charge_density_volume | 4 | | C/m³ |
| 14.014 | compressibility | 4 | | m²/N |
| 14.015 | conductance | 4 | | S |
| 14.016 | electrical_conductivity | 4 | | S/m |
| 14.017 | density | 4 | | kg/m³ |
| 14.018 | electric_charge | 4 | | C |
| 14.019 | electric_current | 4 | | A |
| 14.020 | electric_current_density | 4 | | A/m² |
| 14.021 | electric_dipole_moment | 4 | | C m |
| 14.022 | electric_displacement | 4 | | C/m² |
| 14.023 | electric_field_strength | 4 | | V/m |
| 14.024 | electric_flux | 4 | | c |
| 14.025 | electric_flux_density | 4 | | C/m² |
| 14.026 | electric_polarization | 4 | | C/m² |
| 14.027 | electric_potential | 4 | | V |
| 14.028 | electric_potential_difference | 4 | | V |
| 14.029 | electromagnetic_moment | 4 | | A m² |
| 14.030 | electromotive_force | 4 | | V |
| 14.031 | energy | 4 | | J |
| 14.032 | force | 4 | | N |
| 14.033 | frequency | 4 | | Hz |
| 14.034 | angular_frequency | 4 | | rad/s |
| 14.035 | heatcapacity | 4 | | J/K |
| 14.036 | heatflowrate | 4 | | W |
| 14.037 | heat_quantity | 4 | | J |
| 14.038 | impedance | 4 | | Ω |
| 14.039 | length | 4 | | m |
| 14.040 | light_quantity | 4 | | lm s |
| 14.041 | luminance | 4 | | cd/m² |
| 14.042 | luminous_flux | 4 | | lm |
| 14.043 | luminous_intensity | 4 | | cd |
| 14.044 | magnetic_field_strength | 4 | | A/m |
| 14.045 | magnetic_flux | 4 | | Wb |
| 14.046 | magnetic_flux_density | 4 | | T |
| 14.047 | magnetic_moment | 4 | | A m² |
| 14.048 | magnetic_polarization | 4 | | T |
| 14.049 | magnetization | 4 | | A/m |
| 14.050 | magnetomotive_force | 4 | | A |
| 14.051 | mass | 4 | | kg |
| 14.052 | mass_flux | 4 | | kg/s |
| 14.053 | momentum | 4 | | N/s |
| 14.054 | phaseanglerad | 4 | | rad |
| 14.055 | phaseangledeg | 4 | | ° |
| 14.056 | power | 4 | | W |
| 14.057 | powerfactor | 4 | | cosΦ |
| 14.058 | pressure | 4 | | Pa |
| 14.059 | reactance | 4 | | Ω |
| 14.060 | resistance | 4 | | Ω |
| 14.061 | resistivity | 4 | | Ω m |
| 14.062 | self_inductance | 4 | | H |
| 14.063 | solid_angle | 4 | | sr |
| 14.064 | sound_intensity | 4 | | W/m² |
| 14.065 | speed | 4 | | m/s |
| 14.066 | stress | 4 | | Pa |
| 14.067 | surface_tension | 4 | | N/m |
| 14.068 | common_temperature | 4 | | °C |
| 14.069 | absolute_temperature | 4 | | K |
| 14.070 | temperature_difference | 4 | | K |
| 14.071 | thermal_capacity | 4 | | J/K |
| 14.072 | thermal_conductivity | 4 | | W/mK |
| 14.073 | thermoelectric_power | 4 | | V/K |
| 14.074 | time_seconds | 4 | | s |
| 14.075 | torque | 4 | | N m |
| 14.076 | volume | 4 | | m³ |
| 14.077 | volume_flux | 4 | | m³/s |
| 14.078 | weight | 4 | | N |
| 14.079 | work | 4 | | J |
| 16.000 | string | 14 | | |
| 17.001 | scene_number | 1 | 1 ... 64 | |
### Full example
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
sync_state: init
type: 'percent'
- name: Kitchen.Temperature
state_address: '6/2/1'
sync_state: every 60
type: 'temperature'
```
## Switch
The `knx` switch platform is used as an interface to switching actuators.
### Configuration
To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
switch:
- name: Kitchen.Coffee
address: '1/1/6'
```
{% configuration %}
address:
description: KNX group address for switching the switch on/off. *DPT 1*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Switch
type: string
state_address:
description: Separate KNX group address for retrieving the switch state. *DPT 1*
required: false
type: string
{% endconfiguration %}
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.
## Weather
The `knx` weather platform is used as an interface to KNX weather stations.
To use your KNX weather station in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
weather:
- name: "home"
address_temperature: "7/0/0"
address_brightness_south: "7/0/1"
address_brightness_west: "7/0/2"
address_brightness_east: "7/0/3"
address_wind_speed: "7/0/4"
address_rain_alarm: "7/0/5"
address_frost_alarm: "7/0/6"
address_wind_alarm: "7/0/7"
address_day_night: "7/0/8"
address_air_pressure: "7/0/9"
address_humidity: "7/0/10"
expose_sensors: False
sync_state: True
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Weather
type: string
address_temperature:
description: KNX group address for reading current outside temperature from KNX bus. *DPT 9.001*
required: true
type: string
address_brightness_south:
description: KNX group address for reading current brightness to south coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_brightness_west:
description: KNX group address for reading current brightness to west coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_brightness_east:
description: KNX group address for reading current brightness to east coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_wind_speed:
description: KNX group address for reading current wind speed from KNX bus. *DPT 9.005*
required: false
type: string
address_rain_alarm:
description: KNX group address for reading if rain alarm is on/off.
required: false
type: string
address_frost_alarm:
description: KNX group address for reading if frost alarm is on/off.
required: false
type: string
address_wind_alarm:
description: KNX group address for reading if wind alarm is on/off.
required: false
type: string
address_day_night:
description: KNX group address for reading if it's day/night.
required: false
type: string
address_air_pressure:
description: KNX address reading current air pressure. *DPT 9.006*
required: false
type: string
address_humidity:
description: KNX address for reading current humidity. *DPT 9.007*
required: false
type: string
expose_sensors:
description: If true, exposes all sensor values as dedicated sensors to HA.
required: false
type: boolean
default: False
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus.
required: false
type: boolean
default: True
{% endconfiguration %}

135
source/_integrations/light.knx.markdown
View File

@ -1,135 +0,0 @@
---
title: "KNX Light"
description: "Instructions on how to integrate KNX lights with Home Assistant."
ha_category:
- Light
ha_release: 0.44
ha_iot_class: Local Push
ha_domain: knx
---
The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as:
- switching actuators
- dimming actuators
- LED controllers
- DALI gateways
## Configuration
To use your KNX light in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
light:
- name: 'kitchen'
address: '1/0/9'
```
{% configuration %}
address:
description: KNX group address for switching the light on and off. *DPT 1.001*
required: true
type: string
state_address:
description: KNX group address for retrieving the switch state of the light. *DPT 1.001*
required: false
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
brightness_address:
description: KNX group address for setting the brightness of the light in percent (absolute dimming). *DPT 5.001*
required: false
type: string
brightness_state_address:
description: KNX group address for retrieving the brightness of the light in percent. *DPT 5.001*
required: false
type: string
color_address:
description: KNX group address for setting the RGB color of the light. *DPT 232.600*
required: false
type: string
color_state_address:
description: KNX group address for retrieving the RGB color of the light. *DPT 232.600*
required: false
type: string
rgbw_address:
description: KNX group address for setting the RGBW color of the light. *DPT 251.600*
required: false
type: string
rgbw_state_address:
description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600*
required: false
type: string
color_temperature_address:
description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode*
required: false
type: string
color_temperature_state_address:
description: KNX group address for retrieving the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode*
required: false
type: string
color_temperature_mode:
description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
required: false
type: string
default: absolute
min_kelvin:
description: Warmest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*)
required: false
type: integer
default: 2700
max_kelvin:
description: Coldest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*)
required: false
type: integer
default: 6000
{% endconfiguration %}
Many KNX devices can change their state internally without a message to the switch address on the KNX bus, e.g., if you configure a scene or 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` (in most cases from the light actuator), it will overwrite the state of the switch object.
For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set `state_address` to the same value as `address`.
*Note on tunable white:* Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior.
## Extended configuration example
```yaml
knx:
light:
# dimmable light
- name: Bedroom-Light-1
address: '1/0/9'
state_address: '1/1/9'
brightness_address: '1/2/9'
brightness_state_address: '1/3/9'
#
# RGB light
- name: Bathroom-Light-1
address: '1/0/9'
state_address: '1/1/9'
brightness_address: '1/2/9'
brightness_state_address: '1/3/9'
color_address: '1/4/9'
color_state_address: '1/5/9'
#
# tunable white light
- name: Office-Light-1
address: '1/0/21'
state_address: '1/1/21'
brightness_address: '1/2/21'
brightness_state_address: '1/3/21'
color_temperature_address: '1/4/21'
color_temperature_state_address: '1/5/21'
color_temperature_mode: absolute
min_kelvin: 2550
max_kelvin: 6200
#
# actuator without dedicated state communication object
- name: Cellar-Light-1
address: '1/0/5'
state_address: '1/0/5'
```

2
source/_integrations/nest.markdown
View File

@ -329,7 +329,7 @@ The following conditions are available by device:
<div class='note warning'>
This feature is not designed to transform your Home Assistant into a security system, neither Home Assistant nor Nest be liable to You for damages,
This feature is not designed to transform your Home Assistant into a security system, neither Home Assistant nor Nest are liable for damages,
or consequential damages of any character arising as a result of use this feature.
This feature does not depend on the [Nest Secure alarm system](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,

33
source/_integrations/notify.knx.markdown
View File

@ -1,33 +0,0 @@
---
title: "KNX Notify"
description: "Instructions on how to use the KNX notify with Home Assistant."
ha_category:
- Notifications
ha_release: 0.53
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices.
## Configuration
To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
notify:
- name: Alarm
address: '5/1/10'
```
{% configuration %}
address:
description: KNX group address of the notification. *DPT 16.000*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
{% endconfiguration %}

38
source/_integrations/scene.knx.markdown
View File

@ -1,38 +0,0 @@
---
title: "KNX Scene"
description: "Instructions on how to integrate KNX Scenes into Home Assistant."
ha_category:
- Scene
ha_release: 0.63
ha_domain: knx
---
The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes.
## Configuration
To use your KNX scence in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
scene:
- name: Romantic
address: 8/8/8
scene_number: 23
```
{% configuration %}
address:
description: KNX group address for the scene. *DPT 17.001*
required: true
type: string
scene_number:
description: KNX scene number to be activated. ( 1 ... 64 )
required: true
type: integer
name:
description: A name for this device used within Home Assistant.
required: false
type: string
{% endconfiguration %}

213
source/_integrations/sensor.knx.markdown
View File

@ -1,213 +0,0 @@
---
title: "KNX Sensor"
description: "Instructions on how to use a KNX Sensor with Home Assistant."
ha_category:
- Sensor
ha_release: 0.29
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors.
Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
## Configuration
To use your KNX sensor in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
```
In order to actively read the sensor data from the bus all 30 seconds you can add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
sync_state: expire 30
```
{% configuration %}
state_address:
description: KNX group address of the sensor.
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false
type: [boolean, string, integer]
default: True
type:
description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly.
required: true
type: string
{% endconfiguration %}
| KNX DPT | type | size in byte | range | unit |
|--------:|-------------------------------|-------------:|:--------------------------:|----------------|
| 5.001 | percent | 1 | 0 ... 100 | % |
| 5.003 | angle | 1 | 0 ... 360 | ° |
| 5.004 | percentU8 | 1 | 0 ... 255 | % |
| 5.010 | pulse | 1 | 0 ... 255 | |
| 5.010 | 1byte_unsigned | 1 | 0 ... 255 | |
| 6.001 | percentV8 | 1 | -128 ... 127 | % |
| 6.010 | counter_pulses | 1 | -128 ... 127 | counter pulses |
| 7.001 | 2byte_unsigned | 2 | 0 ... 65535 | pulses |
| 7.002 | time_period_msec | 2 | 0 ... 65535 | ms |
| 7.003 | time_period_10msec | 2 | 0 ... 65535 | ms |
| 7.004 | time_period_100msec | 2 | 0 ... 65535 | ms |
| 7.005 | time_period_sec | 2 | 0 ... 65535 | s |
| 7.006 | time_period_min | 2 | 0 ... 65535 | min |
| 7.007 | time_period_hrs | 2 | 0 ... 65535 | h |
| 7.011 | length_mm | 2 | 0 ... 65535 | mm |
| 7.012 | current | 2 | 0 ... 65535 | mA |
| 7.013 | brightness | 2 | 0 ... 65535 | lx |
| 7.600 | color_temperature | 2 | 0 ... 65535 | K |
| 8.001 | 2byte_signed | 2 | -32768 ... 32767 | pulses |
| 8.002 | delta_time_ms | 2 | -32768 ... 32767 | ms |
| 8.005 | delta_time_sec | 2 | -32768 ... 32767 | s |
| 8.006 | delta_time_min | 2 | -32768 ... 32767 | min |
| 8.007 | delta_time_hrs | 2 | -32768 ... 32767 | h |
| 8.010 | percentV16 | 2 | -32768 ... 32767 | % |
| 8.011 | rotation_angle | 2 | -32768 ... 32767 | ° |
| 9.* | enthalpy | 2 | -671088.64 ... 670760.96 | H |
| 9.001 | temperature | 2 | -273 ... 670760 | °C |
| 9.002 | temperature_difference_2byte | 2 | -670760 ... 670760 | K |
| 9.003 | temperature_a | 2 | -670760 ... 670760 | K/h |
| 9.004 | illuminance | 2 | 0 ... 670760 | lx |
| 9.005 | wind_speed_ms | 2 | 0 ... 670760 | m/s |
| 9.006 | pressure_2byte | 2 | 0 ... 670760 | Pa |
| 9.007 | humidity | 2 | 0 ... 670760 | % |
| 9.008 | ppm | 2 | -671088.64 ... 670760.96 | ppm |
| 9.010 | time_1 | 2 | -670760 ... 670760 | s |
| 9.011 | time_2 | 2 | -670760 ... 670760 | ms |
| 9.020 | voltage | 2 | -671088.64 ... 670760.96 | mV |
| 9.022 | power_density | 2 | -671088.64 ... 670760.96 | W/m² |
| 9.023 | kelvin_per_percent | 2 | -671088.64 ... 670760.96 | K/% |
| 9.024 | power_2byte | 2 | -671088.64 ... 670760.96 | kW |
| 9.025 | volume_flow | 2 | -671088.64 ... 670760.96 | l/h |
| 9.026 | rain_amount | 2 | -671088.64 ... 670760.96 | l/m² |
| 9.027 | temperature_f | 2 | -459.6 ... 670760 | °F |
| 9.028 | wind_speed_kmh | 2 | 0 ... 670760 | km/h |
| 12.*** | 4byte_unsigned | 4 | 0 ... 4294967295 | |
| 13.*** | 4byte_signed | 4 | -2147483648 ... 2147483647 | |
| 13.002 | flow_rate_m3h | 4 | -2147483648 ... 2147483647 | m³/h |
| 13.010 | active_energy | 4 | -2147483648 ... 2147483647 | Wh |
| 13.011 | apparant_energy | 4 | -2147483648 ... 2147483647 | VAh |
| 13.012 | reactive_energy | 4 | -2147483648 ... 2147483647 | VARh |
| 13.013 | active_energy_kwh | 4 | -2147483648 ... 2147483647 | kWh |
| 13.014 | apparant_energy_kvah | 4 | -2147483648 ... 2147483647 | kVAh |
| 13.015 | reactive_energy_kvarh | 4 | -2147483648 ... 2147483647 | kVARh |
| 13.100 | long_delta_timesec | 4 | -2147483648 ... 2147483647 | s |
| 14.000 | acceleration | 4 | | m/s² |
| 14.*** | 4byte_float | 4 | | |
| 14.001 | acceleration_angular | 4 | | rad/s² |
| 14.002 | activation_energy | 4 | | J/mol |
| 14.003 | activity | 4 | | s⁻¹ |
| 14.004 | mol | 4 | | mol |
| 14.005 | amplitude | 4 | | |
| 14.006 | angle_rad | 4 | | rad |
| 14.007 | angle_deg | 4 | | ° |
| 14.008 | angular_momentum | 4 | | J s |
| 14.009 | angular_velocity | 4 | | rad/s |
| 14.010 | area | 4 | | m² |
| 14.011 | capacitance | 4 | | F |
| 14.012 | charge_density_surface | 4 | | C/m² |
| 14.013 | charge_density_volume | 4 | | C/m³ |
| 14.014 | compressibility | 4 | | m²/N |
| 14.015 | conductance | 4 | | S |
| 14.016 | electrical_conductivity | 4 | | S/m |
| 14.017 | density | 4 | | kg/m³ |
| 14.018 | electric_charge | 4 | | C |
| 14.019 | electric_current | 4 | | A |
| 14.020 | electric_current_density | 4 | | A/m² |
| 14.021 | electric_dipole_moment | 4 | | C m |
| 14.022 | electric_displacement | 4 | | C/m² |
| 14.023 | electric_field_strength | 4 | | V/m |
| 14.024 | electric_flux | 4 | | c |
| 14.025 | electric_flux_density | 4 | | C/m² |
| 14.026 | electric_polarization | 4 | | C/m² |
| 14.027 | electric_potential | 4 | | V |
| 14.028 | electric_potential_difference | 4 | | V |
| 14.029 | electromagnetic_moment | 4 | | A m² |
| 14.030 | electromotive_force | 4 | | V |
| 14.031 | energy | 4 | | J |
| 14.032 | force | 4 | | N |
| 14.033 | frequency | 4 | | Hz |
| 14.034 | angular_frequency | 4 | | rad/s |
| 14.035 | heatcapacity | 4 | | J/K |
| 14.036 | heatflowrate | 4 | | W |
| 14.037 | heat_quantity | 4 | | J |
| 14.038 | impedance | 4 | | Ω |
| 14.039 | length | 4 | | m |
| 14.040 | light_quantity | 4 | | lm s |
| 14.041 | luminance | 4 | | cd/m² |
| 14.042 | luminous_flux | 4 | | lm |
| 14.043 | luminous_intensity | 4 | | cd |
| 14.044 | magnetic_field_strength | 4 | | A/m |
| 14.045 | magnetic_flux | 4 | | Wb |
| 14.046 | magnetic_flux_density | 4 | | T |
| 14.047 | magnetic_moment | 4 | | A m² |
| 14.048 | magnetic_polarization | 4 | | T |
| 14.049 | magnetization | 4 | | A/m |
| 14.050 | magnetomotive_force | 4 | | A |
| 14.051 | mass | 4 | | kg |
| 14.052 | mass_flux | 4 | | kg/s |
| 14.053 | momentum | 4 | | N/s |
| 14.054 | phaseanglerad | 4 | | rad |
| 14.055 | phaseangledeg | 4 | | ° |
| 14.056 | power | 4 | | W |
| 14.057 | powerfactor | 4 | | cosΦ |
| 14.058 | pressure | 4 | | Pa |
| 14.059 | reactance | 4 | | Ω |
| 14.060 | resistance | 4 | | Ω |
| 14.061 | resistivity | 4 | | Ω m |
| 14.062 | self_inductance | 4 | | H |
| 14.063 | solid_angle | 4 | | sr |
| 14.064 | sound_intensity | 4 | | W/m² |
| 14.065 | speed | 4 | | m/s |
| 14.066 | stress | 4 | | Pa |
| 14.067 | surface_tension | 4 | | N/m |
| 14.068 | common_temperature | 4 | | °C |
| 14.069 | absolute_temperature | 4 | | K |
| 14.070 | temperature_difference | 4 | | K |
| 14.071 | thermal_capacity | 4 | | J/K |
| 14.072 | thermal_conductivity | 4 | | W/mK |
| 14.073 | thermoelectric_power | 4 | | V/K |
| 14.074 | time_seconds | 4 | | s |
| 14.075 | torque | 4 | | N m |
| 14.076 | volume | 4 | | m³ |
| 14.077 | volume_flux | 4 | | m³/s |
| 14.078 | weight | 4 | | N |
| 14.079 | work | 4 | | J |
| 16.000 | string | 14 | | |
| 17.001 | scene_number | 1 | 1 ... 64 | |
## Full example
```yaml
# Example configuration.yaml entry
knx:
sensor:
- name: Heating.Valve1
state_address: '2/0/0'
sync_state: init
type: 'percent'
- name: Kitchen.Temperature
state_address: '6/2/1'
sync_state: every 60
type: 'temperature'
```

7
source/_integrations/shelly.markdown
View File

@ -16,11 +16,14 @@ Integrate [Shelly devices](https://shelly.cloud) into Home Assistant.
## Configuration
To add a Shelly device to your installation, go to **Configuration** >> **Integrations** in the UI, click the + to add a new integration and search for Shelly. Devices will be automatically discovered when on the same network and listed on the integrations page. Click on "Configure" of the discovered device to add it to Home Assistant.
To add a Shelly device to your installation, make sure they are connected to your Wi-Fi network first. Next, go to **Configuration** >> **Integrations** in the UI. If the new device is on the same network as Home Assistant, it is discovered automatically. Clicking "Configure" on the discovered device, adds it to Home Assistant. If your device isn't discovered automatically, click the button with `+` sign on the integrations page and from the list of integrations, select **Shelly** and follow the instructions shown.
A device can also be added manually, click the button with `+` sign on the integrations page and from the list of integrations, select **Shelly** and follow the instructions shown.
<div class="note">
Integration is communicating directly with the device; cloud connection is not needed.
</div>
## Known issues and limitations
- Only supports firmware 1.8 and later
- Support relays, lights (with brightness), sensors and rollers
- Support for battery powered devices is currently very limited

7
source/_integrations/sms.markdown
View File

@ -50,6 +50,11 @@ device:
type: string
{% endconfiguration %}
## Notifications
You can also receive SMS messages that are sent to the SIM card number in your device.
Every time there is a message received, `event: sms.incoming_sms` is fired with date, phone number and text message.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
If the integration is used with the Home Assistant Operating System, then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required.
@ -70,7 +75,7 @@ Note: When running Home Assistant, you need to install the SSH add-on.
## Required Hardware
You will need a USB GSM stick modem.
You will need a USB GSM stick modem or device like SIM800L v2 connected via USB UART.
### List of modems known to work

41
source/_integrations/switch.knx.markdown
View File

@ -1,41 +0,0 @@
---
title: "KNX Switch"
description: "Instructions on how to integrate KNX switches with Home Assistant."
ha_category:
- Switch
ha_release: 0.24
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` switch platform is used as an interface to switching actuators.
## Configuration
To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
knx:
switch:
- name: Kitchen.Coffee
address: '1/1/6'
```
{% configuration %}
address:
description: KNX group address for switching the switch on/off. *DPT 1*
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Switch
type: string
state_address:
description: Separate KNX group address for retrieving the switch state. *DPT 1*
required: false
type: string
{% endconfiguration %}
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.

2
source/_integrations/tibber.markdown
View File

@ -15,7 +15,7 @@ ha_config_flow: true
---
The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer.
If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://watty.io/) it will also show the electricity consumption in real time.
If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://tibber.com/se/store/produkt/watty-smart-energimatare) it will also show the electricity consumption in real time.
There is currently support for the following device types within Home Assistant:

95
source/_integrations/weather.knx.markdown
View File

@ -1,95 +0,0 @@
---
title: "KNX Weather"
description: "Instructions on how to integrate KNX weather stations with Home Assistant."
ha_category:
- Weather
ha_release: 0.115
ha_iot_class: Local Push
ha_domain: knx
---
The `knx` weather platform is used as an interface to KNX weather stations.
To use your KNX weather station in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml
# Example configuration.yaml entry
knx:
weather:
- name: "home"
address_temperature: "7/0/0"
address_brightness_south: "7/0/1"
address_brightness_west: "7/0/2"
address_brightness_east: "7/0/3"
address_wind_speed: "7/0/4"
address_rain_alarm: "7/0/5"
address_frost_alarm: "7/0/6"
address_wind_alarm: "7/0/7"
address_day_night: "7/0/8"
address_air_pressure: "7/0/9"
address_humidity: "7/0/10"
expose_sensors: False
sync_state: True
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Weather
type: string
address_temperature:
description: KNX group address for reading current outside temperature from KNX bus. *DPT 9.001*
required: true
type: string
address_brightness_south:
description: KNX group address for reading current brightness to south coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_brightness_west:
description: KNX group address for reading current brightness to west coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_brightness_east:
description: KNX group address for reading current brightness to east coordinate from KNX bus. *DPT 9.004*
required: false
type: string
address_wind_speed:
description: KNX group address for reading current wind speed from KNX bus. *DPT 9.005*
required: false
type: string
address_rain_alarm:
description: KNX group address for reading if rain alarm is on/off.
required: false
type: string
address_frost_alarm:
description: KNX group address for reading if frost alarm is on/off.
required: false
type: string
address_wind_alarm:
description: KNX group address for reading if wind alarm is on/off.
required: false
type: string
address_day_night:
description: KNX group address for reading if it's day/night.
required: false
type: string
address_air_pressure:
description: KNX address reading current air pressure. *DPT 9.006*
required: false
type: string
address_humidity:
description: KNX address for reading current humidity. *DPT 9.007*
required: false
type: string
expose_sensors:
description: If true, exposes all sensor values as dedicated sensors to HA.
required: false
type: boolean
default: False
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus.
required: false
type: boolean
default: True
{% endconfiguration %}

2
source/_integrations/xiaomi_miio.markdown
View File

@ -32,7 +32,7 @@ The `xiaomi_miio` integration supports the following devices:
- [Xiaomi Philips Light](#xiaomi-philips-light)
- [Xiaomi Smart WiFi Socket and Smart Power Strip](#xiaomi-smart-wifi-socket-and-smart-power-strip)
For many of these devices you need a acces token, the first section will describe how to obtain that acces token.
For many of these devices you need an access token, the first section will describe how to obtain that access token.
## Retrieving the Access Token

0
source/_lovelace/calendar-card.markdown → source/_lovelace/calendar.markdown
View File

41
source/_posts/2020-09-17-release-115.markdown
View File

@ -105,6 +105,7 @@ navigating you around this release.
- [Breaking Changes](#breaking-changes)
- [Farewell to the following](#farewell-to-the-following)
- [Release 0.115.1 - September 18](#release-01151---september-18)
- [Release 0.115.2 - September 19](#release-01152---september-19)
- [All changes](#all-changes)
## Media Browser
@ -1689,6 +1690,46 @@ discovery. Users currently using that should set up all devices through UI.
[velux docs]: /integrations/velux/
[vizio docs]: /integrations/vizio/
## Release 0.115.2 - September 19
- Get option flow defaults from yaml for non configured MQTT options ([@emontnemery] - [#40177]) ([mqtt docs])
- Correct modbus switch to return correct coil ([@janiversen] - [#40190]) ([modbus docs])
- Handle an unsupported device in the Broadlink config flow ([@felipediel] - [#40242]) ([broadlink docs])
- Fix Kodi discovery title ([@OnFreund] - [#40247]) ([kodi docs])
- Fix high CPU usage in vera integration. ([@vangorra] - [#40249]) ([vera docs])
- Updated frontend to 20200918.0 ([@bramkragten] - [#40253]) ([frontend docs])
- Bump hangups to 0.4.11 ([@dshokouhi] - [#40258]) ([hangouts docs])
- Update ZHA dependencies ([@Adminiuga] - [#40283]) ([zha docs])
- Fix error creating duplicate ConfigEntry upon import for rfxtrx ([@RobBie1221] - [#40296]) ([rfxtrx docs])
[#40177]: https://github.com/home-assistant/core/pull/40177
[#40190]: https://github.com/home-assistant/core/pull/40190
[#40242]: https://github.com/home-assistant/core/pull/40242
[#40247]: https://github.com/home-assistant/core/pull/40247
[#40249]: https://github.com/home-assistant/core/pull/40249
[#40253]: https://github.com/home-assistant/core/pull/40253
[#40258]: https://github.com/home-assistant/core/pull/40258
[#40283]: https://github.com/home-assistant/core/pull/40283
[#40296]: https://github.com/home-assistant/core/pull/40296
[@Adminiuga]: https://github.com/Adminiuga
[@OnFreund]: https://github.com/OnFreund
[@RobBie1221]: https://github.com/RobBie1221
[@bramkragten]: https://github.com/bramkragten
[@dshokouhi]: https://github.com/dshokouhi
[@emontnemery]: https://github.com/emontnemery
[@felipediel]: https://github.com/felipediel
[@janiversen]: https://github.com/janiversen
[@vangorra]: https://github.com/vangorra
[broadlink docs]: /integrations/broadlink/
[frontend docs]: /integrations/frontend/
[hangouts docs]: /integrations/hangouts/
[kodi docs]: /integrations/kodi/
[modbus docs]: /integrations/modbus/
[mqtt docs]: /integrations/mqtt/
[rfxtrx docs]: /integrations/rfxtrx/
[vera docs]: /integrations/vera/
[zha docs]: /integrations/zha/
## All changes
<details>

91
source/_posts/2020-09-19-summing-up-the-month-of-what-the-heck.markdown Normal file
View File

@ -0,0 +1,91 @@
---
layout: post
title: Summing-up the month of 'What the heck?!'
description: All good things come to an end, including the month of 'What the heck?!'. So, how was this first edition?
date: 2020-09-19 00:00:00
date_formatted: "September 19, 2020"
author: Franck Nijhof
author_twitter: frenck
comments: true
categories: Announcements
og_image: /images/blog/2020-08-18-the-month-of-what-the-heck/social.png
---
<a href='https://community.home-assistant.io/c/what-the-heck/52'><img src='/images/blog/2020-08-18-the-month-of-what-the-heck/social.png' class='no-shadow'></a>
A month ago, I wrote [a blog post][kickoff], starting our first month of
"What the heck?!" (WTH) ever! An experiment and without any expectations,
as we never had done anything like this before. But WTH, why not. 😁
And today, I think we can actually say: All good things come to an end.
It has been an amazing month! A whopping 746 topics have been created in the
[WTH forum][forum], that together collected over 4,500 posts. The contents of
all these created topics are amazing! And apparently, you all agreed on that,
as a stunning 2,600 likes have been given on all those posts.
About the content, it is amazing! There was some really good feedback in there.
Annoyances made many people think: “Yeah! What the heck?!” and more importantly,
developers chimed in as well!
Developers dived in and started resolving and fixing stuff! At the moment
of writing, a whopping 68 pull requests with code changes to address those WTHs
have been made. A lot of these are already shipped with the [0.115 birthday
release][release].
## So, what was fixed?
Let's take a quick peek at stuff that was reported and fixed/addressed/improved
(in no particular order):
- [Duplicate Automation Button](https://community.home-assistant.io/t/duplicate-automation-button/219646)
- [Manage sidebar/menu items (hide/add/move)](https://community.home-assistant.io/t/manage-sidebar-menu-items-hide-add-move/219476)
- [Stop requiring magic to enable templates](https://community.home-assistant.io/t/stop-requiring-magic-to-enable-templates/219523)
- [WTH can I not use the update button while running an NGINX HA proxy](https://community.home-assistant.io/t/wth-can-i-not-use-the-update-button-while-running-an-nginx-ha-proxy/221061)
- [How the heck can I set this user picture?](https://community.home-assistant.io/t/how-the-heck-can-i-set-this-user-picture/219511)
- [Why the heck isn’t there any official macOS desktop app?!](https://community.home-assistant.io/t/why-the-heck-isnt-there-any-official-macos-desktop-app/221014)
- [What the heck turned my light on?](https://community.home-assistant.io/t/what-the-heck-turned-my-light-on/219488)
- [Reload integrations individually](https://community.home-assistant.io/t/reload-integrations-indiviudally/220478)
- [Why doesn’t a trigger platform for state attributes exist?](https://community.home-assistant.io/t/why-doesnt-a-trigger-platform-for-state-attributes-exist/219651)
- [WTH why can’t I permanently delete jinja2 tutorial in the template editor](https://community.home-assistant.io/t/wth-why-cant-i-permanently-delete-jinja2-tutorial-in-the-template-editor/220486)
- [WTH why can’t an administrator change a user’s password](https://community.home-assistant.io/t/wth-why-cant-an-administrator-change-a-users-password/219971)
- [WTH: Can’t we see which trigger fired an automation?](https://community.home-assistant.io/t/wth-cant-we-see-which-trigger-fired-an-automation/220888)
- [Set static IP in supervisor](https://community.home-assistant.io/t/set-static-ip-in-supervisor/219780)
- [WTH: Why can’t I use “for” without defining a “to”-state in automations?](https://community.home-assistant.io/t/wth-why-can-t-i-use-for-without-defining-a-to-state-in-automations/222137)
- [Option to template the keys in data_template in addition to only values](https://community.home-assistant.io/t/option-to-template-the-keys-in-data-template-in-addition-to-only-values/219513)
- [WTH Slack no username/icon customization](https://community.home-assistant.io/t/wth-slack-no-username-icon-customization/220227)
- [Dev Tools –> Template – WTH isn’t it refreshing automatically?!](https://community.home-assistant.io/t/dev-tools-template-wth-isnt-it-refreshing-automatically/219542)
- [Why the heck is a restart needed for each an every change to configuration.yaml?](https://community.home-assistant.io/t/why-the-heck-is-a-restart-needed-for-each-an-every-change-to-configuration-yaml/219630) (Partly solved, much progress is made available already)
- [WTH do pressing update button doesn’t have confirmation](https://community.home-assistant.io/t/wth-do-pressing-update-button-doesnt-have-confirmation/219628)
- [WTH can’t I click outside of a dialog to close the dialog?](https://community.home-assistant.io/t/wth-cant-i-click-outside-of-a-dialog-to-close-the-dialog/222756)
This list isn't even complete, but gives a nice idea of what went on. We think
it is an impressive accomplishment. If you are a bit into GitHub, you can find
[all pull requests made for the month of WTH][prs], as they are all labeled
with "WTH".
## Closing the WTH forum & Hacktoberfest
As said, all good things come to an end. We are going to close the WTH forum.
This means that no new WTH topics can be created, but everything will remain
visible.
Hacktoberfest is right around the corner and all current data in that forum
can really help drive it. It is a great resource for developers to find
opportunities to contribute on during the October month. So, while we close
it down, we hope more will be addressed.
Why not run this WTH all the time? Well, it looses its power over time. This is
already visible right now when comparing the velocity at the beginning and end
of the month.
However, let's see if we can do it again next year. Maybe, we should combine
it with Hacktoberfest in 2021?
How did you experience the month of WTH? Should we do it again?
[forum]: https://community.home-assistant.io/c/what-the-heck/52
[hacktoberfest]: https://hacktoberfest.digitalocean.com
[kickoff]: /blog/2020/08/18/the-month-of-what-the-heck/
[prs]: https://github.com/search?o=desc&q=org%3Ahome-assistant+label%3AWTH+is%3Apr&s=created&type=Issues
[release]: /blog/2020/09/17/release-115/

114
source/_posts/2020-09-20-community-highlights.markdown Normal file
View File

@ -0,0 +1,114 @@
---
title: "Community Highlights: 6th edition"
description: "A 'Dad status' board, illuminating the steps of your stairs and the most beautiful thermostat you've ever seen"
date: 2020-09-20 00:00:00
date_formatted: "September 20, 2020"
author: Franck Nijhof
author_twitter: frenck
categories: Community
og_image: /images/blog/2020-09-20-community-highlights/social.png
---
It has been waaay too long since we had a Community Highlights blog.
Honestly, it is my fault. And then the [month of "What the heck?!"][mwth]
happened, and one of the raised WTH topics was:
> [Where are the “Community Highlights”?][wth]
Bas, and all the voters on that WTH topic, let's resolve that
WTH topic right now!
A nice way of closing our birthday week by showing some cool things our
community does while resolving a WTH. 🥳
[mwth]: /blog/2020/09/19/summing-up-the-month-of-what-the-heck/
[wth]: https://community.home-assistant.io/t/where-are-the-community-highlights/219580
## A nice side project
OmegaX-NL shared a nice little project on our [subreddit][reddit], that really
fits the new style of working that many of us have to adapt too during this
pandemic.
It looks great, OmegaX-NL! Does it work for the kids?
<blockquote class="reddit-card">
<a href="https://www.reddit.com/r/homeassistant/comments/fyhgwj/nice_side_project/">Nice side project!</a> from <a href="http://www.reddit.com/r/homeassistant">r/homeassistant</a>
</blockquote><script async src="//embed.redditmedia.com/widgets/platform.js" charset="UTF-8"></script>
## Illuminate your stairs
A regularly recurring project is the illumination of the stairs.
It can give a nice, futuristic touch to your home. Good illumination of the
steps also greatly improves safety.
Winter is coming, daylight will become shorter; it might be the time
to take care of some proper lights on the stairs outside.
[JayBigGuy] shared an [excellent blog article][smart-stairs] on building stairs
connecting his driveway with the deck, of course, full of smart lights.
<p class='img'>
<a href="https://jaybigguy10.gitlab.io/post/building-stairs-with-smart-lights-during-quarantine/">
<img
src='/images/blog/2020-09-20-community-highlights/scan.png'
alt="Scan of a concept drawing of the stairs with smart lights"
style='border: 0;box-shadow: none;'
/>
</a>
A scan of the sketch/idea of what Jay had in mind of building.
</p>
<p class='img'>
<a href="https://jaybigguy10.gitlab.io/post/building-stairs-with-smart-lights-during-quarantine/">
<img
src='/images/blog/2020-09-20-community-highlights/result.jpg'
alt="Picture of the end result of the stairs with smart lights Jay build."
style='border: 0;box-shadow: none;'
/>
</a>
And this is the end result, nice job there Jay!
</p>
Jay was not the only one, [debsahu] added some lights to the deck steps as well!
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">Decks lights are in. It blinks now. Powered by <a href="https://twitter.com/hashtag/esp32?src=hash&amp;ref_src=twsrc%5Etfw">#esp32</a> <a href="https://twitter.com/esphome_?ref_src=twsrc%5Etfw">@esphome_</a> and controlled by <a href="https://twitter.com/home_assistant?ref_src=twsrc%5Etfw">@home_assistant</a> <a href="https://t.co/ukCcDw8Mhm">pic.twitter.com/ukCcDw8Mhm</a></p>&mdash; Debashish Sahu, PhD (@debsahu) <a href="https://twitter.com/debsahu/status/1292255588618043394?ref_src=twsrc%5Etfw">August 9, 2020</a>
</blockquote>
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
[JayBigGuy]: https://twitter.com/jaybigguy10
[debsahu]: https://twitter.com/debsahu
[smart-stairs]: https://jaybigguy10.gitlab.io/post/building-stairs-with-smart-lights-during-quarantine/
## Thermostat with a wow factor
Thingsbeliketheydo shared probably one of the prettiest thermostats I've ever
seen. Using an old cell phone and a frame from the dollar store, he turned
Lovelace into a beautiful thermostat. 🤩
<blockquote class="reddit-card" data-card-created="1600587966">
<a href="https://www.reddit.com/r/homeassistant/comments/ig39jo/diy_fireplace_thermostat_with_shelly/">DIY Fireplace Thermostat with Shelly</a> from <a href="http://www.reddit.com/r/homeassistant">r/homeassistant</a>
</blockquote>
## Got a tip for the next edition?
Have you seen (or made) something awesome, interesting, unique, amazing, inspirational, unusual or funny, using Home Assistant?
[Click here to send us your Community Highlight suggestion](/suggest-community-highlight).
Also, don't forget to share your creations with us via Social Media:
- Twitter it! Be sure to mention [@home_assistant][twitter]
- Share it on our [Facebook group][facebook-group]
- Post it to our [subreddit][reddit]
- Tag [@homeasssistant][instagram] on Instagram
- Or via chat, drop us a line in the [#lounge at Discord][chat]
See you next edition!
[chat]: https://www.home-assistant.io/join-chat
[facebook-group]: https://www.facebook.com/groups/HomeAssistant/
[instagram]: https://www.instagram.com/homeassistant/
[reddit]: https://www.reddit.com/r/homeassistant
[twitter]: https://www.twitter.com/home_assistant

10
source/_redirects
View File

@ -2056,6 +2056,15 @@
/ecosystem/notebooks/installation https://data.home-assistant.io
/ecosystem/notebooks/stats https://data.home-assistant.io
/ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started
/integrations/binary_sensor.knx /integrations/knx#binary-sensor
/integrations/climate.knx /integrations/knx#climate
/integrations/cover.knx /integrations/knx#cover
/integrations/light.knx /integrations/knx#light
/integrations/notify.knx /integrations/knx#notify
/integrations/scene.knx /integrations/knx#scene
/integrations/sensor.knx /integrations/knx#sensor
/integrations/switch.knx /integrations/knx#switch
/integrations/weather.knx /integrations/knx#weather
# Migrated Community Guides
/cookbook/apache_configuration https://community.home-assistant.io/t/reverse-proxy-with-apache/196942
@ -2124,6 +2133,7 @@
/lovelace/entity-button /lovelace/button
/lovelace/views /lovelace/dashboards-and-views
/lovelace/yaml-mode /lovelace/dashboards-and-views
/lovelace/calendar-card /lovelace/calendar
# Removed documentation
/docs/installation/hassbian /getting-started

BIN
source/images/blog/2020-09-20-community-highlights/result.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 100 KiB

BIN
source/images/blog/2020-09-20-community-highlights/scan.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 283 KiB

BIN
source/images/blog/2020-09-20-community-highlights/social.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 341 KiB

2
source/index.html
View File

@ -77,7 +77,7 @@ description: Open source home automation that puts local control and privacy fir
<div class="recent-posts material-card text">
<h1>Recent Blog Posts</h1>
{% for post in site.posts limit: 4 %}
{% for post in site.posts limit: 7 %}
<li class="post">
<a href="{{ post.url }}">{{ post.title }}</a>
<small class="blog-date">{{ post.date_formatted }}</small>