From 6d3011e01564e4b8a3a00485828e5aaed29c2825 Mon Sep 17 00:00:00 2001 From: Georgi Yanev Date: Mon, 8 Jan 2018 09:18:03 +0200 Subject: [PATCH 01/11] Update image references to correct file extensions (#4370) --- source/_components/device_tracker.huawei_router.markdown | 2 +- source/_components/sensor.dublin_bus_transport.markdown | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/device_tracker.huawei_router.markdown b/source/_components/device_tracker.huawei_router.markdown index 6fb470ea4fb..6c9647ac3cd 100644 --- a/source/_components/device_tracker.huawei_router.markdown +++ b/source/_components/device_tracker.huawei_router.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: huawei.png +logo: huawei.svg ha_category: Presence Detection ha_release: 0.51 --- diff --git a/source/_components/sensor.dublin_bus_transport.markdown b/source/_components/sensor.dublin_bus_transport.markdown index 3b3161cdf10..c44a9f593e6 100644 --- a/source/_components/sensor.dublin_bus_transport.markdown +++ b/source/_components/sensor.dublin_bus_transport.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: dublin_bus.jpg +logo: dublin_bus.png ha_category: Transport ha_iot_class: "Cloud Polling" ha_release: 0.36 From fdaf151386beee36f23c6821b3edf56773da95b3 Mon Sep 17 00:00:00 2001 From: Zorks <6314048+Zorks@users.noreply.github.com> Date: Sun, 7 Jan 2018 23:35:53 -0800 Subject: [PATCH 02/11] Clarification on which username/password to use (#4366) As the standard Unifi component uses an admin user/pass, clarification that you're using the device SSH user/pass instead seems useful. They are different and will cause a failure if not changed when converted over. --- source/_components/device_tracker.unifi_direct.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/device_tracker.unifi_direct.markdown b/source/_components/device_tracker.unifi_direct.markdown index d00d2259646..8c0bda46b8e 100644 --- a/source/_components/device_tracker.unifi_direct.markdown +++ b/source/_components/device_tracker.unifi_direct.markdown @@ -32,11 +32,11 @@ host: required: true type: string username: - description: The username used to connect to your Unifi AP. + description: The SSH device username used to connect to your Unifi AP. required: true type: string password: - description: The password used to connect to your Unifi AP. + description: The SSH device password used to connect to your Unifi AP. required: true type: string {% endconfiguration %} From a3364e6608e30ef66e96c1658cb28a8dd15ee100 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Mon, 8 Jan 2018 07:36:29 +0000 Subject: [PATCH 03/11] Formatting and example tweaks (#4365) Added some more example automations to help people. Changed the service names to reflect how they're shown everywhere now. --- source/_components/hdmi_cec.markdown | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 43c95c45ada..758f8d468e9 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -154,7 +154,7 @@ hdmi_cec: ### {% linkable_title Select Device %} -Call the `hdmi_cec/select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: +Call the `hdmi_cec.select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: ```json {"device": "Chromecast"} @@ -179,15 +179,29 @@ action: ### {% linkable_title Power On %} -Call the `hdmi_cec/power_on` service (no arguments) to power on any devices that support this function. +Call the `hdmi_cec.power_on` service (no arguments) to power on any devices that support this function. + +An Automation action using the example above would look something like this. + +```yaml +action: + service: hdmi_cec.power_on +``` ### {% linkable_title Standby %} -Call the `hdmi_cec/standby` service (no arguments) to place in standby any devices that support this function. +Call the `hdmi_cec.standby` service (no arguments) to place in standby any devices that support this function. + +An Automation action using the example above would look something like this. + +```yaml +action: + service: hdmi_cec.standby +``` ### {% linkable_title Change volume level %} -Call the `hdmi_cec/volume` service with one of following commands: +Call the `hdmi_cec.volume` service with one of following commands: #### {% linkable_title Volume up %} Increase volume three times: @@ -208,7 +222,6 @@ Stop increasing volume: {"up": "release"} ``` - #### {% linkable_title Volume down %} Decrease volume three times: From 94c267623fa32c7ae435284029f3d4c889e77ca8 Mon Sep 17 00:00:00 2001 From: "Michael R. Davis" Date: Mon, 8 Jan 2018 07:03:47 -0500 Subject: [PATCH 04/11] Update the YAML example to a more "generic" example (#4371) The original YAML platform example was written to only support one platform within a switch component. --- source/_components/switch.command_line.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown index cdb5162ca2a..0c70ae6afca 100644 --- a/source/_components/switch.command_line.markdown +++ b/source/_components/switch.command_line.markdown @@ -21,11 +21,11 @@ To enable it, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry switch: - platform: command_line - switches: - kitchen_light: - command_on: switch_command on kitchen - command_off: switch_command off kitchen + - platform: command_line + switches: + kitchen_light: + command_on: switch_command on kitchen + command_off: switch_command off kitchen ``` Configuration variables: From 0c3c98312fbb8620fe90662d4a680070355f9749 Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 8 Jan 2018 13:04:46 +0100 Subject: [PATCH 05/11] Advise to stop hass before running certbot (#4363) * Advise to stop hass before running certbot Since I had trouble running certbot while home assistant was running, but it worked fine when I stopped home assistant before, I added this to the tutorial. * Update name --- .../certificates/lets_encrypt.markdown | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index edc5fe6b2b3..2841c355031 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -254,7 +254,7 @@ If you did not already log in as the user that currently runs Home Assistant, ch $ sudo su -s /bin/bash hass ``` -Make sure you are in the home directory for the HA user: +Make sure you are in the home directory for the Home Assistant user: ```bash $ cd @@ -269,7 +269,14 @@ $ wget https://dl.eff.org/certbot-auto $ chmod a+x certbot-auto ``` -Now we will run the certbot program to get our ssl certificate. You will need to include your email address and your DuckDNS URL in the appropriate places: +You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Hassbian: + +```text +$ sudo systemctl stop home-assistant@homeassistant.service +``` + +You can restart Home Assistant after the next step using the same command and replacing `stop` with `start`. +Now we will run the certbot program to get our SSL certificate. You will need to include your email address and your DuckDNS URL in the appropriate places: ```text $ ./certbot-auto certonly --standalone --preferred-challenges http-01 --email your@email.address -d examplehome.duckdns.org @@ -297,13 +304,13 @@ Did all of that go without a hitch? Wahoo! Your Let's Encrypt certificate is now ### {% linkable_title 5 - Check the incoming connection %}

-Following on from Step 4 your SSH will still be in the certbot folder. If you edit your configuration files over SSH you will need to change to your `homeassistant` folder: +Following on from Step 4 your SSH will still be in the certbot folder. If you edit your configuration files over SSH you will need to change to our `homeassistant` folder: ``` $ cd ~/.homeassistant ``` -If you use samba shares to edit your files you can exit your SSH now. +If you use Samba shares to edit your files you can exit your SSH now.

If during step 4 you had to use port 443 instead of port 80 to generate your certificate, you should delete that rule now. @@ -519,7 +526,7 @@ $ ./certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challe * If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"` -So, now were all set up. We have our secured, remotely accesible HA instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures. +So, now were all set up. We have our secured, remotely accessible Home Assistant instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures. ### {% linkable_title 9 - Set up an alert to warn us if something went wrong. %} From 46229902406ffb367385ea9fa468d427513ead7d Mon Sep 17 00:00:00 2001 From: tchentchen Date: Mon, 8 Jan 2018 07:40:10 -0500 Subject: [PATCH 06/11] Changed desc of where push notification slider was (#4362) The previous description made it sound like the push notification slider was in the sidebar. I thought something had been wrong with my GCM html5 setup until I found a screenshot in the forum that showed it under the general configuration tab. Updating the language to make it clearer. --- source/_components/notify.html5.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown index 194acd9b3af..1adf5f015e1 100644 --- a/source/_components/notify.html5.markdown +++ b/source/_components/notify.html5.markdown @@ -66,7 +66,7 @@ The `html5` platform can only function if all of the following requirements are Assuming you have already added the platform to your configuration: 1. Open Home Assistant in Chrome or Firefox. -2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider in the sidebar labeled Push Notifications. +2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the sidebar Configuration > General. 3. Slide it to the on position. 4. Within a few seconds you should be prompted to allow notifications from Home Assistant. 5. Assuming you accept, that's all there is to it! From c13889dbee0b0863293b30d26714e70f5ecc3ae4 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 8 Jan 2018 17:46:04 +0100 Subject: [PATCH 07/11] Minor changes --- source/_docs/configuration/secrets.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index b5feb55b2b4..523bba9c4c4 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -85,7 +85,7 @@ If you launch Home Assistant now, you will be prompted for the keyring password ```bash $ hass -Config directory: /home/fab/.homeassistant +Config directory: /home/homeassistant/.homeassistant Please enter password for encrypted keyring: ``` @@ -97,7 +97,7 @@ Please enter password for encrypted keyring: Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script. -Before using credstash, you need to set up AWS credentials either via the `aws` command line tool, or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named 'credstash' as explained in the [credstash readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash +Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash. ```bash $ hass --script credstash --help From e1a09f03f2e147404784e2b504931216d26a02a9 Mon Sep 17 00:00:00 2001 From: Ioan Loosley Date: Mon, 8 Jan 2018 17:19:33 +0000 Subject: [PATCH 08/11] changed image (#4375) --- source/_components/climate.mqtt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 7d624b4d9a9..94a9bf27e70 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: heat-control.png +logo: mqtt.png ha_category: Climate ha_release: 0.55 ha_iot_class: "Local Polling" From 591721fa82964b924d0f6335e1aeb19b6ace5f94 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 8 Jan 2018 19:04:23 +0100 Subject: [PATCH 09/11] Update license shield --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index e055c8e3369..8d32eb487ff 100644 --- a/README.markdown +++ b/README.markdown @@ -1,14 +1,14 @@ [![Discord](https://img.shields.io/discord/330944238910963714.svg)](https://discord.gg/CxqDrfU) [![Travis branch](https://img.shields.io/travis/home-assistant/home-assistant.github.io/next.svg)](https://travis-ci.org/home-assistant/home-assistant.github.io) [![Krihelimeter](http://www.krihelinator.xyz/badge/home-assistant/home-assistant.github.io)](http://www.krihelinator.xyz) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![License: CC BY-NC-SA 4.0]((https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/) # Home Assistant website This is the source for the [Home-Assistant.io website](https://home-assistant.io). ## Setup - +https://opensource.org/licenses/Apache-2.0 Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/documentation/). ## Site preview From 7a0bf2678698cf3932a6581b7a418c8ec8f4379b Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 8 Jan 2018 19:07:48 +0100 Subject: [PATCH 10/11] Remove bracket --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 8d32eb487ff..23e8ab7e6df 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,7 @@ [![Discord](https://img.shields.io/discord/330944238910963714.svg)](https://discord.gg/CxqDrfU) [![Travis branch](https://img.shields.io/travis/home-assistant/home-assistant.github.io/next.svg)](https://travis-ci.org/home-assistant/home-assistant.github.io) [![Krihelimeter](http://www.krihelinator.xyz/badge/home-assistant/home-assistant.github.io)](http://www.krihelinator.xyz) -[![License: CC BY-NC-SA 4.0]((https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/) +[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/) # Home Assistant website From 24cf7d98ede9e1df0d74d0119de546b9f53829ce Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 8 Jan 2018 20:54:49 +0100 Subject: [PATCH 11/11] Remove link --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 23e8ab7e6df..d3a630cb1ea 100644 --- a/README.markdown +++ b/README.markdown @@ -8,7 +8,7 @@ This is the source for the [Home-Assistant.io website](https://home-assistant.io). ## Setup -https://opensource.org/licenses/Apache-2.0 + Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/documentation/). ## Site preview