pimatic-calendar2

---

Pimatic-calendar2 is a plugin for getting ical calendar events integrated in Pimatic.
This plugin is based on pimatic-calendar from @sweetpi and updated to get it compatible again in Pimatic.

The changes are:

• Ical is replaced by ical-expander for better support of recurring events.
• Request is not maintained anymore and is replaced by needle for http(s) ical calendar requests.
• The calendars settings in the plugin is fixed.
• A variable that holds the title or description when an event is started.

The following predicates are supported:

if calendar event with [title|description] [contains|equals] "some text" [starts|ends|takes place] then ...

The minimum node requirement for this plugin is node v8!

Any requests or bugs on issues

@bertreb Many thanks for this very useful plugin. I have waited a long time for such a plugin for Pimatic. Finally I can control my garden watering by calendar entries.

I have still have a question about the plugin:

I run my own Sabre/baikal-based CalDAV server. This server can export an ics-calendar but user credentials are mandatory. It cannot provide an private URL for calendars like Google it does. Do you plan to add user credentials to your plugin configuration?

Best regards

So you need username/password credentials to get an ics-calendar?

Yes, because i need access to the CalDAV server first and the server exports ics.

Let me explain:

A CalDAV URL looks like this: https://some.domain/html/cal.php/calendars/username/default/
The ics export is done with this URL https://some.domain/html/cal.php/calendars/username/default?export
This way : https://username:pass@some.domain/html/cal.php/calendars/username/default?export is not working.

additional information: https://sabre.io/baikal/

The current version supports the second type of url.
You use as url, the complete line ‘https://some.domain/html/cal.php/calendars/username/default?export’ and replace ‘some.domain’ and ‘username’ with your values.
I can’t test if the result is handled the right way, if you would test it and post the result

I tested it.
My first step was test the URL in Chrome. When I call my DAV URL https://mydomain/html/cal.php/calendars/myuser/default?export, Chrome asked for the credentials (User/Pass) and then the download of an ics-file started. When I call in Chrome my DAV URL in this way: https://myuser:mypass@mydomain/html/cal.php/calendars/myname/default?export the download of the ics-file started immediately.

When i use the URL https://myuser:mypass@mydomain/html/cal.php/calendars/myname/default?export as the calendar subscription URL in pimatic-calendar2 i got this error message:

Fatal TypeError: Cannot read property 'message' of null
    at /home/pi/pimatic-app/node_modules/pimatic-calendar2/calendar.coffee:59:24
    at tryCatcher (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:517:31)
    at Promise._settlePromise (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:574:18)
    at Promise._settlePromise0 (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:619:10)
    at Promise._settlePromises (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:695:18)
    at _drainQueueStep (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/async.js:138:12)
    at _drainQueue (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/async.js:131:9)
    at Async._drainQueues (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/async.js:147:5)
    at Immediate.Async.drainQueues [as _onImmediate] (/home/pi/pimatic-app/node_modules/pimatic/node_modules/bluebird/js/release/async.js:17:14)
    at runCallback (timers.js:705:18)
    at tryOnImmediate (timers.js:676:5)
    at processImmediate (timers.js:658:5)

node is v10.20.1
npm is 6.14.4

I published version 0.9.4 with extra debug info on errors when getting the ical file

@bertreb Can you check the v0.9.4 please? This version logs absolutely nothing after installation. Not even an entry of the plugin itself appears in the Pimatic mobile frontend “Messages” section (for selecting messages only for the plugin).

I did some checking and small adjustments. version 0.9.6 should give info

for testing i also created a username / password option for a calendar. That could be the solution for your type of calender server. Version 0.9.7

Great, it works. Thank you for this version.

Thanks for building this plugin, I have been testing with it and seems to work well for timed events. Though I cannot get it to work with all-day events, is that intentional?
What I was trying to do is trigger an action at for instance 7.00 when an all-day event is active (in my case garbage collection day) but that does not trigger anything.

Calendar events are triggered on start or stop of a calendar item.
I will investigate you question and come back to you

Yes indeed, I went through your code and figured so much. I couldn’t find a good description of the data format, but could it be the case that an all day event has an empty start and end time and just contains a date? Or maybe a dedicated all-day event field which needs to be checked by your plugin in that case?
Thanks for the quick reply by the way!

Edit: found this, might help; https://github.com/icalendar/icalendar/issues/71

Hi, i released version 0.9.9 with small fix and extra debug info. You can switch now switch on the debug in the plugin.
For the all-day event with trigger at 7:00, the rule should look like:
when its 7:00 and calendar event with title contains “the all day event” takes place

Thanks, once again, for you quick response! Has anyone already mentioned you’re a hero? Well; you’re awesome, hattip to you!
I have installed the update and everything seems to be working fine for me!

