Skip to content
/ flaav Public

docker container mit python script um Kalenderinformationen per REST-API zur Verfügung zu stellen

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

SonZions/flaav

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits

.gitignore

.gitignore

 
 

Dockerfile

Dockerfile

 
 

README.md

README.md

 
 

app.py

app.py

 
 

requirements.txt

requirements.txt

 
 

Repository files navigation

flaav

Flask- Applikation im Docker-Container um Kalender-Informationen aus CalDav via API zur Verfügung zu stellen. Zwei Use-Cases schwebten mir dabei im Kopf

  1. Wann ist der nächste Termin (Bsp: Abholtermin Müllabfuhr)
  2. Ist heute ein Bestimmter Termin (Bsp: für einen bestimmten Betriebsmodus bei Urlaub)

Der Fantasie sind nun aber keine Grenzen gesetzt.

Ich hab das nur für den iCloud-Kalender getestet. Theoretisch sollten auch andere CalDav-Server funktionieren.

Zur Zeit kann die API nur mit ganztägigen Events umgehen. Andere Termin und Serientermine haben eine andere Struktur in der Angabe der start- und end-dates. Das müsste man mal handeln.

build

docker build -t flaav:latest .

Der Build datuert auf meinem Raspberry relativ ewig. Wäre ein guter Plan das Image bei Bedarf in ein Repo zu laden.

run

Vorbereitung

Anwendungspezifisches Passwort erstellen: https://support.apple.com/de-de/HT204397

Mit .env -File

caldav_url=<<your CalDav Server URL Bsp: https://caldav.icloud.com:443>>
caldav_username=<<your User Name/AppleID>>
caldav_passwd=<<your app specific password>>
look_ahead_days=<<30>>

docker run --env-file .env \
           --name flaav \
           --detach \
           --publish 5000:5000 \ 
          flaav:latest

Oder environment -Parameter

docker run --env-file .env \
           --name flaav \
           --detach \
           --publish 5000:5000 \
           --env caldav_url=<<your CalDav Server URL Bsp: https://caldav.icloud.com:443>>
           --env caldav_username=<<your User Name/AppleID>>
           --env caldav_passwd=<<your application Password>>
           --env look_ahead_days=<<30>>
          flaav:latest

Konfiguration

Parameter Name Beschreibung
caldav_url Url zum CalDav-Server (incl. Port) in meinem Fall https://caldav.icloud.com:443
caldav_username User-Name zur Authentifizierung am CalDav-Server in meinem Fall die Apple Id
caldav_passwd Passwort zum user-name für iCloud ein anwenungdspezifisches Passwort
look_ahead_days Die API fragt bei jedem Call den Kalender ab. Aus Performance-Sicht kann es sinnvoll sein hier nur den notwendigen Zeitraum zu wählen.

API Dokumentation

Verfügbare Kalender

als Root zeit die API alle verfügbaren Kalender an

$ curl http://myserver.com:5000/flaav/api/v0.1

> Reminders ⚠️
> Müllabfuhr ROW
> Kalender
> Packen ⚠️
> Family
> Einkauf
> Wochenmarkt
> Baumarkt

Events

Diese sind nun auch der nächste zu wählende Knotenpunkt. Der Knoten nach Auswahl des Kalenders zeigt alle verfügbaren Events im CalDav-Format. Das ist relativ unübersichtlich. Hilft aber beim Debuggen. Theoretisch könnten verschiedene Objekte in einem Kalender stecken (Events, Tasks ... ). Bisher gibts nur Events:

$ curl http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events

Beipsiel:

$ curl http://myserver.com:5000/flaav/api/v0.1/Family/events

