Skip to content
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

Merged
merged 4 commits into from
Oct 18, 2017
Merged

Conversation

philk
Copy link
Contributor

@philk philk commented Oct 17, 2017

Description:

Documentation for setup of the Google Assistant component

Pull request in home-assistant (if applicable): home-assistant/core#9632

* *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.
Copy link
Contributor

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
Copy link
Contributor

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.
Copy link
Contributor

@cnrd cnrd Oct 17, 2017

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?

Copy link
Contributor Author

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.
Copy link
Contributor

@cnrd cnrd Oct 17, 2017

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?

@cnrd
Copy link
Contributor

cnrd commented Oct 17, 2017

@philk I put in a few comments.

@fabaff fabaff added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-integration This PR adds documentation for a new Home Assistant integration labels Oct 17, 2017
*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.
Copy link
Contributor

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?

Copy link
Contributor Author

@philk philk Oct 18, 2017

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.

Copy link
Contributor

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.
Copy link
Contributor

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.

@frenck frenck self-requested a review October 18, 2017 19:28
@frenck frenck self-assigned this Oct 18, 2017
Copy link
Member

@frenck frenck left a 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.

@frenck frenck merged commit 889934d into home-assistant:next Oct 18, 2017
@arsaboo
Copy link
Contributor

arsaboo commented Oct 19, 2017

@Filipe-Figueiredo Please use this thread for support/configuration questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants