[APP][Pro] IcalCalendar

IcalCalendar

The IcalCalendar gives Homey flow cards to trigger on your calendar events

large

Test tool

A separate test tool is created for you to test IcalCalendar behavior in your own console

Setup

For how to setup this app, check out the readme on the GitHub repo

Sync

  • Events are fetched automatically every 15th minute (xx:00, xx:15, xx:30, xx:45)
  • The following events will be fetched in to the app:
    • Events not started yet where start date is within the timeframe given in the setup
    • Recurring events where start date is within the timeframe given in the setup
    • Events started but not finished

See a list of which events exists in the app

To see a list of synced in events, create a new flow and use the condition card Specific event is ongoing in a flow like this:

  1. Create a new flow, or use an existing one (your choice)
  2. Choose the FlowThis flow has started as the trigger in the WHEN section
  3. In the AND section, add the Specific event is ongoing card from IcalCalendar
    1. Click Select event... in the condition card
    2. This will present you with a list of all the events synced in

Local events

A local event is just local. They will never interact with your calendar externally!

Create local event

You can use the action card Create local event to add a local event to one of your calendars in Homey. This local event will live and behave just as a normal event would.

When the event is finished, it will automatically be removed, just as any other event.

:exclamation: If you set Apply your timezone to True, this will treat the datetimes given as UTC and your timezone difference will be added!

Delete local event by title

You can use the action card Delete local event by title to remove any local events containing the title given.

Flow cards

Triggers

  • Event starts - will trigger when any event starts
  • Event starts in - will trigger when any event starts in when specified
  • Event starts from calendar - will trigger when any event in specified calender starts
  • Event ends - will trigger when any event ends
  • Event ends in - will trigger when any event ends in when specified
  • Event ends from calendar - will trigger when any event in specified calender ends
  • Event changed - will trigger when any of the previously synchronized events have been changed (after sync)
  • Event added - will trigger when a new event is created in one of your synced calendars
    • Will trigger when these requirements are met:
      • The event has the CREATED property
      • The created events start time is inside the current datetime frame beeing synced in
      • The created event is created within the last 24 hours
  • Synchronization error occurred - will trigger when a synchronization error occurs with one of your calendars

Conditions

  • Specific event is ongoing - will check if specified event is|isn’t ongoing
  • Specific event starts within - will check if specified event starts|doesn’t start within when specified
  • Specific event ends within - will check if specified event ends|doesn’t end within when specified
  • Any event is ongoing - will check if any event is|isn’t ongoing
  • Any event starts within - will check if any event starts|doesn’t start within when specified
  • Any event ends within - will check if any event ends|doesn’t ends within when specified
  • Any event ongoing in calendar - will check if any event is|isn’t ongoing in specified calendar
  • Event containing … in calendar … starts within - Event containing search value in chosen calendar starts within selected time range (will fill up global tags (containing))
  • Event containing … in calendar … ends within - Event containing search value in chosen calendar ends within selected time range (will fill up global tags (containing))
  • Any event starts within from calendar - will check if any event starts|doesn’t start within when specified from specified calendar
  • Event containing … in calendar … is ongoing - will check if an event containing value in calendar is|isn’t ongoing

