NEWS
Test Adapter autodoc
-
Hallo zusammen,
ich stelle hier meinen Adapter ioBroker.autodoc vor — das ist mein erster Adapter für ioBroker; über konstruktives Feedback und Tipps freue ich mich sehr.
Bei der Entwicklung habe ich u. a. Perplexity, Claude und zuletzt Cursor genutzt.
Was der Adapter heute schon kann
Aus eurer Installation werden HTML-, Markdown- und JSON-Dokumente erzeugt — per Knopf oder automatisch (Start, Intervall, Änderungen an Adaptern). In einem Lauf entstehen drei Lesarten:- Admin — technischer Überblick (Adapter, Hosts, Skripte, Wartung, Aliase, eigene Datenpunkte, …)
- User / Familie — Alltagssprache, Räume und Funktionen ohne „Technik-Wände“
- Onboarding / Gäste — Willkommen, Orientierung, QR zum Teilen der Seite, ohne Admin-Jargon
Optional: KI (z. B. Ollama lokal oder andere Anbieter), getrennt nach Bewohner- und Gäste-Profil — nur wenn ihr es einschaltet. Es werden keine Live-Daten von der Installation „von der KI ausgelesen“; es geht nur der vorbereitete Dokutext an den gewählten Dienst.
Aktuell liegt der Fokus auf stabiler Dokuerzeugung und guter Lesbarkeit der drei Profile.
Installation zum Ausprobieren
Im Admin: Adapter → von URL installieren, z. B.:
https://github.com/crunchip77/ioBroker.autodoc/tarball/main
(Hinweis zum Cache bei gleicher Versionsnummer steht im README — kurz lesen, spart Frust beim Update.)
→ Instanz neu starten; bei Bedarf im Adapterordnernpm install(u. a. Paket qrcode, optional für erweiterte Toolchains siehe README).
Ein stabiler Liste-Install wie bei npm-Adaptern folgt später mit npm und Eintrag in ioBroker.repositories — bis dahin ist der Weg über Git/Tarball normal.Links
- Repo: https://github.com/crunchip77/ioBroker.autodoc
- Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
- Kurzanleitungen im Repo: User-Guide EN · Szenario DE
Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.
ioBroker.autodoc — Update (
main, v0.9.34, Stand 2026-05-08)Neu seit dem letzten Foren-Post (0.9.32 → jetzt)
0.9.33
- Optional PDF-Export (drei Dateien: Admin / User / Onboarding), wenn
puppeteerim Adapterordner installiert ist. Ohne das: unverändert nur HTML & Co. Zusätzlich Datenpunkt, um nur PDF zu erzeugen.
0.9.34 documentation.exportHashesberücksichtigt nach einem gelingenden PDF-Lauf auch die PDF-Dateien.- Mermaid: Wenn Diagramme schon eingebettet sind, wird kein jsDelivr-Skript mehr nachgeladen.
- Admin: kurzer PDF-Hinweis im Tab HTML-Export; kleine Verbesserung Quick-Start (Skripte stabiler sortiert).
Doku - Kurzanleitung unter
docs/user-guide/mit Screenshots aller Konfig-Tabs (DE/EN) + Tipps zu Lesbarkeit/Datenschutz bei eigenen Bildern.
ioBroker.autodoc — Update (
main, v0.9.32, Stand 2026-05-08)
Forum (Kurzüberblick, Stand, 0.9.29–0.9.31)
Forum (Kurzüberblick, Stand 0.9.26–0.9.28)
Forum (Kurzüberblick, Stand 0.9.25)
Hallo,
cool wäre es noch wenn es eine Kurzübersicht geben würde wo die wichtigsten Daten des Systems ersichtlich sind.
Vor allem für einen helfenden User um nicht immer nachfragen zu müssen wie das System ist. -
Konfiguration & Bedienung (Instanz)
Die Einstellungen sind in Tabs gegliedert:-
Basic / Grundeinstellungen — Projekt-/Dokusprache, Profil (steuert v. a. den Fokus des Markdown-Exports; alle drei HTML-Seiten Admin / User / Onboarding werden immer erzeugt). Automatik: beim Start, bei Adapter-Änderungen (mit kurzer Verzögerung), optional Intervall in Stunden. Live-Werte (Temperatur, Tür/Fenster, Alarm) nur für Onboarding, wenn du es aktivierst. Zum sofortigen Start: „Generate documentation now“; darunter siehst du, wann zuletzt erzeugt wurde.

