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, 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.autodocinstallierbar (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.
Bitte benutzt das Voting rechts unten im Beitrag wenn er euch geholfen hat.
Immer Daten sichern! -
@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äterumgestiegen von Proxmox auf Unraid
-
@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; ü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.autodocinstallierbar (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.
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; ü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.autodocinstallierbar (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.
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; ü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.autodocinstallierbar (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.
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; ü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.autodocinstallierbar (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.
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).
-
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.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.
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
541
Online32.9k
Benutzer83.1k
Themen1.3m
Beiträge