From 2d7c648e52e2955c2316ebe503d0bc660a23e677 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 13:50:29 +0200 Subject: [PATCH] u-integrations: restart HA after changing config (#32727) --- source/_integrations/ubus.markdown | 6 +++- source/_integrations/ue_smart_radio.markdown | 8 +++-- source/_integrations/uk_transport.markdown | 8 +++-- source/_integrations/unifi_direct.markdown | 8 +++-- source/_integrations/unifiled.markdown | 6 ++++ source/_integrations/universal.markdown | 6 +++- source/_integrations/upc_connect.markdown | 8 +++-- .../usgs_earthquakes_feed.markdown | 32 +++++++++++-------- source/_integrations/uvc.markdown | 10 ++++-- 9 files changed, 65 insertions(+), 27 deletions(-) diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 4b915e075c7..917632db8ba 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -9,6 +9,9 @@ ha_domain: ubus ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router. @@ -66,7 +69,8 @@ Check if the `file` namespaces is registered with the RPC server. file ``` -After this is done, add the following to your {% term "`configuration.yaml`" %} file: +After this is done, 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/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown index 3f80548b0d6..0ef82a723ed 100644 --- a/source/_integrations/ue_smart_radio.markdown +++ b/source/_integrations/ue_smart_radio.markdown @@ -9,11 +9,15 @@ ha_domain: ue_smart_radio ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `ue_radio` platform allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. +The `ue_radio` {% term integration %} allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. -To add your UE Smart Radio player to your installation, add the following to your {% term "`configuration.yaml`" %} file: +To add your UE Smart Radio player 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 diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index e8f991bd129..720e22c7c76 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -9,9 +9,12 @@ ha_domain: uk_transport ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes. +The `uk_transport` {% term integration %} will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes.
@@ -23,7 +26,8 @@ Queries are entered as a list, with the two transport modes available being `bus Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json). -To add a single train departure sensor add the following to your {% term "`configuration.yaml`" %} file: +To add a single train departure {% term integration %} add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry for a single sensor diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown index f352e1c0836..2decfc3e17c 100644 --- a/source/_integrations/unifi_direct.markdown +++ b/source/_integrations/unifi_direct.markdown @@ -11,11 +11,15 @@ ha_platforms: ha_integration_type: integration ha_codeowners: - '@tofuSCHNITZEL' +related: + - docs: /docs/configuration/ + title: Configuration file --- -This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application. +This {% term integration %} allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application. -To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: +To use this device tracker 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/unifiled.markdown b/source/_integrations/unifiled.markdown index fb0f18dcb11..9141fede2f0 100644 --- a/source/_integrations/unifiled.markdown +++ b/source/_integrations/unifiled.markdown @@ -11,6 +11,9 @@ ha_domain: unifiled ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- [UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ui.com/) is a system of controller managed LED light panels and dimmers. @@ -21,6 +24,9 @@ There is currently support for the following device type within Home Assistant: ## Configuration +To use the {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry light: diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown index 1c0ccc78567..2ecac991410 100644 --- a/source/_integrations/universal.markdown +++ b/source/_integrations/universal.markdown @@ -10,13 +10,17 @@ ha_domain: universal ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- A universal media player can combine multiple existing entities in Home Assistant into a single media player {% term entity %}. This is used to create a single media player {% term entity %} that can control an entire media center. Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example. -A universal media player is created in {% term "`configuration.yaml`" %} as follows. +To use a universal media player add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown index ed7f39fa541..6a7833b9717 100644 --- a/source/_integrations/upc_connect.markdown +++ b/source/_integrations/upc_connect.markdown @@ -12,15 +12,19 @@ ha_iot_class: Local Polling ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone). +The `upc_connect` {% term integration %} offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone).
This integration works by logging into the router with a password. The router can only have one active session at any time, so if you want to access your router settings then stop Home Assistant first.
-To use a Connect Box in your installation, add the following to your {% term "`configuration.yaml`" %} file: +To use a Connect Box 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/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown index 8eaee34241e..2c09b6fd270 100644 --- a/source/_integrations/usgs_earthquakes_feed.markdown +++ b/source/_integrations/usgs_earthquakes_feed.markdown @@ -11,6 +11,9 @@ ha_domain: usgs_earthquakes_feed ha_platforms: - geo_location ha_integration_type: service +related: + - docs: /docs/configuration/ + title: Configuration file --- The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided by the [U.S. Geological Survey](https://earthquake.usgs.gov/) with information about seismic events like earthquakes. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. @@ -29,7 +32,8 @@ The data is updated every 5 minutes. ## Configuration -To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %}. +To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -68,7 +72,7 @@ longitude: ### Supported feed types | Description | Feed Type | -|----------------------------------------|--------------------------------------| +| -------------------------------------- | ------------------------------------ | | Past Hour - Significant Earthquakes | `past_hour_significant_earthquakes` | | Past Hour - M4.5+ Earthquakes | `past_hour_m45_earthquakes` | | Past Hour - M2.5+ Earthquakes | `past_hour_m25_earthquakes` | @@ -95,18 +99,18 @@ longitude: The following state attributes are available for each {% term entity %} in addition to the standard ones: -| Attribute | Description | -|--------------------|-------------| -| latitude | Latitude of the earthquake. | -| longitude | Longitude of the earthquake. | -| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. | -| external_id | The external ID used in the feed to identify the earthquake in the feed. | -| place | Textual description of named geographic region near to the event. | -| magnitude | Reported magnitude of the earthquake. | -| time | Date and time when this event occurred. | -| updated | Date and time when this event was most recently updated. | -| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" | -| type | Type of seismic event: "earthquake" or "quarry". | +| Attribute | Description | +| ----------- | -------------------------------------------------------------------------------------------- | +| latitude | Latitude of the earthquake. | +| longitude | Longitude of the earthquake. | +| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. | +| external_id | The external ID used in the feed to identify the earthquake in the feed. | +| place | Textual description of named geographic region near to the event. | +| magnitude | Reported magnitude of the earthquake. | +| time | Date and time when this event occurred. | +| updated | Date and time when this event was most recently updated. | +| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" | +| type | Type of seismic event: "earthquake" or "quarry". | ## Full configuration diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown index 6722d49b2b8..cd44234fc1f 100644 --- a/source/_integrations/uvc.markdown +++ b/source/_integrations/uvc.markdown @@ -9,22 +9,26 @@ ha_domain: uvc ha_platforms: - camera ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant. +The `uvc` camera {% term integration %} allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant. The platform connects to the [UniFi NVR software](https://www.ui.com/download/unifi-video) and automatically discovers/adds any camera connected to the NVR. ### Setup -It is recommended that you create a new user for this platform in the NVR software and only give the user the permissions it need to operate. +It is recommended that you create a new user for this {% term integration %} in the NVR software and only give the user the permissions it need to operate. - The API key is found in `User` -> `My account` -> `API Access` in the NVR software. - The camera password is found in `Settings` -> `Camera Settings` -> `Camera Password` in the NVR software. ### Configuration -To enable, add the following to your {% term "`configuration.yaml`" %} file: +To use the {% 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