-
My documentation — Projektname, Beschreibung, Kontakt, allgemeine Notizen; Tabellen für Hinweise pro Adapter und pro Raum; Listen, welche Räume/Adapter du in User- bzw. Onboarding-HTML ausblendest.

-
Advanced — nur aktivierte Instanzen dokumentieren, Markdown kürzer (ohne volle Instanzliste), Obergrenzen für Instanzen und für die Anzahl archivierter Dateisätze, optional Basis-URL für die Direktlinks in den States (sinnvoll bei Docker/fester Adresse).

-
Notifications — nach einer Erzeugung z. B. Telegram/Pushover/E-Mail informieren (Instanz + optional Empfänger + Textvorlage).

-
AI documentation — optional: Anbieter (z. B. Ollama lokal), Modell, API-Key (falls nötig), Ollama-URL, Timeout und Temperaturen getrennt für Bewohner- und Gästetext. Ohne Anbieter bleibt die KI-Box aus bzw. neutral.

Benutzung im Alltag
Nach dem Speichern der Konfiguration: „Generate now“ oder Automatik abwarten. Die HTML-Dateien liegen unter …/files/autodoc.<Instanz>/ (z. B. autodoc-admin.html, autodoc-user.html, autodoc-onboarding.html). Im Objektbaum findest du u. a. States mit Direktlinks zu den letzten HTML-Seiten (info.htmlUrlAdmin usw.), wenn die Basis-URL passt. -
-
-
-
@arteck ok, wenn das so falsch ist mit der Ablage, ändert ich das ab.
Bei den Feldern dachte ich mir, füge ich Beschreibungen hinzu, damit es verständlicher ist. -
Hallo,
cool wäre es noch wenn es eine Kurzübersicht geben würde wo die wichtigsten Daten des Systems ersichtlich sind.
Vor allem für einen helfenden User um nicht immer nachfragen zu müssen wie das System ist.@sigi234 geb mir mal ein Beispiel was du genau meinst?
-
@sigi234 geb mir mal ein Beispiel was du genau meinst?

RAM und CPU zum 1. Bild dazu
Aber hier:
Phase 5 — Erweiterungen (Nice-to-Have)
PDF-Export
Backup-Adapter Integration
Custom Templates
QR-Code für Onboarding (qrcodejs CDN + Fallback)hast du ja Custom Templates geplant, damit könnte man ja dann eine eigene zusammen stellen?
-
@sigi234 geb mir mal ein Beispiel was du genau meinst?

