gfaservices/svc/mqttcl/cfg/README.md

Mögliche Parameter in mqttcl.cfg.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: Leer, wenn nicht angegeben.

• 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, oder nur MAC-Adresse, wenn kein devicePrefix angegeben.

• disableTopicPrefix:

  • Optional.
  • Wenn true, wird kein Topic-Prefix gesendet.
  • Default: false.

• topicPrefix:

  • Optional.
  • Nur wenn disableTopicPrefix = false.
  • Ersetzt, wenn angegeben, das Topic-Prefix.

• tlsMode:

  • Optional.
  • 0 = kein TLS, 1 = TLS mit Zertifikat, 2 = TLS mit Preshared Key. Ungültige Werte werden auf 0 korrigiert!
  • 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".

• lastWillMsgStr:

  • Optional.
  • Wenn angegeben, wird diese Nachricht als "Last Will" gepublished.

• lastWillMsgInt:

  • Optional.
  • Nur wenn lastWillMsgStr nicht angegeben.
  • Wenn angegeben, wird dieser Wert als signed 64Bit-Wert binär als "Last Will" gepublished.

• lastWillTopic:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert.
  • Topic des "Last Will".
  • Default: "LWC".

• lastWillQos:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert.
  • Quality of Service des "Last Will".
  • Default: Wert des defaultQos.

• lastWillRetain:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert.
  • Retained-Einstellung des "Last Will".
  • Default: defaultRetain.

• lastWillOnExit:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert.
  • Wenn true, wird auch beim normalen Beenden des Clients eine "Last Will"-Message mit dem Wert von lastWillOnExitMsgStr oder lastWillOnExitMsgInt gepublished.
  • Default: true.

• lastWillOnExitMsgStr:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert ist und lastWillOnExit = true.
  • Nachricht, die beim normalen Beenden des Clients gepublished wird.
  • Default: Wenn weder lastWillOnExitMsgStr noch lastWillOnExitMsgInt angegeben sind, wird lastWillOnExitMsgStr auf lastWillMsgStr gesetzt, sofern dieser konfiguriert ist, ansonsten wird lastWillOnExitMsgInt auf lastWillMsgInt gesetzt.

• lastWillOnExitMsgInt:

  • Optional.
  • Nur wenn lastWillMsgStr oder lastWillMsgInt konfiguriert ist und lastWillOnExit = true.
  • Nur wenn lastWillOnExitMsgStr nicht angegeben.
  • Wird als signed 64Bit-Wert binär beim normalen Beenden des Clients gepublished.
  • Default: Wenn weder lastWillOnExitMsgStr noch lastWillOnExitMsgInt angegeben sind, wird lastWillOnExitMsgStr auf lastWillMsgStr gesetzt, sofern dieser konfiguriert ist, ansonsten wird lastWillOnExitMsgInt auf lastWillMsgInt gesetzt.

• connectMsgStr:

  • Optional.
  • Nachricht, die, wenn konfiguriert, beim Start des Clients gepublished wird.

• connectMsgInt:

  • Optional.
  • Nur wenn connectMsgStr nicht angegeben.
  • Wenn angegeben, wird dieser Wert als signed 64Bit-Wert binär beim Start des Clients gepublished.

• connectTopic:

  • Optional.
  • Nur wenn connectMsgStr oder connectMsgInt konfiguriert.
  • Topic der Nachricht, die beim Start des Clients gepublished wird.
  • Default: lastWillTopic, wenn konfiguriert, sonst "LWC".

• connectQos:

  • Optional.
  • Nur wenn connectMsgStr oder connectMsgInt konfiguriert.
  • Quality of Service der Startnachricht.
  • Default: defaultQos.

• connectRetain:

  • Optional.
  • Nur wenn connectMsgStr oder connectMsgInt konfiguriert.
  • Retained-Einstellung der Startnachricht.
  • Default: defaultRetain.

• maxKeepAlive:

  • Optional.
  • Maximales Zeitintervall in Sekunden, in dem der Broker Keep-Alive-Pakete an den Client sendet. Werte < 10 werden auf 10 korrigiert.
  • Default: 60.