You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/calendar.google.markdown
+26-27Lines changed: 26 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ha_release: 0.33
14
14
---
15
15
16
16
17
-
This platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file *google_calendars.yaml* that will contain information about all of the calendars you can see.
17
+
The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see.
18
18
19
19
### {% linkable_title Prerequisites %}
20
20
@@ -27,7 +27,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co
27
27
1. Save this page. You don't have to fill out anything else there.
28
28
1. Click 'Create credentials' -> OAuth client ID.
29
29
1. Set the Application type to 'Other' and give this credential set a name then click Create.
30
-
1. Save the client ID and secret as you will need to put these in your configuration.yaml file.
30
+
1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file.
31
31
1. Click on "Library", search for "Google Calendar API" and enable it.
32
32
33
33
### {% linkable_title Basic Setup %}
@@ -37,33 +37,43 @@ To integrate Google Calendar in Home Assistant, add the following section to you
37
37
```yaml
38
38
# Example configuration.yaml entry
39
39
google:
40
-
client_id: *Value_created_from_steps_above*
41
-
client_secret: *Value_created_from_steps_above*
40
+
client_id: YOUR_CLIENT_ID
41
+
client_secret: YOUR_CLIENT_SECRET
42
42
```
43
43
44
-
Configuration variables:
45
-
46
-
- **client_id** (*Required*): Use the value you generated in the Prerequisites stage.
47
-
- **client_secret** (*Required*): Use the value you generated in the Prerequisites stage.
48
-
- **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`.
44
+
{% configuration %}
45
+
client_id:
46
+
description: Use the value you generated in the Prerequisites stage.
47
+
required: true
48
+
type: string
49
+
minimum:
50
+
description: Use the value you generated in the Prerequisites stage.
51
+
required: true
52
+
type: string
53
+
track_new_calendar:
54
+
description: Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars only on startup.
55
+
required: false
56
+
type: boolean
57
+
default: true
58
+
{% endconfiguration %}
49
59
50
60
The next steps will require you to have Home Assistant running.
51
61
52
62
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.
@@ -79,38 +89,27 @@ A basic entry for a single calendar looks like:
79
89
Variables:
80
90
81
91
- **cal_id**: The Google generated unique id for this calendar. **DO NOT CHANGE**
82
-
83
92
- **entities**: Yes, you can have multiple sensors for a calendar!
84
-
85
93
- **device_id**: (*Required*): The name that all your automations/scripts will use to reference this device.
86
-
87
94
- **name**: (*Required*): What is the name of your sensor that you'll see in the frontend.
88
-
89
95
- **track**: (*Required*): Should we create a sensor `True` or ignore it `False`?
90
-
91
96
- **search**: (*Optional*): If set will only trigger for matched events.
92
-
93
97
- **offset**: (*Optional*): A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. (Default: `!!`)
94
98
95
99
From this we will end up with the binary sensors `calendar.test_unimportant` and `calendar.test_important` which will toggle themselves on/off based on events on the same calendar that match the search value set for each. You'll also have a sensor `calendar.test_everything` that will not filter events out and always show the next event available.
96
100
97
101
But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.
98
102
99
-
**Note**: If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.
100
-
103
+
<p class='note warning'>
104
+
If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.
105
+
</p>
101
106
102
107
### {% linkable_title Sensor attributes %}
103
108
104
109
- **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts.
105
-
106
110
- **all_day**: `True`/`False` if this is an all day event. Will be `False` if there is no event found.
107
-
108
111
- **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting`
0 commit comments