Community Forum

Your browser does not seem to support JavaScript. As a result, your viewing experience will be diminished, and you have been placed in read-only mode.

Please download a browser that supports JavaScript, or enable it if it's disabled (i.e. NoScript).

NEWS

Test Adapter autodoc

Verschoben ...nicht in offiziellem Repo

44 Beiträge 6 Kommentatoren 1.4k Aufrufe 10 Beobachtet

S sigi234

@crunchip

Hallo,

Ist im Dark Mode nicht zu lesen!
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#7

@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
umgestiegen von Proxmox auf Unraid
S 1 Antwort Letzte Antwort

0
C crunchip

@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
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von

#8

@crunchip sagte:

ok, guck mal durch ob noch weitere Felder dabei sind.

Nein, nur diese.
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern!
1 Antwort Letzte Antwort

0
C crunchip
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 Adapterordner npm 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 puppeteer im Adapterordner installiert ist. Ohne das: unverändert nur HTML & Co. Zusätzlich Datenpunkt, um nur PDF zu erzeugen.
  0.9.34
- documentation.exportHashes berü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)
Neu in 0.9.32

docs/user-guide/ — englische Kurzanleitung + deutsches Muster-Szenario; Platzhalter-Grafiken (SVG) und Hinweise für echte Screenshots

Admin: mehr Hilfe zu Mermaid, zu Export-Hashes und Documentation-States (z. B. documentation.exportHashes, Speicher full vs. metadata) sowie Platzhalter bei langen Feldern; KI-Registerkarte aufgeräumt ohne aktiven Provider

common.extIcon und die Guide-URLs folgen main; Icon als PNG (512×512)

CI: Workflow-Concurrency wie von ioBroker empfohlen (Adapter Checker E3009); lokales npm run check ignoriert versehentliche Bootstrap-Reste im Klon wie bei ESLint
Forum (Kurzüberblick, Stand, 0.9.29–0.9.31)
Neu in 0.9.31

Check „Instanzen ohne Raum“ fließt nicht mehr in den Score (war oft irreführend).

Dafür u. a.: eigenes Doku‑Kapitel mit Inhalt; KI‑Provider, wenn Skripte existieren (ohne Skripte zählt der Punkt nicht).

Alte Admin‑Felder zu „ohne Raum“ bleiben, wirken aber nicht mehr auf den Score.

Neu in 0.9.30

Statt einem Wert gibt es drei Teil‑Scores: Datenerfassung · manuelle Angaben · Doku‑Tiefe, plus Gesamtpunktzahl (Durchschnitt).

Oberfläche und Texte (EN / DE / FR) angepasst.

Neu in 0.9.29

User‑Ansicht „Verbundene Systeme“ als Raster‑Layout.

Mermaid: ruhigere Farben; Diagramme nach Dark/Light‑Wechsel neu gerendert.

„Ohne Raum“ nur noch für aktive Instanzen; Hinweis zu common.desc bei Skripten entfernt.

Pro Instanz wird die Adapter‑Kategorie (common.type) mit ausgewertet.
Forum (Kurzüberblick, Stand 0.9.26–0.9.28)
Neu in 0.9.28 (Phase 5.x.3 · Stufe 2)

Optional „Auto host topology diagram“ (autoMermaidHostGraph) + Max. Instanzen (8–80, Standard 40): zweites Mermaid-Diagramm, Adapter-Instanzen pro ioBroker-Host (Multihost sinnvoll; begrenzte Knotenzahl, Round-Robin bei vielen Instanzen). Kein vollständiger Verbindungsgraph.

Ebenfalls über mermaid ausblendbar wie das eigene Diagramm.

Anzeige z. B. in Onboarding-Begrüßung nach dem manuellen Diagramm; gleiche Hide-Logik.

Neu in 0.9.27 (Phase 5.x.3 · Stufe 1)

Unter „Meine Dokumentation“: optionales Feld „Mermaid diagram“ (manualMermaidDiagram) — eigenes Diagramm (z. B. flowchart TB …).