> BEGIN:VCALENDAR
> END:VCALENDAR
> BEGIN:VCALENDAR
> X-EXPANDED:True
> X-MASTER-DTSTART:20160731T180000
> X-MASTER-RRULE:FREQ=MONTHLY\;BYDAY=SU\;BYSETPOS=5
> BEGIN:VEVENT
> DTSTAMP:20220103T123212Z
> UID:0E25C87B-9961-4937-BC63-18492BD9EBCD
> LOCATION:Hainholzweg 52\, 21077 Hamburg
> SEQUENCE:0
> SUMMARY:Punkt 18 Gottesdienst
> LAST-MODIFIED:20160626T200825Z
> CREATED:20160626T200824Z
> TRANSP:OPAQUE
> X-APPLE-TRAVEL-ADVISORY-BEHAVIOR;ACKNOWLEDGED=20211031T163948Z:AUTOMATIC
> DTSTART;TZID=Europe/Berlin:20220130T180000
> DTEND;TZID=Europe/Berlin:20220130T190000
> RECURRENCE-ID:20220130T170000Z
> BEGIN:VALARM
> X-WR-ALARMUID:12DD00B8-470E-4EFF-8751-DF86DD5BD97D
> UID:12DD00B8-470E-4EFF-8751-DF86DD5BD97D
> TRIGGER:-PT15M
> ATTACH;VALUE=URI:Chord
> ACTION:AUDIO
> X-APPLE-DEFAULT-ALARM:TRUE
> ACKNOWLEDGED:20211031T155409Z
> END:VALARM
> BEGIN:VALARM
> X-WR-ALARMUID:89E25769-A9F4-47F3-9123-F304422BFD7B
> UID:89E25769-A9F4-47F3-9123-F304422BFD7B
> DESCRIPTION:Erinnerung
> ACKNOWLEDGED:20211031T155409Z
> TRIGGER:-PT30M
> ACTION:DISPLAY
> END:VALARM
> END:VEVENT
> END:VCALENDAR
> ...
...

Verfügbare Events mit Namen

Der Nächste Knoten, nach dem Events gefiltert werden können, ist der Name. Dieser kann mittels Regex ermittelt werden. Notwendig ist zu wählen ob jedes event, nur das nächste anstehende, oder nur ein heutiges Event mit dem gegebenen Namen zurückgegeben werden soll (any/next/today)

any:

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/any/<event name>"

Beispiel 1:

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/any/Kita%20frei"

> BEGIN:VCALENDAR
> VERSION:2.0
> PRODID:-//PYVOBJECT//NONSGML Version 1//EN
> BEGIN:VEVENT
> UID:58FD33C8-358C-4FEE-8BC2-CDD82960DE32
> DTSTART;VALUE=DATE:20211222
> DTEND;VALUE=DATE:20220103
> CREATED:20210928T072630Z
> DTSTAMP:20210928T072631Z
> LAST-MODIFIED:20210928T072630Z
> SEQUENCE:0
> SUMMARY:Kita frei 
> URL;VALUE=URI:
> END:VEVENT
> END:VCALENDAR

Beispiel 2: Dieses mal mit Regex

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/any/Kita.*"

> BEGIN:VCALENDAR
> VERSION:2.0
> PRODID:-//PYVOBJECT//NONSGML Version 1//EN
> BEGIN:VEVENT
> UID:58FD33C8-358C-4FEE-8BC2-CDD82960DE32
> DTSTART;VALUE=DATE:20211222
> DTEND;VALUE=DATE:20220103
> CREATED:20210928T072630Z
> DTSTAMP:20210928T072631Z
> LAST-MODIFIED:20210928T072630Z
> SEQUENCE:0
> SUMMARY:Kita frei 
> URL;VALUE=URI:
> END:VEVENT
> END:VCALENDAR

next:

auf dem gleichen Knoten aber mit "next" in er Route gibt das Event zurück, dass als nächstes stattfindet

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/next/<event name>"

Beispiel: nächstes Event (Uraub findet aktuell statt deswegen:)

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/next/.*"

> BEGIN:VCALENDAR
> VERSION:2.0
> PRODID:-//PYVOBJECT//NONSGML Version 1//EN
> BEGIN:VEVENT
> UID:B888496E-FC4F-4D88-B4B4-79C8AA0328DB
> DTSTART;VALUE=DATE:20211224
> DTEND;VALUE=DATE:20220103
> CREATED:20211225T211840Z
> DTSTAMP:20211225T211841Z
> LAST-MODIFIED:20211225T211840Z
> SEQUENCE:0
> SUMMARY:Urlaub
> TRANSP:OPAQUE
> URL;VALUE=URI:
> BEGIN:VALARM
> ACTION:DISPLAY
> DESCRIPTION:Erinnerung
> TRIGGER:PT9H
> UID:CBE19EA0-E4CA-43BC-B03E-8DC3CF3F7F4A
> X-APPLE-DEFAULT-ALARM:TRUE
> X-WR-ALARMUID:CBE19EA0-E4CA-43BC-B03E-8DC3CF3F7F4A
> END:VALARM
> END:VEVENT
> END:VCALENDAR

today:

nur weils geht ... gibts den gleichen Knoten auch noch mit today. Dieser zeigt nur events von heute an.

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/today/<event name>"

