Difference between revisions of "MQTTBROKER"

From HSYCO
Jump to navigation Jump to search
Line 5: Line 5:
 
== HSYCO Configuration ==
 
== HSYCO Configuration ==
 
Add the MQTTBROKER I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
 
Add the MQTTBROKER I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
 
=== Communication ===
 
*'''IP Port''': TCP/IP port assigned to the broker
 
  
 
=== Authentication ===
 
=== Authentication ===
Line 34: Line 31:
  
 
|rowspan="2"|acceptunknown
 
|rowspan="2"|acceptunknown
 +
|rowspan="2"|false
 +
|true
 +
|accept connection from clients whose id isn't specified in mqttbrokerauth.ini
 +
|-
 +
|false
 +
|doesn't accept connection from clients whose id isn't specified in mqttbrokerauth.ini
 +
 +
|-
 +
 +
|rowspan="2"|localport
 
|rowspan="2"|false
 
|rowspan="2"|false
 
|true
 
|true
Line 56: Line 63:
 
|online
 
|online
 
|R
 
|R
|connection established
+
|the broker accepted a connection from a client
 
|-
 
|-
 
|offline
 
|offline

Revision as of 10:47, 22 July 2019

This driver acts as an MQTT broker for Hsyco. It can connects with many clients but can only receive messages without forwarding them.

HSYCO Configuration

Add the MQTTBROKER I/O Server in the I/O Servers section of the Settings and set its parameters:

Authentication

  • Username: optional default username for clients
  • Password: optional default password for clients

Options

ID Default Values Description
startupevents false true generate IO events also during the driver’s start-up phase
false start generating events only after HSYCO is aligned with the current status of the system
acceptunknown false true accept connection from clients whose id isn't specified in mqttbrokerauth.ini
false doesn't accept connection from clients whose id isn't specified in mqttbrokerauth.ini
localport false true accept connection from clients whose id isn't specified in mqttbrokerauth.ini
false doesn't accept connection from clients whose id isn't specified in mqttbrokerauth.ini

Datapoints

ID Value R/W Description
connection online R the broker accepted a connection from a client
offline R initialization of the driver failed or loop cycle failed
client.<clientId>.connected 1 R clientId is connected to the broker
0 R clientId isn't connected to the broker
client.<clientId>.topic.<topicName> <message> R clientId published a message on topicName