HTML: Diagramm wird im Browser über Mermaid (CDN jsdelivr) gerendert; JavaScript aktiv und Zugriff auf das CDN sollten möglich sein, sonst bleibt Text sichtbar.

Markdown: Zusätzlicher ```mermaid-Block unter den manuellen Informationen.

Ausblenden in User/Onboarding über Kapitel-Id mermaid.

Neu in 0.9.26 (Phase 5.x.2 · Quick-Start-Anpassung)

Onboarding Quick Start (HTML + Markdown): kürzerer Schnitt aus denselben Daten — 3 Setup-Zeilen, 4 Raum-Karten, 2 Highlights pro Raum (sliceQuickStartForOnboarding).

User „Überblick“: weiterhin die volle Tiefe; Einleitungstext klärt Bewohner vs. Gast; Link zum Räume-Kapitel, wenn Highlights da sind und das Kapitel nicht versteckt ist (User-HTML + User-Markdown).

KI-Zugrundelegung Nutzerprofil: weiterhin die vollen Quick-Start-Fakten.
Forum (Kurzüberblick, Stand 0.9.25)
Meine Dokumentation: neues Freitextfeld ownerPlaybookNote („Ablauf / Playbook“): typische Reihenfolge, was erledigt werden muss, was Gäste oder Familie nicht ändern soll — in eigenen Worten.

Ausgabe:

eigenes Kapitel in User- und Onboarding-HTML (Navigation, wenn ausgefüllt),

im Admin-Handbuch als Unterpunkt,

im Markdown-Export unter Manual information, wenn das gewählte Dokumentationsprofil User bzw. Onboarding ist.

Ausblenden: Kapitel-Id ownerPlaybook in den JSON-Feldern auf dem Tab HTML-Export & Zusatzkapitel (User- bzw. Onboarding-Profil — ausgeblendete Kapitel).

KI: Playbook-Text fließt in den Owner-Kontext (analog zu Hilfe & Notfall / Abläufe).

Admin-UI: DE/FR für das neue Feld; Hinweis Doc layout intro präzisiert Admin-Kapitel vs. User/Onboarding-Ausblenden.

RENDERER_VERSION: 2026.04.28.5 — bei Bedarf Doku neu erzeugen.

Kurz zuvor (0.9.22–0.9.24)

Doku-Setup-Score / Wartung: konfigurierbare Checks und Schwellen; einheitliche Benennung Dokumentations-Setup vs. Diagnose; Quick-Start u. a. stabile Sortierung wenn Räume die gleiche Gerätezahl haben.
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von sigi234

#9

@crunchip

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!
C 1 Antwort Letzte Antwort

0
S sigi234

@crunchip

Hallo, habe da

Skripte ohne Beschreibung - Handlungsbedarf (338)

wo/wie soll ich die Beschreibung ändern?
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von crunchip

#10

@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
umgestiegen von Proxmox auf Unraid
1 Antwort Letzte Antwort

0
C crunchip
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 Adapterordner npm 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 puppeteer im Adapterordner installiert ist. Ohne das: unverändert nur HTML & Co. Zusätzlich Datenpunkt, um nur PDF zu erzeugen.
  0.9.34
- documentation.exportHashes berü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)
Neu in 0.9.32

docs/user-guide/ — englische Kurzanleitung + deutsches Muster-Szenario; Platzhalter-Grafiken (SVG) und Hinweise für echte Screenshots

Admin: mehr Hilfe zu Mermaid, zu Export-Hashes und Documentation-States (z. B. documentation.exportHashes, Speicher full vs. metadata) sowie Platzhalter bei langen Feldern; KI-Registerkarte aufgeräumt ohne aktiven Provider

common.extIcon und die Guide-URLs folgen main; Icon als PNG (512×512)

CI: Workflow-Concurrency wie von ioBroker empfohlen (Adapter Checker E3009); lokales npm run check ignoriert versehentliche Bootstrap-Reste im Klon wie bei ESLint
Forum (Kurzüberblick, Stand, 0.9.29–0.9.31)
Neu in 0.9.31

Check „Instanzen ohne Raum“ fließt nicht mehr in den Score (war oft irreführend).

Dafür u. a.: eigenes Doku‑Kapitel mit Inhalt; KI‑Provider, wenn Skripte existieren (ohne Skripte zählt der Punkt nicht).

Alte Admin‑Felder zu „ohne Raum“ bleiben, wirken aber nicht mehr auf den Score.

Neu in 0.9.30

Statt einem Wert gibt es drei Teil‑Scores: Datenerfassung · manuelle Angaben · Doku‑Tiefe, plus Gesamtpunktzahl (Durchschnitt).

Oberfläche und Texte (EN / DE / FR) angepasst.

Neu in 0.9.29

User‑Ansicht „Verbundene Systeme“ als Raster‑Layout.

Mermaid: ruhigere Farben; Diagramme nach Dark/Light‑Wechsel neu gerendert.

„Ohne Raum“ nur noch für aktive Instanzen; Hinweis zu common.desc bei Skripten entfernt.

Pro Instanz wird die Adapter‑Kategorie (common.type) mit ausgewertet.
Forum (Kurzüberblick, Stand 0.9.26–0.9.28)
Neu in 0.9.28 (Phase 5.x.3 · Stufe 2)

Optional „Auto host topology diagram“ (autoMermaidHostGraph) + Max. Instanzen (8–80, Standard 40): zweites Mermaid-Diagramm, Adapter-Instanzen pro ioBroker-Host (Multihost sinnvoll; begrenzte Knotenzahl, Round-Robin bei vielen Instanzen). Kein vollständiger Verbindungsgraph.

Ebenfalls über mermaid ausblendbar wie das eigene Diagramm.

Anzeige z. B. in Onboarding-Begrüßung nach dem manuellen Diagramm; gleiche Hide-Logik.

Neu in 0.9.27 (Phase 5.x.3 · Stufe 1)

Unter „Meine Dokumentation“: optionales Feld „Mermaid diagram“ (manualMermaidDiagram) — eigenes Diagramm (z. B. flowchart TB …).

HTML: Diagramm wird im Browser über Mermaid (CDN jsdelivr) gerendert; JavaScript aktiv und Zugriff auf das CDN sollten möglich sein, sonst bleibt Text sichtbar.

Markdown: Zusätzlicher ```mermaid-Block unter den manuellen Informationen.

Ausblenden in User/Onboarding über Kapitel-Id mermaid.

Neu in 0.9.26 (Phase 5.x.2 · Quick-Start-Anpassung)

Onboarding Quick Start (HTML + Markdown): kürzerer Schnitt aus denselben Daten — 3 Setup-Zeilen, 4 Raum-Karten, 2 Highlights pro Raum (sliceQuickStartForOnboarding).

User „Überblick“: weiterhin die volle Tiefe; Einleitungstext klärt Bewohner vs. Gast; Link zum Räume-Kapitel, wenn Highlights da sind und das Kapitel nicht versteckt ist (User-HTML + User-Markdown).

KI-Zugrundelegung Nutzerprofil: weiterhin die vollen Quick-Start-Fakten.
Forum (Kurzüberblick, Stand 0.9.25)
Meine Dokumentation: neues Freitextfeld ownerPlaybookNote („Ablauf / Playbook“): typische Reihenfolge, was erledigt werden muss, was Gäste oder Familie nicht ändern soll — in eigenen Worten.

Ausgabe:

eigenes Kapitel in User- und Onboarding-HTML (Navigation, wenn ausgefüllt),

im Admin-Handbuch als Unterpunkt,

im Markdown-Export unter Manual information, wenn das gewählte Dokumentationsprofil User bzw. Onboarding ist.

Ausblenden: Kapitel-Id ownerPlaybook in den JSON-Feldern auf dem Tab HTML-Export & Zusatzkapitel (User- bzw. Onboarding-Profil — ausgeblendete Kapitel).

KI: Playbook-Text fließt in den Owner-Kontext (analog zu Hilfe & Notfall / Abläufe).

Admin-UI: DE/FR für das neue Feld; Hinweis Doc layout intro präzisiert Admin-Kapitel vs. User/Onboarding-Ausblenden.

RENDERER_VERSION: 2026.04.28.5 — bei Bedarf Doku neu erzeugen.

Kurz zuvor (0.9.22–0.9.24)

Doku-Setup-Score / Wartung: konfigurierbare Checks und Schwellen; einheitliche Benennung Dokumentations-Setup vs. Diagnose; Quick-Start u. a. stabile Sortierung wenn Räume die gleiche Gerätezahl haben.
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von sigi234

#11

@crunchip

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!
C 1 Antwort Letzte Antwort

0
S sigi234

@crunchip

Hallo, irgendwie fehlt mir in der Systemübersicht die NPM Version?
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#12

@sigi234 sollte jetzt alles behoben sein
umgestiegen von Proxmox auf Unraid
S 1 Antwort Letzte Antwort

1
U Offline
U Offline
UlliJ

schrieb am zuletzt editiert von

#13

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
C 2 Antworten Letzte Antwort

0
C crunchip

@sigi234 sollte jetzt alles behoben sein
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von

#14

@crunchip sagte:

@sigi234 sollte jetzt alles behoben sein

Ja, Danke
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern!
1 Antwort Letzte Antwort

0
U UlliJ

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🤔
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#15

@UlliJ sagte:

Mehr darauf ausgerichtet die Zusammenhänge verständlich zu machen

Ja das fehlt bei mir noch ein wenig
umgestiegen von Proxmox auf Unraid
U 1 Antwort Letzte Antwort

0
C crunchip

@UlliJ sagte:

Mehr darauf ausgerichtet die Zusammenhänge verständlich zu machen

Ja das fehlt bei mir noch ein wenig
U Offline
U Offline
UlliJ

schrieb am zuletzt editiert von

#16

@crunchip sagte:

Ja das fehlt bei mir noch ein wenig

mal quick & dirty auf Teile der Autodoku verlinkt
Proxmox auf iNuc, lxc für IoB, InfluxDB2, Grafana, u.a. *** Homematic & Homematic IP, Shellies, Zigbee etc
1 Antwort Letzte Antwort

0
U UlliJ

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🤔
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#17

@UlliJ sagte:

Die Kombi aus beidem wäre perfekt

Ich hab mal mit auf die todo Liste gesetzt
umgestiegen von Proxmox auf Unraid
1 Antwort Letzte Antwort

0
C crunchip
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 Adapterordner npm 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 puppeteer im Adapterordner installiert ist. Ohne das: unverändert nur HTML & Co. Zusätzlich Datenpunkt, um nur PDF zu erzeugen.
  0.9.34
- documentation.exportHashes berü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)
Neu in 0.9.32

docs/user-guide/ — englische Kurzanleitung + deutsches Muster-Szenario; Platzhalter-Grafiken (SVG) und Hinweise für echte Screenshots

Admin: mehr Hilfe zu Mermaid, zu Export-Hashes und Documentation-States (z. B. documentation.exportHashes, Speicher full vs. metadata) sowie Platzhalter bei langen Feldern; KI-Registerkarte aufgeräumt ohne aktiven Provider

common.extIcon und die Guide-URLs folgen main; Icon als PNG (512×512)

CI: Workflow-Concurrency wie von ioBroker empfohlen (Adapter Checker E3009); lokales npm run check ignoriert versehentliche Bootstrap-Reste im Klon wie bei ESLint
Forum (Kurzüberblick, Stand, 0.9.29–0.9.31)
Neu in 0.9.31

Check „Instanzen ohne Raum“ fließt nicht mehr in den Score (war oft irreführend).

Dafür u. a.: eigenes Doku‑Kapitel mit Inhalt; KI‑Provider, wenn Skripte existieren (ohne Skripte zählt der Punkt nicht).

Alte Admin‑Felder zu „ohne Raum“ bleiben, wirken aber nicht mehr auf den Score.

Neu in 0.9.30

Statt einem Wert gibt es drei Teil‑Scores: Datenerfassung · manuelle Angaben · Doku‑Tiefe, plus Gesamtpunktzahl (Durchschnitt).

