Neues YouTube-Video: Visualisierung im Devices-Adapter

[Jey Cee]

Aktuelle Test Version	v0.0.2
Veröffentlichungsdatum	2024-10-24
Github Link	https://github.com/Jey-Cee/ioBroker.public-holidays

Kann von npm installiert werden.

Im Zuge unserer Responsive Design Initiative, habe ich mir den Feiertage Adapter angeschaut. Das Ziel war zu Prüfen ob und mit welchem Aufwand die Konfiguration nach JSONConfig Migriert werden kann.

Neben der Tatsache das eine Migration Überraschend Komplex wäre, sind mir auch andere Punkte aufgefallen.
Darunter:

• Es lässt sich nicht nach Ländern Auswählen
• Erweiterung mit weiteren Feiertagen und für andere Länder nur Umständlich möglich
• es werden die selben Objekte zwei mal angelegt nur um mehrere Sprachen an zu bieten
• Adapter hat einen deutschen Namen Bietet aber international Feiertage an, darunter für Italien

Eine neu Entwicklung war gar nicht der Plan, aber es hat mich gepackt.

---

Der Ansatz vom neuen Adapter ist vor allem Internationalisierung und leichtere Erweiterung um neue Feiertage.

Momentan ist das ein Alpha Test, weswegen auch nur Deutsche Feiertage drin sind.
In erster Linie geht es jetzt darum zu Testen ob die Feiertage richtig berechnet werden und nach und nach um neue Feiertage zu erweitern.

---

Wenn sich jemand daran beteiligen möchte Feiertage in den Adapter auf zu nehmen, freue ich mich sehr.
Am einfachsten ist es wenn dafür das Datenmodel genommen wird und entsprechend befüllt wird. Bitte auch dazu schreiben in Welchem Land. Falls etwas unklar ist Fragen oder leer lassen und einen Link zur Erklärung des Feiertages.

Das Datenmodel für die Feiertage sieht folgendermaßen aus:

{
    "id": "mothersDay", 
    "name": "Muttertag", // Der Name des Feiertags in der Sprache des jeweiligen landes
    "type": "calendar", // religion, political oder calendar
    "date": null, // Datum des Feiertags, wenn es sich um ein festes Datum handelt; Format: MM-DD
    "states": "Alle", // Bundesländer (oder z.B. die Kantone in der Schweiz) in den der Tag gilt 
    "ruleType": "weekdayInMonth", // fixed, easter oder weekdayInMonth; Die Regel nach der ein Feiertag berechnet wird falls nötig. 
    "offsetDay": null, // Anzahl Tage vor oder nach einem bestimmten Tag
    "referenceHoliday": null, // Feiertag von dem aus die Berechnung anhand des offsetDays durchgeführt wird
    "weekdayInMonth": { // Zusätzliche informationen für den ruleType weekdayInMonth
      "weekday": 0, // Wochentag 0-6 (Sonntag - Samstag)
      "week": 2, // Die x-te Woche im Monat
      "month": 5 // Der Monat in dem der Feiertag ist
    },
    "enabled": true
  }

[Negalein]

@jey-cee sagte in Test adapter public-holidays v0.0.x:

Wenn sich jemand daran beteiligen möchte Feiertage in den Adapter auf zu nehmen, freue ich mich sehr.

Österreich

{
    "id": "Staatsfeiertag", 
    "name": "Staatsfeiertag", // Der Name des Feiertags in der Sprache des jeweiligen landes
    "type": "political", // religion, political oder calendar
    "date": 05-01, // Datum des Feiertags, wenn es sich um ein festes Datum handelt; Format: MM-DD
    "states": "Alle", // Bundesländer (oder z.B. die Kantone in der Schweiz) in den der Tag gilt 
    "ruleType": "fixed", // fixed, easter oder weekdayInMonth; Die Regel nach der ein Feiertag berechnet wird falls nötig. 
    "offsetDay": null, // Anzahl Tage vor oder nach einem bestimmten Tag
    "referenceHoliday": null, // Feiertag von dem aus die Berechnung anhand des offsetDays durchgeführt wird
    "weekdayInMonth": { // Zusätzliche informationen für den ruleType weekdayInMonth
      "weekday": null, // Wochentag 0-6 (Sonntag - Samstag)
      "week": null, // Die x-te Woche im Monat
      "month": 5 // Der Monat in dem der Feiertag ist
    },
    "enabled": true
  }


