[erledigt] Artikelstruktur fronthem/smartVISU

[joshi04]

  jupp, in ini's kann viel stehen ... Jetzt passt es auch wieder mit dem hier zusammen: https://forum.fhem.de/index.php/topic,52358.msg441062.html#msg441062.
Da hatte ich nämlich Deine Anleitung her. Hätte ich besser verlinken sollen   

Dann ist die derzeitige Beschreibung im Wiki ja doch nicht soo verkehrt, auch wenn er hier und da noch ein bisschen "holpert".

Lass Dir Zeit, wollte hier erstmal Konsens finden, bevor zumindest ich das Wiki diesbezüglich wieder anfasse.

Edith: Hab mal ein unfertiges Beispiel angehängt, wie ich Beschreibung und in dieser Ausnahme Code beschrieben sein könnten. Wohlgemerkt als Diskussionsgrundlage.

[dev0]

heißt das, es sind die "highcharts", die bei herrmanj's cleaninstall noch nicht drin sind?

Drin schon, aber eine ältere Version.

Für die Frage, wie Widgets eingebunden werden können (import), habe ich im Forum mehrere Möglichkeiten gefunden und mir vorgenommen, das allgemeingültig zu beschreiben, sobald ich das durchdrungen habe.

Im ersten Mega Fronthem Thread gab es bereits eine Diskussion, wie man Widgets am Besten einbindet. Konsens war, dass wir includen wollen. Darauf hin wurden die Widgets im herrmannj Repo auch entsprechend umbenannt. So kann man sie einfach downloaden und in den pages Ordner kippen. Man muss sie dann nur einmal includen. Bei einem Update einfach die vorhandenen Dateien überschreiben.

Ich entnehme aber daraus, dass ich das PDU und das Sonos Widget von Dir verlinken darf?

Alle anderen Widget auch. Zum Verlinken und Beschreiben benötigst Du keine Zustimmung. Wenn Du Code (ins Wiki) _kopierst_ sieht es anderes aus, dann ist die Lizenz zu beachten. Sollte aber in den meisten Fällen eine GPL sein, ist nichts angegeben, dann würde ich die GPL zugrunde legen, da SV lebst unter GPL steht.

Siehst Du das ebenso bei Code, der derzeit nur in einem Forums-Beitrag zu finden ist?

In dem Fall wäre es das Eleganteste, wenn der Entwickler den Code in das smartvisu-widgets Repo einchecken würde und ggf. vorher in die passende Forum bringen würde (drei Dateien ala widget_name_.ext). Wenn der Schreiberling keinen Bock drauf hat, dann kann man das auch selbst machen und im Thread bekanntgeben. Wenn ich es richtig verstanden habe, dann steht Code im Forum generell unter einer CC Lizenz, die das auch rechtlich hergibt (Quelle angeben). Ist natürlich auch der aufwendigste Weg...
Du merkst schon, ich habe etwas gegen kopierten Code im Wiki. Das Problem dabei ist, dass Du Änderungen am Code nicht unbedingt mitbekommst und nachtragen kannst. Wen DU dich irgendwann einmal nicht mehr intensiv drum kümmerst, dann ist das Wiki schneller überholt als man gucken kann und verursacht durch die unterschiedlichen Versionen ggf. noch erhöten Supportaufwand.

Hab mal ein unfertiges Beispiel angehängt, wie ich Beschreibung und in dieser Ausnahme Code beschrieben sein könnten.

Code Auswählen Erweitern

{% import  "widgets\\widget_temp_sensor.html" as TempSensor %}
Das \\ ist mir unklar.

Code Auswählen Erweitern

Der folgende Code muss als widget_temp_sensor.html gespeichert werden.

In welchen Ordner?

Code Auswählen Erweitern

Das Widget wird mit folgendem Aufruf innerhalb einer Seite in smartVISU eingebunden:
{{ TempSensor.Data(<id>, <txt>, <gad>, <icon>, <flags>) }}

Ist dem Leser an dieser Stelle schon bekannt, dass diese Aufrufe noch in einen Block o.ä. verpackt werden sollten/müssen?

Code Auswählen Erweitern

gad: GAD-Prefix, das im GAD-Editor verknüpft werden muss

Prefix bitte weglassen.
Was ist überhaupt ein GAD oder Item?

Toll, dass Du Dich um das Thema kümmerst. Respekt!

[joshi04]

Er nahm die aufmunternden Worte und verschwand auf nimmer wiedersehen...
War ein paar Tage beschäftig und nehme nun wieder Anlauf.

Im ersten Mega Fronthem Thread gab es bereits eine Diskussion, wie man Widgets am Besten einbindet. Konsens war, dass wir includen wollen.

Durch den habe ich zwar auch durchgekämpft, aber mit einem anderen Fokus. So ist mir gerade das wohl entgangen. Dem Konsens will ich natürlich unter keinen Umständen widersprechen. Gehe davon aus, dass herrmannj's github derjenige zum includen sein wird, das frage ich gleich aber noch im anderen Fred.

Wenn Du Code (ins Wiki) _kopierst_ sieht es anderes aus, dann ist die Lizenz zu beachten.

Das habe ich bereits mit krikan diskutiert. Genehmigung liegt aber bereits auch vor, obwohl das wohl nicht mehr so (im Wiki) zum Tragen kommt.

Du merkst schon, ich habe etwas gegen kopierten Code im Wiki.

Ich teile mittlerweile Deine Meinung, habe vorher aber keine bessere Möglichkeit gesehen.

Deine Anregungen nehme ich gerne auf:
\\ -> stammt auf dem ursprünglichen Post. Gerade noch einmal getestet, mit nur einem findet er das widget im Unterverzeichnis nicht. Ist der "import" hier eigentlich ein smartVISU-Befehl?

In welchen Ordner? -> Das sollte bereits in einem anderen Artikel/Abschnitt beschrieben worden sein. Vielleicht muss ich mir das zuerst anschauen. Sonst kann man da nicht drauf aufbauen.

Ist dem Leser an dieser Stelle schon bekannt, dass diese Aufrufe noch in einen Block o.ä. verpackt werden sollten/müssen? -> Guter Punkt, sollte ich noch einmal drauf hinweisen. Vielleicht an allgemeiner Stelle, ist ja immer so. Spätestens im Beispiel stolpert man nochmal drüber.

Prefix bitte weglassen. -> Auch aus dem Ursprungspost, nehm ich aber raus. Hast recht.

Was ist überhaupt ein GAD oder Item? -> sollte im Wiki schon beschrieben sein, ich schau nochmal. Das Thema Widgets ist mM derzeit im Wiki noch sehr rudimentär eingeführt. Das muss man noch einmal allgemein beschreiben, was das ist und mit was das einhergeht. Hab ich auf dem Zettel.

In den Zusammenhang werde ich die Struktur vom smartVISU-Artikel noch einmal ein wenig umstellen (Bausteine und Konfiguration fürs Verständnis, der Rest als Nachschlagewerk):
Bausteine
   Statische Seiten
   Treiber
   Widgets
      Funktion: Was ist das? (Was sind items, GAD)
      Einbindung: Wie binde ich Widgets ein (import)? Wie verwende ich Widgets auf meiner Seite?
Konfiguration
verfügbare Widgets und Codebeispiele
Links

Anmerkungen und Anregungen sind wie immer stets willkommen.

[joshi04]

Ich bin nun noch einmal auf V2.7 und V2.8 näher eingegangen.
http://www.fhemwiki.de/wiki/SmartVISU_Installation

Als nächstes kommt die Konfiguration (Widgets, Seitenaufbau, etc.) dran. Das wird aber etwas dauern und reifen müssen.

[joshi04]

Fürs Erste hab ich nun die mir bekannten Repositories mit Quellen zu weiteren Widgets auf der smartVISU-Seite hinzugefügt.

Bis ich hier weitermachen kann, muss ich mich erstmal selbst schlau turnen.

Zwischenzeitlich würde ich mich freuen, wenn Ihr Euch den derzeitigen Stand der folgenden Artikel anschaut:
http://www.fhemwiki.de/wiki/Fronthem
http://www.fhemwiki.de/wiki/Fronthem_Installation
http://www.fhemwiki.de/wiki/SmartVISU
http://www.fhemwiki.de/wiki/SmartVISU_Installation

Schöne Grüße,
John

[dev0]

Gute Arbeit!

[joshi04]

Danke fürs drüber schauen und die Blumen. Das freut mich

[joshi04]

Habe noch das Repo für die Plots (mit DbLog) hinzugefügt. Und ein paar Links für die Schreibweise korrigiert. Die alten Weiterleitungen können nun gefahrlos (ohne tote Links) gelöscht werden. Da diese aber bereits so markiert sind (das findet seinen Weg), würde ich alles Weitere nicht mehr unter dem Thema "Artikelstruktur" sehen und diesen Thread entsprechend als erledigt markieren.
Schöne Grüße,
John

[dev0]

@John: Magst Du das vll noch mit ins Wiki aufnehmen: https://forum.fhem.de/index.php/topic,59338.msg507736.html#msg507736

[joshi04]

Bin gerade nicht ganz auf stand und muss mich erst wieder einlesen. Zwischenzeitlich hat es ja wieder richtig Fahrt aufgenommen und sich einiges verändert (freu).
Was meinst Du denn genau?
Falls der Hinweis auf das mysql-php gemeint ist, wird das ja erst in Zusammenhang mit den Plots notwendig. Diese Doku wollte ich allerdings auf dessen github belassen. So hatte ich damals zumindest die Aufteilung verstanden. Oder meinst Du etwas ganz anderes? Habe's selbst leider noch nicht eingerichtet...

Unabhängig davon, dass Du recht hast, ich könnte mich mal wieder kümmern, freue ich mich natürlich jederzeit auch über weitere Bearbeiter des Wiki und andere Blickwinkel.


Gesendet von iPhone mit Tapatalk

[dev0]

Falls der Hinweis auf das mysql-php gemeint ist, wird das ja erst in Zusammenhang mit den Plots notwendig. Diese Doku wollte ich allerdings auf dessen github belassen.

Yepp, das meinte ich. Du hast aber Recht, dass es eigentlich in die Doku zum Widget gehört.
Habe einen Issue auf Github eröffnet, da der Autor seit ~1 Jahr hier nicht mehr aktiv ist.

[dev0]

Ich habe den den Absatz "Config.ini kopieren" gerade etwas nach oben verschoben, da es sonst mit den Berechtigungen Probleme gibt: siehe hier