Skip to content

Generates an iCalendar (.ics) link that you can use to view your Home Assistant calendars in another app

License

Notifications You must be signed in to change notification settings

chris-y/ha-icalendar

 
 

Repository files navigation

iCalendar API integration for Home Assistant

Generates an iCalendar (.ics) link that you can use to view your Home Assistant calendars in another app.

Installation

HACS (recommended)

  1. Install HACS, if you did not already

  2. Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  3. Press the Download button

  4. Add the following to your configuration.yaml file:

    icalendar:
      calendars:
        - entity_id: calendar.entity_id
          secret: yourSuperSecret
    

There should be a "calendars" entry for all calendars that need remote access.

  1. Restart Home Assistant

Manually

Copy all files in the custom_components/icalendar folder to your Home Assistant folder config/custom_components/icalendar.

Getting started

In your preferred calendar application, input your iCalendar URL in the following format:

Example

  • http://homeassistant.local:8123/api/ics/calendar.holidays?s=yourSuperSecret

Additional configuration

You can add colours to both calendars and specific named events by adding them to your config. Colours are specified as named CSS3 colours. For example, to colour events for your bin calendar, you might use:

icalendar:
  calendars:
    - entity_id: calendar.bins
      secret: yourSuperSecret
      colour: black
  colours:
    - name: "Recycling"
      colour: green
    - name: "Food waste"
      colour: brown

This will colour the event "Recycling" as green, "Food waste" as brown and the calendar itself (usually this is used as the default event colour) as black.

Known issues

  • Line length is not restricted to 75 characters

Future enhancements

Your support is welcomed.

About

Generates an iCalendar (.ics) link that you can use to view your Home Assistant calendars in another app

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 91.0%
  • Shell 9.0%