Beispiel: Events, die heute stattfinden. Egal mit welchem Namen (regex = .*)

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/today/.*"

> BEGIN:VCALENDAR
> VERSION:2.0
> PRODID:-//PYVOBJECT//NONSGML Version 1//EN
> BEGIN:VEVENT
> UID:B888496E-FC4F-4D88-B4B4-79C8AA0328DB
> DTSTART;VALUE=DATE:20211224
> DTEND;VALUE=DATE:20220103
> CREATED:20211225T211840Z
> DTSTAMP:20211225T211841Z
> LAST-MODIFIED:20211225T211840Z
> SEQUENCE:0
> SUMMARY:Urlaub
> TRANSP:OPAQUE
> URL;VALUE=URI:
> BEGIN:VALARM
> ACTION:DISPLAY
> DESCRIPTION:Erinnerung
> TRIGGER:PT9H
> UID:CBE19EA0-E4CA-43BC-B03E-8DC3CF3F7F4A
> X-APPLE-DEFAULT-ALARM:TRUE
> X-WR-ALARMUID:CBE19EA0-E4CA-43BC-B03E-8DC3CF3F7F4A
> END:VALARM
> END:VEVENT
> END:VCALENDAR
> 
> BEGIN:VCALENDAR
> VERSION:2.0
> PRODID:-//PYVOBJECT//NONSGML Version 1//EN
> BEGIN:VEVENT
> UID:58FD33C8-358C-4FEE-8BC2-CDD82960DE32
> DTSTART;VALUE=DATE:20211222
> DTEND;VALUE=DATE:20220103
> CREATED:20210928T072630Z
> DTSTAMP:20210928T072631Z
> LAST-MODIFIED:20210928T072630Z
> SEQUENCE:0
> SUMMARY:Kita frei 
> URL;VALUE=URI:
> END:VEVENT
> END:VCALENDAR

Eventeigenschaften

der Wert jeder Eigenschaft/Component/Subcomponent kann auch einzeln ausgegeben werden. Der Knoten beschreibt sich über die verfügbaren Eigenschaften. Leider haben nicht alle Events immer alle Eigenschaften gesetzt. Am Besten sucht man sich die aus der Anzeige des ganzen Events raus

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/any/<event name>/<component name>"

Beispiel 1: Nächster Starttermin für Papier(-müll)

$ curl "http://myserver.com:5000/flaav/api/v0.1/M%C3%BCllabfuhr%20ROW/events/next/Papier/dtstart"

> 20220111

Beispiel 2: Welche Termine (Namen) stehen heute an?

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/today/.*/summary"

> Urlaub
> Kita frei

Weitere Funktionen

is_today

liefert einen einfach eine 1 bzw. eine 0 je nach dem ob das Event heute stattfinden oder nicht. Diese Funktion ist nur auf dem any-Knoten verfügbar

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/any/<event name>/is_today"

Beispiel: Angenommen es ist heute Urlaub ;)

$ curl "http://myserver.com:5000/flaav/api/v0.1/Family/events/any/Urlaub/is_today"

> 1

weekday

liefert den Wochentag des Startdatum des Events wobei Montag = 0 und Sonntag = 6. Diese Funktion ist nur auf dem next-Knoten verfügbar

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/any/<event name>/weekday"

Beispiel: Wochentag an dem Papier(-Müll) das nächste mal abgeholt wird

$ curl http://myserver.com:5000/flaav/api/v0.1/Müllabfuhr%20ROW/events/next/Papier/weekday

> 1

days_until

liefert die Tage bis zum Eintritt des Events Diese Funktion ist nur auf dem next-Knoten verfügbar

$ curl "http://myserver.com:5000/flaav/api/v0.1/<calendar name>/events/any/<event name>/days_until"

Beispiel: Anzahl Tage bis das nächste Mal Papier(-Müll) abgeholt wird

http://localhost:5000/flaav/api/v0.1/Müllabfuhr%20ROW/events/next/Papier/days_until

> 8

known issues

  • Es können nur Ganztägige Ereignisse betrachtet werden
  • is_today berücksichtigt auch ganztägige Termine, deren enddatum = Heute 00:00. Das ist leider immer so bei ganztägigen Terminen

About

docker container mit python script um Kalenderinformationen per REST-API zur Verfügung zu stellen

Topics

docker raspberry-pi flask rest-api caldav loxone

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages