From fdce69cadcdad4f4a543a382a95ef57115223bd0 Mon Sep 17 00:00:00 2001 From: Linus H <30652341+linus-ha@users.noreply.github.com> Date: Fri, 20 Aug 2021 23:16:22 +0200 Subject: [PATCH 01/26] "iframe Panel" better example (#18985) --- source/_integrations/panel_iframe.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/panel_iframe.markdown b/source/_integrations/panel_iframe.markdown index 48dd0d9b182..cfbe1b1f535 100644 --- a/source/_integrations/panel_iframe.markdown +++ b/source/_integrations/panel_iframe.markdown @@ -27,9 +27,11 @@ panel_iframe: fridge: title: "Fridge" url: "http://192.168.1.5" + icon: mdi:fridge otherapp: title: "Other App" url: "/otherapp" + require_admin: true ``` {% configuration %} From 37c118755715b023f4b346f2a33e3dbe83de4178 Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Sat, 21 Aug 2021 12:16:41 +0100 Subject: [PATCH 02/26] Fix formatting of numbers in prefix warning box (#19001) --- source/_docs/automation/trigger.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 56d7ee98b2e..babb6537c0d 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -677,7 +677,7 @@ automation 3:
-Do not prefix numbers with a zero - using `'00'` instead of '0' for example will result in errors. +Do not prefix numbers with a zero - using `'00'` instead of `'0'` for example will result in errors.
From d836a3844faadcea6c19ad58682d96e59e631f2f Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 21 Aug 2021 04:18:03 -0700 Subject: [PATCH 03/26] Document Zigbee energy profile (#19003) --- source/_docs/energy/electricity-grid.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_docs/energy/electricity-grid.markdown b/source/_docs/energy/electricity-grid.markdown index 6414515f69b..84a13de0e51 100644 --- a/source/_docs/energy/electricity-grid.markdown +++ b/source/_docs/energy/electricity-grid.markdown @@ -43,6 +43,12 @@ We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to devel ![Photo of SlimmeLezer attached to a smart electricity meter](/images/docs/energy/slimmelezer.jpg) +#### Connect via Zigbee Energy Profile + +The Zigbee Energy Profile is a wireless energy standard to provide real-time information about electricity usage. This standard is available in some meters in the US, UK and Australia. This is not "normal" Zigbee as implemented by Home Assistant but requires special certified hardware. + +One such option with a local API is the [Rainforest EAGLE-200](/integrations/rainforest_eagle/). + #### Reading the meter via a pulse counter Many meters, including older ones, have an LED that will flash whenever energy passes through it. For example, each flash is a 1/1000th kWh. By monitoring the time between flashes it’s possible to determine the energy consumption. From 3da92a28a998c82d4dacef8fb5a51e49615fa2e0 Mon Sep 17 00:00:00 2001 From: Dan <59684116+dcs8@users.noreply.github.com> Date: Sat, 21 Aug 2021 12:28:37 +0100 Subject: [PATCH 04/26] 'Monetary' missing from list of Device Classes (#19005) --- source/_integrations/sensor.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown index 730dd15c3a4..61ff05e99a0 100644 --- a/source/_integrations/sensor.markdown +++ b/source/_integrations/sensor.markdown @@ -22,6 +22,7 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T - **energy**: Energy in Wh or kWh. - **humidity**: Percentage of humidity in the air. - **illuminance**: The current light level in lx or lm. +- **monetary**: The monetary value. - **signal_strength**: Signal strength in dB or dBm. - **temperature**: Temperature in °C or °F. - **power**: Power in W or kW. From 0c0f5416676c32353dcba0a20a561fad927935f5 Mon Sep 17 00:00:00 2001 From: Liran Tal Date: Sat, 21 Aug 2021 15:39:28 +0300 Subject: [PATCH 05/26] docs: update required paid plan for using this field (#19017) --- source/_integrations/openexchangerates.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/openexchangerates.markdown b/source/_integrations/openexchangerates.markdown index 19474473814..06613ddf80c 100644 --- a/source/_integrations/openexchangerates.markdown +++ b/source/_integrations/openexchangerates.markdown @@ -39,7 +39,7 @@ quote: required: true type: string base: - description: The symbol of the base currency. + description: The symbol of the base currency. Note that, changing the API `base` currency is not part of the freemium API plan. required: false type: string default: USD From 8a7c474a5ab7bb54009e8028ec308320b8059d1e Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 21 Aug 2021 12:11:55 -0700 Subject: [PATCH 06/26] Update CT clamp docs (#19030) --- source/_docs/energy/electricity-grid.markdown | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/source/_docs/energy/electricity-grid.markdown b/source/_docs/energy/electricity-grid.markdown index 84a13de0e51..e9b229bac2b 100644 --- a/source/_docs/energy/electricity-grid.markdown +++ b/source/_docs/energy/electricity-grid.markdown @@ -19,18 +19,6 @@ If you want to split energy usage into multiple tariffs, [read this](/docs/energ Home Assistant will need to know the amount of energy flowing through your meter. This data can be tracked in various ways. -### Using a CT clamp sensor - -CT clamp sensors measure the instantaneous current passing through an electrical wire. To translate this into electrical power (W) you also need a voltage measurement, because Power = Current x Voltage. - -In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own with ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html). You can also use a dedicated energy meter sensor in ESPHome, which outputs more detailed data, like the [ATM90E32](https://esphome.io/components/sensor/atm90e32.html). - -The off-the-shelf solution that we advise is the [Shelly EM](https://shop.shelly.cloud/shelly-em-2-x-120a-clamp-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality integration. - -In case of three-phase electrical systems, attention should be drawn to the fact that the current measurement of a given phase is matched to the voltage of the same phase, otherwise the power measurements will be incorrect. - -_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._ - ### Connect to your meter The best way to get this data is directly from your electricity meter that sits between your house and the grid. In certain countries these meters contain standardized ways of reading out the information locally. @@ -57,6 +45,16 @@ We have developed [Home Assistant Glow](https://github.com/klaasnicolaas/home-as ![Photo of Home Assistant Glow attached to an electricity meter](/images/docs/energy/home-assistant-glow.jpg) +### Using a CT clamp sensor + +CT clamp sensors measure your energy usage by looking at the current passing through an electrical wire. This makes it possible to calculate the energy usage. In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own. + +The off-the-shelf solution that we advise is the [Shelly EM](https://shop.shelly.cloud/shelly-em-2-x-120a-clamp-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality integration. + +You can build your own using ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html) or energy meter sensors like the [ATM90E32](https://esphome.io/components/sensor/atm90e32.html). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started. + +_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._ + ### Data provided by your energy provider Some energy providers will provide you real-time information about your usage and have this data integrated into Home Assistant. From 5bba202984fdccad6545e639137691dbbe5324e7 Mon Sep 17 00:00:00 2001 From: Dycelll <52333700+Dycelll@users.noreply.github.com> Date: Sat, 21 Aug 2021 22:51:16 +0200 Subject: [PATCH 07/26] You need a Pro subscription to access API (#18802) --- source/_integrations/point.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index af0e199e6f1..d47ac9247e4 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -19,7 +19,7 @@ ha_platforms: - sensor --- -The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. +The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account and have a Pro subscription](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**. From de733088a8cf4d86b4c94a2a501a43b359de048d Mon Sep 17 00:00:00 2001 From: Phil Hollenback Date: Sat, 21 Aug 2021 13:53:23 -0700 Subject: [PATCH 08/26] Fix broken code link, edit for clarity. (#18882) Co-authored-by: Franck Nijhof --- source/_integrations/denonavr.markdown | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown index 75672de7930..989734ab63c 100644 --- a/source/_integrations/denonavr.markdown +++ b/source/_integrations/denonavr.markdown @@ -91,9 +91,9 @@ show_all_sources: zone1: description: Specifies if zone 1 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports. zone2: - description: Specifies if zone 2 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports. + description: Specifies if zone 2 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports. Some receivers do not support a second zone. update_audyssey: - description: Specifies if Audyssey settings should be updated. This can take up to 10 Seconds for some receivers. + description: Specifies if Audyssey settings should be updated. This can take up to 10 seconds for some receivers. required: false default: false type: boolean @@ -110,14 +110,25 @@ A few notes: #### Service `denonavr.get_command` -Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g., "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. -A comprehensive list of telnet protocol commands is [also available](http://assets.denon.com/_layouts/15/xlviewer.aspx?id=/DocumentMaster/us/AVR-X6400H_X4400H_X3400H_X2400H_X1400H_S930H_S730H_PROTOCOL_V01.xlsx) and so is a [full list of IR codes](http://assets.denon.com/DocumentMaster/UK/AVR3313_IR_CODE_V01.pdf) +Denon AVR receivers support a simple text-based network interface for sending commands to the receiver over the network. You can access this interface via the `denonavr.get_command` service. In addition, IR remote codes can also be sent to this interface. + +A list of network commands supported by the various Denon AVR receivers can be [found here](https://www.heimkinoraum.de/upload/files/product/IP_Protocol_AVR-Xx100.pdf). A list of IR codes can be [found here](https://www.heimkinoraum.de/upload/files/product/IP_Protocol_AVR-Xx100.pdf). + +To use these commands, call the `denonavr.get_command` service and append the specific command to the path `/goform/formiPhoneAppDirect.xml?`: | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------- | | `entity_id` | no | Name of entity to send command to. For example `media_player.marantz`| | `command` | no | Command to send to device, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2`| +So for example, the above command `/goform/formiPhoneAppDirect.xml?VSMONI2` will switch the HDMI to output 2 (if your receiver supports it). Sending an IR code works the same, so the command `/goform/formiPhoneAppDirect.xml?RCKSK0410370` will toggle muting. + +
+ +The denonavr platform supports the standard media player controls such as `turn_on` and `volume_up`. Thus calling the service `media_player.turn_on` is equivalent to calling `denonavr.get_command` with the command `/goform/formiPhoneAppDirect.xml?PWON`. See [media_player](/integrations/meida_player/) for more details. + +
+ #### Service `denonavr.set_dynamic_eq` Enable or disable DynamicEQ setting. From ac40d3e37130c6e779aefc870cafa1e1a7fe8030 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 22 Aug 2021 04:18:11 +0200 Subject: [PATCH 09/26] Small tweak to frontend integration page (#19034) --- source/_integrations/frontend.markdown | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index d939ac9789f..80755d46acd 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -46,7 +46,6 @@ frontend: type: string {% endconfiguration %} - ## Defining Themes ### Theme format @@ -99,18 +98,19 @@ frontend: Theme `happy`: Same as in the previous example. This legacy format is still supported and will behave as before and automatically use the default light theme as the base. -Theme `sad`: By using the new `mode` key plus the subkey `dark` this theme will now be based on the default dark theme. The final theme rules are determined in three steps: First, the default dark theme CSS variables will be applied, then second the CSS variables from the top level of the theme that are mode-independent (`primary-color: steelblue` in this example) and lastly the mode-specific CSS variables will be layered on top (`secondary-text-color: slategray`). +Theme `sad`: By using the new `modes` key plus the subkey `dark` this theme will now be based on the default dark theme. The final theme rules are determined in three steps: First, the default dark theme CSS variables will be applied, then second the CSS variables from the top level of the theme that are mode-independent (`primary-color: steelblue` in this example) and lastly the mode-specific CSS variables will be layered on top (`secondary-text-color: slategray`). Note: Since this example theme only has a `dark` mode defined, this mode will automatically be used. Theme `day_and_night`: This theme has both a `light` and a `dark` mode section. That tells the frontend to allow the user to choose which mode to use from the user profile (default selection is based on the system settings). Independent of the selection, the primary color will be set to green, but based on the chosen mode either the default light or dark theme will be used as the basis for rendering, plus the secondary text color will be either olive or slategray. ### Theme configuration splitting + As with all configuration, you can either: -- Directly specify the themes inside your `configuration.yaml` file -- Put them into a separate file (e.g. `themes.yaml`) and include that in your configuration (`themes: !include themes.yaml`) -- Create a dedicated folder (e.g. `my_themes`) and include all files from within this folder (`themes: !include_dir_merge_named my_themes`) +- Directly specify the themes inside your `configuration.yaml` file. +- Put them into a separate file (e.g., `themes.yaml`) and include that in your configuration (`themes: !include themes.yaml`). +- Create a dedicated folder (e.g., `my_themes`) and include all files from within this folder (`themes: !include_dir_merge_named my_themes`). For more details about splitting up the configuration into multiple files, see [this page](/docs/configuration/splitting_configuration/). @@ -120,10 +120,10 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them There are two themes-related services: - - `frontend.reload_themes`: Reloads theme configuration from your `configuration.yaml` file. - - `frontend.set_theme`: Sets backend-preferred theme name. +- `frontend.reload_themes`: Reloads theme configuration from your `configuration.yaml` file. +- `frontend.set_theme`: Sets backend-preferred theme name. - ### Service `set_theme` +### Service `set_theme` | Service data attribute | Description | | ---------------------- | --------------------------------------------------------------------------------------------------- | From f0ae72bc8538260733c7287b0ebfeda181faca75 Mon Sep 17 00:00:00 2001 From: Rich Schumacher Date: Mon, 23 Aug 2021 12:13:15 -0400 Subject: [PATCH 10/26] Update tplink.markdown: include device EP40 support (#19058) --- source/_integrations/tplink.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index de606256753..bf70b799081 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -55,6 +55,7 @@ Plugs are type `switch` when autodiscovery has been disabled. - KP400 (outdoor 2-outlet) - KP200 (indoor 2-outlet) - KP40 (outdoor 2-outlet) +- EP40 (outdoor 2-outlet) ### Wall Switches From 476abf5ec34616f5916b12e366b0a94de80d091a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 24 Aug 2021 11:53:50 +0200 Subject: [PATCH 11/26] Add blogpost about upcomming supervisor changes (#18493) Co-authored-by: Franck Nijhof Co-authored-by: Stefan Agner --- .../2021-08-24-supervisor-update.markdown | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 source/_posts/2021-08-24-supervisor-update.markdown diff --git a/source/_posts/2021-08-24-supervisor-update.markdown b/source/_posts/2021-08-24-supervisor-update.markdown new file mode 100644 index 00000000000..79f4152f08c --- /dev/null +++ b/source/_posts/2021-08-24-supervisor-update.markdown @@ -0,0 +1,62 @@ +--- +title: "Supervisor update" +description: "Upcoming changes to the Supervisor" +date: 2021-08-24 00:00:00 +date_formatted: "August 24, 2020" +comments: true +author: Joakim Sørensen +author_twitter: ludeeus +categories: + - Announcements + - Supervisor +--- + +## Renaming snapshot to backup + +"Snapshot" is a term that we have been using in the Supervisor since the beginning, +but it's not very descriptive for those that do not know what it is. +Over the next few weeks, we will start using "backup" +in all our software and documentation. + +The functionality of it does not change, this is just a rename to make it more understandable. + +## Supervised installations + +
+Having a supervisor does not make it a supervised installation, Home Assistant Operating System also has this, the information below does not apply to Home Assistant Operating System. +
+ +While we try not to break supervised installations, we do have a few things we need to change. +These adjustments you have to manually apply to your installation. Without these adjustments you will start to see warnings in your logs, and your installation will eventually be marked as unsupported. + +If you are interested to make changes required on supervised installations more maintainable, have a look at the [blog on the developer site][dev_blog]. + +As an alternative to doing these adjustments, you can migrate your installation to [Home Assistant Operating System][installation_docs]. + +## Bullseye + +Two weeks ago Debian 11 (Bullseye) was released. The upcoming version of the Supervisor will recognize that version as a supported Operating System. This means that if you are running Home Assistant Supervised, you can start upgrading that. + +Support for the previous version (Debian 10 (Buster))is now deprecated and will be removed in the first version of the Supervisor after the 4 months grace period. +This means that within the next 4 months you need to update to Debian 11. + +### Environment variables + +There are a few environment variables that you have to add in order to make the Supervisor work properly with newer versions of the Supervisor. +These variables have to be added to the run command for the Supervisor container, on most installations this is a script called from a service file. + +- `SUPERVISOR_SHARE` - The path to the directory for the Supervisor data files, typically `/usr/share/hassio`. +- `SUPERVISOR_NAME` - The name of the supervisor container, typically `hassio_supervisor` +- `SUPERVISOR_MACHINE` - The machine you are using. For a list of machine types, [have a look here][machine_types] + +### OS Agent + +Recently, we created an [OS Agent][os_agent]. OS Agent allows for better communication between the host OS and the Supervisor which will enable new features. +You can find the installation instructions for OS Agent in its [GitHub repository][os_agent]. + +If you you are interested we have also just published a [blog on the developer site][dev_blog]. + +[os_agent]: https://github.com/home-assistant/os-agent +[dev_blog]: https://developers.home-assistant.io/blog/2021/08/24/supervisor_update/ +[installation_docs]: /installation/ +[machine_types]: https://github.com/home-assistant/supervised-installer#supported-machine-types From 3cd4eb1003341d6e873b3dbec31ae70f54417871 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 24 Aug 2021 12:44:36 +0200 Subject: [PATCH 12/26] Adjust homeassistant services description to clarify their purpose (#19035) --- source/_integrations/homeassistant.markdown | 35 +++++++++++++++------ 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/source/_integrations/homeassistant.markdown b/source/_integrations/homeassistant.markdown index ef0270e522a..fccd2f0e54b 100644 --- a/source/_integrations/homeassistant.markdown +++ b/source/_integrations/homeassistant.markdown @@ -38,7 +38,7 @@ Reloads the core configuration under `homeassistant:` and all linked files. Once ### Service `homeassistant.restart` -Restarts the Home Assistant instance (also reloading the configuration on start). +Restarts the Home Assistant instance (also reloading the configuration on start). This will also do a configuration check before doing a restart. If the configuration check fails then Home Assistant will not be restarted, instead a persistent notification with the ID `persistent_notification.homeassistant_check_config` will be created. The logs will show details on what failed the configuration check. @@ -65,9 +65,12 @@ action: longitude: 117.22743 ``` -### Service `homeassistant.toggle` +### Service `homeassistant.toggle` -Generic service to toggle devices on/off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services. +Generic service to toggle devices on/off. Same usage as the +`light.toggle`, `switch.toggle`, etc. services. The difference with this +service compared the others, is that is can be used to mix different domains, +for example, a light and a switch can be toggled in a single service call. | Service data attribute | Optional | Description | |---------------------------|----------|-------------------------------------------------------| @@ -79,12 +82,17 @@ Generic service to toggle devices on/off under any domain. Same usage as the lig action: service: homeassistant.toggle target: - entity_id: light.living_room + entity_id: + - light.living_room + - switch.tv ``` -### Service `homeassistant.turn_on` +### Service `homeassistant.turn_on` -Generic service to turn devices on under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services. +Generic service to toggle devices on. Same usage as the +`light.turn_on`, `switch.turn_on`, etc. services. The difference with this +service compared the others, is that is can be used to mix different domains, +for example, a light and a switch can be turned on in a single service call. | Service data attribute | Optional | Description | |---------------------------|----------|-------------------------------------------------------| @@ -96,12 +104,17 @@ Generic service to turn devices on under any domain. Same usage as the light.tur action: service: homeassistant.turn_on target: - entity_id: light.living_room + entity_id: + - light.living_room + - switch.tv ``` ### Service `homeassistant.turn_off` -Generic service to turn devices off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services. +Generic service to toggle devices off. Same usage as the +`light.turn_off`, `switch.turn_off`, etc. services. The difference with this +service compared the others, is that is can be used to mix different domains, +for example, a light and a switch can be turned off in a single service call. | Service data attribute | Optional | Description | |---------------------------|----------|-------------------------------------------------------| @@ -113,10 +126,12 @@ Generic service to turn devices off under any domain. Same usage as the light.tu action: service: homeassistant.turn_off target: - entity_id: light.living_room + entity_id: + - light.living_room + - switch.tv ``` -### Service `homeassistant.update_entity` +### Service `homeassistant.update_entity` Force one or more entities to update its data rather than wait for the next scheduled update. From ec30fba22abbe35e8fe4aefdecccb6fe5a581d58 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 24 Aug 2021 12:45:40 +0200 Subject: [PATCH 13/26] Remove non-existing services from Kostal Plenticore documentation (#19036) --- .../_integrations/kostal_plenticore.markdown | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/source/_integrations/kostal_plenticore.markdown b/source/_integrations/kostal_plenticore.markdown index a7392c7357d..d7646745fe7 100644 --- a/source/_integrations/kostal_plenticore.markdown +++ b/source/_integrations/kostal_plenticore.markdown @@ -105,23 +105,3 @@ The following sensors are available in the library:
Setting values change less often, therefore these sensors are only polled every 5 minutes.
- -## Services - -### Service `kostal_plenticore.write_setting_value` - -Write a new value to a setting. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String that point to a setting `entity_id`. -| `value` | no | The new value to write to the setting. - -Example: - -Set the minimal SoC of the battery: - -```yaml -entity_id: sensor.plenticore_battery_min_soc -value: 10 -``` From e0011641cf3a565207cdbc21b1dc2080b6f31ba6 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 24 Aug 2021 12:46:51 +0200 Subject: [PATCH 14/26] Clarify target example in script service call documentation (#19037) --- source/_docs/scripts/service-calls.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index 896126b7aa4..bb65a50c8f7 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -30,12 +30,13 @@ This is done with the `target` key. A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`. Each of these can be a list. -When the service is called, the areas and devices will be resolved to entities. +The following example uses a single service call to turn on the lights in the +living room area, 2 additional light devices and 2 additional light entities: ```yaml -service: homeassistant.turn_on +service: light.turn_on target: - area_id: livingroom + area_id: living_room device_id: - ff22a1889a6149c5ab6327a8236ae704 - 52c050ca1a744e238ad94d170651f96b From e6d42dcf71a4fb8d6a2dd178fa9533fd6dcb662e Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 24 Aug 2021 12:47:21 +0200 Subject: [PATCH 15/26] Fix typo in fido documentation (#19038) --- source/_integrations/fido.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/fido.markdown b/source/_integrations/fido.markdown index 5722b8fe182..58f9831e6fa 100644 --- a/source/_integrations/fido.markdown +++ b/source/_integrations/fido.markdown @@ -84,6 +84,6 @@ monitored_variables: description: Other talk time used (It could be international calls) other_talk_limit: description: Other talk time limit - other_talt_remaining: + other_talk_remaining: description: Other talk time remaining {% endconfiguration %} From 8718d5583b1b8d7260cfd998af046c44b772cf69 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 24 Aug 2021 12:48:01 +0200 Subject: [PATCH 16/26] Fixes typo on Derivative page (#19033) --- source/_integrations/derivative.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/derivative.markdown b/source/_integrations/derivative.markdown index 7e169ca99f5..e8032a79aa7 100644 --- a/source/_integrations/derivative.markdown +++ b/source/_integrations/derivative.markdown @@ -80,6 +80,6 @@ sensor: source: sensor.temperature name: Temperature change per hour round: 1 - unit_time: h # the resulting "unit_of_measurement" will be °C/h if the sensor.temperate has set °C as it's unit + unit_time: h # the resulting "unit_of_measurement" will be °C/h if the sensor.temperate has set °C as its unit time_window: "00:30:00" # we look at the change over the last half hour ``` From 55f05418b8b5e595b1bf3bfe3517973db6e89abb Mon Sep 17 00:00:00 2001 From: Karim Roukoz Date: Tue, 24 Aug 2021 07:11:50 -0400 Subject: [PATCH 17/26] Fixed Hue bulb reset instructions (#18885) --- source/_integrations/zha.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 7dbaa6f43ac..c1ec45ff760 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -391,9 +391,11 @@ Using a Philips Hue Dimmer Switch or Lutron Connected Bulb Remote is probably th 1. Turn on your Hue bulb/light you want to reset. (It is important that the bulb has just been turned). 2. Hold the Philips Hue Dimmer Switch near your bulb (closer than 10 centimeters / 4 inches). -3. Press and hold the (I)/(ON) and (O)/(OFF) buttons on the Philips Hue Dimmer Switch for about 10 seconds continuously until your bulb starts to blink. +3. Press and hold the (I)/(ON) and (O)/(OFF) buttons on the Philips Hue Dimmer Switch for about 10 seconds continuously until your bulb starts to blink. On the newer switches hold the I/O and Scene Switch buttons. 4. Your bulb should stop blinking and eventually turn on again. At the same time, a green light on the top left of your remote indicates that your bulb has been successfully reset to factory default settings. +Note: If you are not unable to reset the bulb, remove it from the Hue Bridge and retry the procedure. + #### Lutron Connected Bulb Remote 1. Turn on your Hue bulb/light you want to reset. (It is important that the bulb has just been turned). From 6bc36c75c7e92cfa327f690c532d10fd826d4d71 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Tue, 24 Aug 2021 13:14:52 +0200 Subject: [PATCH 18/26] Change description for unhealthy (#19057) Co-authored-by: Franck Nijhof --- source/more-info/unhealthy/untrusted.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/more-info/unhealthy/untrusted.markdown b/source/more-info/unhealthy/untrusted.markdown index 94c952a9190..a91d3745f83 100644 --- a/source/more-info/unhealthy/untrusted.markdown +++ b/source/more-info/unhealthy/untrusted.markdown @@ -5,8 +5,8 @@ description: "More information on why untrusted content marks an installation as ## The issue -Home Assistant detected untrusted code. It looks like someone/something tried to inject not signed images or code into your Home Assistant system. But don't worry, we blocked this action and nothing was applied. +Home Assistant detected untrusted code. It looks like someone/something injected not signed images or code into your Home Assistant system. ## The solution -Please make sure your network is not affected by an intruder and try it again. To reset this status, you need to restart the Supervisor. +Please make sure your network is not affected by an intruder. We recommend reinstalling your installation and make sure only authorized persons have access to your instance. From 98a3a01f6b8be65a984384dde36a8645c8625c96 Mon Sep 17 00:00:00 2001 From: Philip Allgaier Date: Tue, 24 Aug 2021 16:28:01 +0200 Subject: [PATCH 19/26] Update 2021-08-24-supervisor-update.markdown (#19070) --- source/_posts/2021-08-24-supervisor-update.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2021-08-24-supervisor-update.markdown b/source/_posts/2021-08-24-supervisor-update.markdown index 79f4152f08c..a990d215a5d 100644 --- a/source/_posts/2021-08-24-supervisor-update.markdown +++ b/source/_posts/2021-08-24-supervisor-update.markdown @@ -37,7 +37,7 @@ As an alternative to doing these adjustments, you can migrate your installation Two weeks ago Debian 11 (Bullseye) was released. The upcoming version of the Supervisor will recognize that version as a supported Operating System. This means that if you are running Home Assistant Supervised, you can start upgrading that. -Support for the previous version (Debian 10 (Buster))is now deprecated and will be removed in the first version of the Supervisor after the 4 months grace period. +Support for the previous version (Debian 10 (Buster)) is now deprecated and will be removed in the first version of the Supervisor after the 4 months grace period. This means that within the next 4 months you need to update to Debian 11. ### Environment variables From 78f203d853be17a6451b9c753c3c0997c094cc11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 24 Aug 2021 17:56:25 +0200 Subject: [PATCH 20/26] Update year in blogpost (#19071) --- source/_posts/2021-08-24-supervisor-update.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2021-08-24-supervisor-update.markdown b/source/_posts/2021-08-24-supervisor-update.markdown index a990d215a5d..31f6f2f0301 100644 --- a/source/_posts/2021-08-24-supervisor-update.markdown +++ b/source/_posts/2021-08-24-supervisor-update.markdown @@ -2,7 +2,7 @@ title: "Supervisor update" description: "Upcoming changes to the Supervisor" date: 2021-08-24 00:00:00 -date_formatted: "August 24, 2020" +date_formatted: "August 24, 2021" comments: true author: Joakim Sørensen author_twitter: ludeeus From 57989d82ac127c7b81d0b02126c7813405d41ada Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 24 Aug 2021 18:02:44 +0200 Subject: [PATCH 21/26] Fix position of phone image (#19051) --- sass/custom/_layout.scss | 4 ++++ sass/custom/_paulus.scss | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/sass/custom/_layout.scss b/sass/custom/_layout.scss index 0d3a6f7a682..e51aa942dab 100644 --- a/sass/custom/_layout.scss +++ b/sass/custom/_layout.scss @@ -75,5 +75,9 @@ table { > .grid-wrapper { z-index: 0; } + + img { + margin-bottom: 8px; + } } } \ No newline at end of file diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index 0be4ec6efe3..10d4b3eadfd 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -79,6 +79,10 @@ $primary-color: #049cdb; display: inline-block; font-weight: 500; } + + img { + display: block; + } } .material-card { From 29fd215a8f846a3e69d19f59fd9561b72982890a Mon Sep 17 00:00:00 2001 From: tomaszstrejczek <7871555+tomaszstrejczek@users.noreply.github.com> Date: Wed, 25 Aug 2021 08:45:48 +0200 Subject: [PATCH 22/26] Explain API authentication when configuring deCONZ (#19060) Co-authored-by: Robert Svensson --- source/_integrations/deconz.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index fd2ecba00a1..78f565f1806 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -60,6 +60,8 @@ See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/ {% include integrations/config_flow.md %} +Running a stand-alone instance of deCONZ (non add-on installation) requires a pairing between the deCONZ gateway and Home Assistant. To allow Home Assistant to connect with deCONZ go to the Phoscon UI click Settings -> Gateway -> Advanced and press the "Authenticate app" button. This same information is also shown during the config flow of the deCONZ integration. + ## Debugging integration If you have problems with deCONZ or the integration you can add debug prints to the log. From 8b720bf54049fc647dc70a830884f8db5e1d2184 Mon Sep 17 00:00:00 2001 From: Thorjan Knudsvik Date: Wed, 25 Aug 2021 09:29:39 +0200 Subject: [PATCH 23/26] Automation Debugging (#18400) Co-authored-by: Franck Nijhof --- .../_docs/automation/troubleshooting.markdown | 28 ++++++++---------- .../integrations/automation/logbook.png | Bin 2833 -> 0 bytes 2 files changed, 12 insertions(+), 16 deletions(-) delete mode 100644 source/images/integrations/automation/logbook.png diff --git a/source/_docs/automation/troubleshooting.markdown b/source/_docs/automation/troubleshooting.markdown index bd6b0bd3c92..349752b59f8 100644 --- a/source/_docs/automation/troubleshooting.markdown +++ b/source/_docs/automation/troubleshooting.markdown @@ -3,31 +3,27 @@ title: "Troubleshooting Automations" description: "Tips on how to troubleshoot your automations." --- -## Using debug traces +When an automation is run, all steps are recorded and a trace is made. From the UI choose **Configuration** which is located in the sidebar, then click on **Automation** to go to the automation editor or click this button directly: {% my automation badge %} -Every time an automation runs, a debugging trace is generated regardless of whether the automation was completed, aborted, or suffered an error. Traces allow you to interactively inspect the state of the automation at every step and also check the values of [variables](/docs/scripts/#variables) and rendered [templates](/docs/configuration/templating/). Traces can be accessed in the {% my automations title="Automations Section" %} of {% my configuration %}. +Click on the clock icon next to an automation to enter the debugging screen. Alternatively, click on **Show trace** directly from a Logbook automation entry. -![Automation debug trace example](/images/integrations/automation/automation-tracing.png) +![Automation tracing example](/images/integrations/automation/automation-tracing.png) + +The above screenshot shows a previous run of an automation. The automation is displayed using an interactive graph, highlighting which path the automation took. Each node in the graph can be clicked to view the details on what happened with the automation during that specific step. It traces the complete run of an automation. + +The debugging screen is split into four features, the first being the Step Details which provides all details for each step of the automation. The second feature is the Trace Timeline which the screenshot above shows and where the automation can be followed on a timeline. The next is Related logbook entries, as the name says a logbook for all the entries related to the specific trace. The last two features are Automation Config and optionally Blueprint Config for the automation YAML code. Automations created in YAML must have an [`id`](/docs/automation/yaml/#migrating-your-yaml-automations-to-automationsyaml) assigned in order for debugging traces to be stored. -By default the last 5 traces are stored for each automation, this can be adjusted in the [YAML configuration](/docs/automation/yaml/#number-of-debug-traces-stored) of an automation. Stored traces are reset each time Home Assistant restarts. +#### Traces #### -## Inspecting logs and the Logbook +The last 5 traces are recorded for all automations. It is possible to change this by adding the following code to your automation. -You can verify that your automation rules are being initialized correctly by watching both the realtime logs (`homeassistant.log` in the configuration directory) and also the [Logbook](/integrations/logbook/). The realtime logs will show the rules being initialized (once for each trigger), example: - -```text -INFO [homeassistant.components.automation] Initialized rule Rainy Day -INFO [homeassistant.components.automation] Initialized rule Rainy Day -INFO [homeassistant.components.automation] Initialized rule Rainy Day -INFO [homeassistant.components.automation] Initialized rule Rain is over +```yaml +trace: + stored_traces: 1 ``` -The Logbook integration will show a line entry when an automation is triggered. You can look at the previous entry to determine which trigger in the rule triggered the event. - -![Logbook example](/images/integrations/automation/logbook.png) - [template]: /topics/templating/ ## Testing your automation diff --git a/source/images/integrations/automation/logbook.png b/source/images/integrations/automation/logbook.png deleted file mode 100644 index 5c2add90395e35389f9a904cd877b2bbf651260a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2833 zcmV+s3-0uZP)Jt5+Cb-W&P_Yfiii_c$nV+CvzAa1{?+)28RKM0fzyH!C~Nx!?aDZZY60u z;P8eX17D2?9Ny4+ZNB2qz8QEpu0>(|&nZw~fCm&P5HJBQ5TGzq4;w5gOj+iEFlbRR za8Y8Q6dkNExF|7rLCIi+MWC*M_vSRWov)db5oYY`=Hj5 zn{A((DUQ=V^H%%i~R%9~>^VeBl44g184_1*c&N{nMlbEt(Ly_rtvR5f# zW-dY|mYE5-PUBzp$XSqFxPE8`0?u}^mhB3z5%D! z8C&FXI<@px?Fa^jf#CJFgr{L~J~!($-w%KJYrfg;2U7jKYl@%MjF$IxbJk&KO%pg4 zO$Jm;8+*&JQ9w2jQ~gU)@o(K)S|_1LrLHmZLx?ju0G60=kP{z@Jd~WcPXDaawV_sq z(dF1!0K-hcZy%fkL)2iH&mLsZt7SeF^yXdY`yQ_J2{HUQyEw9|J*_{N-!Awato-|| zR7W$QgJ$40C^v{<=r@OlryEp{263j*uNK2*{e|_o)}9vC?(Qnp=!Ye=LAeIQm7&n` z$b;n-M?>>%)?r7cM#F<%R2Dyr;S{2P&dYo%7`xi#wANuX4lV}I&0JE0Tbp51L`z8} zbrTsjw~y%pW8d;trg==2FFLguCjN)M@4At$|7?lwGZ7?ue*m9x>B#eZe?X|$V7M|A zcF8(jxPs}2MG(K~hZFcUqq$HtOt0W~LT9l`bX|t~lbAXFfqs}x1!MCr*bh_XGVGli z!?>r#;JJO6;<0)R(`MG_hRAOw!)9mMi*&JxD~es|p5sTMYs<7I!?bidd*x&m-$pMHt#}~hIC;&aU#cV`;G@$`>rMSupc*UvHz!*1bt6c%b#y8!!5&EIG`T) zvn*G>jdgkRO{>6PrH99QUAlT+ZW;c)8NR%{jN>?pqL&XR!!Xs#xaa%vcc=IrZJc!$aBy zR()-t9V*Bb;TQ1;sd*3n*&5t#j^X};GUf|Z3wU&Sc>9yH^II|l90Y+iOVchHFplBZ zR#`Ww;HI)lP(u&hWJ?(4(}$~v{|&>AVduAWa&p2lFa+4Ar>C!lmXl|ejcG?%)y~PB zHoZVQ#Jq=AZ$V%lLkOkl7sXU|7p;pG^XGXvzx6#4d^3{2D&($iqE`@P7e?{glIf3P3hCUx{PA!XGjFauEk*dofAd zDb=LO?5o6mp3J6DX1615?_}z1c5-6R;-s;Tpfi{Hd`dmU4s6`)n@V%K+2#C}!Z2jz zF12v51+M1K_L5kFK^r0)^J4fak4}gu!QP;Zjv%3Xfc~v$1SoqqFZ6l1TEuVy(zJ(a z1uzB_ohz7TnM)tw8wA5UXg1^^=P~>O#;G_~jHZ}xBSAeU2k-h%UES_3P5MoQyl#L-o+pI9Qm&E6>;GrNt$`MfqAY5P>qwZm)1bzivA^e7( z;X$h8d}7ZWkUC$d8P>E4xSuQnzQI`eGE$eRZpxIaG4#-h6(S$-g)=NSWRScFVsu*k z{^wvcxB4ovR=p`yczPI&cyGPEliiYmHL@U>e=adcS{enzn#ExZYfjhsEjDSO{l=r6d; z49oruxXhj`TAwHVqu}-KPI`MMi!~B!)V)9QKd24-@NC?SVeRQUzom8O(tHJr{snM( zd8zGe5urHnl+SL0prI7QF`5les+g}S2z?L;FYf0=EF~&+AYAHiX zl)l|qmYuT%_lc;M4=_$;of(x?hB26!88!r5pW#^#)iS=OlGR~|8Lx-Y&97At%kotJ zq1O96nHkpC!&-YMyEPJXa-tyb%=IwGQa|nuGVJ`8XbGAgH><)~tyZnSEzvHtW7Z#U zsx_#(lWSD!GBUr!fmf!+fbZ_^m{p^!846Yb5UElxm?mY~Gz!Rbkckkgp?bERU0002MAb;z9qbP@P j7;qSv!{9LBFyJr{c)olCuLzrj00000NkvXXu0mjfsuzFM From 5167f1318911d75eb0a63f0f4e7276106bd582d8 Mon Sep 17 00:00:00 2001 From: Darrell Date: Wed, 25 Aug 2021 03:30:56 -0400 Subject: [PATCH 24/26] Update mqtt_room.markdown (#19073) --- source/_integrations/mqtt_room.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/mqtt_room.markdown b/source/_integrations/mqtt_room.markdown index 5c4d4d14464..cfe52354e46 100644 --- a/source/_integrations/mqtt_room.markdown +++ b/source/_integrations/mqtt_room.markdown @@ -66,6 +66,7 @@ Example JSON that should be published to the room topics: This integration works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. Instead of developing your own application, you can also use any of these already existing clients: +- [**ESPresense**](https://github.com/ESPresense/ESPresense): Fork of ESP32-MQTT-room w/ fingerprinting, tile support, Kalman filter, based on C++/Platformio - [**ESP-32-BLE-Scanner for Home Assistant**](https://github.com/HeimdallMidgard/ESP-32-BLE-Scanner): ESP32 based BLE presence detection for Home Assistant with web GUI - [**room-assistant**](https://github.com/mKeRix/room-assistant): looks for Bluetooth LE beacons, based on Node.js - [**Happy Bubbles Presence Server**](https://github.com/happy-bubbles/presence): presence detection server for Happy Bubbles BLE-scanning devices, based on Go From 03124d99e2b70f8dbe6686b2178237563921539d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Wed, 25 Aug 2021 09:48:59 +0200 Subject: [PATCH 25/26] Rename snapshot -> backup (#18129) Co-authored-by: Franck Nijhof --- plugins/my.rb | 2 +- source/_includes/common-tasks/backups.md | 59 ++++++++++++++++++++ source/_includes/common-tasks/commandline.md | 2 +- source/_includes/common-tasks/file_access.md | 4 +- source/_includes/common-tasks/snapshots.md | 59 -------------------- source/_includes/common-tasks/update.md | 2 +- source/_integrations/ozw.markdown | 2 +- source/_integrations/zwave_js.markdown | 2 +- source/_redirects | 2 + source/common-tasks/os.markdown | 2 +- source/common-tasks/supervised.markdown | 2 +- source/installation/index.html | 2 +- source/more-info/free-space.markdown | 8 +-- source/more-info/unsupported/os.markdown | 4 +- 14 files changed, 77 insertions(+), 75 deletions(-) create mode 100644 source/_includes/common-tasks/backups.md delete mode 100644 source/_includes/common-tasks/snapshots.md diff --git a/plugins/my.rb b/plugins/my.rb index 7ec7cd19ea3..55008e058b4 100644 --- a/plugins/my.rb +++ b/plugins/my.rb @@ -101,7 +101,7 @@ module Jekyll "general" => "General Settings", "info" => "Information", "supervisor_info" => "Supervisor Information", - "supervisor_snapshots" => "Snapshots", + "supervisor_backups" => "Backups", } def parse_options(input, context) diff --git a/source/_includes/common-tasks/backups.md b/source/_includes/common-tasks/backups.md new file mode 100644 index 00000000000..c7519032812 --- /dev/null +++ b/source/_includes/common-tasks/backups.md @@ -0,0 +1,59 @@ +## Backups + +Backup of your Home Assistant and add-on data and configuration. They are stored in a compressed archive file (.tar). Backups are made from the Supervisor Backups panel. There is also a service available that allows you to trigger the creation of a backup from an automation. Backups are stored in the /backup directory. + +A full backup includes the following directories: + +* `config` +* `share` +* `addons` (only manually installed or created add-ons, not those installed from the store) +* `ssl` +* `media` + +A partial backup consists of any number of the above default directories and installed add-ons. + +### Making a Backup from the UI + +1. Go to {% my supervisor_backups title="Supervisor > Backups" %} in the UI. +2. Provide a name for the backup. +3. Choose full or partial. +4. Choose to password protect or not. Password-protected backups cannot easily be browsed outside of Home Assistant OS. +5. Click "Create" to begin the backup. + +### Restoring a Backup on a new install + +You can make use of backup which you have copied off of a previous install to restore to a new installation during the onboarding process. Follow the link at the bottom of the account creation page to upload your backup from the previous installation. + +For restoring a backup at any other time, visit the Supervisor backup panel in your UI and use the following steps: + +1. Select "Upload Backup" from the icon in the upper right of the page. +2. Click on the folder icon to navigate to your backup .tar file and select it. + +When the upload is completed, you will be presented with the backup restore dialog for restoring it, and can then choose to restore in full or in part by manually selecting individual items. + +If the backup you are uploading is more than 1GB in size, it can be faster and more efficient to make use of the Samba add-on in order to transfer files to the `/backup` directory. + +The length of time it takes to create or restore backup will depend on how much you have to compress or decompress. + +If you're looking to slim down your backup, check if your configuration directory contains a large database file (`home-assistant_v2.db`). See the [`recorder`](/integrations/recorder/) integration page for options to keep your database data down to a size that won't cause issues. Note the keep days, purge interval, and include/exclude options. + +When the restore is complete, Home Assistant will restart to apply the new settings. You will lose the connection to the UI and it will return once the restart is completed. + +### Creating backup using the Home Assistant Command Line Interface + +1. `ha backups list` - lists backups and their slugnames +2. `ha backups restore slugname` - restores a specific backup +3. `ha backups new --name nameofbackup` - create a backup + +Use `ha help` to get more information about the command line usage. + + +### Copying your backups to another location + +You often need a backup in case your system has crashed. If you only store them on the crashed device, you won't be able to access them easily. We recommend that you manually copy them from `/backup` to another machine on occasion. Or even better, create an automation to handle that, or make use of one of the following add-ons: + +- [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup) +- [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync) +- [Nextcloud Backup](https://github.com/Sebclem/hassio-nextcloud-backup) +- [Samba backup](https://github.com/thomasmauerer/hassio-addons/tree/master/samba-backup) +- [Remote Backup (uses scp)](https://github.com/overkill32/hassio-remote-backup) diff --git a/source/_includes/common-tasks/commandline.md b/source/_includes/common-tasks/commandline.md index 25e8a28d22e..ee40123c174 100644 --- a/source/_includes/common-tasks/commandline.md +++ b/source/_includes/common-tasks/commandline.md @@ -84,7 +84,7 @@ Available Commands: observer Get information, update or configure the Home Assistant observer os Operating System specific for updating, info and configuration imports resolution Resolution center of Supervisor, show issues and suggest solutions - snapshots Create, restore and remove snapshot backups + backups Create, restore and remove backups supervisor Monitor, control and configure the Home Assistant Supervisor Flags: diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md index e28f99d57f5..207e3825049 100644 --- a/source/_includes/common-tasks/file_access.md +++ b/source/_includes/common-tasks/file_access.md @@ -37,7 +37,7 @@ You would then enter the IP address or hostname of your Home Assistant OS instan ### Installing and using the SSH add-on (requires enabling advanced mode for the HA user) -The Terminal & SSH add-on provides access over an SSH connection, and also includes nano and vi editors. It can be installed from the add-on store's Official add-on repository after enabling advanced mode for your Home Assistant user's profile. Additionally, this add-on provides access to the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring snapshots, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). The Terminal & SSH add-on does *not* provide access to the underlying host file system. +The Terminal & SSH add-on provides access over an SSH connection, and also includes nano and vi editors. It can be installed from the add-on store's Official add-on repository after enabling advanced mode for your Home Assistant user's profile. Additionally, this add-on provides access to the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). The Terminal & SSH add-on does *not* provide access to the underlying host file system. To use the add-on, enter a password or public key on its configuration page, then save and start the add-on. @@ -47,7 +47,7 @@ The Terminal & SSH add-on also provides a web terminal which allows you to acces ### Installing and using the Visual Studio Code (VSC) add-on -The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring snapshots, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). +The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details. diff --git a/source/_includes/common-tasks/snapshots.md b/source/_includes/common-tasks/snapshots.md deleted file mode 100644 index 49f33abd950..00000000000 --- a/source/_includes/common-tasks/snapshots.md +++ /dev/null @@ -1,59 +0,0 @@ -## Snapshots - -Snapshots are a backup of your Home Assistant and add-on data and configuration. They are stored in a compressed archive file (.tar). Snapshots are made from the Supervisor Snapshot panel. There is also a service available which allows you to trigger the creation of a snapshot from an automation. Backups are stored in the /backup directory. - -A full snapshot includes the following directories: - -* `config` -* `share` -* `addons` (only manually installed or created add-ons, not those installed from the store) -* `ssl` -* `media` - -A partial snapshot consists of any number of the above default directories and installed add-ons. - -### Making a Snapshot from the UI - -1. Go to {% my supervisor_snapshots title="Supervisor > Snapshots" %} in the UI -2. Provide a name for the snapshot. -3. Choose full or partial. -4. Choose to password protect or not. Password protected snapshots cannot easily be browsed outside of Home Assistant OS -5. Click "Create" to begin the snapshot. - -### Restoring a Snapshot on a new install - -You can make use of snapshots which you have copied off of a previous install to restore to a new installation during the onboarding process. Follow the link at the bottom of the account creation page to upload your snapshot from the previous installation. - -For restoring a snapshot at any other time, vist the Supervisor Snapshot panel in your UI and use the following steps: - -1. Select "Upload Snapshot" from the icon in the upper right of the page. -2. Click on the folder icon to navigate to your snapshot .tar file and select it. - -When the upload is completed, you will be presented with the snapshot restore dialog for restoring it, and can then choose to restore in full or in part by manually selecting individual items. - -If the snapshot you are uploading is more than 1GB in size, it can be faster and more efficient to make use of the Samba add-on in order to transfer files to the `/backup` directory. - -The length of time it takes to create or restore snapshots will depend on how much you have to compress or decompress. - -If you're looking to slim down your snapshots, check if your configuration directory contains a large database file (`home-assistant_v2.db`). See the [`recorder`](https://www.home-assistant.io/components/recorder/) integration page for options to keep your database data down to a size that won't cause issues. Note the keep days, purge interval, and include/exclude options. - -When the restore is complete, Home Assistant will restart to apply the new settings. You will lose the connection to the UI and it will return once the restart is completed. - -### Creating snapshots using the Home Assistant Command Line Interface - -1. `ha snapshot list` - lists snapshots and their slugnames -2. `ha snapshot restore slugname` - restores a specific snapshot -3. `ha snapshot new --name nameofsnapshot` - create a snapshot - -Use `ha help` to see more info. - - -### Copying your snapshots to another location - -You often need a snapshot in case your system has crashed. If you only store them on the crashed device, you won't be able to access it easily. We recommend that you manually copy them from `/backup` to another machine on occasion. Or even better, create an automation to handle that, or make use of one of the following add-ons: - -- [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup) -- [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync) -- [Nextcloud Backup](https://github.com/Sebclem/hassio-nextcloud-backup) -- [Samba backup](https://github.com/thomasmauerer/hassio-addons/tree/master/samba-backup) -- [Remote Backup (uses scp)](https://github.com/overkill32/hassio-remote-backup) diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md index 9eab6f83ea9..362f790e5ee 100644 --- a/source/_includes/common-tasks/update.md +++ b/source/_includes/common-tasks/update.md @@ -2,7 +2,7 @@ Best practice for updating a Home Assistant installation: -1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the snapshot functionality Home Assistant offers{% endif %}. +1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}. 1. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**. {% if page.installation == "os" or page.installation == "supervised" %} 1. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on. diff --git a/source/_integrations/ozw.markdown b/source/_integrations/ozw.markdown index d2b4bbdf816..1ad01cd2f9a 100644 --- a/source/_integrations/ozw.markdown +++ b/source/_integrations/ozw.markdown @@ -61,7 +61,7 @@ will try to migrate the entity IDs, names, icons and areas of the entities and devices of your Z-Wave integration to your OpenZWave integration. At the end of the migration, the Z-Wave integration configuration entry will be removed. -Make sure you take necessary backups, eg a Supervisor snapshot, before migrating +Make sure you take necessary backups, eg a Supervisor backup, before migrating to be able to restore the Z-Wave integration. The wizard may not be able to migrate all entity and device information. It will show you what entity and device information failed to migrate. diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown index 521c392d20b..ce9400e3710 100644 --- a/source/_integrations/zwave_js.markdown +++ b/source/_integrations/zwave_js.markdown @@ -430,7 +430,7 @@ It is perfectly doable to switch over from one of the above mentioned previous i ### In a nutshell this is what the migration path looks like -1) Make a **backup** of your Home Assistant configuration. If you're running the supervisor this is very easy to do by creating a snapshot. You should do this so you'll be able to quickly revert if you may run into unexpected problems. +1) Make a **backup** of your Home Assistant configuration. If you're running the supervisor this is very easy to do by creating a backup. You should do this so you'll be able to quickly revert if you may run into unexpected problems.
Write down/copy your Z-Wave network key somewhere, you are going to need it later.
diff --git a/source/_redirects b/source/_redirects index 8f7a1944841..051e06fe088 100644 --- a/source/_redirects +++ b/source/_redirects @@ -2120,6 +2120,8 @@ /cookbook/#infrastructure /examples/#infrastructure /cookbook/#automation-examples /examples /cookbook /examples +/common-tasks/os/#snapshots /common-tasks/os/#backups +/common-tasks/supervised/#snapshots /common-tasks/supervised/#backups # Migrated Community Guides /cookbook/apache_configuration https://community.home-assistant.io/t/reverse-proxy-with-apache/196942 diff --git a/source/common-tasks/os.markdown b/source/common-tasks/os.markdown index 090af5518f3..4baafcb6fbb 100644 --- a/source/common-tasks/os.markdown +++ b/source/common-tasks/os.markdown @@ -12,7 +12,7 @@ This section will provide guides to some common tasks and information which you {% include common-tasks/development_version.md %} {% include common-tasks/configuration_check.md %} {% include common-tasks/file_access.md %} -{% include common-tasks/snapshots.md %} +{% include common-tasks/backups.md %} {% include common-tasks/commandline.md %} {% include common-tasks/lost_password.md %} {% include common-tasks/third-party-addons.md %} diff --git a/source/common-tasks/supervised.markdown b/source/common-tasks/supervised.markdown index 4db6bebb664..f7305e00783 100644 --- a/source/common-tasks/supervised.markdown +++ b/source/common-tasks/supervised.markdown @@ -10,7 +10,7 @@ installation_name: Supervised {% include common-tasks/development_version.md %} {% include common-tasks/configuration_check.md %} {% include common-tasks/file_access.md %} -{% include common-tasks/snapshots.md %} +{% include common-tasks/backups.md %} {% include common-tasks/commandline.md %} {% include common-tasks/lost_password.md %} {% include common-tasks/third-party-addons.md %} \ No newline at end of file diff --git a/source/installation/index.html b/source/installation/index.html index 76755c98269..74c999278b9 100644 --- a/source/installation/index.html +++ b/source/installation/index.html @@ -228,7 +228,7 @@ toc: true ✅❌❌✅ - Snapshots + Backups ✅❌❌✅ diff --git a/source/more-info/free-space.markdown b/source/more-info/free-space.markdown index b63ca5789f2..f3e122ce603 100644 --- a/source/more-info/free-space.markdown +++ b/source/more-info/free-space.markdown @@ -8,7 +8,7 @@ Reaching your storage limit, this page will help you when that happens. There are several things you can do to free up some space: - [Clean the database](#clean-the-database) -- [Delete old snapshots](#delete-old-snapshots) +- [Delete old backups](#delete-old-backups) - [Uninstall unused add-ons](#uninstall-unused-add-ons) - [Last resort](#last-resort) @@ -22,10 +22,10 @@ You can [filter](/integrations/recorder/#configure-filter) what you send to the database, and even change how long it stores the data [with the `purge_keep_days` setting](/integrations/recorder/#purge_keep_days) -## Delete old snapshots +## Delete old backups Open the Home Assistant UI and go to "Supervisor" in the sidebar, and then to -the "Snapshots" tab, here you will see all your snapshots, these can be +the "Backups" tab, here you will see all your backups, these can be downloaded and placed somewhere safe. When you have done that, you can delete them in the UI and it will free up some space for you. @@ -47,5 +47,5 @@ documentation for your hypervisor on how to expand disks for virtual machines. Home Assistant will auto-expand to use the newly added space. If you are not running a VM, you need to replace your storage medium -(typically, this will be an SD card). You can use [snapshots](/hassio/haos_common_tasks/#home-assistant-os-snapshots) to quickly restore your Home Assistant +(typically, this will be an SD card). You can use [backups](/hassio/haos_common_tasks/#home-assistant-os-backups) to quickly restore your Home Assistant installation on a new storage medium. diff --git a/source/more-info/unsupported/os.markdown b/source/more-info/unsupported/os.markdown index 4a5ea69672e..036808dbbd1 100644 --- a/source/more-info/unsupported/os.markdown +++ b/source/more-info/unsupported/os.markdown @@ -17,7 +17,7 @@ These operating systems are actively tested and maintained, for use with the Sup You need to reinstall the host machine running the Supervisor on one of the supported operating systems. -The best approach here is to take a full snapshot of your current installation +The best approach here is to take a full backup of your current installation from the Supervisor panel, then reinstall your host with one of the supported operating systems. @@ -25,4 +25,4 @@ If the host is a virtual machine or a supported board, you can use our [applianc If not, you can get [Debian from here](https://www.debian.org/) and use our [convenience installation script](https://github.com/home-assistant/supervised-installer). Make sure you make it compliant with [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), the convenience script will handle most of that for you. -When the new host is set up and you can reach the Home Assistant frontend, you can upload and restore the snapshot you made earlier. +When the new host is set up and you can reach the Home Assistant frontend, you can upload and restore the backup you made earlier. From 6e4564cbce913f99131f7312b151b5fc0769885e Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 25 Aug 2021 09:49:16 +0200 Subject: [PATCH 26/26] Update Supervised supported systems (#19031) --- source/more-info/unsupported/os.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/more-info/unsupported/os.markdown b/source/more-info/unsupported/os.markdown index 036808dbbd1..98f3412e180 100644 --- a/source/more-info/unsupported/os.markdown +++ b/source/more-info/unsupported/os.markdown @@ -8,7 +8,7 @@ description: "More information on why the OS marks the installation as unsupport There are only two supported operating systems to run the Supervisor on: - Home Assistant OS -- Debian 10 (Buster) +- Debian 11 (Bullseye) These operating systems are actively tested and maintained, for use with the Supervisor.