Calendar event helper for Home Assistant
Allows creation of binary sensor helpers that look at the summary of the currently active events for a calendar, turning the sensor on if the summary matches that configured in the helper.
The description of the calendar event is available as an attribute within the helper.
Using the built-in calendar state within a template does not handle multiple events at the same time; it is on if any event is active and the message attribute only displays one of the events, or an upcoming event, making it very hard to use in a dashboard.
Calendar Event helpers detect when a calendar state is on, and while it's on they will locally compare all current events every minute against the criteria specified, allowing for multiple calendar events to overlap within the same calendar. They will not refresh external calendars such as CalDAV; that schedule is determined by the integration for the calendar.
Please ⭐ this repo if you find it useful
If you want to show your support please
Restart Home Assistant
In the HA UI go to "Configuration" -> "Devices & services" -> "Helpers" click "+" and select "Calendar Event"
Show detailed instructions
Installation via HACS is recommended, but a manual setup is supported.
- Manually copy custom_components/calendar_event folder from latest release to custom_components folder in your config folder.
- Restart Home Assistant.
- In the HA UI go to "Configuration" -> "Devices & services" -> "Helpers" click "+" and select "Calendar Event"
A new Calendar Event helper will be available within Settings/Helpers or click the My link to jump straight there
You can help by adding missing translations when you are a native speaker. Or add a complete new language when there is no language file available.
Calendar Event uses Crowdin to make contributing easy.
Instructions
Changing or adding to existing language
First register and join the translation project
- If you don’t have a Crowdin account yet, create one at https://crowdin.com
- Go to the Calendar Event Crowdin project page
- Click Join.
Next translate a string
- Select the language you want to contribute to from the dashboard.
- Click Translate All.
- Find the string you want to edit, missing translation are marked red.
- Fill in or modify the translation and click Save.
- Repeat for other translations.
Calendar Event will automatically pull in latest changes to translations every day and create a Pull Request. After that is reviewed by a maintainer it will be included in the next release of Calendar Event.
Adding a new language
Create an Issue requesting a new language. We will do the necessary work to add the new translation to the integration and Crowdin site, when it's ready for you to contribute we'll comment on the issue you raised.