{
    "id": "Maria-Himmelfahrt", 
    "name": "Maria-Himmelfahrt", // Der Name des Feiertags in der Sprache des jeweiligen landes
    "type": "religion", // religion, political oder calendar
    "date": 08-15, // Datum des Feiertags, wenn es sich um ein festes Datum handelt; Format: MM-DD
    "states": "Alle", // Bundesländer (oder z.B. die Kantone in der Schweiz) in den der Tag gilt 
    "ruleType": "fixed", // fixed, easter oder weekdayInMonth; Die Regel nach der ein Feiertag berechnet wird falls nötig. 
    "offsetDay": null, // Anzahl Tage vor oder nach einem bestimmten Tag
    "referenceHoliday": null, // Feiertag von dem aus die Berechnung anhand des offsetDays durchgeführt wird
    "weekdayInMonth": { // Zusätzliche informationen für den ruleType weekdayInMonth
      "weekday": null, // Wochentag 0-6 (Sonntag - Samstag)
      "week": null, // Die x-te Woche im Monat
      "month": 8 // Der Monat in dem der Feiertag ist
    },
    "enabled": true
  }


{
    "id": "Nationalfeiertag", 
    "name": "Nationalfeiertag", // Der Name des Feiertags in der Sprache des jeweiligen landes
    "type": "political", // religion, political oder calendar
    "date": 10-26, // Datum des Feiertags, wenn es sich um ein festes Datum handelt; Format: MM-DD
    "states": "Alle", // Bundesländer (oder z.B. die Kantone in der Schweiz) in den der Tag gilt 
    "ruleType": "fixed", // fixed, easter oder weekdayInMonth; Die Regel nach der ein Feiertag berechnet wird falls nötig. 
    "offsetDay": null, // Anzahl Tage vor oder nach einem bestimmten Tag
    "referenceHoliday": null, // Feiertag von dem aus die Berechnung anhand des offsetDays durchgeführt wird
    "weekdayInMonth": { // Zusätzliche informationen für den ruleType weekdayInMonth
      "weekday": null, // Wochentag 0-6 (Sonntag - Samstag)
      "week": null, // Die x-te Woche im Monat
      "month": 10 // Der Monat in dem der Feiertag ist
    },
    "enabled": true
  }

die religiösen Feiertage müssten mit Deutschland ziemlich gleich sein. Das check ich heute noch.

[sigi234]

@jey-cee

Hallo, sollten da nicht Daten kommen?

admin.0
2024-10-24 19:23:09.134	warn	public-holidays has an invalid jsonConfig: [{"instancePath":"/items/_hitSave","schemaPath":"#/properties/items/patternProperties/%5E.%2B/allOf/37/then/additionalProperties","keyword":"additionalProperties","params":{"additionalProperty":"onChange"},"message":"must NOT have additional properties"},{"instancePath":"","schemaPath":"#/if","keyword":"if","params":{"failingKeyword":"else"},"message":"must match \"else\" schema"}]

admin.0
2024-10-24 19:23:06.331	info	==> Connected system.user.admin from ::1

admin.0
2024-10-24 19:23:06.094	info	<== Disconnect system.user.admin from ::1 admin

host.SmartHome
2024-10-24 19:23:00.707	info	instance system.adapter.public-holidays.0 terminated with code 0 (NO_ERROR)

Edit:

Betriebssystem:Windows
RAM:15.9 GB
Node.js:v20.18.0
NPM:10.8.2
Admin: 7.2.6
JS-Controller: 7.0.1

[Jey Cee]

@sigi234 Ja, ich hab eine neue Version Veröffentlicht mit der der Fehler beim ersten mal Auswählen behoben ist.

@Negalein Danke, hab die 3 aufgenommen. Wenn du mir sagst welche Identisch sind mit den Deutschen kann ich die einfach Übernehmen.

[sigi234]

@jey-cee

Möchte ich 2 Länder muss ich 2 Instanzen anlegen?

[Jey Cee]

@sigi234 Ja das erfordert eine zweite Instanz

[sigi234]

@jey-cee sagte in Test adapter public-holidays v0.0.x:

@sigi234 Ja das erfordert eine zweite Instanz

Ok, cool wäre noch eine Übersicht als Json-Table für das aktuelle Jahr

[mcm1957]

@Jey-Cee

