IcalCalendar

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

Test tool

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

Setup

Open settings (configure app)
- Paste in the ical link
- Change the date/time format or use the default (your choice)
- Choose whether or not you want next event tags per calendar. Default is off

Find Exchange Online ical link

Go to https://outlook.office.com/mail/inbox
Click settings -> Show all outlook setting
Go to Calendar -> Shared calenders
Publish a calendar, click the ics link and choose copy
Paste the ical link in settings of Homey app

Find Gmail ical url

Go to https://calendar.google.com/
Click the three dots next to the calendar you want to share -> Click Settings and sharing
Scroll all the way down to the bottom
Copy the link from Secret address in ical format
Paste the ical link in settings of Homey app

Find Apple iCloud url

Go to https://www.icloud.com/calendar/, or open the Calendar app on your iOS device
Click on the icon next to the calendar name in the left pane
Tick the checkbox for Public calendar
Copy the link
Paste the calendar link in the Homey app settings
- It must be the original link (Apple Calendar has case sensitive urls)

Usage

Sync

Events are fetched automatically every 15 minutes
The Sync calendars action flow card can also be used to trigger a sync
Only events not started yet or events started but not finished and has start date within 2 months or less will be fetched (this can be overridden in the settings)
Recurring events where start date is within 2 months or less will be fetched (this can be overridden in the settings)

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 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 created events start time is inside the current datetime frame beeing synced in
  - The created event is created within the last 24 hours

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

Actions

Sync calendars - will download new .ics files to update current events

Next event tags per calendar (can be turned on in the settings)

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%

Recurring events

Be aware of multiple/duplicate "recurring" events:

On a recurring event, where one or more participants have declined, that specific event is detached from the recurring event and created as a separate non-recurring event. This can result in two similar events, both have the same name and date.

Homey reads settings before app is ready

Issue at Homeys GitHub

The setting page is requesting settings while the app is not yet ready and this is causing the app to crash.

This bug is fixed in Homey firmware 5.0, unfortunately Athom cannot backport this fix to older Homey versions :(

When this happens, Homey will throw this in the console:

/opt/homey-client/system/manager/ManagerApps/bootstrap/sdk/v2/manager/settings.js:1
"use strict";const fs=require("fs"),path=require("path"),Homey=require("homey");class ManagerSettings extends Homey.Manager{__onInit(){this._updateSettingsTimeout=void 0,this._writing=!1,this.__client.emitSystem("getSettings").then(t=>{this._settings=t,this.__ready()}).catch(t=>{this.error(t),this._settings={},this._updateSettings(),this.__ready()}),this.__client.on("settings.get",this._onSettingsGet.bind(this)),this.__client.on("settings.set",this._onSettingsSet.bind(this)),this.__client.on("settings.unset",this._onSettingsUnset.bind(this))}_onSettingsGet(t,e){return!1===t.name?e(null,this._settings):e(null,this.get(t.name))}_onSettingsSet(t,e){try{return this.set(t.name,t.value),e(null,this.get(t.name))}catch(t){return e(t)}}_onSettingsUnset(t,e){try{return this.unset(t.name,t.value),e(null)}catch(t){return e(t)}}getKeys(){return Object.keys(this._settings)}get(t){if("string"!=typeof t)throw new Error("Cannot get setting, 

TypeError: Cannot read property 'uris' of undefined
    at ManagerSettings.get (/opt/homey-client/system/manager/ManagerApps/bootstrap/sdk/v2/manager/settings.js:1:998)
    at ManagerSettings._onSettingsGet (/opt/homey-client/system/manager/ManagerApps/bootstrap/sdk/v2/manager/settings.js:1:622)
    at /opt/homey-client/system/manager/ManagerApps/bootstrap/sdk/v2/lib/HomeyClient.js:1:1284
    at Array.forEach (<anonymous>)
    at HomeyClient._onMessage (/opt/homey-client/system/manager/ManagerApps/bootstrap/sdk/v2/lib/HomeyClient.js:1:1261)
    at process.emit (events.js:311:20)
    at emit (internal/child_process.js:876:12)
    at processTicksAndRejections (internal/process/task_queues.js:85:21)

--- INFO: no.runely.calendar has been killed ---

Tutorial

Visit this tutorial created by @RobHomey for a good summary of the apps possibilities!

Changelog

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 @Lavve -> PR #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
  - This also fixes (Issue #184)
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
- Bugfix: Events missing end date is approximately 1 day long or as long as duration (if present) (RFC5545 3.6.1)
  - Issue #212
  - Issue #221
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
- Dependency updates
- App store readme cleanup
- Updated node-ical to fix the bug No toISOString function in exdate[name]
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
- Updated node-ical which should fix the bug 'Unknown RRULE property 'RRULE''
- A separate test tool is created to test IcalCalendar behavior
- Exception handling for node-ical
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
- @RobHomey: Fixed dutch translation
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
- German translation. Thanks to @dirkg173 -> Issue #62
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 @RobHomey -> Issue #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 @RobHomey -> Issue #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 :D
- 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

Thanks

Translators
- @RobHomey : Dutch
- @dirkg173 : German
- @Lavve : Swedish

If you like the app, buy me a cup of ☕

lavve / calendar-homey Goto Github PK

calendar-homey's Introduction