Dokumentation unseres SmartHome, KNX und openHAB

[motto]

Guten Abend in die Runde,

wenn diese Frage in einem anderen Forum/Thread besser aufgehoben ist bitte ich um eine entsprechende Info.

Wir haben vor 2 Jahren gebaut und haben bei der Haustechnik auf KNX gesetzt und sind damit auch sehr zufrieden. Das Haus "funktioniert" inzwischen auch ganz grundsätzlich - allerdings wage ich hier die Prognose - fertig wird das nie :-) Die Installation und Programmierung habe ich komplett selbstständig gemacht, es gibt also keine fertige Dokumente vom Projektierer o.ä.

Zusätzlich habe ich auch noch openHAB am laufen worüber wir die die Visualisierung realisiert haben und auch noch einige andere "Spielereien" die aber die grundsätzliche Funktion des Hauses nicht tangieren.

Während der Bauphase und auch in den letzten zwei Jahren sind viele Fragmente einer Dokumentation entstanden deren Zustand inzwischen aber mit Fug und Recht als unüberschaubar betitelt werden dürfen.

Jetzt stehe ich ganz grundsätzlich vor der Frage wie dokumentiert man soetwas am elegantesten. Meine Frau meint immer, wenn mir mal was passiert müsste Sie erst mal einen SmartHome Archäologen beauftragen und - zumindest ein klein wenig - hat sie Recht.

Daher mal meine Frage, wie macht man sowas üblicherweise - mir fallen spontan zwei Varianten ein:

1) der Klassiker - Einfach ein Textdokument (Word o.ä.) das kann om Notfall vermutlich jeder lesen
2) vielleicht ein Wiki, die Idee finde ich ganz charmant weiß aber nicht ob eine solche Doku die richtige Anwedung für ein Wiki ist, da diese ja keiner ständigen aktualisierung unterzogen wird

Daher nun die Frage in die Runde, und ich hoffe ich bin hier in diesem Forum einigermaßen richtig, wie habt Ihr das für Euch gelöst?

Ich habe auch bei Google keine wirklich zufriedenstellende Antwort auf diese Frage gefunden.....

Viele Grüße,
Michael

[Schlaubi]

Moin,

- Stromlaufpläne
- Installationspläne

Aus der ETS
- Reports

[intelligente Haustechnik]

Das was Schlaubi geschrieben hat, stimmt erst einmal (gesicherte und wieder auffindbare KNXprod).
Viel wichtiger wäre aber ein Raumbuch oder ein Pflichtenheft, wo einzelne Funktionen genauer beschrieben sind sowie ein "Handbuch" zu den Spielereien
(Den Raspi im Schrank, der mir den aktuellen Spritpreis über Nodered auf den Glastaster sendet, muß erst mal jemand 1. finden und 2. verstehen)

Weiterhin: Zugangsdaten...

Edit: verwendete / erforderliche Software

[Proto]

Hallo Michael,

das ist Geschmackssache. Wichtigstes Auswahlkriterium ist die - aus persönlicher Sicht - einfache Bedienung. Dokumentation ist ungeliebte Arbeit, ist dann die Doku-Lösung auch noch schlecht zu bedienen, dann wird die Dokumentation erfahrungsgemäß aufgeschoben und bleibt dann immer mehr liegen, bis es zu spät ist.

Wenn du also z.B. mit Stift und Blatt am einfachsten dokumentieren kannst, nimm das, selbes gilt für Diktiergerät mit Spracherkennung, Tabellenkalkulation, Datenbank, Textdokument usw.

Persönlich finde ich die Wiki-Lösung gut und nutze sie auch (Produkt: DokuWiki). Vorteile (Wiki): verlinkbar, durchsuchbar, Historie je Seite.

Direkt nach dem Auswahlkriterium Einfachheit kommt übrigens die gewünschte Struktur. Schreibst du am liebsten alles untereinander, weil du es nur irgendwann durchsuchen willst, dann ist z.B. das Textdokument gut geeignet und das Wiki unnötig kompliziert und hinderlich. Magst du hingegen Struktur kann z.B. das Wiki seine stärken ausspielen. Ich lege z.B. pro KNX-Gerät eine eigene Seite an mit den notwendigen Gerätedaten, Hinweisen und auch mit Dateien (Handbuch, Applikation).

Grüße

Alexander

[john7]

Nachdem die Dokumentation ein eher langfristiges Thema ist, ist die Frage gut möglich nach wie vor aktuell.

Ich habe mir ähnliche Fragen auch gestellt und immer das Gefühl gehabt, dass meine Familie ohne mich bzgl. der diversen Details von Bau- und SmartHome-Technik nicht so gut aufgestellt wäre und auch ein notwendiger od. gewünschter Verkauf problembehaftet sein könnte + nicht zuletzt persönliche Änderungsschwierigkeiten durch die eigene Vergesslichkeit.

Folglich habe ich eine Software entwickelt habe, die sich diesem oft nicht so beliebten aber wichtigem Thema widmet. Damit lassen sich kurzgefasst alle möglichen "Bauteile" aus allen denkbaren Gewerken/Bereichen verwalten bzw. dokumentieren (Elektro, Sanitär, Baumaterialien, Gartenbau etc.). Dieser Aspekt ist wohl in vielerlei Hinsicht ähnlich wie ein Raumbuch, nur dass es sich halt auch um Fassaden, Garten, Verteiler oder sonstige Bereiche handeln kann und dass alles miteinander in Beziehung steht. Rohre und Kabel können speziell erfasst werden und so findet man später z.B. alle Rohre und Kabel z.B. vom Technikraum ins Wohnzimmer oder vom Haus in den Garten quasi auf Knopfdruck.

Eine Verknüpfung mit Fotos und Dokumenten (Anleitungen, Pläne etc.) ist möglich und schließlich lassen sich die ganzen erfassten Daten auch als Nachschlagedokumentation u.a. als PDF generieren (für die Frau, Nachwelt, Kunde, Käufer, Professionisten etc.).

Die Software ist derzeit noch in der Testphase, weil ich gerne noch Feedback sammeln möchte und auch noch Dokumentation über die Dokumentation zu erstellen habe ;-) Einen Link für weitere Infos/Download würde ich hier für ev. Interessierte zwar gerne nennen, mache ich aber lieber nicht, weil womöglich unerwünscht bzw. nicht erlaubt (habe dazu vor Ostern schon eine Anfrage gestellt aber bislang noch keine Antwort erhalten). Bei Interesse daher bitte einfach eine PN an mich.

Liebe Grüße,

Johannes

[xrk]

Hi Johannes, super Sache mit dein Smarthome-Doku-Software. Um ersten Eindruck davon zu bekommen, könntest Du bitte uns vielleicht paar Screenshots hinzufügen wie das Beispielhaus Doku mit deinem Software aussieht. Danke!

[irgendwer]

Ja, ruhig hier zeigen

[john7]

Danke für das bekundete Interesse. Damit man sich das Ganze auch ohne PN ein wenig besser vorstellen kann, habe ich einmal vier ganz frische Screenshots von eher wichtigen Ansichten angehängt.

Der erste Screenshot zeigt den sogenannten Elemente-Baum. Hier können alle Bereiche und ortsgebundene Bauteile erfasst werden (ortsgebunden ist bei mir auch schon ein wenig relativ, weil ich mittlerweile u.a. den Rasenmäher und andere mobile Geräte erfasst habe, wo ich mir z.B. den letzten Ölwechsel vermerke und tlw. Anleitungen verknüpfe).

Im zweiten Screenshot sieht man dann die Detailansicht eines geöffneten Elements (hier ein Glastaster). Was man leider nicht sieht sind die ToolTips, die zu ziemlich jedem Feld eine kurze Beschreibung liefern :-) Dafür sieht man im unteren Bereich die eingehenden Verbindungen auf das Element. Eine Verbindung ist ein Bauteil, der zwei Elemente miteinander verbindet. D.h. zumeist ein Kabel oder Rohr es könnte aber bspw. auch ein Schacht oder ein Überströmkanal für die Wohnraumlüftung zwischen zwei Räumen etc. sein. Im konkreten Fall sieht man hier also einen "Glastaster 4-fach" mit eingehendem Rohr und Buskabel.

Im dritten Screenshot sieht man die Vorschau eines generierten Elemente-Detailberichts (= ein Teil der erwähnten "Nachschlagedokumentation").

Und schließlich noch ein Screenshot von der Bilder-Gallerieansicht, bei der man via Drag&Drop Bilder (d.h. in der Regel Fotos) und Bauteile (d.h. Elemente und Verbindungen) miteinander verknüpfen kann um Bilder später in endlicher Zeit wiederzufinden und auch um zu wissen was denn da gezeigt wird - gerade bei Detailfotos ist das später oft nicht mehr klar.

Ich hoffe, dass man sich damit deutlich besser vorstellen kann um was es bei dem Programm geht (oder auch nicht geht).

[xrk]

Danke für die Beschreibung und Screenshots. Hut ab, sieht nach gut durchgedachte und visuell sehr ansprechend gemachte Software aus!

Folgende Fragen/Ideen:

• können Grundrisse oder noch besser 3D Ansicht des Gebäudes (z.B. wie in DIALux 2D/3D Ansichten) eingefügt werden, wo an das Element geklickt die verknüpften Daten verlinkt/geöffnet werden können?
• Datenaustausch mit ETS um z.B. Info vom Gerätefeldern wie Beschreibung, Installationshinweise, Kommentar abzugleichen/synchronisieren

Ich könnte auch vorstellen die Ausgabe als Webseite (statt Word Dokument oder PDF), wo dies z.B. an Heimautomations-Visu verknüpft werden könnte als Dokureferenz.

[john7]

Danke für das Feedback!

Grundsätzlich kannst Du jede Art von Datei als "Dokument" mit einem Element, Verbindung, Bauteiltyp oder auch einer sog. Objektkategorie verknüpfen. Wenn man z.B. den Glastaster offen hat und auf den Dokumente-Tab klickt kann man Dateien zunächst auch via Drag&Drop aus dem Explorer hinzufügen (z.B. eine PDF-Anleitung). Bilder und Dokumente bleiben übrigens immer Dateisystem (d.h. sie werden (bewusst) nicht in der Datenbank gespeichert). Hinzugefügte Dokumente (und auch Bilder) können einfach mit dem Standard-Progamm in Windows geöffnet werden. D.h. eine PDF-Anleitung wird mit der entsprechenden Öffnen-Aktion (bzw. einfach mit einem Doppelklick bei gedrückter Alt-Taste) in dem Programm geöffnet ist, dass in Windows als Standard-Programm für den Dateityp hinterlegt ist.

Ein Datenaustausch mit der ETS ist künftig denkbar, aber da müssen sich vorher klare Anwendungsszenarien + erhöhter Bedarf abzeichnen. Am ehesten kann ich mir da momentan so etwas wie einen Initialimport vorstellen, damit man alle Geräte als Elemente in der Anwendung hat.

Die Berichte können bereits jetzt nicht nur als PDF exportiert werden sondern u.a. auch als MHTML (eine Datei wo nebst HTML auch Bilder drinnen sind). Der MHTML-Standard wird z.B. von Chrome und IE unterstützt (nicht aber Firefox).

[starwarsfan]

Hi

Bilder und Dokumente bleiben übrigens immer Dateisystem (d.h. sie werden (bewusst) nicht in der Datenbank gespeichert).

Frage an der Stelle: Wie werden die Bilder, Dokumente etc. referenziert? Hoffentlich mit relativen Pfaden oder? Wenn nicht, dann wäre das gleich ein Feature-Request.

Denn ich würde das Projekt sowie die dort referenzierten Dateien in einem Verzeichnis ablegen bzw. dort dann eine sinnvolle Ordnerstruktur aufbauen und das dann vollumfänglich bspw. in einem Git-Repo versionieren. Dann kann man zumindest sicher sein, dass alle Referenzen dauerhaft funktionieren und hat dazu noch eine komplette History.

