Add calendar section to documentation. Explanations and example is pr… (#33955)

* Add calendar section to documentation. Explanations and example is provided.

* Apply suggestions from code review

* Update source/_integrations/ridwell.markdown

* Update source/_integrations/ridwell.markdown

* Update source/_integrations/ridwell.markdown

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Corbin Black 2024-07-29 04:03:41 -05:00 committed by GitHub
parent 4a108bfcfb
commit 42891083d9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -21,6 +21,30 @@ The Ridwell integration allows users to track waste recycling pickups scheduled
{% include integrations/config_flow.md %}
## Calendar
The calendar sensor contains a `calendar` state attribute, which contains:
- The name of the Ridwell Calendar.
- If the event is an all-day event (Boolean).
- The start time of the calendar event. Starts at midnight.
- The end time of the event. Ends at midnight.
- The location of the event.
- The description of the items being picked up.
- Friendly name of the calendar event.
For example:
```yaml
message: Ridwell Pickup (scheduled)
all_day: true
start_time: 2024-07-26 00:00:00
end_time: 2024-07-27 00:00:00
location:
description: Pickup types: Light Bulbs (quantity: 1), Hand Tools (quantity: 1), Batteries (quantity: 1), Threads (quantity: 1), Plastic Film (quantity: 1)
friendly_name: Ridwell
```
## Pickup types
The pickup sensor contains a `pickup_types` state attribute, which contains: