From 85c91b3c5e92c81c59d5f3023b69241a3d42b5d5 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 9 May 2024 18:03:43 +0200 Subject: [PATCH] j-k-integrations: restart HA after config change (#32644) * i-integrations: - add note to restart HA after changing config - add related topics - rename 'platform' or 'sensor' to 'integration' to streamline terminology - add glossary reference to Configuration file * Undo formatting --- source/_integrations/jewish_calendar.markdown | 8 ++- source/_integrations/joaoapps_join.markdown | 24 ++++--- source/_integrations/kaiterra.markdown | 10 ++- source/_integrations/kankun.markdown | 8 ++- source/_integrations/keba.markdown | 8 ++- source/_integrations/kef.markdown | 66 ++++++++++--------- source/_integrations/keyboard_remote.markdown | 8 ++- source/_integrations/kitchen_sink.markdown | 8 ++- source/_integrations/kiwi.markdown | 8 ++- source/_integrations/knx.markdown | 3 +- source/_integrations/kwb.markdown | 8 ++- 11 files changed, 103 insertions(+), 56 deletions(-) diff --git a/source/_integrations/jewish_calendar.markdown b/source/_integrations/jewish_calendar.markdown index 61008551f2c..12806e6036d 100644 --- a/source/_integrations/jewish_calendar.markdown +++ b/source/_integrations/jewish_calendar.markdown @@ -12,13 +12,17 @@ ha_platforms: - binary_sensor - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The Jewish Calendar (`jewish_calendar`) integration displays a variety of information related to the Jewish Calendar as a variety of sensors. +The Jewish Calendar (`jewish_calendar`) {% term integration %} displays a variety of information related to the Jewish Calendar as a variety of sensors. ## Configuration -To enable this integration in your installation, add the following to your `configuration.yaml` file: +To enable this {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown index 035aa874b8e..9d869075372 100644 --- a/source/_integrations/joaoapps_join.markdown +++ b/source/_integrations/joaoapps_join.markdown @@ -10,9 +10,12 @@ ha_domain: joaoapps_join ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `joaoapps_join` integration exposes services from +The `joaoapps_join` {% term integration %} exposes services from [Join](https://joaoapps.com/join). In Home Assistant, the Joaoapps Join features are divided up in two locations, the Join integration, and the Joaoapps Join notify platform. The notify platform allows us to send messages to Joaoapps Join devices, the integration @@ -22,7 +25,8 @@ In the `configuration.yaml` file you need to provide the API key and device id or name of the target device. You can find your device id and API key [here](https://joinjoaomgcd.appspot.com/). -To set it up, add the following information to your `configuration.yaml` file: +To set it up, add the following information to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -104,11 +108,11 @@ data: The services exposed in the `joaoapps_join` integration can be used with the service data described below: -| Service | Data | -|------------------------------ |------------------------------------------------------------------ | -| joaoapps_join/ring | | -| joaoapps_join/send_sms | `{"number":"5553334444", "message":"Hello!"}` | -| joaoapps_join/send_tasker | `{"command":"test"}` | -| joaoapps_join/send_url | `{"url":"http://google.com"}` | -| joaoapps_join/send_wallpaper | `{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}` | -| joaoapps_join/send_file | `{"url":"http://download.thinkbroadband.com/5MB.zip"}` | +| Service | Data | +| ---------------------------- | ------------------------------------------------------------------ | +| joaoapps_join/ring | | +| joaoapps_join/send_sms | `{"number":"5553334444", "message":"Hello!"}` | +| joaoapps_join/send_tasker | `{"command":"test"}` | +| joaoapps_join/send_url | `{"url":"http://google.com"}` | +| joaoapps_join/send_wallpaper | `{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}` | +| joaoapps_join/send_file | `{"url":"http://download.thinkbroadband.com/5MB.zip"}` | diff --git a/source/_integrations/kaiterra.markdown b/source/_integrations/kaiterra.markdown index 7e866d0cd7e..dd344225b7e 100644 --- a/source/_integrations/kaiterra.markdown +++ b/source/_integrations/kaiterra.markdown @@ -12,15 +12,19 @@ ha_platforms: - air_quality - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://dev.kaiterra.com/). +The `kaiterra` {% term integration %} allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://dev.kaiterra.com/). -To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`. +To use the {% term integration %}, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`. ## Configuration -To enable `kaiterra` in your installation, add the following to your `configuration.yaml` file: +To enable `kaiterra` in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/kankun.markdown b/source/_integrations/kankun.markdown index 1c63842022a..b022428eea8 100644 --- a/source/_integrations/kankun.markdown +++ b/source/_integrations/kankun.markdown @@ -9,9 +9,12 @@ ha_domain: kankun ha_platforms: - switch ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `kankun` switch platform allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are +The `kankun` switch {% term integration %} allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi) script to provide an HTTP API. Details of the necessary modifications were provided on the now dead HomeAutomationForGeeks site, @@ -21,7 +24,8 @@ but fortunately we can still access the information via ## Configuration -To enable it, add the following lines to your `configuration.yaml`: +To enable it, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown index 02128a9cb18..427e5c62d97 100644 --- a/source/_integrations/keba.markdown +++ b/source/_integrations/keba.markdown @@ -17,11 +17,14 @@ ha_platforms: - notify - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `keba` integrates your Keba charging station/BMW Wallbox into your Home Assistant instance using the UDP Smart Home Interface ([manual](https://www.ifix-solar.shop/wp-content/uploads/shop/Dokumente/KEBA/KeContact_P20_P30_UDP_ProgrGuide_en.pdf)). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app. In order to use the integration, enable the UDP Smart Home Interface by adjusting the DIP switches within the charging station according to the [installation manual](https://www.keba.com/file/downloads/e-mobility/KeContact_KCP20_30_ih_en.pdf). -This integration provides the following platforms: +This {% term integration %} provides the following platforms: - Binary sensors: Online state, plug state, charging state and failsafe mode state. - Lock: Authorization (like with the RFID card). @@ -31,7 +34,8 @@ This integration provides the following platforms: ## Configuration -To enable this integration in your installation, add at least the following to your `configuration.yaml` file: +To enable this integration in your installation, add at least the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/kef.markdown b/source/_integrations/kef.markdown index 27644471ecf..af7155490cf 100644 --- a/source/_integrations/kef.markdown +++ b/source/_integrations/kef.markdown @@ -11,19 +11,23 @@ ha_domain: kef ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `kef` platform allows you to control the KEF LS50 Wireless and [KEF LSX](https://international.kef.com/products/lsx) speakers from Home Assistant. +The `kef` {% term integration %} allows you to control the KEF LS50 Wireless and [KEF LSX](https://international.kef.com/products/lsx) speakers from Home Assistant. Supported devices: - KEF LS50 Wireless - KEF LSX -To add KEF Speakers to your installation, add the following to your `configuration.yaml` file: - ## Configuration +To add KEF Speakers to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry media_player: @@ -101,76 +105,76 @@ To update the settings manually, use `kef.update_dsp`. Update all DSP settings. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------- | | entity_id | No | The entity_id of the KEF speaker. | ### Service `kef.set_mode` Set the mode of the speaker. When optional attributes are left out, the setting will be unchanged. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | -| desk_mode | Yes | "Desk mode" (`true` or `false`) | -| wall_mode | Yes | "Wall mode" (`true` or `false`) | -| phase_correction | Yes | "Phase correction" (`true` or `false`) | -| high_pass | Yes | "High-pass mode" (`true` or `false`) | -| sub_polarity | Yes | "Sub polarity" (`-` or `+`) | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | +| desk_mode | Yes | "Desk mode" (`true` or `false`) | +| wall_mode | Yes | "Wall mode" (`true` or `false`) | +| phase_correction | Yes | "Phase correction" (`true` or `false`) | +| high_pass | Yes | "High-pass mode" (`true` or `false`) | +| sub_polarity | Yes | "Sub polarity" (`-` or `+`) | | bass_extension | Yes | "Bass extension" selector (`Less`, `Standard`, or `Extra`) | ### Service `kef.set_desk_db` Set the "Desk mode" slider of the speaker in dB. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | db_value | No | Value of the slider (-6 to 0 with steps of 0.5) | ### Service `kef.set_wall_db` Set the "Wall mode" slider of the speaker in dB. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | db_value | No | Value of the slider (-6 to 0 with steps of 0.5) | ### Service `kef.set_treble_db` Set desk the "Treble trim" slider of the speaker in dB. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | db_value | No | Value of the slider (-2 to 2 with steps of 0.5) | ### Service `kef.set_high_hz` Set the "High-pass mode" slider of the speaker in Hz. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | hz_value | No | Value of the slider (50 to 120 with steps of 5) | ### Service `kef.set_low_hz` Set the "Sub out low-pass frequency" slider of the speaker in Hz. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | hz_value | No | Value of the slider (40 to 250 with steps of 5) | ### Service `kef.set_sub_db` Set the "Sub gain" slider of the speaker in dB. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| entity_id | No | The entity_id of the KEF speaker. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------- | +| entity_id | No | The entity_id of the KEF speaker. | | db_value | No | Value of the slider (-10 to 10 with steps of 1) | ## Notes diff --git a/source/_integrations/keyboard_remote.markdown b/source/_integrations/keyboard_remote.markdown index 3b14b4da2cb..867b384c0a2 100644 --- a/source/_integrations/keyboard_remote.markdown +++ b/source/_integrations/keyboard_remote.markdown @@ -10,14 +10,20 @@ ha_codeowners: - '@lanrat' ha_domain: keyboard_remote ha_integration_type: hub +related: + - docs: /docs/configuration/ + title: Configuration file --- Receive signals from a keyboard and use it as a remote control. -This integration allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. +This {% term integration %} allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it. +To enable the Keyboard Remote {% term integration %}, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry keyboard_remote: diff --git a/source/_integrations/kitchen_sink.markdown b/source/_integrations/kitchen_sink.markdown index 388b2ea832f..6e15886a40b 100644 --- a/source/_integrations/kitchen_sink.markdown +++ b/source/_integrations/kitchen_sink.markdown @@ -19,13 +19,17 @@ ha_platforms: - switch - weather ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The Kitchen Sink integration contains demonstrations of various odds and ends. +The Kitchen Sink {% term integration %} contains demonstrations of various odds and ends. This sets up a demo environment of features which are obscure or which represent incorrect behavior, and are thus not wanted in the `demo` integration. -To enable the `kitchen_sink` integration in Home Assistant, add the following section to your `configuration.yaml` file: +To enable the `kitchen_sink` {% term integration %} in Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/kiwi.markdown b/source/_integrations/kiwi.markdown index 5ddeedafd21..1b05a02268d 100644 --- a/source/_integrations/kiwi.markdown +++ b/source/_integrations/kiwi.markdown @@ -9,13 +9,19 @@ ha_domain: kiwi ha_platforms: - lock ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. +The `KIWI` {% term integration %} allows you to open your KIWI Smart Locks and Smart Entry Devices. All you need to get started is a KIWI account. Register at [the KIWI website](https://kiwi.ki/login/). ## Configuration +To enable the KIWI {% term integration %}, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry lock: diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown index 0b74b7f25c5..47d5e4f9dc8 100644 --- a/source/_integrations/knx.markdown +++ b/source/_integrations/knx.markdown @@ -82,7 +82,8 @@ As a Home Assistant KNX user, you can start a FREE KNX online training and get a ## Basic configuration -In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main `configuration.yaml` file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/). +In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main {% term "`configuration.yaml`" %} file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/). +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml knx: diff --git a/source/_integrations/kwb.markdown b/source/_integrations/kwb.markdown index 1fbbff97817..2f086ee072a 100644 --- a/source/_integrations/kwb.markdown +++ b/source/_integrations/kwb.markdown @@ -9,14 +9,20 @@ ha_domain: kwb ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant. +The `kwb` {% term integration %} integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant. Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals). Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see ). +To enable the KWB Easyfire {% term integration %}, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + Direct connection via serial port: ```yaml