Just my two cents...

[john7]

Die Dateien bzw. speziell die Dokumente (von Produtktinformationen, Pläne, Bescheide, ev. Angebote und Rechnungen etc.) unterhalb eines extra Dateiordners zusammenzufassen ist auf jeden Fall eine gute Idee.

Die Dateien (d.h. Dokumente und Bilder) werden aktuell in der Anwendung absolut referenziert. Ich sehe darin bislang mehr Vorteile als Nachteile. So ist es z.B. auch möglich, dass man z.B. ev. die Fotos ganz wo anders liegen hat. Ein relativer Pfad wäre hier dann sehr unleserlich (z.B. wichtig für Berichte) und die Dateireferenz würde z.B. auch nicht mehr funktionieren, wenn man die Anwendungsdatenbank verschiebt (deren Ablageort wäre ja vermutlich der Bezugspunkt der relativen Pfade).

Freilich - wenn sicherzustellen wäre, dass immer alles unter einem Ordner liegt, dann wären ggf. die kürzeren Pfade wiederum u.a. eher ein Lesevorteil.

Auf jeden Fall sehe ich bislang kein Hindernis es jetzt schon genauso wie angedacht zu machen (d.h. alles unterhalb eines Ordners und den unter Versionskontrolle).

Eine Nachteil zu den relativen Pfaden ist jetzt beim Verschieben des gesamten Ordners gegeben. Beim Verschieben und Umbenennen innerhalb des Ordners wäre es jedoch das gleiche Problem wie mit absoluten Pfaden. Es gibt deshalb in der Anwendung bereits eine Funktion zum gleichzeitigen Anpassen der Dateipfade von mehreren Dateien. Wenn z.B. alle Dokumente von C:\MyDocs nach D:\MyNewDocs verschoben werden sollen, dann werden in der Liste alle Dokumente gewählt die Funktion "Dateipfad ändern" aufgerufen und wie bei einem Suchen und Ersetzen-Dialog der alte und neue Pfade eingegeben + Knopfdruck und fertig. Ich hoffe das ist/wäre ein gangbarer Weg.

Danke auf jeden Fall mal für den Input!

[xrk]

Auch ich würde für interne Abspeicherung mit relativen Pfaden plädieren. Ein Beispiel, wo es mit absoluten Pfaden wenig Sinn macht ist, wenn man die Datenbank und die zusammengehörige Projektdateien auf einem NAS oder Serverlaufwerk hat. Falls nun zwei Rechner den Servershare unterschiedlich mappen/mounten (z.B. ein PC als X:, andere als Y: ), kann nicht ohne jedes mal den Dateipfad zu ändern an dem Projekt an den anderen PC gearbeitet werden. Mit relativen Pfaden wäre es problemlos möglich.

[john7]

Die Datenbank darf aus technischen Gründen leider ohnehin auf keinem Netzwerkshare liegen (würde zur Zerstörung der DB führen, die DB-Engine braucht einen garantiert exklusiven Zugriff). In einer ev. künftigen Mehrplatzvariante wäre das möglich (es muss dann ein DB-Server laufen) . Da liegt dann auch die Datenbank nicht mehr im selben Ordner. Generell muss man zudem immer Vor- und Nachteile sorgfältig abwiegen. Das Mappen eines Netzwarshares auf den gleichen Laufwerksbuchstaben würde ich dabei ehrlich gesagt eher als very Minor-Problem ansehen. Das ist gängige Praxis in kleinen und großen Unternehmen.

[xrk]

Bei mir Zuhause liegen mittlerweile aber auch keine Nutzdaten mehr auf Client-PCs, sondern alles was wertvoll ist, in zentralen Server, der sowohl RAID für Verfügbarkeit als auch Backup-Strategie hat. Das Netzlaufwerk für Dateiablage nicht Unterstützt wird ist leider IMHO nicht schön.