A small tip to save precious time for anyone in the future testing/playing with this: an already ongoing all-day event will not trigger an action unless the event is (re)moved and moved back or added again.

Thanks. A remark/question on your tip.
On startup an ongoing all-day event should set the ‘takes place’ value that can be used in a rule.
It’s not a trigger but a condition. The start or stopping of events are triggers.
What happens in your case or what is the type of all-day event that you need to reschedule the event?

In the debug log (when debug is switched on) you can see the ‘nextEvents’ (events that will start or stop in the next 10 minutes) and the current ‘ongoing events’.

I moved the event just for testing purposes to figure out when it generates a trigger (I am an engineer and love to test/break stuff )
Most of my all-day events are imported from the city garbage collection scheme and tells me when to put out which type of garbage. Yesterday was such a day and as I updated pimatic and installed your plugin that caused me to keep an eye on it and hence finding the earlier mentioned issue.

I switched on the debug logging for you; yesterday I copied the all day event to today as well, so one is taking place at this moment. When I add a new rule, or change an existing one; for example its 15.27 and calendar event with title contains "GFT" takes place nothing happens when the all-day event is already active.
If I then change the rule to its 15.33 and calendar event with title contains "GFT" takes place and then remove the event, wait a minute to let the plugin refresh (set to 60 seconds) and then again add the event it does trigger an action. I can spot that the events are refreshed as the list is empty around 15.30:50, at ~15.31 I added the event again and a bit later it shows up (15:31:57). Exactly at 15.33 the second rule was executed.
Just playing around for you, at this point it works fine for my intended purposes. Tomorrow will be another test event: they will be collecting recyclable plastic waste

15:29:43.444 [pimatic-calendar2] debug: nextEvents: [
15:29:43.444 [pimatic-calendar2] debug:>  {
15:29:43.444 [pimatic-calendar2] debug:>    "start": {
15:29:43.444 [pimatic-calendar2] debug:>      "year": 2020,
15:29:43.444 [pimatic-calendar2] debug:>      "month": 5,
15:29:43.444 [pimatic-calendar2] debug:>      "day": 3,
15:29:43.444 [pimatic-calendar2] debug:>      "hour": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "minute": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "second": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "isDate": true,
15:29:43.444 [pimatic-calendar2] debug:>      "timezone": "floating"
15:29:43.444 [pimatic-calendar2] debug:>    },
15:29:43.444 [pimatic-calendar2] debug:>    "end": {
15:29:43.444 [pimatic-calendar2] debug:>      "year": 2020,
15:29:43.444 [pimatic-calendar2] debug:>      "month": 5,
15:29:43.444 [pimatic-calendar2] debug:>      "day": 4,
15:29:43.444 [pimatic-calendar2] debug:>      "hour": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "minute": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "second": 0,
15:29:43.444 [pimatic-calendar2] debug:>      "isDate": true,
15:29:43.444 [pimatic-calendar2] debug:>      "timezone": "floating"
15:29:43.444 [pimatic-calendar2] debug:>    },
15:29:43.444 [pimatic-calendar2] debug:>    "uid": "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com",
15:29:43.444 [pimatic-calendar2] debug:>    "summary": "GFT",
15:29:43.444 [pimatic-calendar2] debug:>    "description": "Ophaaldag: dinsdag"
15:29:43.444 [pimatic-calendar2] debug:>  }
15:29:43.444 [pimatic-calendar2] debug:>]
15:29:43.460 [pimatic-calendar2] debug: Ongoing events: {
15:29:43.460 [pimatic-calendar2] debug:>  "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com": {
15:29:43.460 [pimatic-calendar2] debug:>    "start": {
15:29:43.460 [pimatic-calendar2] debug:>      "year": 2020,
15:29:43.460 [pimatic-calendar2] debug:>      "month": 5,
15:29:43.460 [pimatic-calendar2] debug:>      "day": 3,
15:29:43.460 [pimatic-calendar2] debug:>      "hour": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "minute": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "second": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "isDate": true,
15:29:43.460 [pimatic-calendar2] debug:>      "timezone": "floating"
15:29:43.460 [pimatic-calendar2] debug:>    },
15:29:43.460 [pimatic-calendar2] debug:>    "end": {
15:29:43.460 [pimatic-calendar2] debug:>      "year": 2020,
15:29:43.460 [pimatic-calendar2] debug:>      "month": 5,
15:29:43.460 [pimatic-calendar2] debug:>      "day": 4,
15:29:43.460 [pimatic-calendar2] debug:>      "hour": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "minute": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "second": 0,
15:29:43.460 [pimatic-calendar2] debug:>      "isDate": true,
15:29:43.460 [pimatic-calendar2] debug:>      "timezone": "floating"
15:29:43.460 [pimatic-calendar2] debug:>    },
15:29:43.460 [pimatic-calendar2] debug:>    "uid": "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com",
15:29:43.460 [pimatic-calendar2] debug:>    "summary": "GFT",
15:29:43.460 [pimatic-calendar2] debug:>    "description": "Ophaaldag: dinsdag"
15:29:43.460 [pimatic-calendar2] debug:>  }
15:29:43.460 [pimatic-calendar2] debug:>}
15:29:43.491 [pimatic-homeduino] debug: data: "ACK 21.1 1.0"
15:30:13.553 [pimatic-homeduino] debug: data: "ACK 21.1 1.0"
15:30:25.979 [pimatic] info: rule chantal-presence-longtime: set $longtimepresence_chantal to true
15:30:43.687 [pimatic-homeduino] debug: data: "ACK 21.0 1.0"
15:30:50.267 [pimatic-calendar2] debug: nextEvents: []
15:30:50.297 [pimatic-calendar2] debug: Ongoing events: {}
15:31:13.783 [pimatic-homeduino] debug: data: "ACK 21.0 1.0"
15:31:43.853 [pimatic-homeduino] debug: data: "ACK 21.0 1.0"
15:31:57.430 [pimatic-calendar2] debug: nextEvents: [
15:31:57.430 [pimatic-calendar2] debug:>  {
15:31:57.430 [pimatic-calendar2] debug:>    "start": {
15:31:57.430 [pimatic-calendar2] debug:>      "year": 2020,
15:31:57.430 [pimatic-calendar2] debug:>      "month": 5,
15:31:57.430 [pimatic-calendar2] debug:>      "day": 3,
15:31:57.430 [pimatic-calendar2] debug:>      "hour": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "minute": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "second": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "isDate": true,
15:31:57.430 [pimatic-calendar2] debug:>      "timezone": "floating"
15:31:57.430 [pimatic-calendar2] debug:>    },
15:31:57.430 [pimatic-calendar2] debug:>    "end": {
15:31:57.430 [pimatic-calendar2] debug:>      "year": 2020,
15:31:57.430 [pimatic-calendar2] debug:>      "month": 5,
15:31:57.430 [pimatic-calendar2] debug:>      "day": 4,
15:31:57.430 [pimatic-calendar2] debug:>      "hour": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "minute": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "second": 0,
15:31:57.430 [pimatic-calendar2] debug:>      "isDate": true,
15:31:57.430 [pimatic-calendar2] debug:>      "timezone": "floating"
15:31:57.430 [pimatic-calendar2] debug:>    },
15:31:57.430 [pimatic-calendar2] debug:>    "uid": "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com",
15:31:57.430 [pimatic-calendar2] debug:>    "summary": "GFT",
15:31:57.430 [pimatic-calendar2] debug:>    "description": "Ophaaldag: dinsdag"
15:31:57.430 [pimatic-calendar2] debug:>  }
15:31:57.430 [pimatic-calendar2] debug:>]
15:31:57.478 [pimatic-calendar2] debug: Ongoing events: {
15:31:57.478 [pimatic-calendar2] debug:>  "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com": {
15:31:57.478 [pimatic-calendar2] debug:>    "start": {
15:31:57.478 [pimatic-calendar2] debug:>      "year": 2020,
15:31:57.478 [pimatic-calendar2] debug:>      "month": 5,
15:31:57.478 [pimatic-calendar2] debug:>      "day": 3,
15:31:57.478 [pimatic-calendar2] debug:>      "hour": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "minute": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "second": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "isDate": true,
15:31:57.478 [pimatic-calendar2] debug:>      "timezone": "floating"
15:31:57.478 [pimatic-calendar2] debug:>    },
15:31:57.478 [pimatic-calendar2] debug:>    "end": {
15:31:57.478 [pimatic-calendar2] debug:>      "year": 2020,
15:31:57.478 [pimatic-calendar2] debug:>      "month": 5,
15:31:57.478 [pimatic-calendar2] debug:>      "day": 4,
15:31:57.478 [pimatic-calendar2] debug:>      "hour": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "minute": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "second": 0,
15:31:57.478 [pimatic-calendar2] debug:>      "isDate": true,
15:31:57.478 [pimatic-calendar2] debug:>      "timezone": "floating"
15:31:57.478 [pimatic-calendar2] debug:>    },
15:31:57.478 [pimatic-calendar2] debug:>    "uid": "6thj6e1k60qm2b9nc4pm8b9kc5gj8b9p68pjgb9l71im2cb2cormaphl6g@google.com",
15:31:57.478 [pimatic-calendar2] debug:>    "summary": "GFT",
15:31:57.478 [pimatic-calendar2] debug:>    "description": "Ophaaldag: dinsdag"
15:31:57.478 [pimatic-calendar2] debug:>  }
15:31:57.478 [pimatic-calendar2] debug:>}