From c86023207dd20f276a4aeb40feeeba884fb76fee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Mon, 11 May 2020 20:07:06 +0200 Subject: [PATCH] Rename DOC.md to DOCS.md (#1285) --- google_assistant/{DOC.md => DOCS.md} | 62 +++++++++++++++++++++++++++- google_assistant/README.md | 62 +--------------------------- 2 files changed, 62 insertions(+), 62 deletions(-) rename google_assistant/{DOC.md => DOCS.md} (62%) diff --git a/google_assistant/DOC.md b/google_assistant/DOCS.md similarity index 62% rename from google_assistant/DOC.md rename to google_assistant/DOCS.md index 4b57b74..28dae78 100644 --- a/google_assistant/DOC.md +++ b/google_assistant/DOCS.md @@ -1,3 +1,40 @@ +# Home Assistant Add-on: Google Assistant SDK + +## Installation + +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. + +## Configuration + +Add-on configuration: + +```yaml +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][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][google-actions-console]. + +## How to use + You first need to enable access to the Google Assistant API. To do so, do the following: @@ -39,7 +76,30 @@ If the voice of the assistant is really low, you can ask it to increase the volu - "Ok Google, set volume to maximum." - or "Ok Google, set volume to 85%." +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Discord Chat Server][discord]. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +In case you've found a bug, please [open an issue on our GitHub][issue]. + +[dialogflow-integration]: https://www.home-assistant.io/integrations/dialogflow/ +[discord]: https://discord.gg/c5DvZ4e +[documentation]: https://github.com/home-assistant/hassio-addons/blob/master/google_assistant/DOCS.md +[forum]: https://community.home-assistant.io [google-actions-console]: https://console.actions.google.com/ +[google-actions]: https://actions.google.com/ [google-assistant-api]: https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview +[google-assistant]: https://assistant.google.com/ +[google-oauth-client]: https://console.developers.google.com/apis/credentials/oauthclient [google-oauth-concent]: https://console.developers.google.com/apis/credentials/consent -[samba-addon]: https://github.com/home-assistant/hassio-addons/tree/master/samba +[google-platform-project]: https://console.cloud.google.com/project +[issue]: https://github.com/home-assistant/hassio-addons/issues +[reddit]: https://reddit.com/r/homeassistant +[repository]: https://github.com/hassio-addons/repository +[samba-addon]: https://github.com/home-assistant/hassio-addons/tree/master/samba \ No newline at end of file diff --git a/google_assistant/README.md b/google_assistant/README.md index 61798a6..182bfd3 100644 --- a/google_assistant/README.md +++ b/google_assistant/README.md @@ -14,69 +14,9 @@ You can simply say "Ok Google" following by your command, and Google Assistant w If you want to integrate your Google Home or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant integration][google-assistant-integration]. -## Installation - -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 - -[Click here for the full documentation](DOC.md) - -## Configuration - -Add-on configuration: - -```yaml -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][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][google-actions-console]. - -## Support - -Got questions? - -You have several options to get them answered: - -- The [Home Assistant Discord Chat Server][discord]. -- The Home Assistant [Community Forum][forum]. -- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] - -In case you've found a bug, please [open an issue on our GitHub][issue]. - -[aarch64-shield]: https://img.shields.io/badge/aarch64-no-red.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg -[dialogflow-integration]: https://www.home-assistant.io/integrations/dialogflow/ -[discord]: https://discord.gg/c5DvZ4e -[forum]: https://community.home-assistant.io -[google-actions]: https://actions.google.com/ -[google-actions-console]: https://console.actions.google.com/ [google-assistant-integration]: https://www.home-assistant.io/integrations/google_assistant/ -[google-assistant]: https://assistant.google.com/ -[google-oauth-client]: https://console.developers.google.com/apis/credentials/oauthclient -[google-platform-project]: https://console.cloud.google.com/project [i386-shield]: https://img.shields.io/badge/i386-no-red.svg -[issue]: https://github.com/home-assistant/hassio-addons/issues -[reddit]: https://reddit.com/r/homeassistant -[repository]: https://github.com/hassio-addons/repository +[aarch64-shield]: https://img.shields.io/badge/aarch64-no-red.svg \ No newline at end of file