[Doku] Themensammlung zu MQTT allgemein
-
Sollten euch Anregungen, oder spezielle Themen die in einer Doku erwähnt werden sollen,
rund um das Thema mqtt, einfallen, bitte hier einstellen.
Dürfen auch gerne Ideen sein, aus denen man später ein Tutorial erstellt.
Einfaches Brainstorming, sortiert wird später.Gruß, Karsten
Edit:
Sollte hier im Thread schon ein Vorschlag/Hinweis gemacht worden sein, der euch ebenso wichtig erscheint,
dann voted diesen Beitrag bitte positiv.
So kann ich leichter erkennen, wie gewichtig ein Vorschlage/Hinweis einzuschätzen ist.Und noch eine Bitte hätte ich an euch.
Damit ich es später besser differenzieren kann, setzt am Anfang eures Vorschlags/Hinweis
einen Marker.
z.B. [Vorschlag], [Hinweis], usw.Danke
Vorerst finale Version der Doku zu MQTT
(Stand: 14.02.2022)Dankeschön an alle Mitwirkenden
Kleine Übersicht, damit ich es später leichter habe
- Topics -
Ausführlicher behandeln (eventuell Tutorial) - MQTT Client -
AnderenAdaptermit einbeziehen - Einsteigerfreundlich -
Nicht nur technisch versierte Dokumentation - Ausklappmenü -
Tiefergehende Erklärungen verbergen. - Issues -
Auf derzeitige Probleme hinweisen.Sammlungan Problemen - Hilfestellung -
Wann welchen Adapter, in welcher Form anwenden. - best practices -
Server/Client - Bitte Unterstützung -
Hintergrund zu den einzelnen Adaptern - Hinweis -
Adapter, welche in sich das MQTT-Protokoll verwenden, erwähnen - Ports -
Hinweis, wenn mehrere Broker parallel laufen
- Topics -
-
@hydrotec
Da fällt mir direkt was ein.
Ich hatte ganz am Anfang meine Problemchen mit den Topics (ich glaube, das war im Zusammenhang mit Tasmota-Devices).
Darauf sollte man eventuell etwas tiefer eingehen -
Danke zu dem Hinweis
Topics ist auf jeden Fall etwas, was mit in die Doku kommt.
Die Frage ist nur, wie weit macht es Sinn, es auszuschmücken, oder wäre eventuell ein Tutorial,
welches sich tiefer mit der Materie beschäftigt, sinnvoller.Tasmota arbeitet auch mit Topics, soweit ich weiß, selber habe ich kein Tasmota im Einsatz.
Doch wird hierfür nicht der Sonoff Adapter verwendet? -
@hydrotec sagte in MQTT Broker/Client Adapter:
Topics ist auf jeden Fall etwas, was mit in die Doku kommt.
bei dem MQTT-Adapter ist das ganz speziell
(ich hab das nie sauber hinbekommen damit)beim MQTT-Client siht das anders aus.
Vielleicht gehst du auch auf diesen ein. ein Hinweis darauf sollte reichen -
Die Doku sollte m.M nach so einfach wie möglich sein und die Grundlagen (evt. mir einfachen Beispielen) behandeln.
Fachausdrücke, die nur Raketenwissenschaftler verstehen, sollten am Ende vorkommen. -
Die Frage ist halt, wie wir die Dokumentation aufbauen sollen.
MQTT allgemein, und alle in Beziehung stehende Adapter mit einbinden.
Oder für jeden Adapter eine eigene Dokumentation. -
@hydrotec sagte in MQTT Broker/Client Adapter:
wie wir die Dokumentation aufbauen sollen.
ich fürchte ja, dass du bereits in der Adapterref unterwegs bist.
Da gibt es kein allgemein, nur Adapterspezifische Anleitungen.Ich hatte damals immer eine (mehr oder weniger) kurze Einleitung zu dem Hintergrund der Technik o.ä. gemacht.
Allerdings ist das MQTT wieder speziell, weil es da den Client/Broker und den Client Adapter gibt.Ich denke dass dann die Hintergrundinfo wohl besser beim Client/Broker untergebracht is
-
@RoddiEF oder einfach nur unterteilen in Grundlagen und Fortgeschrittene.
Ich bin jedenfalls bei dir. Die Grundlagen sollten so beschrieben sein, dass mein 7-Jähriger Sohn das rafft
️.
Ich schaue Mal, ob ich meine Notizen noch habe. -
Es ist nicht leicht, eine, für beide Seiten (Einsteiger/Raketenwissenschaftler) verständliche Doku zu erstellen.
Ich versuche mein Bestes, damit der Einsteiger sich relativ schnell mit der MQTT Welt auseinander setzen kann.
Ebenso muss ich aber auch vertiefte Einblicke geben, damit ein "Profi" einen Sinn in dieser Doku sieht.
Werde mir noch Gedanken machen, wie das umzusetzen ist.Gruß, Karsten
-
@deralff sagte in MQTT Broker/Client Adapter:
oder einfach nur unterteilen in Grundlagen und Fortgeschrittene.
@crunchip hat mir dort: https://forum.iobroker.net/topic/51619/formatierungshilfe-gesucht/6?_=1643051054226 ein Snippet zur Verfügung gestellt, dass den Fortgeschrittenen Teil verstecken könnte.
Hab es aber noch nirgendwo eingebaut - wäre aber von meiner Seite die sauberste Lösung um den Lesefluss für Einsteiger zu erhalten, und interessierte klappen dann weiter auf -
@hydrotec
Das es nicht Einfach wird beide Seiten zufrieden zustellen ist mir klar.
Was aber wichtig ist (m.M.) , das die Anleitung in Deutsch ist.
Englische Sachen findet man vieles im Internet (wenn man Sucht), aber in Deutsch und vor allem Verständlich, wird es schwierig. -
Ich denke, da sollten wir uns einmal, in einer ruhigen Minute dazu unterhalten.
So ganz verstehe ich es noch nicht, warum die Struktur der Doku,
wenn sie einmal erstellt ist, sich nicht mehr abändern lässt.
Wie gesagt, ich hätte noch die ein oder andere Frage generell,
vermulich wird es das Beste sein, wir unterhalten uns über Teams, oder Ähnlichem. -
@homoran das ist ne Idee!
Ich als Nicht-Web-GUI-Talentierter.... Da kann man bestimmt auch nen Button hin machen, der alles aufklappen, oder? -
@hydrotec sagte in MQTT Broker/Client Adapter:
So ganz verstehe ich es noch nicht, warum die Struktur der Doku,
wenn sie einmal erstellt ist, sich nicht mehr abändern lässt.das hier hast du aber gelesen?
https://forum.iobroker.net/topic/51731/grundlagen-der-struktur-für-die-doku -
Ich erstelle die Doku in Deutsch.
Doch wir dürfen fremdsprachige Einsteiger nicht aussen vor lassen.
Wir wollen doch eine große Familie werden, oder -
@deralff sagte in MQTT Broker/Client Adapter:
das ist ne Idee!
die habe ich schon seit der zweiten Doku, aber nicht das Wissen sie umzusetzen.
-
@hydrotec Ehrlich gesagt finde ich gerade diesen Adapter im jetzigen Umfeld beschreiben zu wollen als problematisch, da er nicht dem Regelwerk der Hierarchies folgt und auch selbstständig keine Objekte anlegt. Aber ich will das hier nicht noch mal diskutieren. Die Frage ist halt nur ob es Sinn macht etwas zu dokumentieren, was sich eben zur Zeit nicht mit mqtt verträgt.
Ich habe hier die derzeitige Problematik ja nochmals erklärt:
https://forum.iobroker.net/topic/50721/core-entwicklung-zu-schnell/53?_=1642957059965Für Shellies jedenfalls mit der Version 1 - wird es jedenfalls Probleme geben. Man kann zwar das wieder extern lösen, aber die prinzipielle Problemtik ist in meinen Augen nicht gelöst.
-
@mickym sagte in MQTT Broker/Client Adapter:
Aber ich will das hier nicht noch mal diskutieren.
es geht ja nicht um die Dinge, die du da monierst, sondern um das Prinzip vom MQTT und die Bedienung des Adapters
-
@homoran sagte in MQTT Broker/Client Adapter:
@mickym sagte in MQTT Broker/Client Adapter:
Aber ich will das hier nicht noch mal diskutieren.
es geht ja nicht um die Dinge, die du da monierst, sondern um das Prinzip vom MQTT und die Bedienung des Adapters
Nun zur Bedienung eines MQTT Adapters gehört es über eigens angelegte Datenpunkt - topics zu publishen und das geht halt nicht in jedem Fall. Das gehört doch zur Bedienung des Adapters und ist eine grundlegende Eigenschaft über eigens angelegte Datenpunkte mqtt topics zu publishen.
-
@hydrotec said in MQTT Broker/Client Adapter:
Doch wir dürfen fremdsprachige Einsteiger nicht aussen vor lassen.
Das mag ja sein und war nicht mein Ansinnen , aber die meisten Adapter und Dokus dazu sind ja auf Englisch.
Ich habe viele Stunden mit DeepL verbracht, da mein Schulenglisch (ist fast 40jahre her) mich nicht weitergebracht haben und sich mir dadurch der Sinn nicht erschlossen hat.
