Simple Python script that reads Google Calendar and updates OH items with event information

FrankR · January 9, 2018, 2:14pm

Hi James,
I looked through all my openhab.log files since the end of August and did not find anything like that.
I am running openhab 2.2.0. Maybe older openhab versions throw this warning?

What do you get when looking into your items using REST API?

My items are looking like this:

{
 {
  "link": "http://openhabianpi:8080/rest/items/gCal_Event1_StartTime",
  "state": "2018-01-09T15:30:00.000+0100",
  "stateDescription": {
    "pattern": "%1$td.%1$tm.%1$tY %1$tH:%1$tM",
    "readOnly": false,
    "options": []
  },
  "type": "DateTime",
  "name": "gCal_Event1_StartTime",
  "label": "Event1 Start",
  "category": "calendar",
  "tags": [],
  "groupNames": [
    "gCalEvent"
  ]
}

I’m not sure if your timezome information “ZT00:00:00+00:00” ist a valid one …

FrankR · January 9, 2018, 3:21pm

Your google calendar settings should look like this:

grafik

Of course you may select another zone, but I guess there has to be selected at least the primary time zone

Mike_Bagdanoff · January 9, 2018, 8:41pm

The problem is that this is not formatted correctly, there are two ‘T’ segments. The script will do this if there is an exception thrown by ‘datetime.datetime.strptime’ because it will fallback to just jamming the timezone on the end of the events start time. I guess the strptime function can throw but still format the date.

changing the code to this solves the problem:

        if 'start' in SingleEvent:
            EventStartTime = SingleEvent['start'].get('dateTime', SingleEvent['start'].get('date'))

        try:
            datetime.datetime.strptime(EventStartTime, '%Y-%m-%dT%H:%M:%S' + S.CalendarTimeZone)
        except ValueError:
            if "T" not in EventStartTime:
                EventStartTime = EventStartTime + 'T00:00:00' + S.CalendarTimeZone
            else:
                EventStartTime = EventStartTime

        if 'end' in SingleEvent:
            EventEndTime = SingleEvent['end'].get('dateTime', SingleEvent['end'].get('date'))

        try:
            datetime.datetime.strptime(EventEndTime, '%Y-%m-%dT%H:%M:%S' + S.CalendarTimeZone)
        except ValueError:
            if "T" not in EventEndTime:
                EventEndTime = EventEndTime + 'T00:00:00' + S.CalendarTimeZone
            else:
                EventEndTime = EventEndTime

james_h1979 · January 9, 2018, 10:08pm

Thanks so much for the help, modifying the script has solved the issue.

ADR · January 22, 2018, 9:46pm

Hi guys,

any ideas ? I´ve read the whole documentation of this Google API but i didn´t find anything for the error: Connection aborted.
System is running on a RPI 3 (with Internet Access )

pi@raspberrypi:/etc/openhab2/scripts/CalSyncHAB-master $ python CalSyncHAB.py 
Traceback (most recent call last):
  File "CalSyncHAB.py", line 126, in <module>
    Main()
  File "CalSyncHAB.py", line 58, in Main
    OpenHABResponse = requests.post(CalendarEventSummaryItemURL, data = '', allow_redirects = True)
  File "/usr/lib/python2.7/dist-packages/requests/api.py", line 94, in post
    return request('post', url, data=data, json=json, **kwargs)
  File "/usr/lib/python2.7/dist-packages/requests/api.py", line 49, in request
    return session.request(method=method, url=url, **kwargs)
  File "/usr/lib/python2.7/dist-packages/requests/sessions.py", line 457, in request
    resp = self.send(prep, **send_kwargs)
  File "/usr/lib/python2.7/dist-packages/requests/sessions.py", line 569, in send
    r = adapter.send(request, **kwargs)
  File "/usr/lib/python2.7/dist-packages/requests/adapters.py", line 407, in send
    raise ConnectionError(err, request=request)
requests.exceptions.ConnectionError: ('Connection aborted.', error(111, 'Connection refused'))

Best regards

binderth · January 23, 2018, 6:26am

This one looks like your credentials don’t match. Are you sure:

Username/password are correct
Your secret JSON is readable and the correct one
Your calendar URL is correct and
You configured the calender to be readable

binderth · February 19, 2018, 7:25pm

I took @FrankR’s example and tried to put my own items in the rule… I’m stuck right at the end…

I’ve got basically the same Setup with items and stuff (a bit of a renaming)…

My rule:

rule "Binder Abfallkalender"
when
	Time cron "0 0 1 * * ?" or
	System started
then
	gCalTrash.members.forEach[ gc | 
		val eventStart = gCalendar.members.filter[ act | act.name == gc.name+"_StartTime"].head 
		val eventEnd =   gCalendar.members.filter[ act | act.name == gc.name+"_EndTime"].head 
		val eventDesc =  gCalendar.members.filter[ act | act.name == gc.name+"_Description"].head 
		val eventSum =   gCalendar.members.filter[ act | act.name == gc.name+"_Summary"].head 
		var dtStart = new DateTime((eventStart as DateTimeType).zonedDateTime.toInstant.toEpochMilli)
		var dtEnd = new DateTime((eventEnd as DateTimeType).zonedDateTime.toInstant.toEpochMilli)
...
end

I can’t get the right casts for dtStart and dtEnd

2018-02-19 20:21:35.713 [ERROR] [ntime.internal.engine.RuleEngineImpl] - Error during the execution of startup rule 'Binder Abfallkalender': Could not cast Calendar_GoogleTrash_Event1_StartTime (Type=DateTimeItem, State=2018-02-19T00:00:00.000+0100, Label=TrashKal Ev1 Start, Category=calendar, Groups=[gCalendar]) to org.eclipse.smarthome.core.library.types.DateTimeType; line 41, column 31, length 26

this is the exact line with var dtStart...

What’s wrong here?

I tried:

var eventStart
var DateTime eventStart
var eventStart ...           as DateTimeItem
var DateTime eventStart ...  as DateTimeItem

// also the deprecated
		var dtStart = new DateTime((eventStart as DateTimeType).calendar.timeInMillis)

always the same error-message…

FrankR · February 19, 2018, 9:05pm

Hi Thomas,
I still run

var DateTime dtStart = new DateTime((eventStart.state as DateTimeType).calendar.timeInMillis)

There has to be a „.state“ following „eventStart“

binderth · February 19, 2018, 9:55pm

Thanks. Trees and forest and so. It works now!

ei_Gelb_Geek · February 20, 2018, 4:09pm

Here the fixed Version (without Deprecated Function) and != null changed to !== null

rule "ExecCal"
when
	Time cron "0 0/1 * * * ?"
then
	logInfo("ExecCal", "Start")
	gCal.members.forEach[ gc | 
		val eventStart = gCalEvent.members.filter[ act |
			act.name == gc.name+"_StartTime"].head
		val eventEnd = gCalEvent.members.filter[ act |
			act.name == gc.name+"_EndTime"].head
		val eventDesc = gCalEvent.members.filter[ act |
			act.name == gc.name+"_Description"].head
		val eventSum = gCalEvent.members.filter[ act |
			act.name == gc.name+"_Summary"].head
		var DateTime dtStart = new DateTime((eventStart.state as DateTimeType).zonedDateTime.toInstant.toEpochMilli)
		var DateTime dtEnd = new DateTime((eventEnd.state as DateTimeType).zonedDateTime.toInstant.toEpochMilli)
		var Long dStart = now.millis - dtStart.millis
		var Long dEnd = now.millis - dtEnd.millis
		if(dStart >=0 && dStart < 60000) {
			val buffer = eventDesc.state.toString.split(";")
			val calItem = gCalItem.members.filter[ ci | ci.name == eventSum.state.toString].head
			if (calItem !== null) {
				logInfo("ExecCal", gc.name + " starting now with '" + calItem.name + "' -> " + buffer.get(0))
				sendCommand(calItem, buffer.get(0))
			}
			else {
				logInfo("ExecCal", "WARNING: cannot find item named '" + eventSum.state + "'")
			}
		}
		if(dEnd >=0 && dEnd < 60000) {
			val buffer = eventDesc.state.toString.split(";")
			val calItem = gCalItem.members.filter[ ci | ci.name == eventSum.state.toString].head
			if (calItem !== null) {
				sendCommand(calItem, buffer.get(1))
				logInfo("ExecCal", gc.name + " ended now with'" + calItem.name + "' -> " + buffer.get(1))
			}
			else {
				logInfo("ExecCal", "WARNING: cannot find item named '" + eventSum.state + "'")
			}
		}
	]
	logInfo("ExecCal", "End")
end

ei_Gelb_Geek · February 20, 2018, 4:12pm

Try this

var dtStart = new DateTime((eventStart as DateTimeType).zonedDateTime.toInstant.toEpochMilli

skatun · February 20, 2018, 4:17pm

Nice work,
I use IFFTT with the calender, higher WAF factor, but I will definately look into this one aswell!

ei_Gelb_Geek · February 20, 2018, 4:23pm

One error seems to be the Python script.
My Max Value is on 5 events!
if I now create an event at 17:00 for 17:15 and read in Openhab.
If I delete the event before 17:15 and read in Openhab, but only 4 events in the future, then the event will not be removed at 17:15 in Openhab!

I think we need a little Function like

if RetrievedEvents < MaxEvents than Clear all Openhab Item’s

binderth · February 20, 2018, 4:37pm

I you didn’t Change the Script, in line 54 to 70 all events are purged and then they’re created anew… There shouldn’t be the fitfth element still in openHAB?

ei_Gelb_Geek · February 20, 2018, 4:40pm

Yes … but if RetrievedEvents only 4 Item’s then the Fifth Item are not cleared

binderth · February 20, 2018, 4:46pm

Ah - That’s right! I changed the script a bit, I’m running a few tests this week.
remember me to publish my code on the weekend. I took care of purging Event-IDs, which are no more used …

ei_Gelb_Geek · February 20, 2018, 4:46pm

5 Events in Future

RestAPI 5 Event

Now I deleted the 5 Event…

RestAPI for 5 Event

ei_Gelb_Geek · February 20, 2018, 6:20pm

Here is my Fixed Version

PS: My python Skills are not very good … but it works …

binderth · February 21, 2018, 9:05am

I Kind of hijacked the script by @davorf and did mainly the following works:

add MQTT-Support
made it controllable, to either use MQTT or REST to update OH2 items
added reading for additional Event-Attributes: EventId, EventNotificationTime, EventEmailTime
moved from pruging all items and updating them afterwards to purging those items, which are not used anymore

ad 1) + 2)
you can now chose your weapon of choice for updating: MQTT or REST

ad 3)
I like the idea to have an Event to trigger something directly at the StartTime, but I also have Events, which I use for throwing my Kids out of the house! e.g. they have an appointment for ther sports, I let openHAB say via the room loudspeakers: “Get out to < EVENTNAME>”. For that I’d like to have distinct times and I use Google Calender notification for it.

Email-Notification time for notifying way in advance
normal notification time for notifying a few minutes before

So you can have actions and rules on that tiems.

ad 4)
at the end, the script compares the number of items updated with the MaxEntry in the settings and purges left overs in OH2, if there are ones.
That way you won’t have needless “item changes” within openHAB on every script run.

I’m unsure, if I would make an PR for this on davorf’s github… or if I should just fork it - @davorf, what’s your opinion?

davorf · February 21, 2018, 10:12am

Hello!

Feel free to make a PR, but please, get the latest version first, since I’ve just merged a pull request before noticing your post. These changes are really good, but there’s a possibility of conflict, so, it would be much easier if you would apply those changes on the latest source. Thank you for your contribution.

Best regards,
Davor