Oberfläche und Texte (EN / DE / FR) angepasst.

Neu in 0.9.29

User‑Ansicht „Verbundene Systeme“ als Raster‑Layout.

Mermaid: ruhigere Farben; Diagramme nach Dark/Light‑Wechsel neu gerendert.

„Ohne Raum“ nur noch für aktive Instanzen; Hinweis zu common.desc bei Skripten entfernt.

Pro Instanz wird die Adapter‑Kategorie (common.type) mit ausgewertet.
Forum (Kurzüberblick, Stand 0.9.26–0.9.28)
Neu in 0.9.28 (Phase 5.x.3 · Stufe 2)

Optional „Auto host topology diagram“ (autoMermaidHostGraph) + Max. Instanzen (8–80, Standard 40): zweites Mermaid-Diagramm, Adapter-Instanzen pro ioBroker-Host (Multihost sinnvoll; begrenzte Knotenzahl, Round-Robin bei vielen Instanzen). Kein vollständiger Verbindungsgraph.

Ebenfalls über mermaid ausblendbar wie das eigene Diagramm.

Anzeige z. B. in Onboarding-Begrüßung nach dem manuellen Diagramm; gleiche Hide-Logik.

Neu in 0.9.27 (Phase 5.x.3 · Stufe 1)

Unter „Meine Dokumentation“: optionales Feld „Mermaid diagram“ (manualMermaidDiagram) — eigenes Diagramm (z. B. flowchart TB …).

HTML: Diagramm wird im Browser über Mermaid (CDN jsdelivr) gerendert; JavaScript aktiv und Zugriff auf das CDN sollten möglich sein, sonst bleibt Text sichtbar.

