Beschreibung der Mqtt-Config-Parameter hinzugefügt.

svc/mqttcl/cfg/README.md

@@ -0,0 +1,112 @@
+**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.
+	* Default: 2.
+
+* **defaultRetain:**
+	* Optional.
+	* Default Retained-Einstellung.
+	* Default: false.
+
+* **devicePrefix:**
+	* Optional.
+	* Wird u. a. verwendet, um zusammen mit der SHM-UUID das Topic-Prefix zu generieren.
+	* Default: "GfA".
+
+* **deviceID:**
+	* Optional.
+	* Wird u. a. verwendet, um zusammen mit der SHM-UUID das Topic-Prefix zu generieren.
+	* Default: Automatisch generiert aus devicePrefix und MAC-Adresse.
+
+* **topicPrefix:**
+	* Optional.
+	* Ersetzt, wenn angegeben, das Topic-Prefix.
+
+* **tlsMode:**
+	* Optional.
+	* 0 = kein TLS, 1 = TLS mit Zertifikat, 2 = TLS mit Preshared Key.
+	* Default: 0 (kein TLS).
+
+* **tlsCaCrtFile, tlsClKeyFile, tlsClCrtFile:**
+	* Erforderlich wenn tlsMode = 1.
+	* Pfad zu den folgenden Dateien:
+		* ***tlsCaCrtFile***: öffentliches Zertifikat der Certificate Authority.
+		* ***tlsClKeyFile***: privater Schlüssel des Client.
+		* ***tlsClCrtFile***: öffentliches Zertifikat zu diesem Schlüssel.
+
+* **tlsPsk:**
+	* Erforderlich wenn tlsMode = 2.
+	* Preshared Key als String im Hex-Format ohne führendes "0x".
+
+* **lastWillMessage:**
+	* Optional.
+	* Wenn angegeben, wird diese Nachricht als "Last Will" gepublished.
+
+* **lastWillTopic:**
+	* Optional.
+	* Nur wenn lastWillMessage konfiguriert.
+	* Topic des "Last Will".
+	* Default: "LAST_WILL_CONNECT".
+
+* **lastWillQos:**
+	* Optional.
+	* Nur wenn lastWillMessage konfiguriert.
+	* Quality of Service des "Last Will".
+	* Default: Wert des defaultQos.
+
+* **lastWillRetain:**
+	* Optional.
+	* Nur wenn lastWillMessage konfiguriert.
+	* Retained-Einstellung des "Last Will".
+	* Default: false.
+
+* **lastWillOnExit:**
+	* Optional.
+	* Nur wenn lastWillMessage konfiguriert.
+	* Wenn true, wird beim normalen Beenden des Clients eine "Last Will"-Message mit dem Wert von lastWillOnExitMsg gepublished.
+	* Default: true.
+
+* **lastWillOnExitMsg:**
+	* Optional.
+	* Nur wenn lastWillMessage konfiguriert und lastWillOnExit = true.
+	* Nachricht, die beim	normalen Beenden des Clients gepublished wird.
+	* Default: lastWillMessage.
+
+* **connectMessage:**
+	* Optional.
+	* Nachricht, die, wenn konfiguriert, beim Start des Clients gepublished wird.
+
+* **connectTopic:**
+	* Optional.
+	* Nur wenn connectMessage konfiguriert.
+	* Topic der Nachricht, die beim Start des Clients gepublished wird.
+	* Default: lastWillTopic, wenn konfiguriert, sonst "LAST_WILL_CONNECT".
+
+* **connectQos:**
+	* Optional.
+	* Nur wenn connectMessage konfiguriert.
+	* Quality of Service der Startnachricht.
+	* Default: defaultQos.
+
+* **connectRetain:**
+	* Optional.
+	* Nur wenn connectMessage konfiguriert.
+	* 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.

svc/mqttcl/cfg/mqtt.conf.txt

@@ -1,86 +0,0 @@
-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.