Google Assistant SDK Custom integration for Home Assistant

This integration patches Google Assistant SDK integration to allow getting responses from commands to Google Assistant and to enable personal results.

Note: After a Home Assistant update the patch will be reapplied automatically and Home Assistant will restart.

Why aren't these changes in the core Google Assistant SDK integration?

Due to a bug in the Google Assistant API, not all responses contain text, especially for home control commands, like turn on the lights. The workaround, per the linked bug, is to enable HTML output and then parse the HTML for the text. Because the core integrations are not allowed to parse HTML, this custom integration is needed.

Lastly, there is a pending PR to enable personal results which has been in the review queue for several months.

Installation

HACS

Add custom integrations repository: https://github.com/tronikos/google_assistant_sdk_custom
Select "Google Assistant SDK Custom" in the Integration tab and click download
Restart Home Assistant
Enable the integration

Manual

Copy directory custom_components/google_assistant_sdk_custom to your <config dir>/custom_components directory
Restart Home-Assistant
Enable the integration

Enable the integration

Go to Settings / Devices & Services / Integrations. Click + ADD INTEGRATION
Search for "Google Assistant SDK Custom" and click on it
Restart Home Assistant

Personal results

Create credentials file

Navigate to Google Developers Console > Credentials
Select the project you created earlier from the dropdown menu in the upper left corner.
Click Create credentials (at the top of the screen), then select OAuth client ID.
Set the Application type to "Desktop app" and give this credential set a name (like "Home Assistant Desktop Credentials").
Click Create.
In the OAuth client created screen, click on Download JSON.
Rename the downloaded file to client_secret.json
On your Windows or Linux or Mac machine download Python if you don't have it already.
Open terminal (on windows click on start and then type cmd).
On the terminal run the following commands (preferably in a Python virtual environment):
python -m pip install --upgrade google-auth-oauthlib[tool]
Under Windows: google-oauthlib-tool --scope https://www.googleapis.com/auth/assistant-sdk-prototype --scope https://www.googleapis.com/auth/gcm --save --client-secrets %userprofile%\Downloads\client_secret.json
Or under Linux: google-oauthlib-tool --scope https://www.googleapis.com/auth/assistant-sdk-prototype --scope https://www.googleapis.com/auth/gcm --save --client-secrets ~/Downloads/client_secret.json
A browser window will open asking you to select the account to continue to the cloud project you created earlier.
Once you select the correct account, add a tick to both: "Use your Google Assistant: broad access to your Google account." and "Send information to your Android device.".
Click continue.
If everything was successful you will get "The authentication flow has completed. You may close this window." in your browser and in your terminal you will see the path where the credentials was saved. E.g. credentials saved: C:\Users\user\AppData\Roaming\google-oauthlib-tool\credentials.json
In the file editor of your Home Assistant, typically http://homeassistant.local:8123/core_configurator, upload credentials.json in your config directory and rename it to google_assistant_sdk_credentials.json.
If you have .gitignore in your config directory, add google_assistant_sdk_credentials.json in that file to avoid uploading your credentials to GitHub.

Enable personal results

In the Developer Tools > Services, issue a query that requires personal results, e.g. call google_assistant_sdk.send_text_command with command: "what is my name"
On your phone you should receive a notification "Allow personal answers" "Allow Google Assistant to answer your questions about your calendar, trips, and more"
DO NOT tap on ALLOW (it won't work until you enter a device name). Instead tap on the notification text.
Tap on Device Name, enter any device name (like Home Assistant), and tap on OK.
Only after having a non empty device name enable the checkbox next to Personal results.

Examples

Nest Guard

Following example allows controlling Nest Guard and getting its status in a text helper. A similar approach, especially the automation that polls the status, can be used for other devices, for which a template, e.g. template light, might make more sense. Here a Template Alarm Control Panel wouldn't work because Google Assistant doesn't allow disarming Nest Guard.

Create a text helper with:

Name: Nest Guard Status
Icon: mdi:shield-home
Entity ID: input_text.nest_guard_status

Create following scripts:

nest_guard_refresh:
  alias: "Nest Guard: Refresh"
  sequence:
    - service: google_assistant_sdk.send_text_command
      data:
        command: what is the status of nest guard
      response_variable: response
    - service: input_text.set_value
      data:
        value: "{{ response.responses[0].text }}"
      target:
        entity_id: input_text.nest_guard_status
  mode: single
  icon: mdi:shield-refresh
nest_guard_away:
  alias: 'Nest Guard: Away'
  sequence:
  - service: google_assistant_sdk.send_text_command
    data:
      command: Set Nest Guard to away and guarding
  - service: script.nest_guard_refresh
    data: {}
  mode: single
  icon: mdi:shield-lock
nest_guard_home:
  alias: 'Nest Guard: Home'
  sequence:
  - service: google_assistant_sdk.send_text_command
    data:
      command: Set Nest Guard to home and guarding
  - service: script.nest_guard_refresh
    data: {}
  mode: single
  icon: mdi:shield-home

Create automation:

alias: "Nest Guard: status"
description: ""
trigger:
  - platform: time_pattern
    minutes: "10"
condition: []
action:
  - service: script.nest_guard_refresh
    data: {}
mode: queued
max: 10

Add the following Entities card in the lovelace dashboard:

type: entities
entities:
  - input_text.nest_guard_status
footer:
  type: buttons
  entities:
    - entity: script.nest_guard_home
      show_icon: true
      show_name: true
    - entity: script.nest_guard_away
      show_icon: true
      show_name: true
    - entity: script.nest_guard_refresh
      show_icon: true
      show_name: true

TonyOneZero/google_assistant_sdk_custom