From 173b9253a73cd749cdaf6c732bb63a5517850c13 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Sat, 28 Oct 2017 17:58:58 +0000 Subject: [PATCH] Site updated at 2017-10-28 17:58:58 UTC --- atom.xml | 2 +- blog/categories/announcements/atom.xml | 2 +- blog/categories/community/atom.xml | 2 +- blog/categories/device-tracking/atom.xml | 2 +- blog/categories/esp8266/atom.xml | 2 +- blog/categories/how-to/atom.xml | 2 +- blog/categories/ibeacons/atom.xml | 2 +- blog/categories/internet-of-things/atom.xml | 2 +- blog/categories/iot-data/atom.xml | 2 +- blog/categories/media/atom.xml | 2 +- blog/categories/merchandise/atom.xml | 2 +- blog/categories/micropython/atom.xml | 2 +- blog/categories/mqtt/atom.xml | 2 +- blog/categories/organisation/atom.xml | 2 +- blog/categories/owntracks/atom.xml | 2 +- blog/categories/presence-detection/atom.xml | 2 +- .../public-service-announcement/atom.xml | 2 +- blog/categories/release-notes/atom.xml | 2 +- blog/categories/survey/atom.xml | 2 +- blog/categories/talks/atom.xml | 2 +- blog/categories/technology/atom.xml | 2 +- blog/categories/user-stories/atom.xml | 2 +- blog/categories/video/atom.xml | 2 +- blog/categories/website/atom.xml | 2 +- components/google_assistant/index.html | 178 ++++++++++-------- sitemap.xml | 80 ++++---- 26 files changed, 161 insertions(+), 145 deletions(-) diff --git a/atom.xml b/atom.xml index 6ae7824c5f..0ac1649faa 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/announcements/atom.xml b/blog/categories/announcements/atom.xml index 4bdde36d8f..94b81a061e 100644 --- a/blog/categories/announcements/atom.xml +++ b/blog/categories/announcements/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Announcements | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/community/atom.xml b/blog/categories/community/atom.xml index f20d0a7fc0..fcb4f7e8fa 100644 --- a/blog/categories/community/atom.xml +++ b/blog/categories/community/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Community | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/device-tracking/atom.xml b/blog/categories/device-tracking/atom.xml index 74f2ed8ad9..711997f338 100644 --- a/blog/categories/device-tracking/atom.xml +++ b/blog/categories/device-tracking/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Device-Tracking | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/esp8266/atom.xml b/blog/categories/esp8266/atom.xml index 3b887b1be8..89094239c3 100644 --- a/blog/categories/esp8266/atom.xml +++ b/blog/categories/esp8266/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: ESP8266 | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/how-to/atom.xml b/blog/categories/how-to/atom.xml index d5cfa39d70..1e7db3c3fd 100644 --- a/blog/categories/how-to/atom.xml +++ b/blog/categories/how-to/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: How-To | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/ibeacons/atom.xml b/blog/categories/ibeacons/atom.xml index afb2a62de5..4b26792582 100644 --- a/blog/categories/ibeacons/atom.xml +++ b/blog/categories/ibeacons/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: iBeacons | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/internet-of-things/atom.xml b/blog/categories/internet-of-things/atom.xml index e311504e5d..bfdfde7180 100644 --- a/blog/categories/internet-of-things/atom.xml +++ b/blog/categories/internet-of-things/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Internet-of-Things | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/iot-data/atom.xml b/blog/categories/iot-data/atom.xml index c38ef9d9ef..5ca775c31b 100644 --- a/blog/categories/iot-data/atom.xml +++ b/blog/categories/iot-data/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: IoT-Data | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/media/atom.xml b/blog/categories/media/atom.xml index 093fb726af..a110bdd5be 100644 --- a/blog/categories/media/atom.xml +++ b/blog/categories/media/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Media | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/merchandise/atom.xml b/blog/categories/merchandise/atom.xml index e83be28d6c..097b63d510 100644 --- a/blog/categories/merchandise/atom.xml +++ b/blog/categories/merchandise/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Merchandise | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/micropython/atom.xml b/blog/categories/micropython/atom.xml index 671e10d3b6..a356778235 100644 --- a/blog/categories/micropython/atom.xml +++ b/blog/categories/micropython/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Micropython | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/mqtt/atom.xml b/blog/categories/mqtt/atom.xml index e2c0719d7c..78913eafcf 100644 --- a/blog/categories/mqtt/atom.xml +++ b/blog/categories/mqtt/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: MQTT | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/organisation/atom.xml b/blog/categories/organisation/atom.xml index 5bb3fdb921..34b5c27d8b 100644 --- a/blog/categories/organisation/atom.xml +++ b/blog/categories/organisation/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Organisation | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/owntracks/atom.xml b/blog/categories/owntracks/atom.xml index 13cc61f265..2a37a99bf2 100644 --- a/blog/categories/owntracks/atom.xml +++ b/blog/categories/owntracks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: OwnTracks | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/presence-detection/atom.xml b/blog/categories/presence-detection/atom.xml index 89b984d870..879488059c 100644 --- a/blog/categories/presence-detection/atom.xml +++ b/blog/categories/presence-detection/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Presence-Detection | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/public-service-announcement/atom.xml b/blog/categories/public-service-announcement/atom.xml index 9b15595930..51752237c7 100644 --- a/blog/categories/public-service-announcement/atom.xml +++ b/blog/categories/public-service-announcement/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Public-Service-Announcement | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml index 6b79f3304c..372cd10285 100644 --- a/blog/categories/release-notes/atom.xml +++ b/blog/categories/release-notes/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Release-Notes | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/survey/atom.xml b/blog/categories/survey/atom.xml index a288f01e9b..7d75b93784 100644 --- a/blog/categories/survey/atom.xml +++ b/blog/categories/survey/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Survey | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/talks/atom.xml b/blog/categories/talks/atom.xml index bb755700dd..517f44aeb5 100644 --- a/blog/categories/talks/atom.xml +++ b/blog/categories/talks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Talks | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/technology/atom.xml b/blog/categories/technology/atom.xml index 5743cf3f4a..978efc6c85 100644 --- a/blog/categories/technology/atom.xml +++ b/blog/categories/technology/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Technology | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml index 9704105b65..c35caff159 100644 --- a/blog/categories/user-stories/atom.xml +++ b/blog/categories/user-stories/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: User-Stories | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/video/atom.xml b/blog/categories/video/atom.xml index 3708183b29..58d7baec41 100644 --- a/blog/categories/video/atom.xml +++ b/blog/categories/video/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Video | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/blog/categories/website/atom.xml b/blog/categories/website/atom.xml index 4afcd95d8d..8f31f97abb 100644 --- a/blog/categories/website/atom.xml +++ b/blog/categories/website/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Website | Home Assistant]]> - 2017-10-28T16:44:17+00:00 + 2017-10-28T17:49:42+00:00 https://home-assistant.io/ diff --git a/components/google_assistant/index.html b/components/google_assistant/index.html index 6a26b018a9..4df77beae8 100644 --- a/components/google_assistant/index.html +++ b/components/google_assistant/index.html @@ -78,88 +78,104 @@

