-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Documentation for Google Calendar component #1403
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
Conversation
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.
A few comments and there's a bit more work to be done. Documentation differs in style quite a bit from the general documentation of Home Assistant.
I'm a bit unsure of the file name since it's a binary sensor and the file name is sensor.google_calendar.markdown
comments: false | ||
sharing: true | ||
footer: true | ||
logo: home-assistant.png |
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.
Change this into the Google calender logo?
|
||
Configuration variables: | ||
|
||
- **client_id** (*Required*): Use the value you generated in the Prerequisies stage |
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.
Prerequisies should be Prerequisites.
1. Click on the tab 'OAuth consent screen' | ||
1. Set 'Product name shown to users' to anything you want. We suggest Home-Assistant. | ||
1. Save this page. You don't have to fill out anything else there. | ||
1. Click 'Create credentials' -> OAuth client ID |
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.
Missing dot at the end
1. Set 'Product name shown to users' to anything you want. We suggest Home-Assistant. | ||
1. Save this page. You don't have to fill out anything else there. | ||
1. Click 'Create credentials' -> OAuth client ID | ||
1. Set the Application type to 'Other' and give this credential set a name then click Create |
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.
Missing dot at the end.
1. Save this page. You don't have to fill out anything else there. | ||
1. Click 'Create credentials' -> OAuth client ID | ||
1. Set the Application type to 'Other' and give this credential set a name then click Create | ||
1. Save the client ID and secret as you will need to put these in your configuration.yaml |
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.
Suggest either changing this to configuration file or configuration.yaml file.
- **client_secret** (*Required*): Use the value you generated in the Prerequisies stage | ||
- **track_new_calendar** (*Optional*): Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars on startup. By default this is set to `True`. | ||
|
||
The next steps will require you to have Home-Assistant running. |
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.
Dash in Home-Assistant shouldn't be there.
|
||
The next steps will require you to have Home-Assistant running. | ||
|
||
After you have it running complete the Google authentication that pops up. It will give you a url and a code to enter. This will grant your Home-Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars. |
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.
Dash in Home-Assistant shouldn't be there.
@Landrash Not sure what you mean by the style differing. I just compared it to ffmpeg and made a few small changes but nothing that I could see that was "quite a bit different" |
Fix spelling and formatting.
Fixed a few formatting and spelling misses but your changes all in all where good :) |
Documenation for Google Calendar component:
Pull request in home-assistant (if applicable): home-assistant/core#4161