diff --git a/Gemfile b/Gemfile index b29288f0477..3a04804fc3e 100644 --- a/Gemfile +++ b/Gemfile @@ -3,7 +3,7 @@ source 'https://rubygems.org' ruby '> 2.5.0' group :development do - gem 'rake', '13.0.3' + gem 'rake', '13.0.4' gem 'jekyll', '4.2.0' gem 'compass', '1.0.3' gem 'sass-globbing', '1.1.5' diff --git a/Gemfile.lock b/Gemfile.lock index 10155b0de21..ef1288421b4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.7.0) + addressable (2.8.0) public_suffix (>= 2.0.2, < 5.0) chunky_png (1.4.0) colorator (1.1.0) @@ -86,7 +86,7 @@ GEM rack (2.2.3) rack-protection (2.1.0) rack - rake (13.0.3) + rake (13.0.4) rb-fsevent (0.11.0) rb-inotify (0.10.1) ffi (~> 1.0) @@ -131,7 +131,7 @@ DEPENDENCIES jekyll-time-to-read (= 0.1.2) jekyll-toc (= 0.17.1) nokogiri (= 1.11.7) - rake (= 13.0.3) + rake (= 13.0.4) sass-globbing (= 1.1.5) sassc (= 2.1.0) sinatra (= 2.1.0) diff --git a/source/_docs/automation/services.markdown b/source/_docs/automation/services.markdown index 40e9ceaf90d..74e3f923de8 100644 --- a/source/_docs/automation/services.markdown +++ b/source/_docs/automation/services.markdown @@ -19,7 +19,7 @@ This service disables the automation's triggers, and optionally stops any curren Service data attribute | Optional | Description -|-|- -`entity_id` | no | Entity ID of automation to turn on. Can be a list. `none` or `all` are also accepted. +`entity_id` | no | Entity ID of automation to turn off. Can be a list. `none` or `all` are also accepted. `stop_actions` | yes | Stop any currently active actions (defaults to true). ## Service {% my developer_call_service service="automation.toggle" %} diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 76cfefbcf7b..1582b8dabac 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -189,15 +189,14 @@ That about wraps it up. If you have issues checkout `home-assistant.log` in the configuration directory as well as your indentations. If all else fails, head over to our [Discord chat server][discord] and ask away. -## Debugging multiple configuration files +## Debugging configuration files -If you have many configuration files, the `check_config` script allows you to see how Home Assistant interprets them: +If you have many configuration files, Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has it's own section in the common-tasks about this: -- Listing all loaded files: `hass --script check_config --files` -- Viewing a component's configuration: `hass --script check_config --info light` -- Or all components' configuration: `hass --script check_config --info all` - -You can get help from the command line using: `hass --script check_config --help` +- [Operating System](/common-tasks/os/#configuration-check) +- [Container](/common-tasks/container/#configuration-check) +- [Core](/common-tasks/core/#configuration-check) +- [Supervised](/common-tasks/supervised/#configuration-check) ## Advanced Usage diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 399853c9148..b6880bde4a3 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -19,9 +19,12 @@ If you have incorrect entries in your configuration files you can use the config One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file. -- With Home Assistant OS and Supervised you can use the [`ha` command](/hassio/commandline/#home-assistant): `ha core check`. - - You can test your configuration with Home Assistant Core using the command line with: `hass --script check_config`. If you need to provide the path for your configuration you can do this using the `-c` argument like this: `hass --script check_config -c /path/to/your/config/dir`. - - On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container. +- Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has it's own section in the common-tasks about this: + - [Operating System](/common-tasks/os/#configuration-check) + - [Container](/common-tasks/container/#configuration-check) + - [Core](/common-tasks/core/#configuration-check) + - [Supervised](/common-tasks/supervised/#configuration-check) + - The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. - You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). diff --git a/source/_faq/component.markdown b/source/_faq/component.markdown index 4acaa816335..950d2472e22 100644 --- a/source/_faq/component.markdown +++ b/source/_faq/component.markdown @@ -6,4 +6,9 @@ ha_category: Configuration When an integration does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your integration you are trying to set up. -If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. +If you have incorrect entries in your configuration files you can use the CLI script to check your configuration, each installation type has it's own section in the common-tasks about this: + +- [Operating System](/common-tasks/os/#configuration-check) +- [Container](/common-tasks/container/#configuration-check) +- [Core](/common-tasks/core/#configuration-check) +- [Supervised](/common-tasks/supervised/#configuration-check) \ No newline at end of file diff --git a/source/_includes/common-tasks/configuration_check.md b/source/_includes/common-tasks/configuration_check.md index 2a5b598083e..4f39fdce11e 100644 --- a/source/_includes/common-tasks/configuration_check.md +++ b/source/_includes/common-tasks/configuration_check.md @@ -8,11 +8,37 @@ ha core check {% elsif page.installation == "container" %} +_If your container name is something other than `homeassistant`, change that part in the examples below._ + +Run the full check: + ```bash docker exec homeassistant python -m homeassistant --script check_config --config /config ``` -_If your container name is something other than `homeassistant`, change that part._ +Listing all loaded files: + +```bash +docker exec homeassistant python -m homeassistant --script check_config --files +``` + +Viewing a component’s configuration ([`light`](/integrations/light) in this example): + +```bash +docker exec homeassistant python -m homeassistant --script check_config --info light +``` + +Or all components’ configuration + +```bash +docker exec homeassistant python -m homeassistant --script check_config --info all +``` + +You can get help from the command line using: + +```bash +docker exec homeassistant python -m homeassistant --script check_config --help +``` {% elsif page.installation == "core" %} @@ -30,10 +56,36 @@ _If your container name is something other than `homeassistant`, change that par 3. Run the configuration check + Run the full check: + ```bash hass --script check_config ``` + Listing all loaded files: + + ```bash + hass --script check_config --files + ``` + + Viewing a component’s configuration ([`light`](/integrations/light) in this example): + + ```bash + hass --script check_config --info light + ``` + + Or all components’ configuration + + ```bash + hass --script check_config --info all + ``` + + You can get help from the command line using: + + ```bash + hass --script check_config --help + ``` + 4. When that is complete restart the service for it to use the new files. {% endif %} diff --git a/source/_includes/installation/container/alternative.md b/source/_includes/installation/container/alternative.md index 1c64f54da5f..549f72836b4 100644 --- a/source/_includes/installation/container/alternative.md +++ b/source/_includes/installation/container/alternative.md @@ -54,7 +54,7 @@ Remark: to update your Home Assistant on your Docker within Synology NAS, you ju - Wait until the system-message/-notification comes up, that the download is finished (there is no progress bar) - Move to "Container"-section - Stop your container if it's running -- Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your configuration-directory +- Right-click on it and select "Action"->"Reset". You won't lose any data, as all files are stored in your configuration-directory - Start the container again - it will then boot up with the new Home Assistant image Remark: to restart your Home Assistant within Synology NAS, you just have to do the following: @@ -136,4 +136,4 @@ That will tell Home Assistant where to look for our Z-Wave radio. ```yaml device_tracker: - platform: bluetooth_tracker -``` \ No newline at end of file +``` diff --git a/source/_includes/installation/core.md b/source/_includes/installation/core.md index a61f904d716..c4fa43e4199 100644 --- a/source/_includes/installation/core.md +++ b/source/_includes/installation/core.md @@ -86,6 +86,8 @@ hass You can now reach your installation via the web interface on `http://homeassistant.local:8123`. +If this address doesn't work you may also try `http://localhost:8123` or `http://X.X.X.X:8123` (replace X.X.X.X with your machines’ IP address). +
When you run the `hass` command for the first time, it will download, install and cache the necessary libraries/dependencies. This procedure may take anywhere between 5 to 10 minutes. During that time, you may get "site cannot be reached" error when accessing the web interface. This will only happen for the first time, and subsequent restarts will be much faster. diff --git a/source/_integrations/acmeda.markdown b/source/_integrations/acmeda.markdown index a60f9dcb2f1..d787f59ac66 100644 --- a/source/_integrations/acmeda.markdown +++ b/source/_integrations/acmeda.markdown @@ -15,9 +15,12 @@ ha_platforms: - sensor --- -The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rolelase Acmeda Automate hub. The integration uses an [API](https://pypi.org/project/aiopulse/) to directly communicate with hubs on the local network, rather than connecting via the cloud or via RS-485. +The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rolelase Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition. + +### Supported devices + +- Automate Pulse Hub v1 -Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition. {% include integrations/config_flow.md %} diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index b299b6b0658..41baf3a8651 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -79,7 +79,7 @@ Amazon also provided a [step-by-step guide](https://developer.amazon.com/docs/sm
-OK, let's go. You first need to sign in to your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details. +OK, let's go. You first need to sign in to your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tier benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details. ### Create an IAM Role for Lambda diff --git a/source/_integrations/avion.markdown b/source/_integrations/avion.markdown index 9f005d3b920..7dc66f506a1 100644 --- a/source/_integrations/avion.markdown +++ b/source/_integrations/avion.markdown @@ -19,7 +19,7 @@ If you want to add your devices manually (like in the example below) then you ne ```bash $ curl -X POST -H "Content-Type: application/json" \ -d '{"email": "fakename@example.com", "password": "password"}' \ - https://admin.avi-on.com/api/sessions | jq + https://api.avi-on.com/sessions | jq ``` with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 228a061b090..abb5cc6f07d 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -363,7 +363,7 @@ If a property works in *optimistic mode* (when the corresponding state topic is #### Using Templates -For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topis can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. +For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. Say you receive the operation mode `"auto"` via your `mode_state_topic`, but the mode is actually called just `auto`, here's what you could do: diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown index cea23f64c69..b46492519a1 100644 --- a/source/_integrations/knx.markdown +++ b/source/_integrations/knx.markdown @@ -575,8 +575,8 @@ The following values are valid for the Home Assistant [Climate](/integrations/cl - `Off` (maps internally to `HVAC_MODE_OFF` within Home Assistant) - `Auto` (maps internally to `HVAC_MODE_AUTO` within Home Assistant) -- `Heat` (maps internally to `HVAC_MDOE_HEAT` within Home Assistant) -- `Cool` (maps internally to `HVAC_MDOE_COOL` within Home Assistant) +- `Heat` (maps internally to `HVAC_MODE_HEAT` within Home Assistant) +- `Cool` (maps internally to `HVAC_MODE_COOL` within Home Assistant) - `Fan only` (maps internally to `HVAC_MODE_FAN_ONLY` within Home Assistant) - `Dry` (maps internally to `HVAC_MODE_DRY` within Home Assistant) diff --git a/source/_integrations/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown index e9e545a2b5b..aa4ce2b22f1 100644 --- a/source/_integrations/panasonic_viera.markdown +++ b/source/_integrations/panasonic_viera.markdown @@ -127,7 +127,7 @@ The list with all known valid keys can be found [here](https://github.com/floria - TC-P60ST50 (can't power on) - TC-P65VT30 - TH-32ES500 -- TH-P60ST50A +- TH-P60ST50A (can't power on) - TX-32AS520E - TX-32DSX609 - TX-40CXE720 diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown index b612bb39fb6..85d44ac4a1e 100644 --- a/source/_integrations/smappee.markdown +++ b/source/_integrations/smappee.markdown @@ -78,11 +78,11 @@ total consumption during the current hour, total consumption during the last 5 m and the always-on (slumber) consumption from today. In case of solar production, entities for the active power production, today's total solar production and the solar production during the current hour are added as well. -Smappee Pro, Plus and Genius devices will create current active powers for each configured load (submeter). +Smappee Pro, Plus, Genius and Connect devices will create current active powers for each configured load (submeter). In case a Smappee Gas and/or Water meter is installed as well, an entity showing today's consumption is provided. -Additionally, Smappee Genius devices will also provide entities for the line voltages and phase voltages (for each phase). +Additionally, Smappee, Genius and Connect devices will also provide entities for the line voltages and phase voltages (for each phase). ### Switch