The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.

To use Google Assistant your Home Assistant configuration has to be externally accessible, with a hostname and SSL certificate. If you haven’t already configured that you should do so before continuing. -<p> -### Configuration -yaml -# Example configuration.yaml entry -google_assistant: - project_id: someproject-2d0b8 - client_id: [long URL safe random string] - access_token: [a different long URL safe random string] - exposed_domains: - - switch - - light - - group - -Note: It’s very important that you use very long strings for client_id and access_token. Those are essentially the credentials to your Home Assistant instance. You can generate them with the following command: -cat /dev/urandom|fold -w 120|head -n 1|base64 -w 0|tr -dc '0-9A-Za-z'|cut -c -80 -Configuration Variables: -* expose_by_default (Optional): Expose devices in all supported domains by default. -* project_id (Required): Project ID from the Google Developer console (looks like words-2ab12) -* client_id (Required): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth. -* access_token (Required): Another different long random URL safe string. -* exposed_domains (Optional): An array of Home Assistant domains to expose to Google Assistant. -You can also customize your devices similar to other components by adding keys to entities: -yaml -homeassistant: - customize: - master_bedroom_light: - google_assistant: true - google_assistant_name: bedroom light - bedroom_blinds: - aliases: - - bedroom shades - - bedroom covers - -Entity Customization Keys: -* google_assistant: True exposes entity, false will hide it -* google_assistant_name: Can be used to override the primary name of an entity. By default the friendly_name of an entity is used. -* aliases: Provides “nicknames” to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken. -### Setup -1. Install the gactions CLI (you’ll use this later) - you can download this anywhere, just remember where you put it for later (and don’t forget to run chmod +x gactions) -2. Create a new file named project.json (in the same directory you downloaded gactions to) and replace the [YOUR HOME ASSISTANT URL] below with the URL you use to access Home Assistant. - Note: This must be an HTTPS URL to work. -json -{ - "actions": [{ - "name": "actions.devices", - "deviceControl": { - }, - "fulfillment": { - "conversationName": "automation" - } - }], - "conversations": { - "automation" : - { - "name": "automation", - "url": "https://[YOUR HOME ASSISTANT URL]/api/google_assistant" - } - } -} - -3. Create a new project in the developer console. - 1. Add/Import project - 2. Go to Build under the Actions SDK box - 3. Copy the command that looks like: - gactions update --action_package PACKAGE_NAME --project doctest-2d0b8 -4. Replace PACKAGE_NAME with project.json and run that command from the same directory you saved project.json in (you’ll need to put ./ before gactions so that it reads ./gactions). It should output a URL like https://console.actions.google.com/project/doctest-2d0b8/overview - go there. -5. You’ll need to fill out most of the information on that page, but none of it really matters since you won’t be addressing the App directly, only through the Smart Home functionality built into Google Assistant. -6. The final item on that page Account linking is required for your app to interact with Home Assistant. - 1. Grant type: Implicit - 2. Client ID: Should be the same as client_id from your hass config above - 3. Authorization URL (replace with your actual URL): https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth - 4. Configure your client. Add scopes for email and name - 5. Testing instructions: doesn’t matter since you won’t submit this app -7. Back on the main app draft page. Click Test Draft. That will take you to the simulator (which won’t work) so just close that window. -8. Open the Google Assistant app and go into Settings > Home Control -9. Click the + sign, and near the bottom, you should have [test] your app name. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices. -10. If you want to allow other houshold users to control the devices: - 1. Go to the developer console using address from point 4. - 2. Under the gear icon, click Permissions - 3. Click Add, type the new user’s e-mail address and choose Project -> Editor role - 4. Have the new user go to developer console and repeat steps starting from point 7.

