Neuer ioBroker-Blog online: Monatsrückblick März/April 2026

[UlliJ]

@fuzzy1955 sagte:

Die Darstellung könnte im VIS-2 in einem Basic-IFrame erfolgen

habe das so gestartet, getriggert durch den autodoc Adapter von @crunchip
Nur sollen mehr Zusammenhänge und Übersicht rein, Funktionsbeschreibung für Skripte, Querverweise Vis <-> Skript <-> DP's... wenn möglich automatisch aktualisiert.
Ist kein Adapter sondern 3 Skripte (generiert mit KI). Ergebnis ist nach Einhaltung von Konventionen in der Vis und in Skripten aktuell so
Doku Übersichtsseite als iframe in Vis

Einzelne Vis Seiten werden über einen Kommentar auf der Seite in der Doku als Referenz angelegt

Skripte werden so dokumentiert

im Header des Skriptes

// ============================================================
// ScriptMappingGenerator.js
// Analysiert alle ioBroker-Skripte aus dem Spiegel-Verzeichnis
// Metadaten (enabled, type) per getObject nachladen
//
// Voraussetzung: JS-Adapter → "Spiegeln von Skripten" aktiviert
//
// ============================================================
// ScriptMappingGenerator
// @desc      Analysiert alle ioBroker-Skripte aus dem Spiegel-Verzeichnis
// @desc-long Liest alle .js/.ts Dateien und extrahiert Metadaten und IPO-Tags.
// @desc-long Ergebnis wird als HTML und JSON in userdata gespeichert.
// @ipo-input  Spiegel-Verzeichnis | getObject() Metadaten
// @ipo-input-sub /home/iobroker/skript
// @ipo-proc   collectFiles() | extractIPO() | findConflicts() | generateHTML()
// @ipo-proc-sub Skripte auslesen | Diagramm erzeugen | Schreibkonflikte | HTML Doku ausgeben
// @ipo-output ScriptMapping.html | ScriptMapping.json | lastUpdate
// @calc       Konflikt = setState() auf gleichem DP durch 2+ aktive Skripte
// ============================================================

ergibt in der Doku so etwas

Teile sind wären ok, andere passen noch nicht. Über die Jahre kommen da ganz schön viele "Leichen" zusammen 🤔

[David G.]

Ich habe die letzten Wochen angefangen es in einer selbst (mit Claude) geschriebenen Notes App zu dokumentieren.
https://forum.iobroker.net/topic/83978/lokal-notizen-verwalten

EDIT:
Das mit einem Adapter oder Script zu machen finde ich auch nicht Sinnig.
Denke die Doku muss auch verfügbar sein, wenn der ioBroker warum auch immer nicht läuft und man was nachschlagen muss.
Oder wenn man gesundheitlich wirklich nicht kann es so einfach wie möglich ist für den Ehepartner etc drauf zuzugreifen.

[crunchip]

@David-G. Ist es doch auch wenn iobroker nicht läuft, speicherbar extern, im weiteren Verlauf folgt noch pdf

[David G.]

@crunchip

Das ist dann natürlich was anderes

[fuzzy1955]

@OliverIO sagte:

Eine fertige Applikation hat den Vorteil, dass sie schon viele Features enthält

Das kenne ich. Ich vergaß zu erwähnen, dass ich nichts im Internet habe möchte.

[fuzzy1955]

@UlliJ sagte:

Ist kein Adapter sondern 3 Skripte (generiert mit KI).

Klar, das ginge auch mit Skript. Also wäre das doch was für mich zum Entwickeln ;-)

[fuzzy1955]

@UlliJ sagte:

autodoc Adapter

Muss ich mir dringend ansehen. Den kenne ich noch nicht.

[fuzzy1955]

@David-G. sagte:

Denke die Doku muss auch verfügbar sein, wenn der ioBroker warum auch immer nicht läuft

Wenn der IOBroker steht, stünde mein ganzes Haus. Wenn da bei mir nicht ein 1:1 Testgerät einspringen würde.

[OliverIO]

@fuzzy1955

Was meinst du mit "das kenne ich"?
Beide sind keine Applikationen im Internet (evtl schon wenn jemand das anbietet).
Ich habe die rausgesucht, weil man sie beide auf node basieren und lokal betreibbar sind.
Aber schau dir mal autodoc an.
Wenn es das nicht ist, dann müssen wir noch ein wenig die groben Anforderungen feststellen, bevor man da weiter ins Detail geht

[fuzzy1955]

@OliverIO sagte:

schau dir mal autodoc an

Ja, das mache ich.

Beide sind keine Applikationen im Internet

Pardon, das wusste ich nicht.

[fuzzy1955]

@UlliJ sagte:

autodoc Adapter?

Wird dieser weiter entwickelt? [EDIT] Pardon, das macht ja @crunchip.

[crunchip]