Markdown: Zusätzlicher ```mermaid-Block unter den manuellen Informationen.

Ausblenden in User/Onboarding über Kapitel-Id mermaid.

Neu in 0.9.26 (Phase 5.x.2 · Quick-Start-Anpassung)

Onboarding Quick Start (HTML + Markdown): kürzerer Schnitt aus denselben Daten — 3 Setup-Zeilen, 4 Raum-Karten, 2 Highlights pro Raum (sliceQuickStartForOnboarding).

User „Überblick“: weiterhin die volle Tiefe; Einleitungstext klärt Bewohner vs. Gast; Link zum Räume-Kapitel, wenn Highlights da sind und das Kapitel nicht versteckt ist (User-HTML + User-Markdown).

KI-Zugrundelegung Nutzerprofil: weiterhin die vollen Quick-Start-Fakten.
Forum (Kurzüberblick, Stand 0.9.25)
Meine Dokumentation: neues Freitextfeld ownerPlaybookNote („Ablauf / Playbook“): typische Reihenfolge, was erledigt werden muss, was Gäste oder Familie nicht ändern soll — in eigenen Worten.

Ausgabe:

eigenes Kapitel in User- und Onboarding-HTML (Navigation, wenn ausgefüllt),

im Admin-Handbuch als Unterpunkt,

im Markdown-Export unter Manual information, wenn das gewählte Dokumentationsprofil User bzw. Onboarding ist.

Ausblenden: Kapitel-Id ownerPlaybook in den JSON-Feldern auf dem Tab HTML-Export & Zusatzkapitel (User- bzw. Onboarding-Profil — ausgeblendete Kapitel).

KI: Playbook-Text fließt in den Owner-Kontext (analog zu Hilfe & Notfall / Abläufe).

Admin-UI: DE/FR für das neue Feld; Hinweis Doc layout intro präzisiert Admin-Kapitel vs. User/Onboarding-Ausblenden.

RENDERER_VERSION: 2026.04.28.5 — bei Bedarf Doku neu erzeugen.

Kurz zuvor (0.9.22–0.9.24)

Doku-Setup-Score / Wartung: konfigurierbare Checks und Schwellen; einheitliche Benennung Dokumentations-Setup vs. Diagnose; Quick-Start u. a. stabile Sortierung wenn Räume die gleiche Gerätezahl haben.
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von

#18

@crunchip

Hallo,

wie sehe ich Live Werte?
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern!
C 1 Antwort Letzte Antwort

0
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
S sigi234

@crunchip

Hallo,

wie sehe ich Live Werte?
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#19

@sigi234 sagte:

Live Werte

Sind es eigentlich nicht, eher Momentaufnahmen, seh ich mir an, vllt nehme ich das auch raus
umgestiegen von Proxmox auf Unraid
1 Antwort Letzte Antwort

0
C crunchip
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 Adapterordner npm 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 puppeteer im Adapterordner installiert ist. Ohne das: unverändert nur HTML & Co. Zusätzlich Datenpunkt, um nur PDF zu erzeugen.
  0.9.34
- documentation.exportHashes berü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)
Neu in 0.9.32

docs/user-guide/ — englische Kurzanleitung + deutsches Muster-Szenario; Platzhalter-Grafiken (SVG) und Hinweise für echte Screenshots

Admin: mehr Hilfe zu Mermaid, zu Export-Hashes und Documentation-States (z. B. documentation.exportHashes, Speicher full vs. metadata) sowie Platzhalter bei langen Feldern; KI-Registerkarte aufgeräumt ohne aktiven Provider

common.extIcon und die Guide-URLs folgen main; Icon als PNG (512×512)

CI: Workflow-Concurrency wie von ioBroker empfohlen (Adapter Checker E3009); lokales npm run check ignoriert versehentliche Bootstrap-Reste im Klon wie bei ESLint
Forum (Kurzüberblick, Stand, 0.9.29–0.9.31)
Neu in 0.9.31

Check „Instanzen ohne Raum“ fließt nicht mehr in den Score (war oft irreführend).

Dafür u. a.: eigenes Doku‑Kapitel mit Inhalt; KI‑Provider, wenn Skripte existieren (ohne Skripte zählt der Punkt nicht).

Alte Admin‑Felder zu „ohne Raum“ bleiben, wirken aber nicht mehr auf den Score.

Neu in 0.9.30

Statt einem Wert gibt es drei Teil‑Scores: Datenerfassung · manuelle Angaben · Doku‑Tiefe, plus Gesamtpunktzahl (Durchschnitt).

Oberfläche und Texte (EN / DE / FR) angepasst.

Neu in 0.9.29

User‑Ansicht „Verbundene Systeme“ als Raster‑Layout.

Mermaid: ruhigere Farben; Diagramme nach Dark/Light‑Wechsel neu gerendert.

„Ohne Raum“ nur noch für aktive Instanzen; Hinweis zu common.desc bei Skripten entfernt.

Pro Instanz wird die Adapter‑Kategorie (common.type) mit ausgewertet.
Forum (Kurzüberblick, Stand 0.9.26–0.9.28)
Neu in 0.9.28 (Phase 5.x.3 · Stufe 2)

Optional „Auto host topology diagram“ (autoMermaidHostGraph) + Max. Instanzen (8–80, Standard 40): zweites Mermaid-Diagramm, Adapter-Instanzen pro ioBroker-Host (Multihost sinnvoll; begrenzte Knotenzahl, Round-Robin bei vielen Instanzen). Kein vollständiger Verbindungsgraph.

Ebenfalls über mermaid ausblendbar wie das eigene Diagramm.

Anzeige z. B. in Onboarding-Begrüßung nach dem manuellen Diagramm; gleiche Hide-Logik.

Neu in 0.9.27 (Phase 5.x.3 · Stufe 1)

Unter „Meine Dokumentation“: optionales Feld „Mermaid diagram“ (manualMermaidDiagram) — eigenes Diagramm (z. B. flowchart TB …).

HTML: Diagramm wird im Browser über Mermaid (CDN jsdelivr) gerendert; JavaScript aktiv und Zugriff auf das CDN sollten möglich sein, sonst bleibt Text sichtbar.

Markdown: Zusätzlicher ```mermaid-Block unter den manuellen Informationen.

Ausblenden in User/Onboarding über Kapitel-Id mermaid.

Neu in 0.9.26 (Phase 5.x.2 · Quick-Start-Anpassung)