+

Configuration

+
# Example configuration.yaml entry
+google_assistant:
+  project_id: someproject-2d0b8
+  client_id: [long URL safe random string]
+  access_token: [a different long URL safe random string]
+  exposed_domains:
+    - switch
+    - light
+    - group
+
+
+

Note: It’s very important that you use very long strings for client_id and access_token. Those are essentially the credentials to your Home Assistant instance. You can generate them with the following command:

+

cat /dev/urandom|fold -w 120|head -n 1|base64 -w 0|tr -dc '0-9A-Za-z'|cut -c -80

+

Configuration Variables:

+
    +
  • expose_by_default (Optional): Expose devices in all supported domains by default.
    • +
  • project_id (Required): Project ID from the Google Developer console (looks like words-2ab12)
    • +
  • client_id (Required): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth.
    • +
  • access_token (Required): Another different long random URL safe string.
    • +
  • exposed_domains (Optional): An array of Home Assistant domains to expose to Google Assistant.
    • +
+

You can also customize your devices similar to other components by adding keys to entities:

+
homeassistant:
+  customize:
+    master_bedroom_light:
+      google_assistant: true
+      google_assistant_name: bedroom light
+    bedroom_blinds:
+      aliases:
+        - bedroom shades
+        - bedroom covers
+
+
+

Entity Customization Keys:

+
    +
  • google_assistant: True exposes entity, false will hide it
    • +
  • google_assistant_name: Can be used to override the primary name of an entity. By default the friendly_name of an entity is used.
    • +
  • aliases: Provides “nicknames” to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.
    • +
+

Setup

+
    +
  1. Install the gactions CLI (you’ll use this later) - you can download this anywhere, just remember where you put it for later (and don’t forget to run chmod +x gactions)
    2. +
  2. Create a new file named project.json (in the same directory you downloaded gactions to) and replace the [YOUR HOME ASSISTANT URL] below with the URL you use to access Home Assistant. +Note: This must be an HTTPS URL to work.
    3. +
+
{
+  "actions": [{
+    "name": "actions.devices",
+    "deviceControl": {
+    },
+    "fulfillment": {
+      "conversationName": "automation"
+    }
+  }],
+  "conversations": {
+    "automation" :
+    {
+      "name": "automation",
+      "url": "https://[YOUR HOME ASSISTANT URL]/api/google_assistant"
+    }
+  }
+}
+
+
+
    +
  1. Create a new project in the developer console. +
      +
    1. Add/Import project
      2. +
    2. Go to Build under the Actions SDK box
      3. +
    3. Copy the command that looks like: + gactions update --action_package PACKAGE_NAME --project doctest-2d0b8
      4. +
    +
    2. +
  2. Replace PACKAGE_NAME with project.json and run that command from the same directory you saved project.json in (you’ll need to put ./ before gactions so that it reads ./gactions). It should output a URL like https://console.actions.google.com/project/doctest-2d0b8/overview - go there.
    3. +
  3. You’ll need to fill out most of the information on that page, but none of it really matters since you won’t be addressing the App directly, only through the Smart Home functionality built into Google Assistant.
    4. +
  4. The final item on that page Account linking is required for your app to interact with Home Assistant. +
      +
    1. Grant type: Implicit
      2. +
    2. Client ID: Should be the same as client_id from your hass config above
      3. +
    3. Authorization URL (replace with your actual URL): https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth
      4. +
    4. Configure your client. Add scopes for email and name
      5. +
    5. Testing instructions: doesn’t matter since you won’t submit this app
      6. +
    +
    5. +
  5. Back on the main app draft page. Click Test Draft. That will take you to the simulator (which won’t work) so just close that window.
    6. +
  6. Open the Google Assistant app and go into Settings > Home Control
    7. +
  7. Click the + sign, and near the bottom, you should have [test] your app name. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices.
    8. +
  8. If you want to allow other houshold users to control the devices: +
      +
    1. Go to the developer console using address from point 4.
      2. +
    2. Under the gear icon, click Permissions
      3. +
    3. Click Add, type the new user’s e-mail address and choose Project -> Editor role
      4. +
    4. Have the new user go to developer console and repeat steps starting from point 7.
      5. +
    +
    9. +