@fuzzy1955 ja, aktuell noch nicht auf npm und auch nicht im repo bis ich mit dem Adapter im großen und ganzen durch bin. Danach beantrage ich die Aufnahme.
Bin auch gerne für Tipps und Ideen dankbar.

[fuzzy1955]

@crunchip sagte:

bis ich mit dem Adapter im großen und ganzen durch bin

Hi,

das Erstellen meiner Doku ist mir damit leider zu kompliziert. Ich greife jetzt auf Hausmitteln im VIS-2 zurück. Funktioniert recht gut, nur der HTML-Editor für das Widget "basic Zeichenfolge" wäre als WYSIWYG-Editor super ;-)

1. Menüleiste links aufgepeppt mit Widget "inventwo design" (Anzeige auf allen Seiten):
   

2. Ein Klick auf das ? öffnet die Doku-Seite.
   

3. Wahlweise setzte ich ein waagrechtes Widget "inventwo design", wenn der Platz nicht ausreicht.
   

Damit ist die gesamte Systemdokumentation schön in der Web-Applikation integriert und mit VIS-2 muss man sowieso umgehen können.

[EDIT] Und ja - ich bevorzuge Einfaches vor dem Komplizierten ;-)

Gruß, Fuzzy

[bloop]

Hi,

Wenn ich mich auch noch an dem Thema beteiligen darf:

Ich habe vor einiger Zeit begonnen eine Dokumentation über das gesamte Haus, Netzwerkinfrastruktur, ioBroker usw. manuell in einem eigenen LXC mit WikiJS zu erstellen. Mit der Zeit wird dies jedoch ziemlich mühsam... Nicht nur das erstellen sondern auch das weiterführen wurde zur monatlichen Herausforderung.

In der Zwischenzeit hab ich mir jedoch Hilfe mit Openclaw geholt. Dieser läuft in einer eingen VM die ausschließlich für Openclaw gedacht ist. Als Modell wird ein Ollama Qwen 2.5 Modell verwendet.
Nun wird einmal wöchentlich überprüft ob sich etwas verändert hat, anschließend erhalte ich eine Benachrichtigung und bei Bedarf werden Änderungen angewiesen.
Die Einrichtung gestaltete sich als Mühsam aber jetzt wird meine Doku regelmäßig überprüft und aktualisiert. Findet er zb. einen neuen Shelly in ioBroker werde ich gefragt wo und wie dieser verbaut ist und fügt diesen dann zur Doku hinzu.

Ja, ich musste dafür Openclaw auch Passwörter und API Keys geben was ein erhöhtes Sicherheitsrisiko mit sich bringt! Darum hat die VM auch keinen Internetzugang. Bedeutete weiterführend, ich benötigte auch ein Lokales Benachrichtigungssystem. Dieses habe ich mit einem Matrix Benachrichtigungsserver realisiert...

Nach viel Vorarbeit wird meine Doku jetzt regelmäßig aktualisiert. Selbstverständlich muss ich weiterhin händisch nacharbeiten, Bilder einfügen usw. aber den Großteil erledigt OC.

Und zu guter Letzt, aus dem Wiki hab ich nun ein RAG indexiert, so kann OC die Doku ebenfalls nutzen und unterstützt mich bei Problemen.

[fuzzy1955]

@bloop sagte:

jetzt wird meine Doku regelmäßig überprüft und aktualisiert

Wenn ich im System etwas ändere, ziehe ich die Doku (mit wenig Aufwand) sofort nach. Da übe ich mich etwas im VIS-2 ;-). Die gesamte Erstellung der Doku habe ich wahrscheinlich an einem Tag erledigt, weil ich sowieso schon viel anderswo verstreut dokumentiert habe.

Findet er zb. einen neuen Shelly in ioBroker werde ich gefragt wo und wie dieser verbaut ist und fügt diesen dann zur Doku hinzu

Machst du das nicht selbst? Ich zeichne sowas bereits vorher in den Schaltplan. Damit habe ich auch die Doku rasch aktuell.

LXC mit WikiJS, Openclaw, Matrix Benachrichtigungsserver, Ollama Qwen 2.5 Modell, ....

Wie gesagt - ich bevorzuge Einfaches vor dem Komplizierten. Aber jede(r) soll es so machen, wie es für ihn passt.

[reutli]

@maloross sagte:

Über das Werkzeug, mit dem ich das erstellen werde, muss ich mir noch Gedanken machen.

Einfach wäre da Confluence (free Version) - das nehme ich. Da kann ich von überall aus einsehen und dokumentieren... aber alles Geschmackssache.

Das ist wie mit den Aliasen: Von Anfang an anlgen oder nachher mühevoll - so ist's mit der Doku auch.
Ich habe mir angwöhnt alles was ich neu einbaue, gleich mit Alias zu versehen und zu dokumentieren (isonst weiss ich es nach zwei Tagen ohnehin nicht mehr ;o)