Difference between revisions of "MQTT Adapter"
From Datonis
m (Tag: Visual edit) |
m (Advance configuration section) (Tag: Visual edit) |
||
| Line 6: | Line 6: | ||
** To install the MQTT broker in Windows, you can download the latest exe file from the official mosquitto site https://mosquitto.org/download/. Then you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/. To configure the MQTTS you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/. | ** To install the MQTT broker in Windows, you can download the latest exe file from the official mosquitto site https://mosquitto.org/download/. Then you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/. To configure the MQTTS you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/. | ||
| − | == | + | == Advanced Configuration == |
| − | This is | + | You can configure the details about the MQTT broker in the advanced configuration tab. You can set the following configurations in this tab: |
| + | {| class="wikitable" | ||
| + | !Configuration | ||
| + | !Type | ||
| + | !Description | ||
| + | |- | ||
| + | |config-json* | ||
| + | |JSON | ||
| + | |Advanced configuration json to fine tune adapter. | ||
| + | |- | ||
| + | |MQTT Address* | ||
| + | |String | ||
| + | |The address the MQTT broker listens for incoming connections. Be sure to check if the firewall is configured correctly to allow access to this address. The default value is 0.0.0.0. | ||
| + | |- | ||
| + | |MQTT Port* | ||
| + | |Number | ||
| + | |The port of the MQTT broker. Be sure to check if the firewall is configured correctly to allow access to this port. The default value is 1883. | ||
| + | |- | ||
| + | |MQTT Secure Port* | ||
| + | |Number | ||
| + | |The secure transport port of the MQTT broker. Be sure to check if the firewall is configured correctly to allow access to this port. The default value is 8883. | ||
| + | |- | ||
| + | |User Name | ||
| + | |String | ||
| + | |This is an optional field. The user name is required to access the broker. | ||
| + | |- | ||
| + | |Password | ||
| + | |String | ||
| + | |This is an optional field. The password is required to connect. If the password is empty, no password will be required to connect. | ||
| + | |- | ||
| + | |Scheduled Thread Pool Size | ||
| + | |Number | ||
| + | |The server scheduled thread pool is used for most activities on the server-side that require running periodically or with delays. The default value is 3. | ||
| + | |- | ||
| + | |General Thread Pool Size | ||
| + | |Number | ||
| + | |This general purpose thread pool is used for most asynchronous actions on the server side. The default value is 10. | ||
| + | |- | ||
| + | |Use Integrated MQTT Broker* | ||
| + | |Boolean | ||
| + | |Switch to enable or disable the usage of the integrated MQTT broker, if disabled(i.e. false) external broker can be used. The default value is true. If it is set to true then we can use the integrated MQTT broker to connect to the other Datonis edge services. | ||
| + | |- | ||
| + | |Client Clean Session* | ||
| + | |Boolean | ||
| + | |If set to false, the client will continue with the old session and the broker may deliver older messages. The default value is true. | ||
| + | |} | ||
Revision as of 12:49, 5 April 2022
Edge Gateway Home > MQTT Adapter
Prerequisite
- MQTT broker should be installed in your setup and accessible to Datonis Edge.
- To install the MQTT broker in Ubuntu you can follow the steps given at https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-the-mosquitto-mqtt-messaging-broker-on-ubuntu-18-04. You can generate the certificates required for MQTTS connection using the steps given at http://www.steves-internet-guide.com/mosquitto-tls/
- To install the MQTT broker in Windows, you can download the latest exe file from the official mosquitto site https://mosquitto.org/download/. Then you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/. To configure the MQTTS you can follow the steps given at https://bytesofgigabytes.com/mqtt/installing-mqtt-broker-on-windows/.
Advanced Configuration
You can configure the details about the MQTT broker in the advanced configuration tab. You can set the following configurations in this tab:
| Configuration | Type | Description |
|---|---|---|
| config-json* | JSON | Advanced configuration json to fine tune adapter. |
| MQTT Address* | String | The address the MQTT broker listens for incoming connections. Be sure to check if the firewall is configured correctly to allow access to this address. The default value is 0.0.0.0. |
| MQTT Port* | Number | The port of the MQTT broker. Be sure to check if the firewall is configured correctly to allow access to this port. The default value is 1883. |
| MQTT Secure Port* | Number | The secure transport port of the MQTT broker. Be sure to check if the firewall is configured correctly to allow access to this port. The default value is 8883. |
| User Name | String | This is an optional field. The user name is required to access the broker. |
| Password | String | This is an optional field. The password is required to connect. If the password is empty, no password will be required to connect. |
| Scheduled Thread Pool Size | Number | The server scheduled thread pool is used for most activities on the server-side that require running periodically or with delays. The default value is 3. |
| General Thread Pool Size | Number | This general purpose thread pool is used for most asynchronous actions on the server side. The default value is 10. |
| Use Integrated MQTT Broker* | Boolean | Switch to enable or disable the usage of the integrated MQTT broker, if disabled(i.e. false) external broker can be used. The default value is true. If it is set to true then we can use the integrated MQTT broker to connect to the other Datonis edge services. |
| Client Clean Session* | Boolean | If set to false, the client will continue with the old session and the broker may deliver older messages. The default value is true. |
