Test Adapter autodoc
-
@sigi234 ok, guck mal durch ob noch weitere Felder dabei sind. Hatte bisher nur auf nem Testserver laufen, da ist nicht viel installiert, von daher nicht alles ausgefüllt.
Korrigiere ich später -
Hallo zusammen,
ich stelle hier meinen Adapter ioBroker.autodoc vor — das ist mein erster Adapter für ioBroker, daher bin ich für konstruktives Feedback und Tipps besonders dankbar.
Zu Hilfe gezogen wurden Perplexity, Claude und letztendlich Cursor
Was der Adapter heute schon kann
Aus eurer Installation werden HTML- und Markdown-Dokumente (plus JSON) 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 Variablen, …)
User / Familie — Alltagssprache, Räume und Funktionen ohne „Technik-Wände“
Onboarding / Gäste — Willkommen, Orientierung, QR zum Teilen der Seite, bewusst ohne Admin-Jargon
Optional: KI-Zusammenfassung (z. B. Ollama lokal oder andere Anbieter), getrennt nach Bewohner- und Gäste-Profil — nur wenn ihr es einschaltet; es werden dafür keine Live-Daten „von der KI ausgelesen“, sondern nur der vorbereitete Text an den gewählten Dienst geschickt.Aktuell liegt der Fokus auf stabiler Doku-Erzeugung 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.)Links
Repo: https://github.com/crunchip77/ioBroker.autodoc
Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.ioBroker.autodoc 0.9.8 (RC, GitHub main)
Repo: https://github.com/crunchip77/ioBroker.autodocInstallation: z. B. benutzerdefinierte URL
https://github.com/crunchip77/ioBroker.autodoc/tarball/main
→ Instanz neu starten; bei Bedarf im Adapterordner npm install (u. a. Paket qrcode).Changelog (Kurzüberblick, Stand 0.9.8)
Auszug — alles Weitere steht im README im Repo.Neu / geändert (Kern):
- Onboarding: QR-Code als serverseitiges SVG (npm qrcode, ohne CDN); „Link kopieren“ nutzt dieselbe öffentliche URL wie der QR-Code (sinnvoll ioBroker base URL in den Einstellungen setzen).
- Optional: Dateisystem-Export (exportPath) für alle drei HTML-Profile — unter Docker Host-Share mounten und nur den Container-Pfad eintragen.
- Multihost: Übersicht im Admin-HTML bei mehreren Hosts; Warnung im Log, wenn AutoDoc nicht auf dem primären Host läuft.
- KI: KI-Kontexthinweise als mehrzeiliges Feld; Einbindung im Prompt; für Gäste bitte Alltagssprache (IT-Jargon kann den Gast-KI-Text durch den Sicherheits-Fallback ersetzen — siehe Hinweis in der Admin-UI).
- Diagnose (Admin-HTML): RAM/CPU-Angaben, Button „Für Forum kopieren“.
- Änderungsprotokoll: weniger gespeicherte Einträge / weniger aufgeklappte Zeilen in der HTML-Ansicht.
- Admin: KI-Tab-Felder nur bei aktivem Anbieter sichtbar (jsonConfig hidden); diverse Kleinigkeiten (u. a. npm-Version bei Single-Host-Docker, README zu Base-URL & Export).
- Technik: ESLint/Prettier-Bereinigung (CI).
0.9.7
12.04.2026
11.04.2026
10.04.2026
Hallo, habe da
Skripte ohne Beschreibung - Handlungsbedarf (338)
wo/wie soll ich die Beschreibung ändern?
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
Hallo, habe da
Skripte ohne Beschreibung - Handlungsbedarf (338)
wo/wie soll ich die Beschreibung ändern?
@sigi234 das sollte dazu dienen Beschreibungen aus den Scripten auszulesen, welche direkt im Script (common.desc) hinterlegt sind, weiterführend dann zu verarbeiten, was macht das Script.
edit
selbst gemerkt, das dies der falsche Ansatz war, muss ich mir was anderes überlegen -
Hallo zusammen,
ich stelle hier meinen Adapter ioBroker.autodoc vor — das ist mein erster Adapter für ioBroker, daher bin ich für konstruktives Feedback und Tipps besonders dankbar.
Zu Hilfe gezogen wurden Perplexity, Claude und letztendlich Cursor
Was der Adapter heute schon kann
Aus eurer Installation werden HTML- und Markdown-Dokumente (plus JSON) 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 Variablen, …)
User / Familie — Alltagssprache, Räume und Funktionen ohne „Technik-Wände“
Onboarding / Gäste — Willkommen, Orientierung, QR zum Teilen der Seite, bewusst ohne Admin-Jargon
Optional: KI-Zusammenfassung (z. B. Ollama lokal oder andere Anbieter), getrennt nach Bewohner- und Gäste-Profil — nur wenn ihr es einschaltet; es werden dafür keine Live-Daten „von der KI ausgelesen“, sondern nur der vorbereitete Text an den gewählten Dienst geschickt.Aktuell liegt der Fokus auf stabiler Doku-Erzeugung 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.)Links
Repo: https://github.com/crunchip77/ioBroker.autodoc
Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.ioBroker.autodoc 0.9.8 (RC, GitHub main)
Repo: https://github.com/crunchip77/ioBroker.autodocInstallation: z. B. benutzerdefinierte URL
https://github.com/crunchip77/ioBroker.autodoc/tarball/main
→ Instanz neu starten; bei Bedarf im Adapterordner npm install (u. a. Paket qrcode).Changelog (Kurzüberblick, Stand 0.9.8)
Auszug — alles Weitere steht im README im Repo.Neu / geändert (Kern):
- Onboarding: QR-Code als serverseitiges SVG (npm qrcode, ohne CDN); „Link kopieren“ nutzt dieselbe öffentliche URL wie der QR-Code (sinnvoll ioBroker base URL in den Einstellungen setzen).
- Optional: Dateisystem-Export (exportPath) für alle drei HTML-Profile — unter Docker Host-Share mounten und nur den Container-Pfad eintragen.
- Multihost: Übersicht im Admin-HTML bei mehreren Hosts; Warnung im Log, wenn AutoDoc nicht auf dem primären Host läuft.
- KI: KI-Kontexthinweise als mehrzeiliges Feld; Einbindung im Prompt; für Gäste bitte Alltagssprache (IT-Jargon kann den Gast-KI-Text durch den Sicherheits-Fallback ersetzen — siehe Hinweis in der Admin-UI).
- Diagnose (Admin-HTML): RAM/CPU-Angaben, Button „Für Forum kopieren“.
- Änderungsprotokoll: weniger gespeicherte Einträge / weniger aufgeklappte Zeilen in der HTML-Ansicht.
- Admin: KI-Tab-Felder nur bei aktivem Anbieter sichtbar (jsonConfig hidden); diverse Kleinigkeiten (u. a. npm-Version bei Single-Host-Docker, README zu Base-URL & Export).
- Technik: ESLint/Prettier-Bereinigung (CI).
0.9.7
12.04.2026
11.04.2026
10.04.2026
Hallo, irgendwie fehlt mir in der Systemübersicht die NPM Version?
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
-
super gemacht👍
Hatte auch gerade mit Doku angefangen, mit etwas anderem Ansatz und manuell generiert. Mehr darauf ausgerichtet die Zusammenhänge verständlich zu machen. Die Kombi aus beidem wäre perfekt🤔
Proxmox auf iNuc, lxc für IoB, InfluxDB2, Grafana, u.a. *** Homematic & Homematic IP, Shellies, Zigbee etc
-
-
super gemacht👍
Hatte auch gerade mit Doku angefangen, mit etwas anderem Ansatz und manuell generiert. Mehr darauf ausgerichtet die Zusammenhänge verständlich zu machen. Die Kombi aus beidem wäre perfekt🤔 -
-
super gemacht👍
Hatte auch gerade mit Doku angefangen, mit etwas anderem Ansatz und manuell generiert. Mehr darauf ausgerichtet die Zusammenhänge verständlich zu machen. Die Kombi aus beidem wäre perfekt🤔 -
Hallo zusammen,
ich stelle hier meinen Adapter ioBroker.autodoc vor — das ist mein erster Adapter für ioBroker, daher bin ich für konstruktives Feedback und Tipps besonders dankbar.
Zu Hilfe gezogen wurden Perplexity, Claude und letztendlich Cursor
Was der Adapter heute schon kann
Aus eurer Installation werden HTML- und Markdown-Dokumente (plus JSON) 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 Variablen, …)
User / Familie — Alltagssprache, Räume und Funktionen ohne „Technik-Wände“
Onboarding / Gäste — Willkommen, Orientierung, QR zum Teilen der Seite, bewusst ohne Admin-Jargon
Optional: KI-Zusammenfassung (z. B. Ollama lokal oder andere Anbieter), getrennt nach Bewohner- und Gäste-Profil — nur wenn ihr es einschaltet; es werden dafür keine Live-Daten „von der KI ausgelesen“, sondern nur der vorbereitete Text an den gewählten Dienst geschickt.Aktuell liegt der Fokus auf stabiler Doku-Erzeugung 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.)Links
Repo: https://github.com/crunchip77/ioBroker.autodoc
Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.ioBroker.autodoc 0.9.8 (RC, GitHub main)
Repo: https://github.com/crunchip77/ioBroker.autodocInstallation: z. B. benutzerdefinierte URL
https://github.com/crunchip77/ioBroker.autodoc/tarball/main
→ Instanz neu starten; bei Bedarf im Adapterordner npm install (u. a. Paket qrcode).Changelog (Kurzüberblick, Stand 0.9.8)
Auszug — alles Weitere steht im README im Repo.Neu / geändert (Kern):
- Onboarding: QR-Code als serverseitiges SVG (npm qrcode, ohne CDN); „Link kopieren“ nutzt dieselbe öffentliche URL wie der QR-Code (sinnvoll ioBroker base URL in den Einstellungen setzen).
- Optional: Dateisystem-Export (exportPath) für alle drei HTML-Profile — unter Docker Host-Share mounten und nur den Container-Pfad eintragen.
- Multihost: Übersicht im Admin-HTML bei mehreren Hosts; Warnung im Log, wenn AutoDoc nicht auf dem primären Host läuft.
- KI: KI-Kontexthinweise als mehrzeiliges Feld; Einbindung im Prompt; für Gäste bitte Alltagssprache (IT-Jargon kann den Gast-KI-Text durch den Sicherheits-Fallback ersetzen — siehe Hinweis in der Admin-UI).
- Diagnose (Admin-HTML): RAM/CPU-Angaben, Button „Für Forum kopieren“.
- Änderungsprotokoll: weniger gespeicherte Einträge / weniger aufgeklappte Zeilen in der HTML-Ansicht.
- Admin: KI-Tab-Felder nur bei aktivem Anbieter sichtbar (jsonConfig hidden); diverse Kleinigkeiten (u. a. npm-Version bei Single-Host-Docker, README zu Base-URL & Export).
- Technik: ESLint/Prettier-Bereinigung (CI).
0.9.7
12.04.2026
11.04.2026
10.04.2026
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
H Homoran verschob dieses Thema von Tester am
-
H Homoran verschob dieses Thema von ...nicht in offiziellem Repo am
-
H Homoran verschob dieses Thema von Tester am
-
-
Hallo zusammen,
ich stelle hier meinen Adapter ioBroker.autodoc vor — das ist mein erster Adapter für ioBroker, daher bin ich für konstruktives Feedback und Tipps besonders dankbar.
Zu Hilfe gezogen wurden Perplexity, Claude und letztendlich Cursor
Was der Adapter heute schon kann
Aus eurer Installation werden HTML- und Markdown-Dokumente (plus JSON) 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 Variablen, …)
User / Familie — Alltagssprache, Räume und Funktionen ohne „Technik-Wände“
Onboarding / Gäste — Willkommen, Orientierung, QR zum Teilen der Seite, bewusst ohne Admin-Jargon
Optional: KI-Zusammenfassung (z. B. Ollama lokal oder andere Anbieter), getrennt nach Bewohner- und Gäste-Profil — nur wenn ihr es einschaltet; es werden dafür keine Live-Daten „von der KI ausgelesen“, sondern nur der vorbereitete Text an den gewählten Dienst geschickt.Aktuell liegt der Fokus auf stabiler Doku-Erzeugung 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.)Links
Repo: https://github.com/crunchip77/ioBroker.autodoc
Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.ioBroker.autodoc 0.9.8 (RC, GitHub main)
Repo: https://github.com/crunchip77/ioBroker.autodocInstallation: z. B. benutzerdefinierte URL
https://github.com/crunchip77/ioBroker.autodoc/tarball/main
→ Instanz neu starten; bei Bedarf im Adapterordner npm install (u. a. Paket qrcode).Changelog (Kurzüberblick, Stand 0.9.8)
Auszug — alles Weitere steht im README im Repo.Neu / geändert (Kern):
- Onboarding: QR-Code als serverseitiges SVG (npm qrcode, ohne CDN); „Link kopieren“ nutzt dieselbe öffentliche URL wie der QR-Code (sinnvoll ioBroker base URL in den Einstellungen setzen).
- Optional: Dateisystem-Export (exportPath) für alle drei HTML-Profile — unter Docker Host-Share mounten und nur den Container-Pfad eintragen.
- Multihost: Übersicht im Admin-HTML bei mehreren Hosts; Warnung im Log, wenn AutoDoc nicht auf dem primären Host läuft.
- KI: KI-Kontexthinweise als mehrzeiliges Feld; Einbindung im Prompt; für Gäste bitte Alltagssprache (IT-Jargon kann den Gast-KI-Text durch den Sicherheits-Fallback ersetzen — siehe Hinweis in der Admin-UI).
- Diagnose (Admin-HTML): RAM/CPU-Angaben, Button „Für Forum kopieren“.
- Änderungsprotokoll: weniger gespeicherte Einträge / weniger aufgeklappte Zeilen in der HTML-Ansicht.
- Admin: KI-Tab-Felder nur bei aktivem Anbieter sichtbar (jsonConfig hidden); diverse Kleinigkeiten (u. a. npm-Version bei Single-Host-Docker, README zu Base-URL & Export).
- Technik: ESLint/Prettier-Bereinigung (CI).
0.9.7
12.04.2026
11.04.2026
10.04.2026
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.Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
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.Nach dem Speichern der Konfiguration: „Generate now“ oder Automatik abwarten. Die HTML-Dateien liegen unter …/files/autodoc.
wiso da ??
alles Adapter spezfifische landet im iobroker-data verzeichniss
anosnten solltest du die Felder ausblenden wenn nicht benötigt
zigbee hab ich, zwave auch, nuc's genauso und HA auch
-
-
alles Adapter spezfifische landet im iobroker-data verzeichniss
Und??
Da ist doch dann files die nächste Ebenekein Support per PN! - Fragen im Forum stellen -
Benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Das Forum freut sich über eine Spende. Benutzt dazu den Spendenbutton oben rechts. Danke!
der Installationsfixer: curl -fsL https://iobroker.net/fix.sh | bash - -
-
@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?
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?
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
@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
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 AnmeldenSupport us
328
Online32.8k
Benutzer82.7k
Themen1.3m
Beiträge