Neues YouTube-Video: Visualisierung im Devices-Adapter

[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, sowie PDF auf Wunsch — 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.

Seit Kurzem ist der Adapter auch als npm-Paket iobroker.autodoc installierbar (weiterhin alternativ per Git/URL).
Aufnahme in die offizielle Adapterliste (repositories, latest): PR gestellt, Merge ausstehend

---

Links

• Repo: https://github.com/crunchip77/ioBroker.autodoc
• npm: https://www.npmjs.com/package/iobroker.autodoc
• Issues / Wünsche: https://github.com/crunchip77/ioBroker.autodoc/issues
• Kurzanleitungen im Repo: User-Guide EN · Szenario DE (dort verlinkt)
• Ausführlicher Verlauf: README — Changelog

---

ioBroker.autodoc — Stand npm 0.9.44

Kurz für euch: Wer per npm installiert oder aktualisiert, ist auf 0.9.44. Kein Handlungsbedarf — es ist keine Funktionsumstellung eurer bestehenden Konfiguration nötig.

Was sich zuletzt „offiziell“ auf npm getan hat (ohne Technik-Details):

• 0.9.44 — bessere Hilfen rund um die Kapitel‑JSON‑Felder plus Log‑Hinweise bei falschen oder doppelten Einträgen; kleine Anpassungen bei der Schnellstart‑Auswahl in den Exporten.“
• 0.9.43 — Nur Hintergrund (Metadaten für ioBroker/npm-Regeln). Dokuerzeugung und Verhalten im Alltag bleiben wie bei 0.9.42.
• 0.9.42 — Erstes npm-Update nach der zuletzt auf npm veröffentlichten 0.9.38. Wer von npm kommt, zieht damit in einem Rutsch die Zwischenentwicklung nach (u. a. Themen rund um Speicher/Export und Volltext unter /files/ — wer tiefer einsteigen will: README-Changelog).
• 0.9.38 und davor — wie gehabt: lauffähige npm-Historie; 0.9.35 war das erste öffentliche npm-Paket.

---

Ich freue mich über Erfahrungsberichte, Screenshots und konkrete Wünsche für die nächsten Schritte.

[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).
  

• HTML-Export/PDF
  

• 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.

[sigi234]

@crunchip sagte:

wenn die Basis-URL passt.

Muss ich die unter Windows extra angeben?

[crunchip]

@sigi234 was meinst du mit extra angeben?
Eigentlich deine iobroker ip:port
In meinem Fall 10.1.1.111:8081

[sigi234]

@crunchip sagte:

@sigi234 was meinst du mit extra angeben?
Eigentlich deine iobroker ip:port
In meinem Fall 10.1.1.111:8081

Ja läuft jetzt . IOB läuft bei mir unter Win ja local.

http://localhost:8091

[sigi234]

@crunchip

Hallo,

Ist im Dark Mode nicht zu lesen!

[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

[sigi234]

@crunchip sagte:

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

Nein, nur diese.

[sigi234]

@crunchip

Hallo, habe da

Skripte ohne Beschreibung - Handlungsbedarf (338)

wo/wie soll ich die Beschreibung ändern?

[crunchip]

@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

[sigi234]

@crunchip

Hallo, irgendwie fehlt mir in der Systemübersicht die NPM Version?

[crunchip]

@sigi234 sollte jetzt alles behoben sein

[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🤔

[sigi234]

@crunchip sagte:

@sigi234 sollte jetzt alles behoben sein

Ja, Danke

[crunchip]

@UlliJ sagte:

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

Ja das fehlt bei mir noch ein wenig

[UlliJ]

@crunchip sagte:

Ja das fehlt bei mir noch ein wenig

mal quick & dirty auf Teile der Autodoku verlinkt

[crunchip]

@UlliJ sagte:

Die Kombi aus beidem wäre perfekt

Ich hab mal mit auf die todo Liste gesetzt

[sigi234]

@crunchip

Hallo,

wie sehe ich Live Werte?

[crunchip]

@sigi234 sagte:

Live Werte

Sind es eigentlich nicht, eher Momentaufnahmen, seh ich mir an, vllt nehme ich das auch raus

[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.