Test Adapter autodoc
-
-
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.Changelog (Kurzüberblick, Stand 0.9.7)
Auszug — alles Weitere steht im README im Repo.Changelog (Kurzüberblick, Stand 0.9.7)
Auszug — alles Weitere steht im README im Repo.0.9.7
12.04.2026
• Generierung: Kein paralleler Lauf mehr — zweiter Start → Warnung + Abbruch (bei Ollama oft spürbar).
• Log: Fortschritt 1/5–5/5 plus KI-Hinweise pro Aufruf — weniger „hängt das noch?“.
• KI: Automatische Wiederholungen bei typischen Netz-/Serverfehlern (z. B. 500, Timeout) mit Backoff (OpenAI-kompatible APIs).
• HTML Desktop: Breitere Hauptspalte; Mobil unverändert. Renderer aktualisiert — wie gewohnt Neu-Generierung auslösen und Seite hart neu laden.
• Admin-Doku (HTML/Markdown): JavaScript-Skripte nach ioBroker-Ordner gruppiert; beim Ordner „Globale Skripte“ kurzer Hinweis zur Ausführungsreihenfolge und sinnvollen Nutzung (entspricht der Script-Engine, keine extra AutoDoc-Option).
• common.desc am Skriptobjekt: nur noch als optionaler Gruppen-/Zwecktext erklärt — keine irreführende „Handlungsbedarf“-Liste mehr wegen fehlender Beschreibung.
• Admin-UI: Texte zu Export/Datenschutz (inkl. optional common.desc bei KI) und kurzer Hinweis im Tab „Erweitert“.11.04.2026
• Start / Einstellungen: Klarere Log-Meldungen zur Startup-Doku; Hilfetexte präziser (Hintergrundlauf, info.templateVersion, Log-Hinweis).
• Standard: „Dokumentation beim Adapterstart“ ist in den Paket-Defaults für neue Instanzen aktiv (bestehende Instanzen behalten ihre gespeicherte Konfiguration).
• HTML (Admin): Eigene Variablen und Aliase — Filter und Zuklappen zuverlässiger über das Skript am Seitenende; Ordnerverhalten bei leerem Suchfeld stabiler (inkl. BF-Cache/pageshow). Renderer-Version für den Template-Check angehoben.
• KI (lokal / kleine Modelle): sinnvollere Ollama-Standard-Temperaturen bei leerer Temperatur; strengere deutsche System- und Lektor-Prompts (u. a. korrektes ioBroker, keine Tippfehler wie iroBroker / „Adapatoren“, kein erfundenes Personal oder Fantasie-Marken); Qualitätsprüfung nach dem Lektor — bei weiterhin kaputtem Bewohner-Text kurze sachliche Kurzfassung aus echten Statistiken; bei kaputtem Gäste-Text neutraler Gäste-Fallback; typischer Stichpunkt-Müll wird stärker gefiltert.10.04.2026
• KI: Timeout und optionale Temperaturen (Bewohner vs. Gäste) in den Einstellungen; Grounding (Räume + Gerätekategorien) in den Prompts.
• Gäste-KI: bei technischem „Müll“ neutraler Fallback statt Admin-Sprech; im HTML-Kommentar erkennbar: primary vs. fallback-neutral.
• Parser: robuster bei NARRATIVE / RECOMMENDATIONS, Bereinigung von Markdown-Artefakten und leeren Stichpunkten.
• Deutsch: strengere Regeln (z. B. kein „Vorgesetzte“ im Privathaushalt, Rollläden statt falscher „Blinde“); erweiterte Trigger für den Sie-Lektor-Pass.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.Changelog (Kurzüberblick, Stand 0.9.7)
Auszug — alles Weitere steht im README im Repo.Changelog (Kurzüberblick, Stand 0.9.7)
Auszug — alles Weitere steht im README im Repo.0.9.7
12.04.2026
• Generierung: Kein paralleler Lauf mehr — zweiter Start → Warnung + Abbruch (bei Ollama oft spürbar).
• Log: Fortschritt 1/5–5/5 plus KI-Hinweise pro Aufruf — weniger „hängt das noch?“.
• KI: Automatische Wiederholungen bei typischen Netz-/Serverfehlern (z. B. 500, Timeout) mit Backoff (OpenAI-kompatible APIs).
• HTML Desktop: Breitere Hauptspalte; Mobil unverändert. Renderer aktualisiert — wie gewohnt Neu-Generierung auslösen und Seite hart neu laden.
• Admin-Doku (HTML/Markdown): JavaScript-Skripte nach ioBroker-Ordner gruppiert; beim Ordner „Globale Skripte“ kurzer Hinweis zur Ausführungsreihenfolge und sinnvollen Nutzung (entspricht der Script-Engine, keine extra AutoDoc-Option).
• common.desc am Skriptobjekt: nur noch als optionaler Gruppen-/Zwecktext erklärt — keine irreführende „Handlungsbedarf“-Liste mehr wegen fehlender Beschreibung.
• Admin-UI: Texte zu Export/Datenschutz (inkl. optional common.desc bei KI) und kurzer Hinweis im Tab „Erweitert“.11.04.2026
• Start / Einstellungen: Klarere Log-Meldungen zur Startup-Doku; Hilfetexte präziser (Hintergrundlauf, info.templateVersion, Log-Hinweis).
• Standard: „Dokumentation beim Adapterstart“ ist in den Paket-Defaults für neue Instanzen aktiv (bestehende Instanzen behalten ihre gespeicherte Konfiguration).
• HTML (Admin): Eigene Variablen und Aliase — Filter und Zuklappen zuverlässiger über das Skript am Seitenende; Ordnerverhalten bei leerem Suchfeld stabiler (inkl. BF-Cache/pageshow). Renderer-Version für den Template-Check angehoben.
• KI (lokal / kleine Modelle): sinnvollere Ollama-Standard-Temperaturen bei leerer Temperatur; strengere deutsche System- und Lektor-Prompts (u. a. korrektes ioBroker, keine Tippfehler wie iroBroker / „Adapatoren“, kein erfundenes Personal oder Fantasie-Marken); Qualitätsprüfung nach dem Lektor — bei weiterhin kaputtem Bewohner-Text kurze sachliche Kurzfassung aus echten Statistiken; bei kaputtem Gäste-Text neutraler Gäste-Fallback; typischer Stichpunkt-Müll wird stärker gefiltert.10.04.2026
• KI: Timeout und optionale Temperaturen (Bewohner vs. Gäste) in den Einstellungen; Grounding (Räume + Gerätekategorien) in den Prompts.
• Gäste-KI: bei technischem „Müll“ neutraler Fallback statt Admin-Sprech; im HTML-Kommentar erkennbar: primary vs. fallback-neutral.
• Parser: robuster bei NARRATIVE / RECOMMENDATIONS, Bereinigung von Markdown-Artefakten und leeren Stichpunkten.
• Deutsch: strengere Regeln (z. B. kein „Vorgesetzte“ im Privathaushalt, Rollläden statt falscher „Blinde“); erweiterte Trigger für den Sie-Lektor-Pass.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?
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
523
Online32.8k
Benutzer82.7k
Themen1.3m
Beiträge