-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add google_assistant component #3657
Conversation
* *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 long random url safe string. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
access_token should also be urlsafe
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: Make up a random-ish or hard to guess string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Client ID should match the client_id from hass config.
* *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 long random url safe string. | ||
* *exposed domains* (Optional): An array of Home Assistant domains to expose to Google Assistant. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
exposed_domians wasn't optional in the first version (Was spewing errors when I didn't have it), not sure about the new version?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not using exposed_domains
and mine's working ok so that may have been an old version issue (I just noticed there's a missing underscore here in the doc though)
### {% linkable_title Setup %} | ||
|
||
1. Install the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) (you'll use this later) | ||
2. Create a new file named `project.json` and replace the hostname with your hostname in the URL. Note: This must be an HTTPS URL to work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is a hostname? Assume that people know nothing :-)
"...and replace "example.com" with the url of your HomeAssistant instance"
or something along those lines?
@philk I put in a few comments. |
*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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you also give an example here (like you do for project_id
) for how this should look like?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get what you're saying but I was slightly skeptical about putting anything that looked like an example because I don't want anyone to use "password123" or "changethis" as their id or token. I'm fine adding it if that's what you guys want, just a thought I had.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, let us leave it out for now. If lot of people struggle with it, we can add it later.
* *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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same....an example will be helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make some minor spelling & grammar changes.
I approve on the documentation part. Since the parent PR is merged already, I will move on and merge this.
@Filipe-Figueiredo Please use this thread for support/configuration questions. |
Description:
Documentation for setup of the Google Assistant component
Pull request in home-assistant (if applicable): home-assistant/core#9632