To set it up, add the following information to your configuration.yaml file:
cliamte:
+climate:
platform: nest
diff --git a/components/notify.telegram/index.html b/components/notify.telegram/index.html
index f0a23edf5b..a74a6990b3 100644
--- a/components/notify.telegram/index.html
+++ b/components/notify.telegram/index.html
@@ -102,17 +102,8 @@
The result set will include your chat ID as id in the from section:
-{
- "ok":true,
- "result":[
- {
- "update_id":254199982,
- "message":{
- "message_id":201,
- "from":{
- "id":123456789,
- "first_name":"Your first name",
-...
+{"ok":true,"result":[{"update_id":254199982,
+"message":{"message_id":27,"from":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME"},"chat":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME","type":"private"},"date":1678292650,"text":"test"}}]}
@@ -174,6 +165,29 @@
password (Optional): Username for an URL which require HTTP basic authentication.
+ Document support
+
+...
+action:
+ service: notify.NOTIFIER_NAME
+ data:
+ title: Send a document
+ message: That's a example that sends a document.
+ data:
+ document:
+ file: /tmp/whatever.odf
+ caption: Picture Title xy
+
+
+
+
+
+ - url or file (Required): For local or remote path to an image.
+ - caption (Optional): The title of the image.
+ - username (Optional): Username for an URL which require HTTP basic authentication.
+ - password (Optional): Username for an URL which require HTTP basic authentication.
+
+
Location support
...
diff --git a/components/sensor.mhz19/index.html b/components/sensor.mhz19/index.html
index a25156cc2d..4842a05331 100644
--- a/components/sensor.mhz19/index.html
+++ b/components/sensor.mhz19/index.html
@@ -89,7 +89,7 @@
- The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 sensors. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. Outside CO2 levels are usually between 250 and 350ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
+ The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 sensors. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
Check out the Open Home Automation web site for a quick guide how to connect the sensor to your PC or Raspberry Pi.
diff --git a/getting-started/configuration/index.html b/getting-started/configuration/index.html
index 464a94f1f7..a4387b9c8f 100644
--- a/getting-started/configuration/index.html
+++ b/getting-started/configuration/index.html
@@ -120,14 +120,14 @@
Inside your configuration folder is the file configuration.yaml. This is the main file that contains which components will be loaded and what their configuration is. Throughout the documentation you will find snippets that you can add to your configuration file to enable that functionality.
-If you run into trouble while configuring Home Assistant, have a look at the configuration troubleshooting page and at the configuration.yaml examples.
-
- You will have to restart Home Assistant for changes to configuration.yaml take effect.
+ You will have to restart Home Assistant for changes to configuration.yaml to take effect.
+If you run into trouble while configuring Home Assistant, have a look at the configuration troubleshooting page and at the configuration.yaml examples.
+
- Install colorlog ($ pip3 install colorlog) to make the console output easier to read, hence also easier to catch errors and warnings.
+ Test any changes to your configuration files from the command line with hass --script check_config. This script allows you to test changes without the need to restart Home Assistant.
Next step: Get familiar with YAML »
diff --git a/getting-started/troubleshooting-configuration/index.html b/getting-started/troubleshooting-configuration/index.html
index 93d1e8ee08..e5b2b9b3d4 100644
--- a/getting-started/troubleshooting-configuration/index.html
+++ b/getting-started/troubleshooting-configuration/index.html
@@ -99,28 +99,29 @@
When a component 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 component 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.
+
Problems with the configuration
One of the most common problems with Home Assistant is an invalid configuration.yaml file.
- - You can test your configuration using this online YAML parser or YAML Lint.
+ - You can test your configuration using the command line with:
hass --script check_config
+ - You can verify your configuration’s yaml structure using this online YAML parser or YAML Lint.
- To learn more about the quirks of YAML, read YAML IDIOSYNCRASIES by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
-configuration.yaml does not allow multiple sections to have the same name. If you want a specific platform to be loaded twice, append a number or string to the name or nest them using this style.
+configuration.yaml does not allow multiple sections to have the same name. If you want to load multiplte platforms for one component, you can append a number or string to the name or nest them using this style:
sensor:
- platform: forecast
- ...
-
-sensor 2:
- platform: bitcoin
- ...
+ - platform: forecast
+ ...
+ - platform: bitcoin
+ ...
-Another common problem is that a required configuration setting is missing. If this is the case, the component will report this to home-assistant.log. You can have a look at the component page for instructions on how to setup the components.
+Another common problem is that a required configuration setting is missing. If this is the case, the component will report this to home-assistant.log. You can have a look at the various component pages for instructions on how to setup the components.
If you find any errors or want to expand the documentation, please let us know.
diff --git a/sitemap.xml b/sitemap.xml
index 0c176ffde4..7073e96845 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1976,62 +1976,62 @@
https://home-assistant.io/demo/frontend.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/index.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
https://home-assistant.io/static/mdi-demo.html
-2016-08-28T03:55:29+00:00
+2016-08-28T17:02:23+00:00
diff --git a/topics/secrets/index.html b/topics/secrets/index.html
index fab4fd2b8a..d29ee24cd7 100644
--- a/topics/secrets/index.html
+++ b/topics/secrets/index.html
@@ -91,11 +91,11 @@
- The configuration.yaml file a plain-text file thus it is readable for everyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. This separation can also help you to keep easier track of your passwords and API keys (as they are all stored at one place and no longer spread across the configuration.yaml file) if you don’t want to split up your configuration.
+ The configuration.yaml file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using !secrets you can remove any private information from you configuration files. This separation can also help you to keep easier track of your passwords and API keys. As they are all stored at one place and no longer spread across the configuration.yaml file or even multiple yaml files if you split up your configuration.
Using secrets.yaml
-The workflow for the outsourcing in the secrets.yaml is very similar to the splitting of the configuration. Create a secrets.yaml file in your Home assistant configuration directory (The location of the folder differs between operating systems: on OS X and Linux it’s ~/.homeassistant and on Windows it’s %APPDATA%/.homeassistant).
+The workflow for moving private information to secrets.yaml is very similar to the splitting of the configuration. Create a secrets.yaml file in your Home assistant configuration directory (The location of the folder differs between operating systems: on OS X and Linux it’s ~/.homeassistant and on Windows it’s %APPDATA%/.homeassistant).
The entries for password and API keys in the configuration.yaml file usually looks like the example below.
@@ -113,11 +113,33 @@
The secrets.yaml file contains the corresponding password assigned to the identifier.
-logger: debug
-http_password: YOUR_PASSWORD
+http_password: YOUR_PASSWORD
+ Debugging secrets
+
+When you start splitting your configuration into multiple files, you might end up with configuration in sub folders. Secrets will be resolved in this order:
+
+ - A
secrets.yaml located in the same folder as the yaml file referencing the secret,
+ - next, parent folders will be searched for a
secrets.yaml file with the secret, stopping at the folder with the main configuration.yaml,
+ - lastly,
keyring will be queried for the secret (more info below)
+
+
+To see where secrets are being loaded from you can either add an option to your secrets.yaml file or use the check_config script.
+
+Option 1: Print where secrets are retrieved from to the Home Assistant log by adding the following to secrets.yaml:
+logger: debug
+
+
+This will not print the actual secret’s value to the log.
+
+Option 2: View where secrets are retrieved from and the contents of all secrets.yaml files used, you can use the check_config script from the command line:
+hass --script check_config --secrets
+
+
+This will print all your secrets
+
Storing passwords in a keyring managed by your OS
Using Keyring is an alternative way to secrets.yaml. They can be managed from the command line via the keyring script.
@@ -139,7 +161,7 @@
-If you launch home Assistant now, you will be prompted for the keyring password to unlock your keyring.
+If you launch Home Assistant now, you will be prompted for the keyring password to unlock your keyring.
$ hass
Config directory: /home/fab/.homeassistant
diff --git a/topics/splitting_configuration/index.html b/topics/splitting_configuration/index.html
index 8d24bc1614..30ba797907 100644
--- a/topics/splitting_configuration/index.html
+++ b/topics/splitting_configuration/index.html
@@ -97,7 +97,7 @@
As commenting code doesn’t always happen, please read on for the details.
-Now despite the logical assumption that the configuration.yaml will be replaced by this process it will in fact remain all be it in a much less cluttered form.
+Now despite the logical assumption that the configuration.yaml will be replaced by this process it will in fact remain, albeit in a much less cluttered form.
In this lighter version we will still need what could be called the core snippet:
@@ -261,17 +261,26 @@ customize.yaml
If you have issues checkout home-assistant.log in the configuration directory as well as your indentations. If all else fails, head over to the Gitter Chatroom and ask away.
+ Debugging multiple configuration files
+
+If you have many configuration files, the check_config script allows you to see how Home Assistant interprets them:
+
+ - Listing all loaded files:
hass --script --check_config --files
+ - Viewing a component’s config:
hass --script --check_config --info light
+ - Or all components’ config:
hass --script check_config --info all
+
+
+You can get help from the command line using: hass --script check_config --help
+
Advanced Usage
We offer four advanced options to include whole directories at once.
-
-!include_dir_list will return content of a directory as a list with each file content being an entry in the list.
-
-!include_dir_named will return content of a directory as a dictionary which maps filename => content of file.
-
-!include_dir_merge_list will return content of a directory as a list by merging all files (which should contain a list) into 1 big list.
-
-!include_dir_merge_named will return content of a directory as a dictionary by loading each file and merging it into 1 big dictionary.
+
+ !include_dir_list will return the content of a directory as a list with each file content being an entry in the list.!include_dir_named will return the content of a directory as a dictionary which maps filename => content of file.!include_dir_merge_list will return the content of a directory as a list by merging all files (which should contain a list) into 1 big list.!include_dir_merge_named will return the content of a directory as a dictionary by loading each file and merging it into 1 big dictionary.
Example: !include_dir_list