{"id":31770,"date":"2021-04-27T17:49:19","date_gmt":"2021-04-27T22:49:19","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=31770"},"modified":"2021-04-27T18:23:17","modified_gmt":"2021-04-27T23:23:17","slug":"mqtt-bridge","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/mqttbroker\/mqtt-bridge\/","title":{"rendered":"MQTT bridge"},"content":{"rendered":"<p><b>\/mqttBroker\/bridge<\/b><\/p>\n<p>Description: MQTT bridge settings : ARRAY<\/p>\n<table border=\"1\" cellspacing=\"0\" cellpadding=\"0\">\n<tbody>\n<tr>\n<td style=\"background-color: #1f5ddf;\"><span style=\"color: #ffffff;\"><strong>Element<\/strong><\/span><\/td>\n<td style=\"background-color: #1f5ddf;\"><span style=\"color: #ffffff;\"><strong>Type<\/strong><\/span><\/td>\n<td style=\"background-color: #1f5ddf;\"><span style=\"color: #ffffff;\"><strong>Description<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">__v<\/td>\n<td valign=\"top\" width=\"75\">UINT<\/td>\n<td valign=\"top\" width=\"350\">Version of model [1]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">bridge<\/td>\n<td valign=\"top\" width=\"75\"><\/td>\n<td valign=\"top\" width=\"350\"><\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0authMethod<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Authentication method for MQTT bridge [no Auth]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0certificate<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Imported local RSA certificate contents (PEM)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0cleanSession<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enable or disable feature where all subscriptions and messages are cleaned up if the connection drops [false]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0clientID<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Unique identifier name of the MQTT broker<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0enabled<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enable or disable the MQTT broker to act as a bridge [false\/disabled]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0identity<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Identity for a Pre-Shared Key as part of the psk authentication method (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0notifications<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enables or disables notifications to local and remote brokers regarding the state of the bridge connection [true\/enabled]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0password<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Password for userPass authentication method (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0privateKey<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">RSA Private key (PEM) for Imported Certificate authentication method<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0protocolVersion<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Version of the MQTT protocol [mqttv31]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0psk<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">User defined Pre-Shared Key for the psk authentication method (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0secondaryAddress<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Backup or secondary address of the server for MQTT broker (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0secondaryPort<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Backup or secondary port for MQTT broker (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0serverAddress<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Primary server address for the MQTT broker<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0serverPort<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Primary server port for the MQTT broker<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0tlsEnabled<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enable or disable SSL\/TLS support during connection [false\/disabled]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0topics<\/td>\n<td valign=\"top\" width=\"75\">ARRAY<\/td>\n<td valign=\"top\" width=\"350\">Topics that the MQTT broker uses\u00a0to filter messages for the connected client<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0tryPrivate<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enabled or disable the bridge to indicate the remote broker that it is a bridge, not an ordinary client [true\/enabled]<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0username<\/td>\n<td valign=\"top\" width=\"75\">STRING<\/td>\n<td valign=\"top\" width=\"350\">Username for the userPass authentication method (optional)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"150\">\u00a0 \u00a0verifyHostname<\/td>\n<td valign=\"top\" width=\"75\">BOOL<\/td>\n<td valign=\"top\" width=\"350\">Enable or disable the bridge to verify the hostname provided in the remote certificate matches the host\/address being connected to [false\/disabled]<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"<p>\/mqttBroker\/bridge Description: MQTT bridge settings : ARRAY Element Type Description __v UINT Version of model [1] bridge \u00a0 \u00a0authMethod STRING Authentication method for MQTT bridge [no Auth] \u00a0 \u00a0certificate STRING Imported local RSA certificate contents (PEM) \u00a0 \u00a0cleanSession BOOL Enable or disable feature where all subscriptions and messages are cleaned up if the connection drops [&hellip;]<\/p>\n","protected":false},"author":1478,"featured_media":0,"parent":31772,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-31770","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31770","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1478"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=31770"}],"version-history":[{"count":3,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31770\/revisions"}],"predecessor-version":[{"id":31777,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31770\/revisions\/31777"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/31772"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=31770"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}