Browse Source

Beschreibung für Mqtt-Parameter hinzugefügt.

Rind 3 years ago
parent
commit
d54c9ae32e
2 changed files with 97 additions and 5 deletions
  1. 11 5
      svc/mqttcl/cfg/mqtt.conf.json
  2. 86 0
      svc/mqttcl/cfg/mqtt.conf.txt

+ 11 - 5
svc/mqttcl/cfg/mqtt.conf.json

@@ -4,9 +4,15 @@
 	"defaultQos":		2,
 	"defaultRetain":	false,
 	"devicePrefix":		"OEM",
-	"tlsMode":			0,
-	"tlsCaCrtFile":		"/opt/GfA/OEM/mqttcl/client/ca.crt",
-	"tlsClCrtFile":		"/opt/GfA/OEM/mqttcl/client/client.crt",
-	"tlsClKeyFile":		"/opt/GfA/OEM/mqttcl/client/client.key",
-	"tlsPsk":			"1234567890abcdef"
+	"tlsMode":			1,
+	"tlsCaCrtFile":		"/path/to/ca.crt",
+	"tlsClCrtFile":		"/path/to/client.crt",
+	"tlsClKeyFile":		"/path/to/client.key",
+	"lastWillTopic":	"LWC",
+	"lastWillMessage":	"X",
+	"lastWillRetain":	true,
+	"lastWillOnExit":	true,
+	"lastWillOnExitMsg": "E",
+	"connectMessage":	"C",
+	"connectRetain":	true
 }

+ 86 - 0
svc/mqttcl/cfg/mqtt.conf.txt

@@ -0,0 +1,86 @@
+Mögliche Parameter in mqtt.conf.json:
+
+
+brokerAddr:
+	Name oder IP-Adresse des Brokers.
+
+brokerPort:
+	Optional. TCPIP-Port des Brokers.
+	Default: 8883 wenn tlsMode > 0, sonst 1883.
+
+defaultQos:
+	Optional. Default Quality of Service. 0, 1 oder 2, siehe MQTT-Dokumentation.
+	2 wenn nicht angegeben.
+
+defaultRetain:
+	Optional. Default Retained-Einstellung. false wenn nicht angegeben.
+
+devicePrefix:
+	Wird u. a. verwendet, um zusammen mit der SHM-UUID das Topic-Prefix zu generieren. Optional.
+	Default: "GfA".
+
+deviceID:
+	Wird u. a. verwendet, um zusammen mit der SHM-UUID das Topic-Prefix zu generieren. Optional.
+	Default: Automatisch generiert aus devicePrefix und MAC-Adresse.
+
+topicPrefix:
+	Optional. Ersetzt, wenn angegeben, das Topic-Prefix.
+
+tlsMode:
+	Optional. 0 = ohne TLS, 1 = TLS mit Zertifikat, 2 = TLS mit Preshared Key.
+	0 (kein TLS) wenn nicht angegeben.
+
+tlsCaCrtFile:
+tlsClKeyFile:
+tlsClCrtFile:
+	Benötigt, wenn tlsMode = 1. Pfad zu den folgenden Dateien:
+	tlsCaCrtFile: öffentliches Zertifikat der Certificate Authority.
+	tlsClKeyFile: privater Schlüssel.
+	tlsClCrtFile: öffentliches Zertifikat zu diesem Schlüssel.
+
+tlsPsk:
+	Benötigt, wenn tlsMode = 2. Preshared Key:
+
+lastWillMessage:
+	Optional. Wenn angegeben, wird diese Nachricht als "Last Will" gepublished.
+
+lastWillTopic:
+	Nur wenn lastWillMessage konfiguriert. Optional. Topic des "Last Will".
+	Default: "LAST_WILL_CONNECT".
+
+lastWillQos:
+	Nur wenn lastWillMessage konfiguriert. Optional. Quality of Service des "Last Will".
+	Default: Wert des defaultQos.
+
+lastWillRetain:
+	Nur wenn lastWillMessage konfiguriert. Optional. Retained-Einstellung des "Last Will".
+	Default: false.
+
+lastWillOnExit:
+	Nur wenn lastWillMessage konfiguriert. Optional. Wenn true, wird beim normalen Beenden des Clients
+	eine "Last Will"-Message mit dem Wert von lastWillOnExitMsg gepublished.
+	Default: true.
+
+lastWillOnExitMsg:
+	Nur wenn lastWillMessage konfiguriert und lastWillOnExit = true. Optional. Nachricht, die beim
+	normalen Beenden des Clients gepublished wird.
+	Default: lastWillMessage.
+
+connectMessage:
+	Optional. Nachricht, die beim Start des Clients gepublished wird.
+
+connectTopic:
+	Nur wenn connectMessage konfiguriert. Optional. Topic der Nachricht, die beim Start des Clients gepublished wird.
+	Default: lastWillTopic, wenn konfiguriert, sonst "LAST_WILL_CONNECT".
+
+connectQos:
+	Nur wenn connectMessage konfiguriert. Optional. Quality of Service der Startnachricht.
+	Default: Wert des defaultQos.
+
+connectRetain:
+	Nur wenn connectMessage konfiguriert. Optional. Retained-Einstellung der Startnachricht.
+	Default: false.
+
+maxKeepAlive:
+	Optional. Maximales Zeitintervall in Sekunden, in dem der Broker Keep-Alive-Pakete an den Client sendet.
+	Default: 60.