Actions

  • Sync calendars - will download new .ics files to update current events (events are fetched automatically, this card can be used to force a sync when you want)
  • Create local event - will allow you to create a local event that behaves just as a normal event, but only lives on your Homey (event is automatically deleted when it's finished)
  • Delete local event by title - will remove any local events with this title (if several local events with this title is found, all of them will be removed!)

Troubleshooting

Problem in the synchronization of your calendars

Create a new flow:

  1. Choose Synchronization error occurred as the trigger
  2. For the action, add a push notification or something else that will get your attention.
  3. Fill the action card you chose with the error message from the trigger card

Any other problems

If you have any other problems, feel free to open an issue on the GitHub repo

But before you do, please do the following:

  1. Make sure you have the lastest version of the app installed
  2. Make sure you have updated your Homey firmware to the latest
  3. Open the settings page for the app
  4. Scroll down to the bottom and enable Log all events (blue checkmark)
  5. Click Save
  6. Restart the app
  7. Wait 5 minutes
  8. Click Create diagnostics report on the app gear icon.
  9. Copy the report id given
  10. Post this report id along with the issue you open on GitHub
3 Likes

Changelog

  • 1.18.1
  • 1.18.0
    • Added Next event description, Next event description in %calendarname% and Description (contains) as global tokens → Issue #447
    • Added Event added in calendar and Event changed in calendar triggers → Issue #447
  • 1.17.0
    • Added trigger Event ends from calendarIssue #444
    • Dependency updates
  • 1.16.2
    • Added a little more descriptions for Local events
    • Trigger Event added when a new local event is added
  • 1.16.1
    • Added description to a local event
  • 1.16.0
    • Added possibility for local events → Issue #442
    • Dependency updates
  • 1.15.0
    • Do not apply local timezone for events created with MS Outlook Custom timezone Customized Time Zone. This means that the raw start time set in the calendar file is what will be used
  • 1.14.1
    • Minimized footprint
    • Dependency updates
  • 1.14.0
    • Fixed support for Homey Pro 2023
      • Fixed a cirular dependency “issue”
    • settings: Save uri’s to settings last to prevent fetching calendars if there’s other settings to be saved first
    • Remove cron jobs in both unload and onUninit
    • Try to find and use fallback uri for calendar if calendar is not retrieved. If both uri and fallback uri fails for a calendar, Synchronization error occurred will be triggered
    • Dependency updates
  • 1.13.2
    • Bugfix: Find meeting url’s by a generic pattern now actually works…
  • 1.13.1
  • 1.13.0
    • Added Meeting URL tag to triggers. For now it reads meeting urls for Microsoft Teams, Apple FaceTime and Google Meet from the description field → Issue #420
    • Added tests for extract-meeting-url
    • Dependency updates
  • 1.12.0
    • Added Was ongoing and Ongoing tags to trigger Event changed
    • Dependency updates
  • 1.11.4
    • Dependency updates
  • 1.11.3
    • Logfix
    • If event hasn’t registered a timezone, don’t use the local timezone from Homey either, for conditions and triggers…
    • Dependency updates
  • 1.11.2
    • Added uid to debug output
  • 1.11.1
    • Use correct date lookup key to find excluded dates
  • 1.11.0
    • If event hasn’t registered a timezone, don’t use the local timezone from Homey either, all the way through
    • Dependency updates
  • 1.10.0
    • Dependency updates
    • Added Status tag to triggers. For now it reads Freebusy status from Microsoft (X-MICROSOFT-CDO-BUSYSTATUS , MICROSOFT-CDO-BUSYSTATUS) → Issue #394
    • If event hasn’t registered a timezone, don’t use the local timezone from Homey either
    • Show timezone in logged event (when Log all events is active)
  • 1.9.0
    • Added debug option to log all events to console for better diagnostic reporting
  • 1.8.3
    • Dependency updates
  • 1.8.2
    • Some repeating ongoing events were not included → Issue #380
    • Dependency updates
  • 1.8.1
    • Dependency updates
    • Added test for croner
    • Updated dependency node-ical - Fixes invalid timezones
  • 1.8.0
    • Added condition Event containing ... in calendar ... ends withinIssue #359
    • Fixed inverted titles in condition cards
  • 1.7.1
    • Bugfix: Catch errors thrown from node-ical
    • Dependency updates
  • 1.7.0
    • Rewritten date/time format to support all tokens (in any layout) from moment.format()
  • 1.6.0
    • Bugfix: Date format in settings view didn’t allow the use of ddd or dddd because the string was forced as uppercase
    • Bugfix: Date format showed wrong short date when YY or YYYY was used as the first date segment
    • Set correctly locale on all events at import
    • Use long date format on startStamp, always. This to allow for weekday to be included IF its added to the date format
    • Better documentation for Date format section
    • Dependency and DevDependency updates
  • 1.5.0
    • Properly handle moved recurrence events
    • Dependency updates
    • Removed sentry in favour for the synchronization error trigger card
  • 1.4.1
    • Bugfix: Trigger cards could be fired twice at every 15th minute (0, 15, 30, 45)
      • This happend because triggering cards was also added to the update schedule. And this was done because the schedule through node-cron was buggy.
      • node-cron has been replaced by croner
    • Dependency updates
  • 1.4.0
    • Added condition Event containing search value in chosen calendar is ongoingIssue #341
  • 1.3.1
    • Bugfix: Cannot read properties of undefined (reading 'forEach')
  • 1.3.0
    • Bugfix: Every 15th minute, events wouldn’t be evaluated for triggering and tokens wouldn’t be updated
    • Added tokens Todays events (count) in and Tomorrows events (count) in for all calendars
  • 1.2.0
    • No need to return value in Promise.resolve
    • Sync calendars action card will present synchronization errors in Error flow path in an Advanced flow, and through the error banner in a regular flow
    • Dependency updates
  • 1.1.4
    • Dates must have year as part of the date for TTS to work properly
  • 1.1.3
    • Improved error handling for trigger Synchronization error occurred
    • Bugfix: calendar_name is undefined
    • Show if error happend onCalendarLoad or onEventLoad
  • 1.1.0 (1.1.2)
    • Next event tags containing as a condition card only
    • Added condition Any event starts within ... from calendarIssue #323
  • 1.1.0 (1.1.1)
    • Next event tags containing added as a condition card. Settings implementation is disabled and will be removed
  • 1.1.0
    • Added trigger ‘Synchronization error occurred’ → Issue #316
    • Translation fix
    • Next event tags containing added. Possibility to have a global tag with the next event matching the given search value
  • 1.0.7
    • Week number event tag were 1 week of since Moment#week were used instead of Moment#isoWeek
  • 1.0.6
    • Full day events need to have the offset removed (fixed throughout)
    • Handle Customized Time Zone from Exchange / Live accounts
    • Dependency updates
  • 1.0.5
    • Error handling when events are parsed
    • Make sure recurrence dates outside the limit will not be included
    • Full day events need to have the offset removed
  • 1.0.4
    • Log which Timezone your Homey is using. Since SDK3 is always running in UTC, we have to rely on Timezone set in your Homey to get the correct datetime on your events.
    • Log out whole day events (debug purposes)
  • 1.0.3
    • Bugfix: location, description and uid could also be objects
  • 1.0.2
    • exdate is an invalid array. And since deepClone only clones valid values, exdate becomes an empty array. To make up for this we have to add the original exdate property to the cloned event object
  • 1.0.1
    • Initalize sentry correctly
  • 1.0.0
    • Updated to SDK3
    • Rewritten a bunch for better maintenance
    • Tests for almost all code :tada:
  • 0.15.0
    • Dependency updates
    • Updated node-ical
    • Localized datetime start and end format in Event changed
  • 0.14.3
    • Dependency updates
    • Bugfix: If a recurrence were found, newEvent was overwritten with the recurrence event
  • 0.14.2
    • Bugfix: Fix misread start when a recurring event had start time set to 00:00 (hopefully this doesn’t mess things up…)
    • Bugfix: Make sure recurrence override is same day
  • 0.14.1
    • Summary of an updated calendar event is now evaluated first.
    • Include recurrence date even when utc date is previous date
  • 0.14.0
    • Bugfix: Exchange calendars (might be others aswell) do not use the CREATED property. Instead they use DTSTAMP and METHOD, but these are treated both as created and as modified timestamp. So from now on only the CREATED property is taken into account.
    • Added tokens Week day, Month and Date to trigger Event added
  • 0.13.1
    • German and Swedish translation fix
  • 0.13.0
    • Added trigger ‘Event added’ → Issue #273
    • Dependency updates
  • 0.12.0
    • Bugfix: summary property of a calendar isn’t required
    • Added week number added as a global token
  • 0.11.0
    • Dependency updates
    • start, end and summary properties of a calendar is now required. If an event in a calendar is missing one of these, no events will be imported from this calendar, and an error will be printed in the settings page!
    • Bugfix: Token update can happen in the same second when tokens are beeing flushed because calendars are beeing updated. This is handled now.
  • 0.10.1
    • Bugfix: Event time frame would not be applied when saved along with a calendar change
  • 0.10.0
    • Swedish translation. Thanks to @LavvePR #270
    • Dependency updates
  • 0.9.3
    • Dependency updates
  • 0.9.2
    • @dirkg173: Fixed German translation
    • Bugfix: Excluded whole day events could mistakenly be included anyway
    • Added more tests to prevent mistakes
    • Dependency updates
    • Updated node-ical
    • Localized time frame types → Issue 252?
    • Excluded tests folder and renovate.json from build
  • 0.9.1
    • Added hint to trigger Event changed
    • Bugfix: Events where a property changed to empty string would not trigger Event changed
    • Added jest for testing
    • Dependency updates
  • 0.9.0
    • Shrunk footprint of events
    • Security dependency update
    • Dependency updates
    • Added Event changed trigger → Issue 251
  • 0.8.2
    • Security dependency updates
  • 0.8.1
    • Dependency updates
  • 0.8.0
    • Dependency updates
    • node-ical updated to 0.13.0
  • 0.7.1
    • Bugfix: Only DATE events missing DTEND and DURATION property is supposed to have a duration for 1 day. DATETIME events missing DTEND property is supposed to end on the same day and time as DTSTART property
  • 0.7.0
  • 0.6.6
    • Bugfix: Events missing end date (ongoing indefinitely) would set end date as now and could make Homey trigger ‘Event ends’ on those events → Issue #212
    • node-ical updated to 0.12.9
    • Dependency updates
  • 0.6.5
    • Bugfix: Trigger card ‘Event ends in’ would not trigger if end time was equal to start time
    • Events over multiple days, where today is not start day or end day, will be set as “whole day” in flowtokens
    • Dependency updates
    • Bugfix: Recurring events crossing over to next day isn’t imported → Issue #218
  • 0.6.4
    • Bugfix: Homey v5.0.0 returns non-existing app settings differently than Homey v4.x.x
  • 0.6.3
    • More App store readme cleanup
    • Code cleanup
    • Bugfix: Flow tokens could cause a crash if calendar names aren’t unique
    • More readable duration token
    • Dependency updates
  • 0.6.2
  • 0.6.1
    • Bugfix for Homey versions prior to 4.2.0: Empty catch block
  • 0.6.0
    • Bugfix: flowtoken_already_exists can be thrown when action card Sync calendars is triggered (#201)
    • Updated node-ical to fix the bug Unknown RRULE property 'RRULE'
    • Added formatted titles to conditions for better readability
    • Added formatted titles to triggers for better readability
    • Moved New calendar button in settings page to calendar section
  • 0.5.1
    • Bugfix: Ongoing regular events were not synced in (#199)
  • 0.5.0
  • 0.4.8
    • German translation typo
    • Bugfix: Homey.ManagerSettings will return null when app is initially installed
    • Bugfix: Custom date format yield invalid date format string (#195)
    • Dependency update: Homey and sentry
  • 0.4.7
    • Enhancement: Sentry property update
    • Bugfix: flowtoken_already_exists (#185)
    • Bugfix: Uri’s without a protocol are allowed (#186)
  • 0.4.6
    • Bugfix: event.summary can be object (#183)
    • Bugfix: Non-Error exception captured with keys: $__type, data (#181)
    • Enhancement: Url’s with webcal://… is replaced with https://… (#180)
    • Enhancement: Url’s in settings are now validated (#180)
    • Bugfix: Amount value in ‘Time frame’ shoud be numbers only (#182)
    • Bugfix: Amount value in ‘Time frame’ now expects a number higher than 0 (#182)
  • 0.4.5
    • Bugfix: Cannot read property ‘start’ of undefined (#179)
  • 0.4.4
    • Bugfix: Used values not yet defined (#178)
  • 0.4.3
    • Added sentry
  • 0.4.2
    • Bugfix: All regular events are imported → Issue #170
    • New setting to specify time frame for events to be fetched (2 months ahead is the default)
  • 0.4.1
    • Ical engine (node-ical) updated (minor)
    • Legacy calendar support (version < 0.0.5) removed
    • Bugfix: Some events had wrong time after DST. Thanks to @MatsAnd
  • 0.4.0
    • Added support for adding weekday in dateformat in settings
    • Added trigger ‘Event ends in’ → Issue #149
    • Bugfix: Ongoing non recurring events were included, but ongoing recurring events were not → Issue #152
    • Added condition ‘Any event ongoing in calendar’ → Issue #151
    • Bugfix: Events over multiple days now also includes short date in tags
    • Bugfix: Full day events were not included in tomorrows events tag
    • Ical engine (node-ical) updated (minor)
  • 0.3.0
    • Next event tags per calendar can be toggled on/off in settings (default is off). Will add the following tags per calendar:
      • Next event title in %calendarname%
      • Next event start date in %calendarname%
      • Next event start time in %calendarname%
      • Next event end date in %calendarname%
      • Next event end time in %calendarname%
    • Humanized next event duration → Issue #137
    • @RobHomey: Fixed dutch translation
  • 0.2.5
    • Date and Time format used in the app can now be changed in the settings. If not changed, default is used.
    • Added trigger ‘Event starts from calendar’
    • @dirkg173: Fixed German translation
  • 0.2.4
    • Specific event conditions made more readable
    • Bugfix: Tags for todays and tomorrows events pr calendar were flushed completely every time calendars were synced
    • Tags ‘Todays events, title and time’, ‘Tomorrows events, title and time’, Todays events (per calendar) and Tomorrows events (per calendar) made more TTS friendly
    • @RobHomey: Fixed dutch translation
  • 0.2.3
  • 0.2.2
    • Conditions/Trigger improved by setting amount in minute(s)/hour(s)/day(s)/week(s)
    • @RobHomey: Fixed dutch translation
  • 0.2.1
    • Next event more TTS friendly
  • 0.2.0
    • Fixed German typo’s
    • Fixed Dutch typo’s
    • Bugfix: Hopefully fixed an app crash “Cannot read property ‘uris’ of undefined”
    • Flow card ‘Event starts in’ changed to enter minutes in free text (number)
    • Flow card ‘Any event starts within’ changed to enter minutes in free text (number)
    • Flow card ‘Any event ends within’ changed to enter minutes in free text (number)
    • Flow card ‘Event starts within’ changed to enter minutes in free text (number)
    • Flow card ‘Event ends within’ changed to enter minutes in free text (number)
    • Global tag ‘Next event start time’ split up to ‘Next event start date’ and ‘Next event start time’
    • Global tag ‘Next event end time’ split up to ‘Next event end date’ and ‘Next event end time’
    • ‘Next event start date’ and ‘Next event end date’ made more TTS friendly
  • 0.1.4
  • 0.1.3
    • ‘Remove button’ in Settings now follows language
    • Bugfix: Apple calendar failed to load because Apple calendar is case sensative on its url… → Issue #61
      • To fix this in your app, replace the url in Settings page and save
    • Dutch translation. Thanks to @RobHomeyIssue #62
    • Dutch translation typo fixes
  • 0.1.2
    • ‘Remove button’ in Settings now follows language
    • Bugfix: Apple calendar failed to load because Apple calendar is case sensative on its url… → Issue #61
      • To fix this in your app, replace the url in Settings page and save
    • Dutch translation. Thanks to @RobHomeyIssue #62
  • 0.1.1
    • Bugfix: Typo in the Norwegian locale
    • Added more choices (timespan) for triggers and conditions
    • Added possibility to remove calendars from settings
    • Added global flow tags for tomorrows events → Issue #36
    • Todays events and Tomorrows events are now sorted by start time → Issue #51
    • Todays and tomorrows events pr calendar → Issue #44
    • Todays and tomorrows events tags no longer include ‘Todays events’ and ‘Tomorrows events’ in the tag value
  • 0.1.0
    • Added support for Mailfence (DTSTART;VALUE=DATE-TIME / DTEND;VALUE=DATE-TIME)
    • Added support for recurring events :smiley:
    • Bugfix: Todays events did not show events with end date greater than start date
    • Bugfix: Global tags were not proparly set as empty before calendars were set
    • Bugfix: Flow tags/triggers were evaluated even before any events existed
    • Condition event chooser rewritten
    • Event list sorted by start date
    • New icon
  • 0.0.6
    • Added global flow tags for next event and todays events → Part of issue Issue #7
    • Added tag ‘Calendar name’ to ‘Event starts’ and ‘Event ends’ triggers
    • Added trigger ‘Event starts in’ → Issue #7
  • 0.0.5
    • Added support for norwegian language → Issue #6
    • Added action for Sync calendar → Issue #3
    • Added duration tags to trigger ‘Event starts’ → Issue #16
    • Added trigger ‘Event ends’ → Issue #4
    • Added conditions ‘Any event ends in…’ and ‘Event ends in…’ → Issue #4
    • Added support for multiple calendars → Issue #17
    • Bugfix: “When Homey looses internet and tries to sync calendars, app crashes…” → Issue #20
  • 0.0.4
    • Changelog moved out of readme…
  • 0.0.3
    • Events in condition card is now presented with a date (and time if present) → Issue #2
    • Alert when settings saved → Issue #9
    • Show message in settings if uri fails to load
    • Importing only active events. This is a significantly performance improvement! → Issue #1
    • Event list in condition card shows if the event is recurring and/or full day
  • 0.0.2:
    • Bugfix: “triggerEvents” failed when events were not imported yet
    • Bugfix: Tags are validated before set (replacing ‘\n’ or ‘\r’ or null with ‘’)
    • Added trigger for any events started
    • Bugfix: “Event is ongoing” validated to true when a started event was missing a end time
    • Updated README.txt with info from README.md (and make it look good)
    • Updated app.json/Description with a really well said sentence of what this app can do
    • Changed brandColor
  • 0.0.1:
    • Initial version
1 Like

Reserved