Docs for transparency feature google calendar component (#5101)

* Add transparency feature to google calendar component

* Set default behaviour to ignore the availability. 

This reflects the old behaviour and does not break current workflows.
This commit is contained in:
cgtobi 2018-04-06 21:49:47 +02:00 committed by Sebastian Muszynski
parent 9bbbf21643
commit 086960a502

View File

@ -95,7 +95,8 @@ Variables:
- **track**: (*Required*): Should we create a sensor `True` or ignore it `False`?
- **search**: (*Optional*): If set will only trigger for matched events.
- **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: `!!`)
 - **ignore_availablilty**: (*Optional*): Should we respect `free`/`busy` flags? (Defaults to `true`)
 
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.
But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.