Corbin Black 42891083d9
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>
2024-07-29 11:03:41 +02:00

2.0 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_codeowners ha_config_flow ha_platforms ha_integration_type
Ridwell Instructions on how to set up the Ridwell
Sensor
2021.12 Cloud Polling ridwell
@bachya
true
calendar
diagnostics
sensor
switch
service

The Ridwell integration allows users to track waste recycling pickups scheduled with Ridwell.

{% 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:

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:

  • The items being picked up during this particular event
  • The category of each item
  • The quantity of each item

For example:

{
  "Latex Paint": {
    "category": "add_on",
    "quantity": 7
  },
  "Beyond the Bin": {
    "category": "add_on",
    "quantity": 2
  },
  "Fluorescent Light Tubes": {
    "category": "add_on",
    "quantity": 1
  },
  "Winter Coats and Jackets": {
    "category": "rotating",
    "quantity": 1
  },
  "Light Bulbs": {
    "category": "standard",
    "quantity": 1
  },
  "Batteries": {
    "category": "standard",
    "quantity": 1
  },
  "Threads": {
    "category": "standard",
    "quantity": 1
  },
  "Plastic Film": {
    "category": "standard",
    "quantity": 1
  }
}