RAM und CPU zum 1. Bild dazu
Aber hier:
Phase 5 — Erweiterungen (Nice-to-Have)
PDF-Export
Backup-Adapter Integration
Custom Templates
QR-Code für Onboarding (qrcodejs CDN + Fallback)hast du ja Custom Templates geplant, damit könnte man ja dann eine eigene zusammen stellen?
RAM und CPU zum 1. Bild dazu
Achso, du meinst eine komplette gesamt Übersicht
hast du ja Custom Templates geplant
Ja, das war zu Anfangszeiten mal als Gedankengang festgehalten
EDIT:
als Beispiel
Ebene 1 — Inhalts-Auswahl (leicht) Der Nutzer wählt welche Kapitel in der generierten Doku erscheinen: Checkboxen in der Admin-UI: "Räume", "Skripte", "Hosts", "Diagnose", ... Reihenfolge der Kapitel anpassbar Eigentlich schon teilweise durch die drei Profile abgedeckt — aber flexibler Ebene 2 — Layout/Styling anpassen (mittel) Eigene CSS-Klassen oder Farb-Themes Logo / Header-Bild einbinden Schriftart, Farbschema (Hell/Dunkel-Präferenz manuell setzen) Für Nutzer die die Doku z. B. an Hausverwaltung oder Familie weitergeben und etwas "Eigenes" haben wollen Ebene 3 — Eigene Sektionen mit Freitext (mittel) Nutzer kann eigene Kapitel definieren: Titel + Markdown-Freitext Z. B. „Notfallkontakte", „WLAN-Passwörter", „Routermodell", „Handwerker-Kontakte" Dinge die ioBroker nicht kennt aber in die Haus-Doku gehören Das überschneidet sich mit manualContext — aber strukturierter und freier Ebene 4 — Eigene Daten-Abfragen (schwer) Nutzer definiert welche States/Objekte zusätzlich abgefragt werden Eigene Tabellen aus beliebigen State-Pfaden Ähnlich wie Vis-Widgets aber für Doku — sehr viel Komplexität Ebene 5 — Komplettes Template-Replacement (sehr schwer) Nutzer liefert eigene Handlebars/Mustache/Jinja-Vorlage Volle Kontrolle über HTML-Ausgabe Extrem mächtig, aber kaum jemand würde das nutzen — und Wartungsaufwand enorm -
-
zur Zeit exisitieren die nur in der DB. wo diese nicht reingehören. das was du generiest ist eine Statische HTML Seite..
und bläht unnötig die DB auf, würde ich behaupten ..bis dato hatten wir sowas noch nicht..
du willst ja aus dem Admin heraus die Seiten aufrufen.. verstehe ich .. ist ja auch nicht falsch.. es muss dir aber im Klaren sein (oder auch nicht) dass das nicht im Filesystem landet sondern in der jsonl oder redis direkt.
läuft iobroker nicht nutzen mir die Seiten nix weil ich kein zugriff drauf habe..
ich nehm das Thema mal mit für heutiges Meeting
-
zur Zeit exisitieren die nur in der DB. wo diese nicht reingehören. das was du generiest ist eine Statische HTML Seite..
und bläht unnötig die DB auf, würde ich behaupten ..bis dato hatten wir sowas noch nicht..
du willst ja aus dem Admin heraus die Seiten aufrufen.. verstehe ich .. ist ja auch nicht falsch.. es muss dir aber im Klaren sein (oder auch nicht) dass das nicht im Filesystem landet sondern in der jsonl oder redis direkt.
läuft iobroker nicht nutzen mir die Seiten nix weil ich kein zugriff drauf habe..
ich nehm das Thema mal mit für heutiges Meeting
@arteck ich verstehe das schon, zumindest halbwegs. Jedoch hatte ich, wie in der Plan.md ersichtlich, es in weiterer Planung, noch im Backup mit aufzunehmen.
Ich habe Hilfe der AI zu Rate gezogen, die mir da auch sagt, das es nicht anders geht.
Aber schön das du das mal besprichst, bin gespannt.
Edit:
@arteck hab mir gerade die Aufzeichnung von gestern abend angesehen, also unterm Strich... Keine einfache Sache😅
Aber ich überlege mir was -
@arteck ich verstehe das schon, zumindest halbwegs. Jedoch hatte ich, wie in der Plan.md ersichtlich, es in weiterer Planung, noch im Backup mit aufzunehmen.
Ich habe Hilfe der AI zu Rate gezogen, die mir da auch sagt, das es nicht anders geht.
Aber schön das du das mal besprichst, bin gespannt.
Edit:
@arteck hab mir gerade die Aufzeichnung von gestern abend angesehen, also unterm Strich... Keine einfache Sache😅
Aber ich überlege mir was -
v0.9.8 im ersten Beitrag
-
Stand 0.9.10 ab sofort verfügbar
-
Guten Morgen.
@crunchip Gute idee, praktische Ergänzung.
Hatte noch nicht ganz so viel Zeit mir das im Detail anzuschauen, aber was mir aufgefallen ist

Diese Änderungen wurde durch ein Adapter Update ausgelöst.
Wie wäre es denn im Changelog auch die Information zum Update selbst zu haben? Zum Beispiel:
Adapter "example" aktualisiert: 0.9 -> 1.0 -
0.9.11 ab sofort verfügbar
-
-
@sigi234 schau ich mir an, gibt heut abend sowieso eine neue Version
-
ab sofort 0.9.16 verfügbar, siehe oben
-
noch die 0.9.17 hinterhergeschoben
Hey! Du scheinst an dieser Unterhaltung interessiert zu sein, hast aber noch kein Konto.
Hast du es satt, bei jedem Besuch durch die gleichen Beiträge zu scrollen? Wenn du dich für ein Konto anmeldest, kommst du immer genau dorthin zurück, wo du zuvor warst, und kannst dich über neue Antworten benachrichtigen lassen (entweder per E-Mail oder Push-Benachrichtigung). Du kannst auch Lesezeichen speichern und Beiträge positiv bewerten, um anderen Community-Mitgliedern deine Wertschätzung zu zeigen.
Mit deinem Input könnte dieser Beitrag noch besser werden 💗
Registrieren Anmelden