Du hast Anfang des Jahres mitgeteilt dass ALLE deine Adapter in Zukunft kostenpflichtig sein werden (https://forum.iobroker.net/topic/72081/zahltag) und zeitnahe den existierenden NET-TOOLS Adapter kostenpflichtig gemacht.

Ich möchte hier keine Diskussion lostreten ob nun Adapter etwas kosten dürfen oder nicht - dazu wurde schon alles geschrieben und der Status Quo ist m.E. in Ordnung.
Bitte nur um eine eindeutige Klarstellung deinerseits bezüglich deines neuen Adapters public-holidays.:

Wird der Adapter public-holidays auch in Zukunft kostenfrei sein - oder kannst / willst du nicht ausschließen dass du hier ebenfalls später eine gebührenpflicht einführst ?

Gemäß deinem Posten von Jänner, würde er ja kostenpflichtzig sein / werden.

User haben m.E. das Recht diese Information rechtzeitig zu erfahren.

[Jey Cee]

@mcm1957 ich habe nicht den Plan ihn Kostenpflichtig zu machen.Wenn es nach mir geht soll er den Feiertags Adapter Vollständig ablösen und in die Community Überführt werden.

Was dann schlußendlich mit dem Adapter passiert hängt davon ab, was beim nächsten Meeting bzgl. Des Feiertags Adapter raus kommt.

[mcm1957]

@jey-cee
Danke für die Klarstellung. Und DANKE für deinen Einsatz und dass du dich des Adapters annimmst.

[mcm1957]

@homoran
Der Adapter hat es nicht in die Repositories geschafft. Bitte in ...nicht in offiziellem Rep verschieben.

@jey-cee
Gibts eigentlich einen Grund warum du den Adapter nie für die Repos eingereicht hast?

[Jey Cee]

@mcm1957 Hauptgrund war das angedacht war den Adapter auf eine library um zu bauen die bereits sehr viele Feiertage kennt und das Du Weltweit.

Das Hindernis ist und war das der Adapter dann als daemon laufen müsste, nur damit die Konfiguration möglich ist.
Der Aktuelle Workaround ist auch nicht so toll, da wird das Instanz Objekt geschrieben jedes mal wenn man in einem Dropdown was auswählt.

[mcm1957]

Hintergrund warum ich auf dieses Topic wieder gestoßen bin ist dass @krobi den Feiertagsadapter "neu schreiben" möchte. Zumindest hab ich das so verstanden. Welche konkreten Problem gefixed werden sollen weiß ich nicht. Macht aber nur bedingt Sinn da zwei gleichartige Adapter zu entwickeln / warten.

Was @krobi genau anders machen will - unter Beibehaltung der jetzigen Funktionalität und Schnittstelle für user müsste er selbst beschreiben. Ein reines ReWrite durch eine AI ohne Vorteile für Nutzer sehe ich nur bedingt als sinnvoll. Ev. könnt ihr euch ja mal austauschen ob es da Synergiene ergeben kann.

[krobi]

Da hier gerade mein Vorhaben angesprochen wurde, vielleicht kurz zur Einordnung, damit kein falscher Eindruck entsteht.

Mein Ziel war nie, einfach den bestehenden Feiertagsadapter durch einen AI-Rewrite zu ersetzen oder parallel Konkurrenz aufzubauen. Ich wollte eher ausprobieren, wie ein moderner Ansatz aussehen könnte und ob sich zusätzliche Funktionen ergeben, die für Nutzer praktisch sein könnten.

Repository:

ioBroker.feiertage (mein Repository)

Der Ansatz bringt aktuell u.a.:

• 206 Länder komplett offline über date-holidays
• automatische Brückentage (Do→Fr, Di→Mo)
• Filter nach Feiertagstypen (public, bank, school, optional, observance)
• einzelne Feiertage per ID ausschließbar
• Schedule-Mode (Berechnung einmal täglich um Mitternacht)
• zusätzliche States wie today, yesterday, tomorrow, dayAfterTomorrow und next
• mehrsprachiges Admin-UI + lokalisierte State-Namen
• TypeScript + jsonConfig + Tests/CI

Ich bin kein klassischer Entwickler und versuche einfach etwas beizutragen und zu helfen. Der Code wird sicher noch Verbesserungen und Reviews brauchen.

Durch die Diskussion hier bin ich jetzt auch erst auf frühere Ansätze bzw. Ideen wie public-holidays gestoßen – das hatte ich beim Start gar nicht auf dem Schirm. Ziel war also nie, bestehende Arbeit zu ignorieren oder bewusst etwas Doppeltes aufzubauen.

Falls sich daraus Synergien ergeben oder Teile davon sinnvoll in bestehende Projekte einfließen können, wäre mir das sogar lieber als langfristig mehrere parallele Lösungen zu pflegen.

[mcm1957]

Ist dieser Adapter mit dem bestehenden Adapter vollständig kompatibel?
Sprich - die Einstellungen der Benutzer werden bei einem Update übernommen?
Existierende States bleiben unverändert erhalten? (Neue zusätzliche States wären ok)?

So wie es für mich aussieht, sollte das ein NEUER Adapter werden und nicht eine neue Version von Feiertage. Da das Ganze auch internationaler zu sein scheint passt der deutsche Name auch nicht mehr.

[krobi]

@mcm1957, hier wird die Date-holidays als Datengrundlage verwendet. Die Änderungen betreffen hauptsächlich die sprachliche Anpassung. Der aktuelle Adapter ist hauptsächlich auf Deutsch ausgelegt, während meine Version international ist und daher die Datenpunkte auf Englisch mit Sprachvarianten in den Beschreibungen vorliegen. Ich werde mir die Einstellungen noch einmal genauer ansehen. Im aktuellen Adapter kann man Feiertage per An- oder Abhaken auswählen oder abwählen. In meiner Version müsste man die IDs angeben, was sicherlich noch verbesserungswürdig ist. Grundsätzlich ist dies eine Variante mit dem neuen Datensatz, anstatt die Feiertage selbst pflegen zu müssen.

[Jey Cee]

@krobi sagte:

Der aktuelle Adapter ist hauptsächlich auf Deutsch ausgelegt, während meine Version international ist und daher die Datenpunkte auf Englisch mit Sprachvarianten in den Beschreibungen vorliegen.

Das war auch der Grund warum ich den Adapter neu geschrieben habe und einen anderen Namen verwendet habe.

Läuft deine Version als Daemon oder Scheduled?

[mcm1957]

Ja seh ich auch so @krobi
Da der Adapter ja auch technisch abgekoppelt ist (kein fork) benenn ihn sinnvoll um (englisher Name) und stell ihn als neuen Adapter zur Verfügung. Bitte stimm dich mit @jey-cee ab ob es ev. Funktionalitäten gibt die sinnvoll in deinen Adapter aufgenommen werden sollten.

P.S. Die state IDs dürfen keinesfalls sprachspezifisch sein - die müssen fix english benannt werden. Namen mehrsprachlich ist ok, das geht aber trivial indem als name ein i18n Objekt übergeben wird. Dass Namensfeld sollte auch NICHT bei einem Adapterneustart überschieben werden, da es der User ändern darf. (Flag bei extend Object setzen)

[Jey Cee]

@krobi ich hab jetzt mal kurz in den Code bei dir geschaut, du hast ihn als Daemon umgesetzt. Edit: Keine Ahnung wo ich da geschaut habe, aber jetzt hab ich gerade am Laptop nochmal genauer geschaut und sehe das es Scheduled ist.

Warum ich das nicht wollte: Jeder Prozess der Dauerhaft läuft verbraucht RAM und das ist bei Nodejs mit 60+MB nicht gerade wenig. Im Falle des Originalen und meines Adapters braucht es das aber gar nicht weil die Eigentliche Logik nur einmal am Tag für 1 Minute ausgeführt werden muss.
Den Rest der Zeit läuft das dann nur um zu warten das der Benutzer etwas an den Einstellungen ändert.

Mein letzter Ansatz war es statt dem Workaround die Gesamte Logik die für die Konfiguration nötig ist, in die JSONConfig zu Quetschen. Das hab ich jedoch nicht zum laufen bekommen.

Alles andere scheint dem wie ich es umgesetzt habe sehr ähnlich zu sein. Da dein Adapter sonst im direkten vergleich deutlich weiter ist, würde ich vorschlagen du benennst ihn in public holidays um und ich archiviere meinen. Du bekommst rechte für npm auf das Paket, dann kannst du ihn unter dem Namen auch Veröffentlichen.

[mcm1957]

Wenn der Adapter nur was zu tun hat, wenn der User was ändert dann sollte das auch bei sheduled Adaptern gehen. Wenn das flag common.allowInit (https://github.com/ioBroker/ioBroker.js-controller/blob/a9d7fcfdd288a7f7e07bc1c175a89c12a11cfdfe/schemas/io-package.json#L1248) gesetzt ist, startet der Adapter einmal nach dem Abspeichern der Config zusätzlich zur normalen Konfiguration via schedule. Wäre das nicht das was du suchst?

P.S: Ich finde es toll dass / wie ihr miteinander kommuniziert und beide am Ziel "Adapater für User" kooperativ arbeitet. DDAANNKKEE