Onboarding Quick Start (HTML + Markdown): kürzerer Schnitt aus denselben Daten — 3 Setup-Zeilen, 4 Raum-Karten, 2 Highlights pro Raum (sliceQuickStartForOnboarding).

User „Überblick“: weiterhin die volle Tiefe; Einleitungstext klärt Bewohner vs. Gast; Link zum Räume-Kapitel, wenn Highlights da sind und das Kapitel nicht versteckt ist (User-HTML + User-Markdown).

KI-Zugrundelegung Nutzerprofil: weiterhin die vollen Quick-Start-Fakten.
Forum (Kurzüberblick, Stand 0.9.25)
Meine Dokumentation: neues Freitextfeld ownerPlaybookNote („Ablauf / Playbook“): typische Reihenfolge, was erledigt werden muss, was Gäste oder Familie nicht ändern soll — in eigenen Worten.

Ausgabe:

eigenes Kapitel in User- und Onboarding-HTML (Navigation, wenn ausgefüllt),

im Admin-Handbuch als Unterpunkt,

im Markdown-Export unter Manual information, wenn das gewählte Dokumentationsprofil User bzw. Onboarding ist.

Ausblenden: Kapitel-Id ownerPlaybook in den JSON-Feldern auf dem Tab HTML-Export & Zusatzkapitel (User- bzw. Onboarding-Profil — ausgeblendete Kapitel).

KI: Playbook-Text fließt in den Owner-Kontext (analog zu Hilfe & Notfall / Abläufe).

Admin-UI: DE/FR für das neue Feld; Hinweis Doc layout intro präzisiert Admin-Kapitel vs. User/Onboarding-Ausblenden.

RENDERER_VERSION: 2026.04.28.5 — bei Bedarf Doku neu erzeugen.

Kurz zuvor (0.9.22–0.9.24)

Doku-Setup-Score / Wartung: konfigurierbare Checks und Schwellen; einheitliche Benennung Dokumentations-Setup vs. Diagnose; Quick-Start u. a. stabile Sortierung wenn Räume die gleiche Gerätezahl haben.
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von

#20

@crunchip

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!
C 1 Antwort Letzte Antwort

0
C crunchip
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.
A Offline
A Offline
arteck
Developer Most Active
schrieb am zuletzt editiert von arteck

#21

@crunchip sagte:

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
H C 3 Antworten Letzte Antwort

0
A arteck

@crunchip sagte:

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
H Nicht stören
H Nicht stören
Homoran
Global Moderator Administrators
schrieb am zuletzt editiert von

#22

@arteck sagte:

alles Adapter spezfifische landet im iobroker-data verzeichniss

Und??
Da ist doch dann files die nächste Ebene
kein 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 -
A 1 Antwort Letzte Antwort

0
H Homoran

@arteck sagte:

alles Adapter spezfifische landet im iobroker-data verzeichniss

Und??
Da ist doch dann files die nächste Ebene
A Offline
A Offline
arteck
Developer Most Active
schrieb am zuletzt editiert von

#23

@Homoran sagte:

Da ist doch dann files die nächste Ebene

und

rate was da nicht steht
zigbee hab ich, zwave auch, nuc's genauso und HA auch
1 Antwort Letzte Antwort

0
A arteck

@crunchip sagte:

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
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#24

@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.
umgestiegen von Proxmox auf Unraid
1 Antwort Letzte Antwort

0
S sigi234

@crunchip

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.
C Abwesend
C Abwesend
crunchip
Forum Testing Most Active Developer
schrieb am zuletzt editiert von

#25

@sigi234 geb mir mal ein Beispiel was du genau meinst?
umgestiegen von Proxmox auf Unraid
S 1 Antwort Letzte Antwort

0
C crunchip

@sigi234 geb mir mal ein Beispiel was du genau meinst?
S Online
S Online
sigi234
Forum Testing Most Active
schrieb am zuletzt editiert von sigi234

#26

@crunchip sagte:

@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!
C 1 Antwort Letzte Antwort

0

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

Support us

499

Online

32.9k

Benutzer

82.9k

Themen

1.3m

Beiträge

1
2
3