Skip to content
Branch: master
Find file Copy path
Find file Copy path
2 contributors

Users who have contributed to this file

@frenck @balloob
105 lines (73 sloc) 6.08 KB

Home Assistant Add-on: Google Assistant SDK

Load and update configuration files for Home Assistant from a Git repository.

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture


Google Assistant is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact via the DialogFlow integration with Home-Assistant. You can also use Google Actions to extend its functionality.

ℹ️ Integration your mobile or Google/Nest Home with Home Assistant

If you want to integrate your Google Home or mobile phone running Google Assistant, with Home Assistant, then you want the Google Assistant integration.


Follow these steps to get the add-on installed on your system:

  1. Navigate in your Home Assistant frontend to Supervisor -> Add-on Store.
  2. Find the "Google Assistant SDK" add-on and click it.
  3. Click on the "INSTALL" button.

How to use

Fist, select the input and output audio devices to use for the Assistant in the "Audio" section of the add-on configuration.

To enable access to the Google Assistant API, do the following:

  1. Go to the [Google Actions Console][oogle-actions-console] and create a new project.
  2. After you created the project on the bottom of the page click "Device registration". Keep this tab open for later use.
  3. Enable the Google Assistant API on the new project through this link. Make sure you have the right project selected (shown in the middle of the screen in the top bar). If you can't select the right project, it may help to open the link in an incognito window.
  4. Configure the OAuth consent screen. Also again check that you have the right project and don't forget to hit "Save" at the bottom of the page. You only have to fill in a project name and your e-mail.
  5. You back to you device registration tab and click "Device registration". Or open you project in the Google Actions Console start the Quick setup, and in the left bar click "Device registration".
  6. Give you project a name, think of a nice manufacturer and for device type select "speaker".
  7. Edit you "model id", if you want to and copy it for later use.
  8. Download the credentials.
  9. Click "Next" and click "Skip".
  10. Upload your credentials as "google_assistant.json" to the "hassio/share" folder, for example by using the Samba add-on.
  11. In the Add-on configuration field fill-in you "project id" and your "model-id" and hit "Save". Your project id can be found in the Google Actions console by clicking on the top right menu button and selecting "Project settings". This id may differ from the project name that you choose!
  12. Below the "Config" window select the microphone and speaker that you want to use. On a Raspberry Pi 3, ALSA device 0 is the built-in headset port and ALSA device 1 is the HDMI port. Also don't forget to click "Save".
  13. Start the add-on. Check the log and click refresh till it says: "ENGINE Bus STARTED".
  14. Now click "Open Web UI" and follow the authentication process. You will get an empty response after you have send your token.

Now install and activate the Samba add-on so you can upload your credential file. Connect to the "share" Samba share and copy your credentials over. Name the file google_assistant.json.

The next step is to authenticate your Google account with Google Assistant. Start the add-on and click on the "OPEN WEB UI" button to start authentication.


Add-on configuration:

client_secrets: google_assistant.json
project_id: project_id_from_google
model_id: model_id_from_google

Option: clients_secrets (required)

The name of the client secrets file to you've downloaded from Google and placed in your /share folder.

Option: project_id (required)

Project ID of the project you've created at Google for this add-on.

The project id can be found in your "google_assistant.json" file or under project settings in the Google Actions Console.

Option: model_id (required)

The ID of the model you've registered at Google for this add-on.

The model id can also be found under the "Develop - Device registration tab" in the Google Actions Console.


Got questions?

You have several options to get them answered:

In case you've found a bug, please open an issue on our GitHub.

You can’t perform that action at this time.