diff --git a/dev/404.html b/dev/404.html index 8ff85978..73b9128e 100644 --- a/dev/404.html +++ b/dev/404.html @@ -19,13 +19,13 @@ - + -

404

That's a Four-Oh-Four.
+ - + diff --git a/dev/assets/js/12.e41769b6.js b/dev/assets/js/12.210be392.js similarity index 79% rename from dev/assets/js/12.e41769b6.js rename to dev/assets/js/12.210be392.js index f603f9db..f6ff5e05 100644 --- a/dev/assets/js/12.e41769b6.js +++ b/dev/assets/js/12.210be392.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{299:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing.17f893db.png"},300:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing2.01f2ed1a.png"},301:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing3.b7cb2b69.png"},302:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing4.3284473c.png"},303:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy.7db34947.png"},304:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy2.8d94ec3f.png"},305:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy3.e0c6444a.png"},306:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate.92ac0d8c.png"},307:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate2.de17aacf.png"},308:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate3.db0aa9d1.png"},309:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Policy.84a712d2.png"},310:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Policy2.d0fefb57.png"},311:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Thing.f8ca1bc7.png"},312:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Thing2.535be9dd.png"},313:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Find_Endpoint.6a2edb1c.png"},314:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_result_MQTT.5772237b.png"},425:function(t,a,s){"use strict";s.r(a);var e=s(14),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integrate-aws-iot"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrate-aws-iot"}},[t._v("#")]),t._v(" Integrate AWS IOT")]),t._v(" "),a("h2",{attrs:{id:"create-a-thing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-thing"}},[t._v("#")]),t._v(" Create a thing")]),t._v(" "),a("ul",[a("li",[t._v("From AWS console, search for IOT core")]),t._v(" "),a("li",[t._v("Create a Thing and name it, this name will be used as the OpenMQTTGateway name.")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(299),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(300),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(301),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(302),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"create-a-policy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-policy"}},[t._v("#")]),t._v(" Create a policy")]),t._v(" "),a("p",[a("img",{attrs:{src:s(303),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(304),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(305),alt:"AWS tutorial step"}})]),t._v(" "),a("ul",[a("li",[t._v("Add this json code to the policy")])]),t._v(" "),a("div",{staticClass:"language-json line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2021-11-01"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Statement"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Effect"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Allow"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Action"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Connect"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Publish"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Subscribe"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Receive"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"greengrass:Discover"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Resource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"*"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br")])]),a("h2",{attrs:{id:"create-a-certificate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-certificate"}},[t._v("#")]),t._v(" Create a certificate")]),t._v(" "),a("ul",[a("li",[t._v("Create a new certificate")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(306),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(307),alt:"AWS tutorial step"}})]),t._v(" "),a("ul",[a("li",[t._v("Download certificates and key")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(308),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"attach-policy-with-certificate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#attach-policy-with-certificate"}},[t._v("#")]),t._v(" Attach Policy with certificate")]),t._v(" "),a("p",[a("img",{attrs:{src:s(309),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(310),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"activate-certificate-and-attach-it-to-thing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#activate-certificate-and-attach-it-to-thing"}},[t._v("#")]),t._v(" Activate certificate and attach it to Thing")]),t._v(" "),a("p",[a("img",{attrs:{src:s(311),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(312),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"find-aws-endpoint"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#find-aws-endpoint"}},[t._v("#")]),t._v(" Find AWS EndPoint")]),t._v(" "),a("p",[a("img",{attrs:{src:s(313),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"gather-the-information-for-openmqttgateway-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#gather-the-information-for-openmqttgateway-configuration"}},[t._v("#")]),t._v(" Gather the information for OpenMQTTGateway configuration")]),t._v(" "),a("p",[t._v("Now you should have the following information for the OpenMQTTGateway configuration:")]),t._v(" "),a("ul",[a("li",[t._v("Root certificate")]),t._v(" "),a("li",[t._v("Client certificate")]),t._v(" "),a("li",[t._v("Client key")]),t._v(" "),a("li",[t._v("End point url")]),t._v(" "),a("li",[t._v("Gateway name")])]),t._v(" "),a("h2",{attrs:{id:"modify-openmqttgateway-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#modify-openmqttgateway-configuration"}},[t._v("#")]),t._v(" Modify OpenMQTTGateway configuration")]),t._v(" "),a("p",[t._v("With PlatformIO you can directly leverage the environment "),a("code",[t._v("esp32dev-ble-aws")]),t._v(" as an example and modify it following your needs.")]),t._v(" "),a("h2",{attrs:{id:"build-and-upload"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#build-and-upload"}},[t._v("#")]),t._v(" Build and upload")]),t._v(" "),a("h2",{attrs:{id:"connect-to-a-wifi-access-point-see-portal"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#connect-to-a-wifi-access-point-see-portal"}},[t._v("#")]),t._v(" Connect to a WiFi Access point "),a("a",{attrs:{href:"../upload/portal"}},[t._v("see portal")])]),t._v(" "),a("p",[t._v("Enter your credentials and verify that Secure connection is marked.")]),t._v(" "),a("h2",{attrs:{id:"verify-that-you-receive-data-in-aws"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#verify-that-you-receive-data-in-aws"}},[t._v("#")]),t._v(" Verify that you receive data in AWS")]),t._v(" "),a("ul",[a("li",[t._v("Go to things")]),t._v(" "),a("li",[t._v("Click on the thing created")]),t._v(" "),a("li",[t._v("Go to Activity")]),t._v(" "),a("li",[t._v("Click on MQTT Test Client")]),t._v(" "),a("li",[t._v("Subscribe to "),a("code",[t._v("+/#")])])]),t._v(" "),a("p",[t._v("You should see messages coming.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(314),alt:"AWS tutorial step"}})])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{307:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing.17f893db.png"},308:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing2.01f2ed1a.png"},309:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing3.b7cb2b69.png"},310:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Thing4.3284473c.png"},311:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy.7db34947.png"},312:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy2.8d94ec3f.png"},313:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Policy3.e0c6444a.png"},314:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate.92ac0d8c.png"},315:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate2.de17aacf.png"},316:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Create_Certificate3.db0aa9d1.png"},317:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Policy.84a712d2.png"},318:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Policy2.d0fefb57.png"},319:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Thing.f8ca1bc7.png"},320:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Attach_Thing2.535be9dd.png"},321:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_Find_Endpoint.6a2edb1c.png"},322:function(t,a,s){t.exports=s.p+"assets/img/Integrate_AWS_IOT_result_MQTT.5772237b.png"},426:function(t,a,s){"use strict";s.r(a);var e=s(14),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integrate-aws-iot"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrate-aws-iot"}},[t._v("#")]),t._v(" Integrate AWS IOT")]),t._v(" "),a("h2",{attrs:{id:"create-a-thing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-thing"}},[t._v("#")]),t._v(" Create a thing")]),t._v(" "),a("ul",[a("li",[t._v("From AWS console, search for IOT core")]),t._v(" "),a("li",[t._v("Create a Thing and name it, this name will be used as the OpenMQTTGateway name.")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(307),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(308),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(309),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(310),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"create-a-policy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-policy"}},[t._v("#")]),t._v(" Create a policy")]),t._v(" "),a("p",[a("img",{attrs:{src:s(311),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(312),alt:"AWS tutorial step"}})]),t._v(" "),a("p",[a("img",{attrs:{src:s(313),alt:"AWS tutorial step"}})]),t._v(" "),a("ul",[a("li",[t._v("Add this json code to the policy")])]),t._v(" "),a("div",{staticClass:"language-json line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2021-11-01"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Statement"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Effect"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Allow"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Action"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Connect"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Publish"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Subscribe"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"iot:Receive"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"greengrass:Discover"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Resource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"*"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br")])]),a("h2",{attrs:{id:"create-a-certificate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-certificate"}},[t._v("#")]),t._v(" Create a certificate")]),t._v(" "),a("ul",[a("li",[t._v("Create a new certificate")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(314),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(315),alt:"AWS tutorial step"}})]),t._v(" "),a("ul",[a("li",[t._v("Download certificates and key")])]),t._v(" "),a("p",[a("img",{attrs:{src:s(316),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"attach-policy-with-certificate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#attach-policy-with-certificate"}},[t._v("#")]),t._v(" Attach Policy with certificate")]),t._v(" "),a("p",[a("img",{attrs:{src:s(317),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(318),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"activate-certificate-and-attach-it-to-thing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#activate-certificate-and-attach-it-to-thing"}},[t._v("#")]),t._v(" Activate certificate and attach it to Thing")]),t._v(" "),a("p",[a("img",{attrs:{src:s(319),alt:"AWS tutorial step"}}),t._v(" "),a("img",{attrs:{src:s(320),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"find-aws-endpoint"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#find-aws-endpoint"}},[t._v("#")]),t._v(" Find AWS EndPoint")]),t._v(" "),a("p",[a("img",{attrs:{src:s(321),alt:"AWS tutorial step"}})]),t._v(" "),a("h2",{attrs:{id:"gather-the-information-for-openmqttgateway-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#gather-the-information-for-openmqttgateway-configuration"}},[t._v("#")]),t._v(" Gather the information for OpenMQTTGateway configuration")]),t._v(" "),a("p",[t._v("Now you should have the following information for the OpenMQTTGateway configuration:")]),t._v(" "),a("ul",[a("li",[t._v("Root certificate")]),t._v(" "),a("li",[t._v("Client certificate")]),t._v(" "),a("li",[t._v("Client key")]),t._v(" "),a("li",[t._v("End point url")]),t._v(" "),a("li",[t._v("Gateway name")])]),t._v(" "),a("h2",{attrs:{id:"modify-openmqttgateway-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#modify-openmqttgateway-configuration"}},[t._v("#")]),t._v(" Modify OpenMQTTGateway configuration")]),t._v(" "),a("p",[t._v("With PlatformIO you can directly leverage the environment "),a("code",[t._v("esp32dev-ble-aws")]),t._v(" as an example and modify it following your needs.")]),t._v(" "),a("h2",{attrs:{id:"build-and-upload"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#build-and-upload"}},[t._v("#")]),t._v(" Build and upload")]),t._v(" "),a("h2",{attrs:{id:"connect-to-a-wifi-access-point-see-portal"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#connect-to-a-wifi-access-point-see-portal"}},[t._v("#")]),t._v(" Connect to a WiFi Access point "),a("a",{attrs:{href:"../upload/portal"}},[t._v("see portal")])]),t._v(" "),a("p",[t._v("Enter your credentials and verify that Secure connection is marked.")]),t._v(" "),a("h2",{attrs:{id:"verify-that-you-receive-data-in-aws"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#verify-that-you-receive-data-in-aws"}},[t._v("#")]),t._v(" Verify that you receive data in AWS")]),t._v(" "),a("ul",[a("li",[t._v("Go to things")]),t._v(" "),a("li",[t._v("Click on the thing created")]),t._v(" "),a("li",[t._v("Go to Activity")]),t._v(" "),a("li",[t._v("Click on MQTT Test Client")]),t._v(" "),a("li",[t._v("Subscribe to "),a("code",[t._v("+/#")])])]),t._v(" "),a("p",[t._v("You should see messages coming.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(322),alt:"AWS tutorial step"}})])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/13.f2f65af0.js b/dev/assets/js/13.62b2c490.js similarity index 79% rename from dev/assets/js/13.f2f65af0.js rename to dev/assets/js/13.62b2c490.js index b787a9e0..2047a257 100644 --- a/dev/assets/js/13.f2f65af0.js +++ b/dev/assets/js/13.62b2c490.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{359:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-ip.8d63f8c6.png"},360:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding.4a6275c5.png"},361:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding2.266324d8.png"},362:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding3.506b08c5.png"},363:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding4.3be7eff4.png"},364:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding5.8c71ca36.png"},365:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding6.48cd3dee.png"},366:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-jinja.270ad9f2.png"},367:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things.b9bcbb97.png"},368:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things2.550b24da.png"},369:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things3.e83eb23c.png"},370:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things4.45af5919.png"},371:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things5.bf15e337.png"},372:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt.719d8beb.png"},434:function(t,e,n){"use strict";n.r(e);var a=n(14),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"integrate-openhab-3-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrate-openhab-3-4"}},[t._v("#")]),t._v(" Integrate OPENHAB 3/4")]),t._v(" "),e("p",[t._v("This tutorial will show how to integrate the BLE gateway to OpenHAB 3 or 4 leveraging the auto discovery functionality.\nAfter this tutorial, you should see your Bluetooth Low Energy devices in OpenHAB without any file based manual configuration.")]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("ul",[e("li",[t._v("OpenHAB 3.3 or higher")]),t._v(" "),e("li",[t._v("MQTT broker installed with or without authentication")]),t._v(" "),e("li",[t._v('A location defined in the "Model" section under "Settings"')])]),t._v(" "),e("h2",{attrs:{id:"ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"}},[t._v("#")]),t._v(" IP address (if your broker is installed on the same server as OpenHAB)")]),t._v(" "),e("p",[t._v("The goal is to disable the IPv6 address of the broker server, so that the gateway can connect through IPv4.")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Network Settings")]),t._v(" "),e("li",[t._v("Click on Show Advanced")]),t._v(" "),e("li",[t._v("Disable IPv6")]),t._v(" "),e("li",[t._v("Click on Save")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(359),alt:"OpenHAB integration"}})]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If the broker is installed on another server you will also need to configure it with an IPv4 address.")])]),t._v(" "),e("h2",{attrs:{id:"install-the-mqtt-binding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-the-mqtt-binding"}},[t._v("#")]),t._v(" Install the MQTT binding")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Bindings")]),t._v(" "),e("li",[t._v("Install the MQTT binding (you can search at the bottom right)")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(360),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("Once installed click on Things under Settings")]),t._v(" "),e("li",[t._v("Click on the + at the bottom right")]),t._v(" "),e("li",[t._v("Click on MQTT Binding")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(361),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"7"}},[e("li",[t._v("Click on MQTT broker")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(362),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"8"}},[e("li",[t._v('Enter for the "Broker Hostname/IP" field, the IP address of your broker, if it is installed on the same server you can enter '),e("code",[t._v("localhost")])])]),t._v(" "),e("p",[e("img",{attrs:{src:n(363),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"9"}},[e("li",[t._v('Click on "Show Advanced" if your broker has authentication activated, if not you can go to step 11')]),t._v(" "),e("li",[t._v("Enter the broker credentials: username and password")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(364),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"11"}},[e("li",[t._v('Click on Create Thing at the bottom, you should see your MQTT Broker in the Things list with the status "online"')])]),t._v(" "),e("p",[e("img",{attrs:{src:n(365),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Bravo👏, second step done! Now let's add the Jinja transformation service.")]),t._v(" "),e("h2",{attrs:{id:"install-jinja-and-jsonpath-transformations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-jinja-and-jsonpath-transformations"}},[t._v("#")]),t._v(" Install Jinja and JSONPath Transformations")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Bindings")]),t._v(" "),e("li",[t._v("Install Jinja Transformation (you can search at the bottom right)")]),t._v(" "),e("li",[t._v("Install JSONPath Transformation")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(366),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Second step done!")]),t._v(" "),e("h2",{attrs:{id:"upload-openmqttgateway-to-an-esp32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#upload-openmqttgateway-to-an-esp32"}},[t._v("#")]),t._v(" Upload OpenMQTTGateway to an ESP32")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/upload/web-install.html"}},[t._v("Upload OpenMQTTGateway from the web")]),t._v(" by selecting the environment corresponding to your need.")],1),t._v(" "),e("p",[t._v("Or use another upload method from the Upload section.")]),t._v(" "),e("h2",{attrs:{id:"configure-openmqttgateway-from-the-web-portal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure-openmqttgateway-from-the-web-portal"}},[t._v("#")]),t._v(" Configure OpenMQTTGateway from the web portal")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/upload/portal.html"}},[t._v("Wifi and MQTT configuration")])],1),t._v(" "),e("p",[t._v("Or use another upload method from the Upload section that requires credentials before the build.")]),t._v(" "),e("p",[t._v("You should see the gateway connected to your broker by checking with an MQTT client like MQTT Explorer.")]),t._v(" "),e("h2",{attrs:{id:"adding-the-things"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#adding-the-things"}},[t._v("#")]),t._v(" Adding the things")]),t._v(" "),e("ol",[e("li",[t._v('From the Administration click on "Things" under "Settings", you should see a number in the INBOX button')])]),t._v(" "),e("p",[e("img",{attrs:{src:n(367),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Click on INBOX, you should see your BLE devices and the gateway")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(368),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v('Click on a device, a pop up "Add as Thing" should appear')]),t._v(" "),e("li",[t._v("Rename it if you need, and click OK, repeat for each Thing discovered. The devices should appears as online progressively.")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(369),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("Click on Model")]),t._v(" "),e("li",[t._v("Select the location of where you want to create the Equipment")]),t._v(" "),e("li",[t._v('Click on "Create Equipment from Thing"')]),t._v(" "),e("li",[t._v("Click on Thing")]),t._v(" "),e("li",[t._v("Select a Thing")]),t._v(" "),e("li",[t._v("Rename your Equipment if you need")]),t._v(" "),e("li",[t._v("Select the Channels")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(370),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"12"}},[e("li",[t._v('Click on "Add to Model"')]),t._v(" "),e("li",[t._v("Go to Model, if you unfold your location and Equipment you should be able to see values")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(371),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Congratulation🎉! You were able to get data from your BLE sensors into OpenHAB. You can now add the others and use the data to build pages, leverage rules and enjoy all the function of your Home Automation controller with BLE devices.")]),t._v(" "),e("p",[e("img",{attrs:{src:n(372),alt:"OpenHAB integration"}})])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{358:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-ip.8d63f8c6.png"},359:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding.4a6275c5.png"},360:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding2.266324d8.png"},361:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding3.506b08c5.png"},362:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding4.3be7eff4.png"},363:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding5.8c71ca36.png"},364:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-binding6.48cd3dee.png"},365:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-jinja.270ad9f2.png"},366:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things.b9bcbb97.png"},367:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things2.550b24da.png"},368:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things3.e83eb23c.png"},369:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things4.45af5919.png"},370:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt-things5.bf15e337.png"},371:function(t,e,n){t.exports=n.p+"assets/img/OpenMQTTGateway-OpenHAB-Theengs-mqtt.719d8beb.png"},430:function(t,e,n){"use strict";n.r(e);var a=n(14),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"integrate-openhab-3-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrate-openhab-3-4"}},[t._v("#")]),t._v(" Integrate OPENHAB 3/4")]),t._v(" "),e("p",[t._v("This tutorial will show how to integrate the BLE gateway to OpenHAB 3 or 4 leveraging the auto discovery functionality.\nAfter this tutorial, you should see your Bluetooth Low Energy devices in OpenHAB without any file based manual configuration.")]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("ul",[e("li",[t._v("OpenHAB 3.3 or higher")]),t._v(" "),e("li",[t._v("MQTT broker installed with or without authentication")]),t._v(" "),e("li",[t._v('A location defined in the "Model" section under "Settings"')])]),t._v(" "),e("h2",{attrs:{id:"ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"}},[t._v("#")]),t._v(" IP address (if your broker is installed on the same server as OpenHAB)")]),t._v(" "),e("p",[t._v("The goal is to disable the IPv6 address of the broker server, so that the gateway can connect through IPv4.")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Network Settings")]),t._v(" "),e("li",[t._v("Click on Show Advanced")]),t._v(" "),e("li",[t._v("Disable IPv6")]),t._v(" "),e("li",[t._v("Click on Save")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(358),alt:"OpenHAB integration"}})]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If the broker is installed on another server you will also need to configure it with an IPv4 address.")])]),t._v(" "),e("h2",{attrs:{id:"install-the-mqtt-binding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-the-mqtt-binding"}},[t._v("#")]),t._v(" Install the MQTT binding")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Bindings")]),t._v(" "),e("li",[t._v("Install the MQTT binding (you can search at the bottom right)")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(359),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("Once installed click on Things under Settings")]),t._v(" "),e("li",[t._v("Click on the + at the bottom right")]),t._v(" "),e("li",[t._v("Click on MQTT Binding")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(360),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"7"}},[e("li",[t._v("Click on MQTT broker")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(361),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"8"}},[e("li",[t._v('Enter for the "Broker Hostname/IP" field, the IP address of your broker, if it is installed on the same server you can enter '),e("code",[t._v("localhost")])])]),t._v(" "),e("p",[e("img",{attrs:{src:n(362),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"9"}},[e("li",[t._v('Click on "Show Advanced" if your broker has authentication activated, if not you can go to step 11')]),t._v(" "),e("li",[t._v("Enter the broker credentials: username and password")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(363),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"11"}},[e("li",[t._v('Click on Create Thing at the bottom, you should see your MQTT Broker in the Things list with the status "online"')])]),t._v(" "),e("p",[e("img",{attrs:{src:n(364),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Bravo👏, second step done! Now let's add the Jinja transformation service.")]),t._v(" "),e("h2",{attrs:{id:"install-jinja-and-jsonpath-transformations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-jinja-and-jsonpath-transformations"}},[t._v("#")]),t._v(" Install Jinja and JSONPath Transformations")]),t._v(" "),e("ol",[e("li",[t._v("From the Administration click on Settings")]),t._v(" "),e("li",[t._v("Click on Bindings")]),t._v(" "),e("li",[t._v("Install Jinja Transformation (you can search at the bottom right)")]),t._v(" "),e("li",[t._v("Install JSONPath Transformation")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(365),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Second step done!")]),t._v(" "),e("h2",{attrs:{id:"upload-openmqttgateway-to-an-esp32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#upload-openmqttgateway-to-an-esp32"}},[t._v("#")]),t._v(" Upload OpenMQTTGateway to an ESP32")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/upload/web-install.html"}},[t._v("Upload OpenMQTTGateway from the web")]),t._v(" by selecting the environment corresponding to your need.")],1),t._v(" "),e("p",[t._v("Or use another upload method from the Upload section.")]),t._v(" "),e("h2",{attrs:{id:"configure-openmqttgateway-from-the-web-portal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure-openmqttgateway-from-the-web-portal"}},[t._v("#")]),t._v(" Configure OpenMQTTGateway from the web portal")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/upload/portal.html"}},[t._v("Wifi and MQTT configuration")])],1),t._v(" "),e("p",[t._v("Or use another upload method from the Upload section that requires credentials before the build.")]),t._v(" "),e("p",[t._v("You should see the gateway connected to your broker by checking with an MQTT client like MQTT Explorer.")]),t._v(" "),e("h2",{attrs:{id:"adding-the-things"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#adding-the-things"}},[t._v("#")]),t._v(" Adding the things")]),t._v(" "),e("ol",[e("li",[t._v('From the Administration click on "Things" under "Settings", you should see a number in the INBOX button')])]),t._v(" "),e("p",[e("img",{attrs:{src:n(366),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Click on INBOX, you should see your BLE devices and the gateway")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(367),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v('Click on a device, a pop up "Add as Thing" should appear')]),t._v(" "),e("li",[t._v("Rename it if you need, and click OK, repeat for each Thing discovered. The devices should appears as online progressively.")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(368),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("Click on Model")]),t._v(" "),e("li",[t._v("Select the location of where you want to create the Equipment")]),t._v(" "),e("li",[t._v('Click on "Create Equipment from Thing"')]),t._v(" "),e("li",[t._v("Click on Thing")]),t._v(" "),e("li",[t._v("Select a Thing")]),t._v(" "),e("li",[t._v("Rename your Equipment if you need")]),t._v(" "),e("li",[t._v("Select the Channels")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(369),alt:"OpenHAB integration"}})]),t._v(" "),e("ol",{attrs:{start:"12"}},[e("li",[t._v('Click on "Add to Model"')]),t._v(" "),e("li",[t._v("Go to Model, if you unfold your location and Equipment you should be able to see values")])]),t._v(" "),e("p",[e("img",{attrs:{src:n(370),alt:"OpenHAB integration"}})]),t._v(" "),e("p",[t._v("Congratulation🎉! You were able to get data from your BLE sensors into OpenHAB. You can now add the others and use the data to build pages, leverage rules and enjoy all the function of your Home Automation controller with BLE devices.")]),t._v(" "),e("p",[e("img",{attrs:{src:n(371),alt:"OpenHAB integration"}})])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/16.e4185a57.js b/dev/assets/js/16.0eeaf94f.js similarity index 98% rename from dev/assets/js/16.e4185a57.js rename to dev/assets/js/16.0eeaf94f.js index a4f65fe5..4c8b7823 100644 --- a/dev/assets/js/16.e4185a57.js +++ b/dev/assets/js/16.0eeaf94f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{276:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway-Configuration-Home-Assistant.531a7826.png"},277:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Home_Assistant_MQTT_discovery.8980f020.png"},315:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway-Configuration-Home-Assistant-Discovery-Integration.15338e07.png"},316:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.79982abd.gif"},317:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_auto_discovery_BLE_Sensor_Home_Assistant.ad3bc9c2.gif"},318:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-DeviceTrigger.8d14f498.png"},319:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-Trigger-example.6dd53087.png"},320:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-MQTTSensor.62ca0325.png"},321:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-Sensor-example.2909340e.png"},322:function(t,s){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAADhCAAAAAAb9E/jAAASS0lEQVR4AeyY15rjONJETyRASdXm/9d7/6T7tOt9G0kkkLFbTeIblVP1mLqbI/oLHAUStNgvz7eSL4XMY6QV9BCAkxUzUIgLMh0FOkKIh/g5evMTtJ5eyVyXmfm5Sax1fbbTiJmVwkoHBAokBdrzDA8lRgDZ09laIg3JxEoCBiRFhFSilAf/8ZL60AG4zfPSo3+SEKx84C79kyQ4RN3txUDPJjGgNp/nuedJRCklPBq9aEUgO3vv6f9XTLvDXh6GZyQGc2zz3CyVUqZaQnpYM0miZW9L63l2ajocdtNao4fUBzm4lTTKVA8K5dJyuZeko1CIPaJW8Ze+5Nz6/P8oZF1PkhL0D6fTvOjm9b58uKMWEwaPwptlSzTl/PFjq9OrV28O8EySAPrxeD7uXu3kY47RYxBAIixcMcZoXTun/b68Ox+rgsNn1KR//HBays2r0s7drxEIKqulb0nCGBvGaRi15undsdRXb99Oz0rax/cn67u4d2otBoMDhCBYLcK2Mdhp04/L/u10/vCv2L35zpvnCr98eH9iN03zOcuulo9SKKSGABFYWKTJzYIEpbWTd6pvluUd8eqZwn/899HTYWrJtIvejCREReuGAUPDadvJap/Dp4+5O9wc352nH/xU3Kf8HgbteOzTvvpErXLPKQKTnnRLhLnEMnZm7y0ie8d76N31cF1yPmm/96Iabe5l34xKqTVtG5sxnCXGgMve+2svPaKdakyR6bx5urt8fPfeb6ZTK+OvaPzWFWNQ5SZr2E5ct8vLuezKPNebX05AK3qk8JldIpOwNgeWZWTAq8UYg0coZHwLWO6K4naeRsMPJL21CFoqMAKNjicZ+yPJ6hmadK6aZpXSzu93u6eGcFtaKdkdYWQBXwSAITWmX5wv65TpTNR7Kcr+bvedeFziZcmq3lUMmwW8GTAgY+yRZJSJdGbaJnMp6fww7V8/LultQdmYoofMSOJh2iaPvSHB2Hbahr4Ix/yvwxOS7D3IVquWUfnRvLeNvkk09Ntyc1jQoNTzf96A9YjEzkJPCjlG12hrSBJjQ1zW/TKpyCVK4XyGpRQG1SAgj21X5yVitpqirI0KYxLfgre1GAJvbTvtpFmLa+2vpj/+7mbHwyRmwwbdsu6M8WMPGb6UrHM6vdLVE+zHazKaA4dCRSCnnSOCyc2m0fqGbGfaaWdziUp/XOJbhgwiJJR2ZjIkHdu+KJRAiNWRtrO3XkqlPSnJLcx4bAMzJJdJhgILSR4WJ85O63bLJ5Mwzl/ZSOrYTr4o/JCNSoyrMTa2W9hdxo92lzUswuA0aBwbEsxYjx5bM7NiJ7ZBDyTBYAz80W/I2Abhy2HHcGwLNES57gakAd+VyCjkCGwUY/iu7uwScHGeDCTblgq9J86SXeFOp1RAF5IX5FvJt5KXp7JSeptAkO4HiRQiTSn2gtMEzbbTGAQgY4Na62kbz8KUVrAeSAY2UiQtZJxktpZ2jrQCLFYMNnLKCNtOKXracfWpPk1EWFF3uypMVuMMZ9oWBjOa9/BZ+6ae7tmLekclr0oAAbMjpPSyLC3XfEYiTDgRlo0VkiKk9j8yM4vAUlyVBO5dsK/TVMI2FASzM0efOM2I0lcHFSsz0zZFMtckRd1CyI0ikekUmA2vYECIU4QtUM804J7aR+lXJVXZoPB3kEoEy9xM+saZBo2XHyMkMasUCS+tJ3b+f+u7XY1luiYJuauEItMClcAtMz9skmW8I0oKiRpRAjzF1pm9M1W1hxKxYufHndzz5rxjfaM1qktPp+1Mu95JAijKruCMkj1tVJRZojR2z5/xuiUuUdxH6+J29ZUuK6GIcpc61g+O3KqkLy9RxGqpt1O9pZR1uR0q64HNIpC+rITh+WQaG2O5bo5FaCTBX0piA9Jl14/uH/NWkFtGDvPlJBjQOq1w0ZwkxgQYCX3ZmgzLGKiDoWAgPpPxfmJnKF3CiSTAFGOQLGPZwpE2DSHEZhx/yQxsf5U742gRfU4EwZeQbMUALiqCnqmCEXeoPI1hdMzWbwivvut8rmQgxkCzWBdxfcDiL/u0MgaqxsAd8/Xu+lISrdPmGbMQ6HqS/HKjazXc2xPX0GMS4RItMAohCYw3crxGGrC9zjz09MBVHVrsqfnST5C2iZeVaKQf1BdK8uIP3EbSSycxUV4+iYIXloxW877EqGdNH9x3LuNsyzSQ6fQn4t69XO4JTjaUPZQpe4Enh/DlRw0zLlgMPJYDfYKBFJJ0/f3EG+B7bQx8aXKAkHTPqatXYYON7wzEe1HMMNkXd4EVO9OZyTXJuO952Fal72VhZDV3yY2r3aURGCMgbTvtO0FsGC5j23m3CbguUUgxCmdWRfJod2GcZJJmoxRKkWt+VpILi20exbAluS8pT0hEppmO+sE+pIipFpmWUdNC2DY+jXfG0ahBishMy5n/f5zno3aO0/R0kvN5SQsJRo5MTG6St5tErDQ7kcjsSfb886m1c7nhcPU8yR5NZo9tbaPF1rJJ3mOn7TL+FFKUEtW9Z196mzMXUbgmmSbXgrFHksx+8T34jNO2xUoqStQpSLkvSyshSt1N/ZokIqT/cmtmyw7bOhDsoXTuTf7/X7PZRGdPWCiWjpfs82pKXTNQgQJlANX8QilBEfwSa31mB/xo5JdpHoW6jft1W7nfbw5koIK/8YgRpmrJHQCoHxkfjI+QjHGMQN2nuYLMqWIQQBNgKXwAAmOJ6+N/53EvIUmGIzmuz1bGMY8jRkQgCaxfHVTL5do4v5sjVUJyvzPnadhDoMychUVyjgEhhVWSCAIEDAgIBHWcxxxHWcU5i/PMnHzsG6SS7VtzeF8DoBpEXVsNe4GI0hXsENAVAgKiKlcSAWQnu5MA+7iA5BrE3kmHZABKj0uBwLNxgfvCx75EQYC8Hxd7yesKTesRj8ewRqokA62SMZgkJGEZhtSqWBIEgGSG4shtzv/jMT93wtsO8xrEPQcF0IZokLeNiH+UExT1mvJXxsWfEdcq34Loc/QOqSN3RNUkAayqUpcTFlBRBVjOHkXIrJFyOMce0mcEX4hKlJ1O9hT0CnDB86rwC8S2Wtl7U8TOSR44JdrOJOBmHfa4RAB3cVXJKnk9roS9k7J8Oi72ccEmLkFFnpSyVdg7UcaRAKLt+tL+MoPCZAws5iwFbjkgQ77+kvgv/Szrnw5RAf90Jyj+B+Lir4jrmgEnEMxwDqfnaS0fwkRwCCKCgND+H5dA4iiBsur/UEd3stlLrjZ1ZK9lMwsNIkEBcQ9y7QW45yC4h7RcBRTUNRO0L9trBzkBART7toEIAgi9JnSJoF6de2Y9a2p3bnFtGSAKqGCDCESv44KH49pDrp8ct33jWcgBFOE+JYkASYLi8hGzm5Ak1LRKFQ5nqMMPJgdu5njtz+zrjSvZj9i1vEoEUJ+5eXMIkhUCgiqoT1lQtdcLk2B/JQqA4hrXwzhtyyW98DACkAgABHwzrnQICSRp5ddX42LnBCAhb+9bl0PQDVJYJJYJlmYIhERlmVNIIMt8okCIJCOYOmd9tMI/sW/bf+mpKkJId9KDEnCbQ2v3uvZqXa4MWyetC+7bNiqAzVTfJcLWidhN26xsbigua0FByAbSGEJjNBtexKUXToAH4mrbGY+NSuNi4hcu7iOAbfX1/1ZuRrRCQpAIGU4JIqqrAySAZVAg1KiyKqlbjes5/nWF/KIxtjXJNQW5kCCYX0QGe8hnB5r6GeP7dq5qTW4n9x6pynbDUDj54zIz7/2+/xMsM4SGum1XSWch+jpjT/v70W2UDLt9WqqyWHWngUaPZyT4mdz2gIk349ClNDr9s4oraHqjifl156dlJDAOgwJOLOXqyc+aRuWBjsUnGS7CBHqNeUgRgvs2GUVIdq94sX/HrihGTdF+yYqU00HzStRI6vGFn2hPhleck2ShlWbHLfuyHiFCB5Lc2fcpqQenFARxGYQHJ0IoAJRmFPiuRfHU7RJJEYjD+I4REQH9/aIsCFanIHLnIrIOg2lu2aq7NmxyaBB3I+igk17HqWXhAicTrywYIWCaJGXyrHLrxc5o7k75N2WBWXJoVvpBNUuY+5Ddsrj4DgUgmJpa+1qzrQa2O78WlUR3p2immRK5SfR6aBJYnGBeFldO5e3bAmF+/ooP/1HYbVoMu8GQu9b3vSCvZYUZcYGThUnNhrd//cvYrbDT3utv1k+arhlu/nHVarNp/XYHtKcq6sesD+/VTyrUijZumqrBnBABnelMbn/xk5/8GK/qfsDPn5y1++tL+dnnv//wD93L5uvf/xb/yFNJ7k6EfwZVhW0huuCtyMyRLLucU17pjeneHnh/Wv72F9936259ma6GZtPlzWC7QWTqCFPprjgGIiBk2rJ3ciVp/GvqcxFjU/52Wl8PF3n/8ra5bSSPf1YdG3jK5b7XZjjGiYCcd9O5jCZ/Gnf/fXG2tdX5zSvrz573f/xVlfXFo2b4C9Z6scmWRh6cDvLg0x4HcRITsq39z3Yz+P4rXbtrvlDyXs63Zyev877L267PKXfrttQymW8FSYgqFoKgQwEg6NUK+phtevv0upH6eC8N8Jd8vt1smjJo+9THnEZTwWxNCM3HCwIAnc67KFtho4NY4/1uqA7dtKqE3BazsfZAP7qjaRjiCgw40tLDSNCn6eHVNaX0qyGP7tIUs3QrXfJhW6vn1eirfbcZC8p9CydHhotrwvVVyjRJkIQce7IIKtpK1kQ1F7qAVrIBQE0sWUaPmdcwiWZNS5YvbT66IDBJ3SwVLLhoM5erDuCiUeeRCzBxJznXIvjI0OHQGrrkVwcApkHpR3MyvfQ9Anm0vkiAdxnhR7dXy0zIjP+xJh8hrsAQWSxH6NFojgeRLItr8o6mclgAWQg9OOVlsYBCYhkk4pMEWNFNoegkPofA6BS8H/lVJyWsn0L+TQFBlEQmMdFqx91UCHgvZIr29qNpQR6Q5zH+couiSLyCB0FTgnhY4lkek7Ma6uHLgsOtB07emwSZnrowuc9d1zd2PAV0Z4yE+3FO/O5reNidd3YAecAIZoNmb0EF4BFOROFx+eEOgRo4d4Vyn5UAcicgmhZSURNxxU2i12omrnm6i3d1zNwuTkEmyzUVxzRen2803lMsIgq5P6f1b//mVqtyzGp0UcfhHKCQnJMevCFWWgMnu5E0F79MqyrNH36UgJpnllFFc5sogLuILoRvixbFzEh386RpU2rVdQMI5iBA22UT0iuyEC5CTKD4USA0IyQ1qKW7aHHc71rlkoR0SyDDkQycpTies3BRBkkFWk4vULPObDwFgN0MjIE4P+yXuDmninlOEvuu3q42Dhn+50soSSZefYhvvd71oup0I1xEVD5KXJNxU5IjNuvBq74A5msS1JzsbrQRukEJilIm4gIXQaqbw83SRTeq++NniEnQeyBYdUZROl1wRDBc5sTegfj6zC43jmensATA8v010bPfe2VWGwTi1aCAitBdSHenI2yCQjT+CdzqDopaoE/1htg//2GiIjTYDATgbjDxti1wZ1LatD+Scq86IqC7ucAK83qbL9n03Rf/h8HlRFx0BUTx3+PVgG6VWC21DbzELJBHgpSzoI+kmxmbocpqlVHHlvY/n8MMI0CEAlF5dDNecyepLYMVU5iIvD8fQThvWDG6mzkzcneSx9469g++dNa3OFJnFIQQnvdD3Q0nKbXjMBIKQVitqfaNs29K9BP7qk3cV9+v+9U3/g9JjmW4FUGbZ8PtZd+9XK1aVWdwAJ35fg4eDJwmgW664bLvNpdN+/9fhTUMjDknQQ/ry9H6sZQude/2v5MwTMnDoCkhmpKo9LtCG9LJ//4/kJbH2qI68ai/quW09mPXKhoXgwOG6VBDqH4oRFPO2lxe1m7dv109+Va+OYHLRx13Vt/8/e3rnMWRcgbdIFonZ5gAJVZqE1vg73EAxU/OHwBVF3u4D5Qftg+l341oV9g3XRYzDyWGHCASbKmI97ubIauMdf3s8eOG4oGxzAk9AcBf3/7jsohIkZTbrktj7PsSLl24CRytllLd21rT+f9+7mLyxC6Ly0QByvjm9eX17dASENDXsZU9QBji20W1bVg/fP78In+Cw/Ro3gL+5vXVeFPGCqEzHpcaYmN4Zhs6JWd9+PDFOeCwLMHLMsiUrOLlzdub4k4NLdHPxFUp7cmDi+1zAAYVU3HTtAyyTLX3sCcNYuHjP1Ordy/MIJbW5KNo6EJXpXieSqwRYye5zq+f0YfjMxfoA8gHkA8gH0D+CY973DQPCQ7bAAAAAElFTkSuQmCC"},427:function(t,s,a){"use strict";a.r(s);var e=a(14),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"integrate-home-assistant"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#integrate-home-assistant"}},[t._v("#")]),t._v(" Integrate Home Assistant")]),t._v(" "),s("p",[t._v("Home Assistant provide the "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT integration"),s("OutboundLink")],1),t._v(" and through this integration it is possible to exploit and manage the messages published by OpenMQTTGateway.")]),t._v(" "),s("p",[t._v("Once this integration on home assistant is configured with the same MQTT broker, it is possible to create devices manually or through the autodiscovery function.")]),t._v(" "),s("h2",{attrs:{id:"automatic-integration-with-auto-discovery"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#automatic-integration-with-auto-discovery"}},[t._v("#")]),t._v(" Automatic integration with Auto discovery")]),t._v(" "),s("p",[t._v("From Home Assistant site")]),t._v(" "),s("blockquote",[s("p",[t._v("The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device.")])]),t._v(" "),s("p",[t._v("On OpenMQTTGateway the Home Assistant discovery is enabled by default on all binaries and platformio configurations. Here are a few tips for activating discovery on Home Assistant, but for detailed configuration please refer to the Home Assistant website.")]),t._v(" "),s("p",[t._v("Enable discovery on your MQTT integration in HASS (activated per default).")]),t._v(" "),s("p",[s("img",{attrs:{src:a(315),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[t._v("The gateway will need an MQTT username and password, you have to create a new user (recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(276),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("The max size of the username and password is 64 characters.")])]),t._v(" "),s("p",[t._v("OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automatically.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(316),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[s("img",{attrs:{src:a(317),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[s("img",{attrs:{src:a(277),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("INFO")]),t._v(" "),s("p",[t._v("The Bluetooth and the RTL_433 gateway will automatically create devices and entities, the RF gateway will create DeviceTrigger.\nThe OpenMQTTGateway will also be available as a device to monitor its parameters and control it. The sensors (DHT for example) and actuators (relays) are attached to the gateway.")]),t._v(" "),s("p",[t._v("On first and subsequent startups, auto discovery will start. If you want to prevent this from happening, be sure to manually turn off auto discovery, either by using the UI in Home Assistant, or by publishing to the home/"),s("gatewayname",[t._v("/commands/MQTTtoSYS/config topic.\n30 minutes after its activation the auto discovery will be automatically deactivated, you can reactivate it from the gateway controls.\nSome devices may require a button push or motion/contact event to trigger a message and generate the auto discovery.")])],1)]),t._v(" "),s("h3",{attrs:{id:"rtl-433-auto-discovery-specificity"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rtl-433-auto-discovery-specificity"}},[t._v("#")]),t._v(" RTL_433 auto discovery specificity")]),t._v(" "),s("p",[t._v("Even if the RTL_433 gateway will create automatically the devices and entities, you may lose the link to them when you change the batteries. This is proper to the RF devices. In this case new device and entities will be created. You may bypass this by creating entities through manual configuration that filter following the device model and other parameters and don't take into account the id.\nExample:")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/WS2032/+"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("instead of")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/WS2032/47998"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Note also that the sensor may leverage channels, types or subtypes, they can be used in the filtering\nExample:\nIn the example below 9 is the "),s("code",[t._v("subtype")]),t._v(" and 1 is the "),s("code",[t._v("channel")])]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/Prologue-TH/9/1/+"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("instead of")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/Prologue-TH/9/1/215"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Alternatively the rssi signal could be used also.")]),t._v(" "),s("h3",{attrs:{id:"rf-rcswitch-based-gateway-auto-discovery-specificity"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rf-rcswitch-based-gateway-auto-discovery-specificity"}},[t._v("#")]),t._v(" RF (RCSwitch based gateway) Auto discovery specificity")]),t._v(" "),s("p",[t._v("With OpenMQTTGateway "),s("RouterLink",{attrs:{to:"/setitup/rf.html"}},[t._v("configured to receive RF signals")]),t._v(" messages are transmitted accordingly.")],1),t._v(" "),s("p",[t._v("As indicated in the "),s("RouterLink",{attrs:{to:"/use/rf.html#rcswitch-based-gateway"}},[t._v("RCSwitch based gateway")]),t._v(", it is possible to receive a pulse each time the sensor detects a signal. With auto-discovery enabled, you can configure two types of entities in Home Assistant to handle RF signals:")],1),t._v(" "),s("ol",[s("li",[t._v("An "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/device_trigger.mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT Device Trigger"),s("OutboundLink")],1),t._v(" which allows actions to be triggered when a specific RF signal is received.")]),t._v(" "),s("li",[t._v("An "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/sensor.mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT Sensor"),s("OutboundLink")],1),t._v("\nwhich stores the received RF data as a sensor value.")])]),t._v(" "),s("p",[t._v("Below are some examples of both configurations.")]),t._v(" "),s("h4",{attrs:{id:"example-a-rf-as-mqtt-device-trigger"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-a-rf-as-mqtt-device-trigger"}},[t._v("#")]),t._v(" Example A - RF as MQTT Device Trigger")]),t._v(" "),s("p",[t._v("If the following parameters are enabled in OpenMQTTGateway:")]),t._v(" "),s("ul",[s("li",[t._v('ZgatewayRF="RF"')]),t._v(" "),s("li",[t._v("valueAsATopic=true")]),t._v(" "),s("li",[t._v("HADiscovery=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_DeviceTrigger=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_MQTTSensor=false")])]),t._v(" "),s("p",[t._v("Then, each time an RF signal is received by OpenMQTTGateway, two messages are sent to the MQTT broker:")]),t._v(" "),s("ol",[s("li",[t._v("A device trigger announcement (used by Home Assistant to recognize the trigger).")]),t._v(" "),s("li",[t._v("The RF signal data on the corresponding MQTT topic.")])]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('...\nN: [ OMG->MQTT ] topic: homeassistant/device_automation/246F287AF0C4/15524904/config msg: {"automation_type":"trigger","platform ":"device_automation","type":"Received","subtype":"RF-15524904","device":{"configuration_url":"http://192.168.2.150/","connections":[["mac","246F287AF0C4"]],"identifiers":["246F287AF0C4"],"mf":"OMG_community","mdl":"[\\"WebUI\\",\\"RF\\"]","name":"OMG_DEVELOPMENT","sw":"1.8.0-o"},"value_template":"{{trigger.value.raw}}","topic":"home/OMG_DEVELOPMENT/433toMQTT/15524904"}\nT: Dequeue JSON\nN: [ OMG->MQTT ] topic: home/OMG_DEVELOPMENT/433toMQTT/15524904 msg: {"value":15524904,"protocol":1,"length":24,"delay":368,"tre_state":"-","binary":"111011001110010000101000","raw":"11427,1042,407,1039,417,1027,430,302,1148,1019,438,1015,440,295,1152,301,1153,1014,442,1012,441,1008,445,291,1160,293,1158,1011,444,292,1156,296,1157,296,1157,298,1154,1011,442,295,1153,1013,443,293,1157,295,1154,300"}\n...\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[t._v("These messages allow Home Assistant to recognize and integrate the RF signal as a device trigger.\n"),s("img",{attrs:{src:a(318),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF device trigger in Home Assistant: Green shows the real message, Yellow shows the device trigger configuration")])]),t._v(" "),s("p",[t._v("Once this process is completed, Home Assistant detects a new trigger associated with the OpenMQTTGateway device and linked to the received RF signal value.\nThis means that Home Assistant can now react to the received RF signal as an automation trigger.")]),t._v(" "),s("p",[t._v("Example of a detected RF trigger in Home Assistant:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(319),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF trigger in Home Assistant")])]),t._v(" "),s("h4",{attrs:{id:"example-b-rf-as-mqtt-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-b-rf-as-mqtt-sensor"}},[t._v("#")]),t._v(" Example B - RF As MQTT Sensor")]),t._v(" "),s("p",[t._v("If the following parameters are enabled in OpenMQTTGateway:")]),t._v(" "),s("ul",[s("li",[t._v('ZgatewayRF="RF"')]),t._v(" "),s("li",[t._v("HADiscovery=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_DeviceTrigger=false")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_MQTTSensor=true")])]),t._v(" "),s("p",[t._v("During any discovery round, a SYS message is sent, setting the MQTT Sensor as a sensor of the OpenMQTTGateway device.")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('...\nN: [ OMG->MQTT ] topic: homeassistant/sensor/246F287AF0C4-gatewayRF/config msg: {"stat_t":"home/OMG_DEVELOPMENT/433toMQTT/#","avty_t":"home/OMG_DEVELOPMENT/LWT","name":"gatewayRF","uniq_id":"246F287AF0C4-gatewayRF","val_tpl":"{{ value_json.value | is_defined }}","pl_avail":"online","pl_not_avail":"offline","device":{"ids":["246F287AF0C4"],"name":"OMG_DEVELOPMENT","mdl":"[\\"WebUI\\",\\"RF\\"]","mf":"OMG_community","cu":"http://192.168.2.150/","sw":"1.8.0-o"}}\nT: Dequeue JSON\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Then, each time an RF signal is received by OpenMQTTGateway, the content of messages are sent to the MQTT broker on classic topic:")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('T: Dequeue JSON\nN: [ OMG->MQTT ] topic: home/OMG_DEVELOPMENT/433toMQTT/15524904 msg: {"value":15524904,"protocol":1,"length":24,"delay":368,"tre_state":"-","binary":"111011001110010000101000","raw":"11404,1045,414,1034,424,1024,430,305,1146,1022,431,1019,436,299,1150,304,1145,1021,432,1017,438,1013,441,295,1156,299,1149,1018,436,300,1149,304,1146,307,1143,310,1141,1025,430,306,1143,1021,432,305,1145,310,1140,309"} \n\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("These messages enable Home Assistant to recognize and integrate the RF signal as a sensor.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(320),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF sensor in Home Assistant: Yellow the configuration of sensor, Green the real message")])]),t._v(" "),s("p",[t._v("Once this process is completed, Home Assistant detects a device with the new sensor and linked to the received RF signal value.\nThis means that Home Assistant can now react to the received RF signal as an sensor event.")]),t._v(" "),s("p",[t._v("Example of a detected RF trigger in Home Assistant:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(321),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF sensor in Home Assistant: Yellow the real message")])]),t._v(" "),s("h2",{attrs:{id:"manual-integration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#manual-integration"}},[t._v("#")]),t._v(" Manual integration")]),t._v(" "),s("p",[t._v("If you prefer not to use MQTT auto-discovery, you can manually configure Home Assistant to manage MQTT topics. This approach gives you full control over the structure and behavior of your MQTT entities. Below are some examples of how to define your devices, sensors, and switches manually using YAML configuration.")]),t._v(" "),s("p",[t._v("From @123, @finity, @denniz03, @jrockstad, @anarchking, @dkluivingh, @Odyno")]),t._v(" "),s("h3",{attrs:{id:"pir-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#pir-sensor"}},[t._v("#")]),t._v(" Pir Sensor")]),t._v(" "),s("p",[t._v("This is an example of how to configure a PIR (Passive Infrared) sensor in Home Assistant using MQTT.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(322),alt:"Pir Sensor"}})]),t._v(" "),s("p",[t._v("The configuration below sets up a binary sensor that detects motion and sends the state to Home Assistant.")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unique_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" pir.15484294\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pir.Mansarda"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" motion\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/+/433toMQTT/15484294"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{{ value_json.value }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"15484294"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br")])]),s("h3",{attrs:{id:"door-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#door-sensor"}},[t._v("#")]),t._v(" Door sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/433toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '7821834' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% elif value_json.value == '7821838' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'OFF'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.test') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("qos")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" opening\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br")])]),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" doorbell\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('#value_template: "{{ value_json.raw }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '14163857' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.doorbell') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sound'")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" light_back_sensor\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#value_template: '{{ value_jason.value }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '1213858' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.light_back_sensor') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" rf_outlet_sensor\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '16766303' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.rf_outlet_sensor') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br"),s("span",{staticClass:"line-number"},[t._v("25")]),s("br"),s("span",{staticClass:"line-number"},[t._v("26")]),s("br"),s("span",{staticClass:"line-number"},[t._v("27")]),s("br"),s("span",{staticClass:"line-number"},[t._v("28")]),s("br"),s("span",{staticClass:"line-number"},[t._v("29")]),s("br"),s("span",{staticClass:"line-number"},[t._v("30")]),s("br"),s("span",{staticClass:"line-number"},[t._v("31")]),s("br"),s("span",{staticClass:"line-number"},[t._v("32")]),s("br"),s("span",{staticClass:"line-number"},[t._v("33")]),s("br")])]),s("h3",{attrs:{id:"motion-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#motion-sensor"}},[t._v("#")]),t._v(" Motion sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Bewegung_Schlafzimmer"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#device_class: motion")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway1/HCSR501toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"presence\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"true"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"false"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("h3",{attrs:{id:"switches"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#switches"}},[t._v("#")]),t._v(" Switches")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#switches")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("switch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" Plug1\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/SRFBtoMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/commands/MQTTtoSRFB"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{{ value_json.value }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{\"value\":4546575}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{\"value\":4546572}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4546575")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4546572")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("qos")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("retain")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br")])]),s("h3",{attrs:{id:"rf-gateway-mode-pilight-rf-kaku"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateway-mode-pilight-rf-kaku"}},[t._v("#")]),t._v(" RF gateway mode - Pilight, RF, kaku")]),t._v(" "),s("p",[t._v("insert an include statement in HA configuration.yaml")]),t._v(" "),s("div",{staticClass:"language-bash line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("grep")]),t._v(" homed ./configuration.yaml \nmqtt: "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("include homed-mqtt.yaml\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br")])]),s("p",[t._v("In the example, the included file is homed-mqtt.yaml. It provides an mqtt select entity with the ability to show and also change via dropdown - the desired mode of the RF receiver gateway. In the homed-mqtt.yaml snippet, the device section (as it is optional) is ommited,")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("select")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'RF: Mode receive'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unique_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" espdevcho"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("rf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("mode\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#platform: mqtt")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("availability_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/LWT "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_available")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" online\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_not_available")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" offline\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pilight"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"RF classic"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"RF2 kaku"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/RFtoMQTT "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {% if value_json.active == 1 %} Pilight\n {% elif value_json.active == 2 %} RF classic\n {% elif value_json.active == 4 %} RF2 kaku\n {% endif %}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#unit_of_measurement: s")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/commands/MQTTtoRF/config "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v('\n {% set value_map = {\n "Pilight": 1,\n "RF classic": 2,\n "RF2 kaku": 4,\n }\n %}\n {"active":{{ value_map[value] }}}')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("configuration_url")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" http"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("//192.168.1.11/ "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# device section is optional. It is almost ommited in this example. Values here will update the corresponding device, if it already exist")]),t._v("\n\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br"),s("span",{staticClass:"line-number"},[t._v("25")]),s("br"),s("span",{staticClass:"line-number"},[t._v("26")]),s("br"),s("span",{staticClass:"line-number"},[t._v("27")]),s("br"),s("span",{staticClass:"line-number"},[t._v("28")]),s("br"),s("span",{staticClass:"line-number"},[t._v("29")]),s("br"),s("span",{staticClass:"line-number"},[t._v("30")]),s("br")])]),s("h3",{attrs:{id:"mijia-thermometer-ble"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#mijia-thermometer-ble"}},[t._v("#")]),t._v(" Mijia Thermometer BLE")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_temperature"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# MQTT topic, check MQTT messages; replace AA... with id (BLE MAC) of your device")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'°C'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.tem | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_humidity"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'%'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.hum | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_battery"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'%'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.batt | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br")])]),s("h3",{attrs:{id:"xiaomi-mi-scale-v2-ble-xmtzc05hm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xiaomi-mi-scale-v2-ble-xmtzc05hm"}},[t._v("#")]),t._v(" Xiaomi Mi Scale V2 BLE (XMTZC05HM)")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Weight"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your MQTT topic here")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"weight\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"kg"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mdi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("weight"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("kilogram\n \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Impedance"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your MQTT topic here also")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"impedance\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Ohm"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mdi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("omega\n \n"),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("body_mass_index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("friendly_name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Body Mass Index'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% set HEIGHT = (1.76)"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v("float %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your height in meters")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% set WEIGHT = states('sensor.xmtzc05hm_weight')"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v("float %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" (WEIGHT/(HEIGHT"),s("span",{pre:!0,attrs:{class:"token important"}},[t._v("*HEIGHT))|float|round(1)")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {{ 'mdi:human' }}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br")])]),s("h3",{attrs:{id:"mqtt-room-presence"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-room-presence"}},[t._v("#")]),t._v(" MQTT Room Presence")]),t._v(" "),s("p",[t._v("For the publication into the presence topic the following needs to be activated - "),s("RouterLink",{attrs:{to:"/use/ble.html#setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[t._v("here is the command")])],1),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("platform")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mqtt_room\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#Mac Address of device wanting to track")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" you_are_in "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# home assistant will show a sensor named (you are in) with its value being the name you gave the gateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/presence"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#timeout:")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#away_timeout:")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br")])]),s("h3",{attrs:{id:"temperature-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#temperature-sensor"}},[t._v("#")]),t._v(" Temperature sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" outdoor temp\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/433toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'°C'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {% if value_json is defined and value_json.sensor == 125 %}\n {{ value_json.tempc }}\n {% else %}\n {{ states('sensor.outdoor_temp') }}\n {% endif %}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{276:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway-Configuration-Home-Assistant.531a7826.png"},277:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Home_Assistant_MQTT_discovery.8980f020.png"},299:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway-Configuration-Home-Assistant-Discovery-Integration.15338e07.png"},300:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.79982abd.gif"},301:function(t,s,a){t.exports=a.p+"assets/img/OpenMQTTGateway_auto_discovery_BLE_Sensor_Home_Assistant.ad3bc9c2.gif"},302:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-DeviceTrigger.8d14f498.png"},303:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-Trigger-example.6dd53087.png"},304:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-MQTTSensor.62ca0325.png"},305:function(t,s,a){t.exports=a.p+"assets/img/HASS-RF-Sensor-example.2909340e.png"},306:function(t,s){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAADhCAAAAAAb9E/jAAASS0lEQVR4AeyY15rjONJETyRASdXm/9d7/6T7tOt9G0kkkLFbTeIblVP1mLqbI/oLHAUStNgvz7eSL4XMY6QV9BCAkxUzUIgLMh0FOkKIh/g5evMTtJ5eyVyXmfm5Sax1fbbTiJmVwkoHBAokBdrzDA8lRgDZ09laIg3JxEoCBiRFhFSilAf/8ZL60AG4zfPSo3+SEKx84C79kyQ4RN3txUDPJjGgNp/nuedJRCklPBq9aEUgO3vv6f9XTLvDXh6GZyQGc2zz3CyVUqZaQnpYM0miZW9L63l2ajocdtNao4fUBzm4lTTKVA8K5dJyuZeko1CIPaJW8Ze+5Nz6/P8oZF1PkhL0D6fTvOjm9b58uKMWEwaPwptlSzTl/PFjq9OrV28O8EySAPrxeD7uXu3kY47RYxBAIixcMcZoXTun/b68Ox+rgsNn1KR//HBays2r0s7drxEIKqulb0nCGBvGaRi15undsdRXb99Oz0rax/cn67u4d2otBoMDhCBYLcK2Mdhp04/L/u10/vCv2L35zpvnCr98eH9iN03zOcuulo9SKKSGABFYWKTJzYIEpbWTd6pvluUd8eqZwn/899HTYWrJtIvejCREReuGAUPDadvJap/Dp4+5O9wc352nH/xU3Kf8HgbteOzTvvpErXLPKQKTnnRLhLnEMnZm7y0ie8d76N31cF1yPmm/96Iabe5l34xKqTVtG5sxnCXGgMve+2svPaKdakyR6bx5urt8fPfeb6ZTK+OvaPzWFWNQ5SZr2E5ct8vLuezKPNebX05AK3qk8JldIpOwNgeWZWTAq8UYg0coZHwLWO6K4naeRsMPJL21CFoqMAKNjicZ+yPJ6hmadK6aZpXSzu93u6eGcFtaKdkdYWQBXwSAITWmX5wv65TpTNR7Kcr+bvedeFziZcmq3lUMmwW8GTAgY+yRZJSJdGbaJnMp6fww7V8/LultQdmYoofMSOJh2iaPvSHB2Hbahr4Ix/yvwxOS7D3IVquWUfnRvLeNvkk09Ntyc1jQoNTzf96A9YjEzkJPCjlG12hrSBJjQ1zW/TKpyCVK4XyGpRQG1SAgj21X5yVitpqirI0KYxLfgre1GAJvbTvtpFmLa+2vpj/+7mbHwyRmwwbdsu6M8WMPGb6UrHM6vdLVE+zHazKaA4dCRSCnnSOCyc2m0fqGbGfaaWdziUp/XOJbhgwiJJR2ZjIkHdu+KJRAiNWRtrO3XkqlPSnJLcx4bAMzJJdJhgILSR4WJ85O63bLJ5Mwzl/ZSOrYTr4o/JCNSoyrMTa2W9hdxo92lzUswuA0aBwbEsxYjx5bM7NiJ7ZBDyTBYAz80W/I2Abhy2HHcGwLNES57gakAd+VyCjkCGwUY/iu7uwScHGeDCTblgq9J86SXeFOp1RAF5IX5FvJt5KXp7JSeptAkO4HiRQiTSn2gtMEzbbTGAQgY4Na62kbz8KUVrAeSAY2UiQtZJxktpZ2jrQCLFYMNnLKCNtOKXracfWpPk1EWFF3uypMVuMMZ9oWBjOa9/BZ+6ae7tmLekclr0oAAbMjpPSyLC3XfEYiTDgRlo0VkiKk9j8yM4vAUlyVBO5dsK/TVMI2FASzM0efOM2I0lcHFSsz0zZFMtckRd1CyI0ikekUmA2vYECIU4QtUM804J7aR+lXJVXZoPB3kEoEy9xM+saZBo2XHyMkMasUCS+tJ3b+f+u7XY1luiYJuauEItMClcAtMz9skmW8I0oKiRpRAjzF1pm9M1W1hxKxYufHndzz5rxjfaM1qktPp+1Mu95JAijKruCMkj1tVJRZojR2z5/xuiUuUdxH6+J29ZUuK6GIcpc61g+O3KqkLy9RxGqpt1O9pZR1uR0q64HNIpC+rITh+WQaG2O5bo5FaCTBX0piA9Jl14/uH/NWkFtGDvPlJBjQOq1w0ZwkxgQYCX3ZmgzLGKiDoWAgPpPxfmJnKF3CiSTAFGOQLGPZwpE2DSHEZhx/yQxsf5U742gRfU4EwZeQbMUALiqCnqmCEXeoPI1hdMzWbwivvut8rmQgxkCzWBdxfcDiL/u0MgaqxsAd8/Xu+lISrdPmGbMQ6HqS/HKjazXc2xPX0GMS4RItMAohCYw3crxGGrC9zjz09MBVHVrsqfnST5C2iZeVaKQf1BdK8uIP3EbSSycxUV4+iYIXloxW877EqGdNH9x3LuNsyzSQ6fQn4t69XO4JTjaUPZQpe4Enh/DlRw0zLlgMPJYDfYKBFJJ0/f3EG+B7bQx8aXKAkHTPqatXYYON7wzEe1HMMNkXd4EVO9OZyTXJuO952Fal72VhZDV3yY2r3aURGCMgbTvtO0FsGC5j23m3CbguUUgxCmdWRfJod2GcZJJmoxRKkWt+VpILi20exbAluS8pT0hEppmO+sE+pIipFpmWUdNC2DY+jXfG0ahBishMy5n/f5zno3aO0/R0kvN5SQsJRo5MTG6St5tErDQ7kcjsSfb886m1c7nhcPU8yR5NZo9tbaPF1rJJ3mOn7TL+FFKUEtW9Z196mzMXUbgmmSbXgrFHksx+8T34jNO2xUoqStQpSLkvSyshSt1N/ZokIqT/cmtmyw7bOhDsoXTuTf7/X7PZRGdPWCiWjpfs82pKXTNQgQJlANX8QilBEfwSa31mB/xo5JdpHoW6jft1W7nfbw5koIK/8YgRpmrJHQCoHxkfjI+QjHGMQN2nuYLMqWIQQBNgKXwAAmOJ6+N/53EvIUmGIzmuz1bGMY8jRkQgCaxfHVTL5do4v5sjVUJyvzPnadhDoMychUVyjgEhhVWSCAIEDAgIBHWcxxxHWcU5i/PMnHzsG6SS7VtzeF8DoBpEXVsNe4GI0hXsENAVAgKiKlcSAWQnu5MA+7iA5BrE3kmHZABKj0uBwLNxgfvCx75EQYC8Hxd7yesKTesRj8ewRqokA62SMZgkJGEZhtSqWBIEgGSG4shtzv/jMT93wtsO8xrEPQcF0IZokLeNiH+UExT1mvJXxsWfEdcq34Loc/QOqSN3RNUkAayqUpcTFlBRBVjOHkXIrJFyOMce0mcEX4hKlJ1O9hT0CnDB86rwC8S2Wtl7U8TOSR44JdrOJOBmHfa4RAB3cVXJKnk9roS9k7J8Oi72ccEmLkFFnpSyVdg7UcaRAKLt+tL+MoPCZAws5iwFbjkgQ77+kvgv/Szrnw5RAf90Jyj+B+Lir4jrmgEnEMxwDqfnaS0fwkRwCCKCgND+H5dA4iiBsur/UEd3stlLrjZ1ZK9lMwsNIkEBcQ9y7QW45yC4h7RcBRTUNRO0L9trBzkBART7toEIAgi9JnSJoF6de2Y9a2p3bnFtGSAKqGCDCESv44KH49pDrp8ct33jWcgBFOE+JYkASYLi8hGzm5Ak1LRKFQ5nqMMPJgdu5njtz+zrjSvZj9i1vEoEUJ+5eXMIkhUCgiqoT1lQtdcLk2B/JQqA4hrXwzhtyyW98DACkAgABHwzrnQICSRp5ddX42LnBCAhb+9bl0PQDVJYJJYJlmYIhERlmVNIIMt8okCIJCOYOmd9tMI/sW/bf+mpKkJId9KDEnCbQ2v3uvZqXa4MWyetC+7bNiqAzVTfJcLWidhN26xsbigua0FByAbSGEJjNBtexKUXToAH4mrbGY+NSuNi4hcu7iOAbfX1/1ZuRrRCQpAIGU4JIqqrAySAZVAg1KiyKqlbjes5/nWF/KIxtjXJNQW5kCCYX0QGe8hnB5r6GeP7dq5qTW4n9x6pynbDUDj54zIz7/2+/xMsM4SGum1XSWch+jpjT/v70W2UDLt9WqqyWHWngUaPZyT4mdz2gIk349ClNDr9s4oraHqjifl156dlJDAOgwJOLOXqyc+aRuWBjsUnGS7CBHqNeUgRgvs2GUVIdq94sX/HrihGTdF+yYqU00HzStRI6vGFn2hPhleck2ShlWbHLfuyHiFCB5Lc2fcpqQenFARxGYQHJ0IoAJRmFPiuRfHU7RJJEYjD+I4REQH9/aIsCFanIHLnIrIOg2lu2aq7NmxyaBB3I+igk17HqWXhAicTrywYIWCaJGXyrHLrxc5o7k75N2WBWXJoVvpBNUuY+5Ddsrj4DgUgmJpa+1qzrQa2O78WlUR3p2immRK5SfR6aBJYnGBeFldO5e3bAmF+/ooP/1HYbVoMu8GQu9b3vSCvZYUZcYGThUnNhrd//cvYrbDT3utv1k+arhlu/nHVarNp/XYHtKcq6sesD+/VTyrUijZumqrBnBABnelMbn/xk5/8GK/qfsDPn5y1++tL+dnnv//wD93L5uvf/xb/yFNJ7k6EfwZVhW0huuCtyMyRLLucU17pjeneHnh/Wv72F9936259ma6GZtPlzWC7QWTqCFPprjgGIiBk2rJ3ciVp/GvqcxFjU/52Wl8PF3n/8ra5bSSPf1YdG3jK5b7XZjjGiYCcd9O5jCZ/Gnf/fXG2tdX5zSvrz573f/xVlfXFo2b4C9Z6scmWRh6cDvLg0x4HcRITsq39z3Yz+P4rXbtrvlDyXs63Zyev877L267PKXfrttQymW8FSYgqFoKgQwEg6NUK+phtevv0upH6eC8N8Jd8vt1smjJo+9THnEZTwWxNCM3HCwIAnc67KFtho4NY4/1uqA7dtKqE3BazsfZAP7qjaRjiCgw40tLDSNCn6eHVNaX0qyGP7tIUs3QrXfJhW6vn1eirfbcZC8p9CydHhotrwvVVyjRJkIQce7IIKtpK1kQ1F7qAVrIBQE0sWUaPmdcwiWZNS5YvbT66IDBJ3SwVLLhoM5erDuCiUeeRCzBxJznXIvjI0OHQGrrkVwcApkHpR3MyvfQ9Anm0vkiAdxnhR7dXy0zIjP+xJh8hrsAQWSxH6NFojgeRLItr8o6mclgAWQg9OOVlsYBCYhkk4pMEWNFNoegkPofA6BS8H/lVJyWsn0L+TQFBlEQmMdFqx91UCHgvZIr29qNpQR6Q5zH+couiSLyCB0FTgnhY4lkek7Ma6uHLgsOtB07emwSZnrowuc9d1zd2PAV0Z4yE+3FO/O5reNidd3YAecAIZoNmb0EF4BFOROFx+eEOgRo4d4Vyn5UAcicgmhZSURNxxU2i12omrnm6i3d1zNwuTkEmyzUVxzRen2803lMsIgq5P6f1b//mVqtyzGp0UcfhHKCQnJMevCFWWgMnu5E0F79MqyrNH36UgJpnllFFc5sogLuILoRvixbFzEh386RpU2rVdQMI5iBA22UT0iuyEC5CTKD4USA0IyQ1qKW7aHHc71rlkoR0SyDDkQycpTies3BRBkkFWk4vULPObDwFgN0MjIE4P+yXuDmninlOEvuu3q42Dhn+50soSSZefYhvvd71oup0I1xEVD5KXJNxU5IjNuvBq74A5msS1JzsbrQRukEJilIm4gIXQaqbw83SRTeq++NniEnQeyBYdUZROl1wRDBc5sTegfj6zC43jmensATA8v010bPfe2VWGwTi1aCAitBdSHenI2yCQjT+CdzqDopaoE/1htg//2GiIjTYDATgbjDxti1wZ1LatD+Scq86IqC7ucAK83qbL9n03Rf/h8HlRFx0BUTx3+PVgG6VWC21DbzELJBHgpSzoI+kmxmbocpqlVHHlvY/n8MMI0CEAlF5dDNecyepLYMVU5iIvD8fQThvWDG6mzkzcneSx9469g++dNa3OFJnFIQQnvdD3Q0nKbXjMBIKQVitqfaNs29K9BP7qk3cV9+v+9U3/g9JjmW4FUGbZ8PtZd+9XK1aVWdwAJ35fg4eDJwmgW664bLvNpdN+/9fhTUMjDknQQ/ry9H6sZQude/2v5MwTMnDoCkhmpKo9LtCG9LJ//4/kJbH2qI68ai/quW09mPXKhoXgwOG6VBDqH4oRFPO2lxe1m7dv109+Va+OYHLRx13Vt/8/e3rnMWRcgbdIFonZ5gAJVZqE1vg73EAxU/OHwBVF3u4D5Qftg+l341oV9g3XRYzDyWGHCASbKmI97ubIauMdf3s8eOG4oGxzAk9AcBf3/7jsohIkZTbrktj7PsSLl24CRytllLd21rT+f9+7mLyxC6Ly0QByvjm9eX17dASENDXsZU9QBji20W1bVg/fP78In+Cw/Ro3gL+5vXVeFPGCqEzHpcaYmN4Zhs6JWd9+PDFOeCwLMHLMsiUrOLlzdub4k4NLdHPxFUp7cmDi+1zAAYVU3HTtAyyTLX3sCcNYuHjP1Ordy/MIJbW5KNo6EJXpXieSqwRYye5zq+f0YfjMxfoA8gHkA8gH0D+CY973DQPCQ7bAAAAAElFTkSuQmCC"},425:function(t,s,a){"use strict";a.r(s);var e=a(14),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"integrate-home-assistant"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#integrate-home-assistant"}},[t._v("#")]),t._v(" Integrate Home Assistant")]),t._v(" "),s("p",[t._v("Home Assistant provide the "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT integration"),s("OutboundLink")],1),t._v(" and through this integration it is possible to exploit and manage the messages published by OpenMQTTGateway.")]),t._v(" "),s("p",[t._v("Once this integration on home assistant is configured with the same MQTT broker, it is possible to create devices manually or through the autodiscovery function.")]),t._v(" "),s("h2",{attrs:{id:"automatic-integration-with-auto-discovery"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#automatic-integration-with-auto-discovery"}},[t._v("#")]),t._v(" Automatic integration with Auto discovery")]),t._v(" "),s("p",[t._v("From Home Assistant site")]),t._v(" "),s("blockquote",[s("p",[t._v("The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device.")])]),t._v(" "),s("p",[t._v("On OpenMQTTGateway the Home Assistant discovery is enabled by default on all binaries and platformio configurations. Here are a few tips for activating discovery on Home Assistant, but for detailed configuration please refer to the Home Assistant website.")]),t._v(" "),s("p",[t._v("Enable discovery on your MQTT integration in HASS (activated per default).")]),t._v(" "),s("p",[s("img",{attrs:{src:a(299),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[t._v("The gateway will need an MQTT username and password, you have to create a new user (recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(276),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("The max size of the username and password is 64 characters.")])]),t._v(" "),s("p",[t._v("OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automatically.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(300),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[s("img",{attrs:{src:a(301),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("p",[s("img",{attrs:{src:a(277),alt:"Home Assistant Auto Discovery"}})]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("INFO")]),t._v(" "),s("p",[t._v("The Bluetooth and the RTL_433 gateway will automatically create devices and entities, the RF gateway will create DeviceTrigger.\nThe OpenMQTTGateway will also be available as a device to monitor its parameters and control it. The sensors (DHT for example) and actuators (relays) are attached to the gateway.")]),t._v(" "),s("p",[t._v("On first and subsequent startups, auto discovery will start. If you want to prevent this from happening, be sure to manually turn off auto discovery, either by using the UI in Home Assistant, or by publishing to the home/"),s("gatewayname",[t._v("/commands/MQTTtoSYS/config topic.\n30 minutes after its activation the auto discovery will be automatically deactivated, you can reactivate it from the gateway controls.\nSome devices may require a button push or motion/contact event to trigger a message and generate the auto discovery.")])],1)]),t._v(" "),s("h3",{attrs:{id:"rtl-433-auto-discovery-specificity"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rtl-433-auto-discovery-specificity"}},[t._v("#")]),t._v(" RTL_433 auto discovery specificity")]),t._v(" "),s("p",[t._v("Even if the RTL_433 gateway will create automatically the devices and entities, you may lose the link to them when you change the batteries. This is proper to the RF devices. In this case new device and entities will be created. You may bypass this by creating entities through manual configuration that filter following the device model and other parameters and don't take into account the id.\nExample:")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/WS2032/+"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("instead of")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/WS2032/47998"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Note also that the sensor may leverage channels, types or subtypes, they can be used in the filtering\nExample:\nIn the example below 9 is the "),s("code",[t._v("subtype")]),t._v(" and 1 is the "),s("code",[t._v("channel")])]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/Prologue-TH/9/1/+"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("instead of")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"+/+/RTL_433toMQTT/Prologue-TH/9/1/215"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Alternatively the rssi signal could be used also.")]),t._v(" "),s("h3",{attrs:{id:"rf-rcswitch-based-gateway-auto-discovery-specificity"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rf-rcswitch-based-gateway-auto-discovery-specificity"}},[t._v("#")]),t._v(" RF (RCSwitch based gateway) Auto discovery specificity")]),t._v(" "),s("p",[t._v("With OpenMQTTGateway "),s("RouterLink",{attrs:{to:"/setitup/rf.html"}},[t._v("configured to receive RF signals")]),t._v(" messages are transmitted accordingly.")],1),t._v(" "),s("p",[t._v("As indicated in the "),s("RouterLink",{attrs:{to:"/use/rf.html#rcswitch-based-gateway"}},[t._v("RCSwitch based gateway")]),t._v(", it is possible to receive a pulse each time the sensor detects a signal. With auto-discovery enabled, you can configure two types of entities in Home Assistant to handle RF signals:")],1),t._v(" "),s("ol",[s("li",[t._v("An "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/device_trigger.mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT Device Trigger"),s("OutboundLink")],1),t._v(" which allows actions to be triggered when a specific RF signal is received.")]),t._v(" "),s("li",[t._v("An "),s("a",{attrs:{href:"https://www.home-assistant.io/integrations/sensor.mqtt/",target:"_blank",rel:"noopener noreferrer"}},[t._v("MQTT Sensor"),s("OutboundLink")],1),t._v("\nwhich stores the received RF data as a sensor value.")])]),t._v(" "),s("p",[t._v("Below are some examples of both configurations.")]),t._v(" "),s("h4",{attrs:{id:"example-a-rf-as-mqtt-device-trigger"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-a-rf-as-mqtt-device-trigger"}},[t._v("#")]),t._v(" Example A - RF as MQTT Device Trigger")]),t._v(" "),s("p",[t._v("If the following parameters are enabled in OpenMQTTGateway:")]),t._v(" "),s("ul",[s("li",[t._v('ZgatewayRF="RF"')]),t._v(" "),s("li",[t._v("valueAsATopic=true")]),t._v(" "),s("li",[t._v("HADiscovery=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_DeviceTrigger=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_MQTTSensor=false")])]),t._v(" "),s("p",[t._v("Then, each time an RF signal is received by OpenMQTTGateway, two messages are sent to the MQTT broker:")]),t._v(" "),s("ol",[s("li",[t._v("A device trigger announcement (used by Home Assistant to recognize the trigger).")]),t._v(" "),s("li",[t._v("The RF signal data on the corresponding MQTT topic.")])]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('...\nN: [ OMG->MQTT ] topic: homeassistant/device_automation/246F287AF0C4/15524904/config msg: {"automation_type":"trigger","platform ":"device_automation","type":"Received","subtype":"RF-15524904","device":{"configuration_url":"http://192.168.2.150/","connections":[["mac","246F287AF0C4"]],"identifiers":["246F287AF0C4"],"mf":"OMG_community","mdl":"[\\"WebUI\\",\\"RF\\"]","name":"OMG_DEVELOPMENT","sw":"1.8.0-o"},"value_template":"{{trigger.value.raw}}","topic":"home/OMG_DEVELOPMENT/433toMQTT/15524904"}\nT: Dequeue JSON\nN: [ OMG->MQTT ] topic: home/OMG_DEVELOPMENT/433toMQTT/15524904 msg: {"value":15524904,"protocol":1,"length":24,"delay":368,"tre_state":"-","binary":"111011001110010000101000","raw":"11427,1042,407,1039,417,1027,430,302,1148,1019,438,1015,440,295,1152,301,1153,1014,442,1012,441,1008,445,291,1160,293,1158,1011,444,292,1156,296,1157,296,1157,298,1154,1011,442,295,1153,1013,443,293,1157,295,1154,300"}\n...\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[t._v("These messages allow Home Assistant to recognize and integrate the RF signal as a device trigger.\n"),s("img",{attrs:{src:a(302),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF device trigger in Home Assistant: Green shows the real message, Yellow shows the device trigger configuration")])]),t._v(" "),s("p",[t._v("Once this process is completed, Home Assistant detects a new trigger associated with the OpenMQTTGateway device and linked to the received RF signal value.\nThis means that Home Assistant can now react to the received RF signal as an automation trigger.")]),t._v(" "),s("p",[t._v("Example of a detected RF trigger in Home Assistant:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(303),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF trigger in Home Assistant")])]),t._v(" "),s("h4",{attrs:{id:"example-b-rf-as-mqtt-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-b-rf-as-mqtt-sensor"}},[t._v("#")]),t._v(" Example B - RF As MQTT Sensor")]),t._v(" "),s("p",[t._v("If the following parameters are enabled in OpenMQTTGateway:")]),t._v(" "),s("ul",[s("li",[t._v('ZgatewayRF="RF"')]),t._v(" "),s("li",[t._v("HADiscovery=true")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_DeviceTrigger=false")]),t._v(" "),s("li",[t._v("RF_on_HAS_as_MQTTSensor=true")])]),t._v(" "),s("p",[t._v("During any discovery round, a SYS message is sent, setting the MQTT Sensor as a sensor of the OpenMQTTGateway device.")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('...\nN: [ OMG->MQTT ] topic: homeassistant/sensor/246F287AF0C4-gatewayRF/config msg: {"stat_t":"home/OMG_DEVELOPMENT/433toMQTT/#","avty_t":"home/OMG_DEVELOPMENT/LWT","name":"gatewayRF","uniq_id":"246F287AF0C4-gatewayRF","val_tpl":"{{ value_json.value | is_defined }}","pl_avail":"online","pl_not_avail":"offline","device":{"ids":["246F287AF0C4"],"name":"OMG_DEVELOPMENT","mdl":"[\\"WebUI\\",\\"RF\\"]","mf":"OMG_community","cu":"http://192.168.2.150/","sw":"1.8.0-o"}}\nT: Dequeue JSON\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("Then, each time an RF signal is received by OpenMQTTGateway, the content of messages are sent to the MQTT broker on classic topic:")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('T: Dequeue JSON\nN: [ OMG->MQTT ] topic: home/OMG_DEVELOPMENT/433toMQTT/15524904 msg: {"value":15524904,"protocol":1,"length":24,"delay":368,"tre_state":"-","binary":"111011001110010000101000","raw":"11404,1045,414,1034,424,1024,430,305,1146,1022,431,1019,436,299,1150,304,1145,1021,432,1017,438,1013,441,295,1156,299,1149,1018,436,300,1149,304,1146,307,1143,310,1141,1025,430,306,1143,1021,432,305,1145,310,1140,309"} \n\n')])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[t._v("These messages enable Home Assistant to recognize and integrate the RF signal as a sensor.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(304),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF sensor in Home Assistant: Yellow the configuration of sensor, Green the real message")])]),t._v(" "),s("p",[t._v("Once this process is completed, Home Assistant detects a device with the new sensor and linked to the received RF signal value.\nThis means that Home Assistant can now react to the received RF signal as an sensor event.")]),t._v(" "),s("p",[t._v("Example of a detected RF trigger in Home Assistant:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(305),alt:"MQTTExplorer Show Topic"}}),t._v(" "),s("em",[t._v("Example of a detected RF sensor in Home Assistant: Yellow the real message")])]),t._v(" "),s("h2",{attrs:{id:"manual-integration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#manual-integration"}},[t._v("#")]),t._v(" Manual integration")]),t._v(" "),s("p",[t._v("If you prefer not to use MQTT auto-discovery, you can manually configure Home Assistant to manage MQTT topics. This approach gives you full control over the structure and behavior of your MQTT entities. Below are some examples of how to define your devices, sensors, and switches manually using YAML configuration.")]),t._v(" "),s("p",[t._v("From @123, @finity, @denniz03, @jrockstad, @anarchking, @dkluivingh, @Odyno")]),t._v(" "),s("h3",{attrs:{id:"pir-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#pir-sensor"}},[t._v("#")]),t._v(" Pir Sensor")]),t._v(" "),s("p",[t._v("This is an example of how to configure a PIR (Passive Infrared) sensor in Home Assistant using MQTT.")]),t._v(" "),s("p",[s("img",{attrs:{src:a(306),alt:"Pir Sensor"}})]),t._v(" "),s("p",[t._v("The configuration below sets up a binary sensor that detects motion and sends the state to Home Assistant.")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unique_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" pir.15484294\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pir.Mansarda"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" motion\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/+/433toMQTT/15484294"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{{ value_json.value }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"15484294"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br")])]),s("h3",{attrs:{id:"door-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#door-sensor"}},[t._v("#")]),t._v(" Door sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/433toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '7821834' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% elif value_json.value == '7821838' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'OFF'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.test') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("qos")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" opening\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br")])]),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" doorbell\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('#value_template: "{{ value_json.raw }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '14163857' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.doorbell') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_class")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sound'")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" light_back_sensor\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#value_template: '{{ value_jason.value }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '1213858' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.light_back_sensor') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("off_delay")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" rf_outlet_sensor\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/SRFBtoMQTT'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% if value_json.value == '16766303' %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ON'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% else %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("states('binary_sensor.rf_outlet_sensor') "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v(" upper"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% endif %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br"),s("span",{staticClass:"line-number"},[t._v("25")]),s("br"),s("span",{staticClass:"line-number"},[t._v("26")]),s("br"),s("span",{staticClass:"line-number"},[t._v("27")]),s("br"),s("span",{staticClass:"line-number"},[t._v("28")]),s("br"),s("span",{staticClass:"line-number"},[t._v("29")]),s("br"),s("span",{staticClass:"line-number"},[t._v("30")]),s("br"),s("span",{staticClass:"line-number"},[t._v("31")]),s("br"),s("span",{staticClass:"line-number"},[t._v("32")]),s("br"),s("span",{staticClass:"line-number"},[t._v("33")]),s("br")])]),s("h3",{attrs:{id:"motion-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#motion-sensor"}},[t._v("#")]),t._v(" Motion sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("binary_sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Bewegung_Schlafzimmer"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#device_class: motion")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway1/HCSR501toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"presence\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"true"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"false"')]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("h3",{attrs:{id:"switches"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#switches"}},[t._v("#")]),t._v(" Switches")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#switches")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("switch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" Plug1\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/SRFBtoMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/commands/MQTTtoSRFB"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{{ value_json.value }}"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{\"value\":4546575}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{\"value\":4546572}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4546575")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4546572")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("qos")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("retain")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br")])]),s("h3",{attrs:{id:"rf-gateway-mode-pilight-rf-kaku"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateway-mode-pilight-rf-kaku"}},[t._v("#")]),t._v(" RF gateway mode - Pilight, RF, kaku")]),t._v(" "),s("p",[t._v("insert an include statement in HA configuration.yaml")]),t._v(" "),s("div",{staticClass:"language-bash line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("grep")]),t._v(" homed ./configuration.yaml \nmqtt: "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("include homed-mqtt.yaml\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br")])]),s("p",[t._v("In the example, the included file is homed-mqtt.yaml. It provides an mqtt select entity with the ability to show and also change via dropdown - the desired mode of the RF receiver gateway. In the homed-mqtt.yaml snippet, the device section (as it is optional) is ommited,")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("select")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'RF: Mode receive'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unique_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" espdevcho"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("rf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("mode\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#platform: mqtt")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("availability_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/LWT "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_available")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" online\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("payload_not_available")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" offline\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pilight"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"RF classic"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"RF2 kaku"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/RFtoMQTT "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {% if value_json.active == 1 %} Pilight\n {% elif value_json.active == 2 %} RF classic\n {% elif value_json.active == 4 %} RF2 kaku\n {% endif %}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#unit_of_measurement: s")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" home/espdevcho/commands/MQTTtoRF/config "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("command_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v('\n {% set value_map = {\n "Pilight": 1,\n "RF classic": 2,\n "RF2 kaku": 4,\n }\n %}\n {"active":{{ value_map[value] }}}')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("configuration_url")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" http"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("//192.168.1.11/ "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# device section is optional. It is almost ommited in this example. Values here will update the corresponding device, if it already exist")]),t._v("\n\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br"),s("span",{staticClass:"line-number"},[t._v("25")]),s("br"),s("span",{staticClass:"line-number"},[t._v("26")]),s("br"),s("span",{staticClass:"line-number"},[t._v("27")]),s("br"),s("span",{staticClass:"line-number"},[t._v("28")]),s("br"),s("span",{staticClass:"line-number"},[t._v("29")]),s("br"),s("span",{staticClass:"line-number"},[t._v("30")]),s("br")])]),s("h3",{attrs:{id:"mijia-thermometer-ble"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#mijia-thermometer-ble"}},[t._v("#")]),t._v(" Mijia Thermometer BLE")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_temperature"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# MQTT topic, check MQTT messages; replace AA... with id (BLE MAC) of your device")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'°C'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.tem | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_humidity"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'%'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.hum | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mijia_thermometer_battery"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'%'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json.batt | is_defined }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("expire_after")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("21600")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# 6 hours")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("force_update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br")])]),s("h3",{attrs:{id:"xiaomi-mi-scale-v2-ble-xmtzc05hm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xiaomi-mi-scale-v2-ble-xmtzc05hm"}},[t._v("#")]),t._v(" Xiaomi Mi Scale V2 BLE (XMTZC05HM)")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Weight"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your MQTT topic here")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"weight\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"kg"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mdi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("weight"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("kilogram\n \n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Impedance"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your MQTT topic here also")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{{ value_json[\"impedance\"] }}'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Ohm"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mdi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("omega\n \n"),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("body_mass_index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("friendly_name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Body Mass Index'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% set HEIGHT = (1.76)"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v("float %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# replace your height in meters")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("% set WEIGHT = states('sensor.xmtzc05hm_weight')"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("|")]),t._v("float %"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" (WEIGHT/(HEIGHT"),s("span",{pre:!0,attrs:{class:"token important"}},[t._v("*HEIGHT))|float|round(1)")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("icon_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {{ 'mdi:human' }}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br"),s("span",{staticClass:"line-number"},[t._v("17")]),s("br"),s("span",{staticClass:"line-number"},[t._v("18")]),s("br"),s("span",{staticClass:"line-number"},[t._v("19")]),s("br"),s("span",{staticClass:"line-number"},[t._v("20")]),s("br"),s("span",{staticClass:"line-number"},[t._v("21")]),s("br"),s("span",{staticClass:"line-number"},[t._v("22")]),s("br"),s("span",{staticClass:"line-number"},[t._v("23")]),s("br"),s("span",{staticClass:"line-number"},[t._v("24")]),s("br")])]),s("h3",{attrs:{id:"mqtt-room-presence"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-room-presence"}},[t._v("#")]),t._v(" MQTT Room Presence")]),t._v(" "),s("p",[t._v("For the publication into the presence topic the following needs to be activated - "),s("RouterLink",{attrs:{to:"/use/ble.html#setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[t._v("here is the command")])],1),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("platform")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" mqtt_room\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("device_id")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("XX "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#Mac Address of device wanting to track")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" you_are_in "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# home assistant will show a sensor named (you are in) with its value being the name you gave the gateway")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/presence"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#timeout:")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("#away_timeout:")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br")])]),s("h3",{attrs:{id:"temperature-sensor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#temperature-sensor"}},[t._v("#")]),t._v(" Temperature sensor")]),t._v(" "),s("div",{staticClass:"language-yaml line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-yaml"}},[s("code",[s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("mqtt")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("sensor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" outdoor temp\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("state_topic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/OpenMQTTGateway/433toMQTT"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("unit_of_measurement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'°C'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("value_template")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token scalar string"}},[t._v("\n {% if value_json is defined and value_json.sensor == 125 %}\n {{ value_json.tempc }}\n {% else %}\n {{ states('sensor.outdoor_temp') }}\n {% endif %}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/18.bb4184c5.js b/dev/assets/js/18.13c1ce83.js similarity index 98% rename from dev/assets/js/18.bb4184c5.js rename to dev/assets/js/18.13c1ce83.js index 29d9bca1..481e13ea 100644 --- a/dev/assets/js/18.bb4184c5.js +++ b/dev/assets/js/18.13c1ce83.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{396:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-sensors-ble.0fac0ddf.png"},397:function(e,t,a){e.exports=a.p+"assets/img/Theengs-Bridge-ble-gateway.659243b3.png"},398:function(e,t,a){e.exports=a.p+"assets/img/Theengs-Plug-OpenMQTTGateway.b78a5091.png"},399:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-mqtt-explorer-lywsd03mmc-atc.373ae7bf.png"},400:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-home-assistant-chart.d38cbd0f.png"},401:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-BLE-tracker-Home-Assistant.158960f9.png"},402:function(e,t,a){e.exports=a.p+"assets/img/KBeacon-app-configuration-moving.ddd3b980.jpg"},403:function(e,t,a){e.exports=a.p+"assets/img/KBeacon-app-configuration-moving2.5530d66f.jpg"},457:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"bluetooth-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bluetooth-gateway"}},[e._v("#")]),e._v(" Bluetooth gateway")]),e._v(" "),t("p",[e._v("The manufacturer agnostic Bluetooth Low Energy (BLE) gateway acts as a powerful BLE scanner and decoder of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(", allowing you to visualize and analyze information from a wide range of sensors.\nIt can also act as a device tracker and presence detection gateway by receiving nearby BLE devices and trackers.")]),e._v(" "),t("p",[e._v("Data are transmitted to an MQTT broker, where it can be used to trigger events and rules, as well as displayed, stored and processed in your favorite controller (Home Assistant, OpenHAB, Jeedom, Domoticz, ioBroker or any MQTT compatible software).")]),e._v(" "),t("p",[e._v("With the ability to monitor and analyze data such as temperature, humidity, moisture, luminance, weight, pressure, fine particles, and more, the BLE gateway provides a flexible and customizable solution for integrating BLE technology into your control and monitoring systems.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(396),alt:"BLE sensors and devices"}})]),e._v(" "),t("h2",{attrs:{id:"products-powered-by-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#products-powered-by-openmqttgateway"}},[e._v("#")]),e._v(" Products powered by OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"theengs-bridge-ble-gateway-with-external-antenna"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-bridge-ble-gateway-with-external-antenna"}},[e._v("#")]),e._v(" Theengs Bridge, BLE gateway with external antenna")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerfull BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(397),alt:"Theengs bridge view"}})])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug-ble-gateway-and-smart-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug-ble-gateway-and-smart-plug"}},[e._v("#")]),e._v(" Theengs Plug, BLE gateway and Smart Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" brings the following features:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(" supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(398),alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Disable or enable the BLE gateway (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to deactivate the BLE gateway:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"enabled\":false}'")])]),e._v(" "),t("p",[e._v("If you want to activate the BLE gateway:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"enabled\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"}},[e._v("#")]),e._v(" Receiving signals from "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices_by_brand.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible BLE sensors"),t("OutboundLink")],1),e._v(" to publish it to an MQTT broker.")]),e._v(" "),t("p",[e._v("To receive data from BLE sensors you can use an ESP32-based device with a programming USB port or use a Serial adapter.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is also available preloaded and configured with the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(", a smart plug that acts as a BLE gateway and energy monitoring device.")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Follow the "),t("RouterLink",{attrs:{to:"/upload/web-install.html"}},[e._v("Upload")]),e._v(" and "),t("RouterLink",{attrs:{to:"/upload/portal.html"}},[e._v("Configuration")]),e._v(" steps.")],1)]),e._v(" "),t("li",[t("p",[e._v("Download an MQTT client like MQTT explorer.")])]),e._v(" "),t("li",[t("p",[e._v("You should see data coming in your broker.")])])]),e._v(" "),t("p",[t("img",{attrs:{src:a(399),alt:"LYWSD03MMC MQTT data view"}})]),e._v(" "),t("p",[e._v("Once the data has been transmitted to the MQTT broker, it can be easily integrated with your preferred controller. For example, the data can be automatically discovered and made available within popular controllers, example below with Home Assistant.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(400),alt:"Home Assistant chart"}})]),e._v(" "),t("p",[e._v("Examples of compatible sensors among [our list](https://decoder.theengs.io/devices/devices_by_brand.html: Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale, iBBQ, TPMS")]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-for-device-tracker-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-for-device-tracker-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices for Device Tracker detection")]),e._v(" "),t("p",[e._v("The gateway will detect BLE trackers from Tile, Nut, TagIt, iTAG, Gigaset G-Tag, TicWatch GTH (Pro), Teltonika FMT100 vehicle tracker and Bosch Nyon eBike computers, as well as other devices with additional properties decoding like Mi Band, Amazfit, RuuviTag and others indicated as Device Trackers in the "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible BLE devices list"),t("OutboundLink")],1),e._v(", and automatically create a device tracker entity following the Home Assistant discovery convention (if auto discovery is activated).")]),e._v(" "),t("p",[e._v("The devicen tracker entity created can be attached to a person to leverage presence detection. The "),t("code",[e._v("away")]),e._v(" or "),t("code",[e._v("not home")]),e._v(" state is triggered if the BLE tracker is not detected during the timer defined by "),t("code",[e._v("presenceawaytimer")]),e._v(".")]),e._v(" "),t("p",[t("img",{attrs:{src:a(401),alt:"Away home Home assistant view"}})]),e._v(" "),t("p",[e._v("By default "),t("code",[e._v("presenceawaytimer")]),e._v(" is set to 120s, you can change it from the slider in your controller or with the following command (ms)")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"presenceawaytimer\":66000}'")])]),e._v(" "),t("p",[e._v("Generally BLE devices will not broadcast if they are paired so you may need to ensure your beacons is unpaired/disconnected before it will be seen by the gateway.")]),e._v(" "),t("p",[e._v("Note that you can find apps to simulate beacons and do some tests like "),t("a",{attrs:{href:"https://play.google.com/store/apps/details?id=net.alea.beaconsimulator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Beacon simulator"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Apple iOS version >=10 devices advertise without an extra MAC address app, nevertheless this address "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/issues/71",target:"_blank",rel:"noopener noreferrer"}},[e._v("changes randomly"),t("OutboundLink")],1),e._v(" and can currently only be used with "),t("a",{attrs:{href:"https://gateway.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(" and its "),t("a",{attrs:{href:"https://gateway.theengs.io/use/use.html#getting-identity-resolving-key-irk-for-apple-watch-iphone-and-ipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identity MAC Address and Identity Resolving Key"),t("OutboundLink")],1),e._v(" feature.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("presenceawaytimer")]),e._v(" is also used to reset the state of the PIR/motion sensors to "),t("code",[e._v("off")]),e._v(" when using HA MQTT discovery convention. If the Sensor does not detect a motion, its state will be automatically set to "),t("code",[e._v("off")]),e._v(" after the "),t("code",[e._v("presenceawaytimer")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-for-presence-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-for-presence-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices for Presence detection")]),e._v(" "),t("p",[e._v('To do this activate the "BT: Publish HASS presence" switch in your controller or send the following MQTT command to your broker: mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"hasspresence":true}\'')]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices with accelerometers for movement detection")]),e._v(" "),t("p",[e._v("The gateway is designed to detect BLE trackers from BlueCharm and automatically create a binary sensor entity in accordance with the Home Assistant discovery convention, provided that auto discovery is enabled.")]),e._v(" "),t("p",[e._v("The binary sensor entity's state will be set to on or off based on whether the BLE beacon's x-axis acceleration value is detected during the time period defined by the movingtimer parameter.")]),e._v(" "),t("p",[e._v("By default, the movingtimer parameter is set to 60 seconds (60,000 ms). To modify this value, use the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"movingtimer\":66000}'")])]),e._v(" "),t("p",[e._v("To ensure proper functionality, configure the beacon using the KBeacon or KBeaconPro app (depending on your specific sensor) with the following settings:")]),e._v(" "),t("ul",[t("li",[e._v('In the General tab, set the Trigger Command to "motion".')]),e._v(" "),t("li",[e._v('In the Slot tab, enable advertisement with the Beacon Type set to "KSensor", the Trigger Only Advertisement option set to "YES", and the Sensor Axis set to "ON".')])]),e._v(" "),t("p",[t("img",{attrs:{src:a(402),alt:"KBeacon trigger settings"}})]),e._v(" "),t("p",[t("img",{attrs:{src:a(403),alt:"KBeacon details"}})]),e._v(" "),t("h2",{attrs:{id:"setting-a-white-or-black-list"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-a-white-or-black-list"}},[e._v("#")]),e._v(" Setting a white or black list")]),e._v(" "),t("p",[e._v("A black list is a list of MAC addresses that will never be published by OMG\nto set black list\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"black-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[e._v("A white list is a list of MAC addresses permitted to be published by OMG\nto set white list\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"white-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[e._v("to temporarily disable white/black list\n"),t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"ignoreWBlist\":true}'")])]),e._v(" "),t("p",[e._v("to enable white/black list back\n"),t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"ignoreWBlist\":false}'")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("So as to keep your white/black list persistent you can publish it with the retain option of MQTT (-r with mosquitto_pub or retain check box of MQTT Explorer)\n"),t("code",[e._v('mosquitto_pub -r -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"white-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[t("strong",[e._v("NOTE")]),e._v(": Only when sending a white/black list should the retain option be set. All other commands to any OpenMQTTGateway gateway "),t("strong",[e._v("must not")]),e._v(" have the retain option set. To persist such other command settings, read "),t("a",{attrs:{href:"https://docs.openmqttgateway.com/use/ble.html#store-ble-configuration-into-the-gateway",target:"_blank",rel:"noopener noreferrer"}},[e._v("the following section"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between BLE scans and force a scan (available with HA discovery)")]),e._v(" "),t("p",[e._v("Example if you want the BLE to scan every 66 seconds:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":66000}'")])]),e._v(" "),t("p",[e._v("you can also force a scan to be done by the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":0}'")])]),e._v(" "),t("p",[e._v("Changing the interval between scans will deactivate adaptive scanning.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("p",[e._v("Once the forced scan has completed, the previous scan interval value will be restored. Forcing a scan command trigger also a BLE connect process after the scan (see below).")]),e._v(" "),t("p",[e._v("The default value "),t("code",[e._v("TimeBtwRead")]),e._v(" is set into config_BT.h or into your .ini file for platformio users.")]),e._v(" "),t("p",[e._v("If you want to scan continuously for BLE devices, for example for beacon location you can set the interval to 100ms:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":100}'")])]),e._v(" "),t("p",[e._v("In this case you should deactivate the BLE connection mechanism to avoid concurrency between scan and connections (see chapter below, bleconnect).")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("For certain devices like LYWSD03MMC OpenMQTTGateway use a connection (due to the fact that the advertized data are encrypted), this connection mechanism is launched after every "),t("code",[e._v("TimeBtwConnect")]),e._v(" per default, you can modify it by following the procedure below.")])]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between connection attempts (default: 60min, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change the time between BLE connect you can change it by MQTT, if you want the BLE connect time to be every 300s:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"intervalcnct\":300000}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway publishes all the BLE devices scanned or only the detected sensors (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"onlysensors\":true}'")])]),e._v(" "),t("p",[e._v("The gateway will publish only detected sensors and trackers like Mi Flora, Mi jia, Mi Band, LYWSD03MMC... or trackers like Tile, Nut, TagIt or iTag, and not any other other BLE devices. This is useful if you don't use the gateway for presence detection with unrecognised trackers.")]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"}},[e._v("#")]),e._v(" Setting if the gateway publishes known devices which randomly change their MAC address (default: false)")]),e._v(" "),t("p",[e._v("The default is false, as such changing MAC addresses cannot be related to specific devices.")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"randommacs\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway use adaptive scanning (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("Adaptive scanning lets the gateway decide for you the best passive "),t("code",[e._v("interval")]),e._v(" and active "),t("code",[e._v("intervalacts")]),e._v(" scan interval, depending on the characteristics of your devices.\nThe gateway retrieves your devices' information from "),t("a",{attrs:{href:"https://decoder.theengs.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Decoder"),t("OutboundLink")],1),e._v(" and adapts its parameters accordingly if a device that requires it is detected.\nFor example a door or a PIR sensor will require continuous scanning, so if detected the gateway is going to reduce its time between scans to the minimum. Or your devices may also require active scanning to retrieve data, in this case the gateway will also trigger active scans at regular intervals.")]),e._v(" "),t("p",[e._v("If you want to change this characteristic (default:true):")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"adaptivescan\":false}'")])]),e._v(" "),t("p",[e._v("Setting Adaptive scanning to "),t("code",[e._v("false")]),e._v(" will automatically put the gateway to continuous active scanning if no additional manual changes have already been applied.")]),e._v(" "),t("p",[e._v("An overview with background information to better understand the different setting used:")]),e._v(" "),t("p",[t("strong",[e._v("Passive scanning:")]),e._v(" With this scanning mode the gateway picks up any freely available broadcasts sent out by devices, without any interaction with the devices. The interval for this is set with "),t("a",{attrs:{href:"#setting-the-time-between-ble-scans-and-force-a-scan"}},[e._v('{"interval":66000}')])]),e._v(" "),t("p",[t("strong",[e._v("Active scanning:")]),e._v(" With this scanning mode the gateway sends out requests for sensor broadcasts first, before then picking up the broadcast advertisement data. Some devices require this request before they send out all data in their broadcasts. The interval for this active scanning with request first is set by "),t("a",{attrs:{href:"#setting-the-time-between-active-scanning"}},[e._v('{"intervalacts":300000}')])]),e._v(" "),t("p",[e._v("Setting "),t("a",{attrs:{href:"#advanced-publishing-advertisement-and-advanced-data-default-false"}},[e._v("Publishing advertisement and advanced data")]),e._v(" to true will show you additional data about which of your devices require active scanning and/or continuous scanning, so that you can tune these setting to your devices and your individual requirements of their data.")]),e._v(" "),t("p",[t("strong",[e._v('"cont":true')]),e._v(' - the device requires continuous scanning. If passive ({"interval":100}) or active ({"intervalacts":100}) depends on the additional device specification.')]),e._v(" "),t("p",[t("strong",[e._v('"acts":true')]),e._v(" - the device requires active scanning to broadcast all of it's data for decoding.")]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-active-scanning-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-active-scanning-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between active scanning (available with HA discovery)")]),e._v(" "),t("p",[e._v("If you have passive scanning activated, but also have some devices which require active scanning, this defines the time interval between two intermittent active scans.")]),e._v(" "),t("p",[e._v("Example for setting the active scan interval time to every 5 minutes:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"intervalacts\":300000}'")])]),e._v(" "),t("p",[e._v("Changing the active scan interval will deactivate adaptive scanning.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("The active scan interval "),t("code",[e._v("intervalacts")]),e._v(" can only bet set equal to or higher than the passive scan interval "),t("code",[e._v("interval")]),e._v(", as any lower value would not make any sense.")])]),e._v(" "),t("h2",{attrs:{id:"setting-the-duration-of-a-scan-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-duration-of-a-scan-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the duration of a scan (available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change the default duration of each scan cycle to 5 seconds")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"scanduration\":5000}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway connects to BLE devices eligibles (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"bleconnect\":false}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway publish into Home Assistant Home presence topic (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to publish to Home Assistant presence topic, you can activate this function by the HASS interface (this command is auto discovered), "),t("RouterLink",{attrs:{to:"/integrate/home_assistant.html#mqtt-room-presence"}},[e._v("here is a yaml example")]),e._v(".\nOr by an MQTT command.")],1),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"hasspresence\":true}'")])]),e._v(" "),t("p",[e._v("To change presence publication topic, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"prestopic":"presence/"}\'')])]),e._v(" "),t("p",[e._v("To use iBeacon UUID for presence, instead of sender (random) MAC address, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"presuseuuid\":true}'")])]),e._v(" "),t("p",[e._v("This will change usual payload for iBeacon from:\n"),t("code",[e._v('{"id":"60:87:57:4C:9B:C2","mac_type":1,"rssi":-78,"distance":7.85288,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}')]),e._v("\nTo:\n"),t("code",[e._v('{"id":"1de4b189115e45f6b44e509352269977","mac_type":1,"rssi":-78,"distance":7.85288,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66,"mac":"60:87:57:4C:9B:C2"}')]),e._v('\nNote: the MAC address is put in "mac" field.')]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"}},[e._v("#")]),e._v(" Setting if the gateway uses iBeacon UUID as topic, instead of (random) MAC address (default: false)")]),e._v(" "),t("p",[e._v("By default, iBeacon are published like other devices, using a topic based on the MAC address of the sender.\nBut modern phones randomize their Bluetooth MAC address making it difficult to track iBeacon.")]),e._v(" "),t("p",[e._v("For example, the 2 following messages corresponds to the same iBeacon, but with different MAC and topics:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/BTtoMQTT/58782076BC24 {"id":"58:78:20:76:BC:24","mac_type":1,"rssi":-79,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\nhome/OpenMQTTGateway/BTtoMQTT/5210A84690AC {"id":"52:10:A8:46:90:AC","mac_type":1,"rssi":-77,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br")])]),t("p",[e._v("To use iBeacon UUID as topic, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubuuid4topic\":true}'")])]),e._v(" "),t("p",[e._v("Resulting in such messages (for the same iBeacon as previously):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/BTtoMQTT/1de4b189115e45f6b44e509352269977 {"id":"52:10:A8:46:90:AC","mac_type":1,"rssi":-76,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\nhome/OpenMQTTGateway/BTtoMQTT/1de4b189115e45f6b44e509352269977 {"id":"7B:63:C6:82:DC:57","mac_type":1,"rssi":-83,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br")])]),t("h2",{attrs:{id:"setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"}},[e._v("#")]),e._v(" Setting the minimum RSSI accepted to publish device data (default:-100)")]),e._v(" "),t("p",[e._v("If you want to change the minimum RSSI value accepted for a device to be published, you can change it by MQTT. For example if you want to set -80")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"minrssi\":-80}'")])]),e._v(" "),t("p",[e._v("you can also accept all the devices by the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"minrssi\":-200}'")])]),e._v(" "),t("p",[e._v("The default value is set into config_BT.h")]),e._v(" "),t("h2",{attrs:{id:"store-ble-configuration-into-the-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#store-ble-configuration-into-the-gateway"}},[e._v("#")]),e._v(" Store BLE configuration into the gateway")]),e._v(" "),t("p",[e._v("OpenMQTTGateway has the capability to save the current configuration and reload it at startup.")]),e._v(" "),t("p",[e._v("To store the running configuration into the gateway, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"save\":true}'")])]),e._v(" "),t("p",[e._v("At any time, you can reload the stored configuration with the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"load\":true}'")])]),e._v(" "),t("p",[e._v("If you want to erase the stored configuration, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"erase\":true}'")]),e._v("\nNote that it will not change the running configuration, only ensure default configuration is used at next startup.")]),e._v(" "),t("p",[e._v("By the way, if you want to load the default built-in configuration (on any board, not only ESP32), use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"init\":true}'")]),e._v("\nNote that it will not change the stored configuration, "),t("code",[e._v("erase")]),e._v(" or "),t("code",[e._v("save")]),e._v(" is still needed to overwrite the saved configuration.")]),e._v(" "),t("h2",{attrs:{id:"controlling-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#controlling-devices"}},[e._v("#")]),e._v(" Controlling devices")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("To control devices reliably, set the interval between scans to at least 5 seconds and the scan duration to 1 second to ensure commands are successfully transmitted to your devices.")])]),e._v(" "),t("h2",{attrs:{id:"read-write-ble-characteristics-over-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#read-write-ble-characteristics-over-mqtt"}},[e._v("#")]),e._v(" Read/write BLE characteristics over MQTT")]),e._v(" "),t("p",[e._v("The gateway can read and write BLE characteristics from devices and provide the results in an MQTT message.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("These actions will be taken on the next BLE connection, which occurs after scanning and after the scan count is reached, "),t("a",{attrs:{href:"#setting-the-number-of-scans-between-connection-attempts"}},[e._v("see above to set this")]),e._v(".\nThis can be overridden by providing an (optional) parameter "),t("code",[e._v('"immediate": true')]),e._v(" within the command. This will cause the BLE scan to stop if currently in progress, allowing the command to be immediately processed. All other connection commands in queue will also be processed for the same device, commands for other devices will be deferred until the next normally scheduled connection.")]),e._v(" "),t("p",[t("strong",[e._v("Note")]),e._v(' Some devices need to have the MAC address type specified. You can find this type by checking the log/MQTT data and looking for "mac_type". The mac_type of your device can be seen by setting '),t("code",[e._v("pubadvdata")]),e._v(" to "),t("code",[e._v("true")]),e._v(" with an MQTT command (see Publishing advertisement data), or with the macro "),t("code",[e._v("pubBLEAdvData true")]),e._v(". By default the type is 0 but some devices use different type values. You must specify the correct type to connect successfully."),t("br"),e._v("\nTo specify the MAC address type add the parameter "),t("code",[e._v('"mac_type"')]),e._v(" to the command. For example "),t("code",[e._v('"mac_type": 1')]),e._v(" to connect with a device with the MAC address type of 1.")])]),e._v(" "),t("h3",{attrs:{id:"example-write-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-write-command"}},[e._v("#")]),e._v(" Example write command")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "ble_write_address":"AA:BB:CC:DD:EE:FF",\n "ble_write_service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "ble_write_char":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "ble_write_value":"TEST",\n "value_type":"STRING",\n "ttl":4,\n "immediate":true }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br")])]),t("p",[e._v("Response:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "characteristic":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "write":"TEST",\n "success":true\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br")])]),t("h3",{attrs:{id:"example-read-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-read-command"}},[e._v("#")]),e._v(" Example read command")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "ble_read_address":"AA:BB:CC:DD:EE:FF",\n "ble_read_service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "ble_read_char":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "value_type":"STRING",\n "ttl": 2 }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("p",[e._v("Response:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "characteristic":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "read":"TEST",\n "success":true\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("ttl")]),e._v(" parameter is the number of attempts to connect (defaults to 1), which occur after the BLE scan completes."),t("br"),e._v(" "),t("code",[e._v("value_type")]),e._v(" can be one of: STRING, HEX, INT, FLOAT. Default is STRING if omitted in the message.")])]),e._v(" "),t("h2",{attrs:{id:"switchbot-bot-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-bot-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Bot control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Bot devices are automatically discovered and available as a device in the Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Press")]),e._v(" "),t("li",[e._v("On")]),e._v(" "),t("li",[e._v("Off")]),e._v(" "),t("li",[e._v("Up")]),e._v(" "),t("li",[e._v("Down")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the SwitchBot mode is changed the ESP32 must be restarted.")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-bot-state-to-on"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-state-to-on"}},[e._v("#")]),e._v(" Set the SwitchBot Bot state to ON:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"on",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-state-to-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-state-to-off"}},[e._v("#")]),e._v(" Set the SwitchBot Bot state to OFF:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"off",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-press"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-press"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to PRESS:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"press",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-go-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-go-up"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to go UP:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"up",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-go-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-go-down"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to go DOWN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"down",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("Response (assuming success):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "state":"on"\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("h2",{attrs:{id:"switchbot-blind-tilt-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-blind-tilt-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Blind Tilt control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Blind Tilt devices are automatically discovered and available as a device in the settings Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Open")]),e._v(" "),t("li",[e._v("Close down")]),e._v(" "),t("li",[e._v("Set a percentage")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-open"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-open"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to OPEN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"open",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-close-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-close-down"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to CLOSE_DOWN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"close_down",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-close-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-close-up"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to CLOSE_UP:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"close_up",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to a percentage (0-100):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":55,\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-to-stop"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-to-stop"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt to Stop:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"stop",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"response-assuming-success"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-assuming-success"}},[e._v("#")]),e._v(" Response (assuming success):")]),e._v(" "),t("p",[e._v("The Switchbot Blind Tilt response :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "tilt":55,\n "open":90,\n "direction":"up"\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("h2",{attrs:{id:"switchbot-curtain-2-3-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-curtain-2-3-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Curtain (2/3) control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Curtain (2/3) devices are automatically discovered and available as a device in the settings Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Set a percentage")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-curtain-state-to-open"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-state-to-open"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain state to OPEN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"open",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-state-to-close"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-state-to-close"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain state to CLOSE:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"close",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-to-a-percentage-0-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-to-a-percentage-0-100"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain to a percentage (0-100):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":55,\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-to-stop"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-to-stop"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain to Stop:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"stop",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"response-assuming-success-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-assuming-success-2"}},[e._v("#")]),e._v(" Response (assuming success):")]),e._v(" "),t("p",[e._v("The Switchbot Curtain response :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "position":55,\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("h2",{attrs:{id:"advanced-setting-up-an-external-decoder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-setting-up-an-external-decoder"}},[e._v("#")]),e._v(" ADVANCED: Setting up an external decoder")]),e._v(" "),t("p",[e._v("This advanced option is used to publish raw radio frames on a specific topic to be decoded by an external decoder instead of the integrated one.")]),e._v(" "),t("p",[e._v("To enable external decoder:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"extDecoderEnable\":true}'")])]),e._v(" "),t("p",[e._v('To change the default external decoder topic to "undecoded":')]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"extDecoderTopic":"undecoded"}\'')])]),e._v(" "),t("h2",{attrs:{id:"advanced-filtering-out-connectable-devices-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-filtering-out-connectable-devices-default-false"}},[e._v("#")]),e._v(" ADVANCED: Filtering out connectable devices (default: false)")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/integrate/openhab2.html"}},[e._v("With OpenHAB integration")]),e._v(", this configuration is highly recommended, otherwise you may encounter incomplete data.")],1),e._v(" "),t("p",[e._v("If you want to enable this feature:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"filterConnectable\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" ADVANCED: Advertisement and advanced data (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to enable this feature:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubadvdata\":true}'")])]),e._v(" "),t("p",[e._v("This will publish extensive information about the device:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"11:22:33:44:55:66"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"mac_type"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"adv_type"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Qingping Motion & Light"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"rssi"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("-93")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servicedata"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"88121122334455660201520f0126090403000000"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servicedatauuid"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0xfdcd"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"brand"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Qingping"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"model"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Motion & Light"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"model_id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"CGPR1"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"lux"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("3")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"batt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("82")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("To stop publishing advertisement data:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubadvdata\":false}'")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("All product and company names are trademarks or registered trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("We strongly encourage the use of a white-list (see below) so as to collect data from your devices only and not from other MAC addresses.\nBy default the gateway scans the advertizing BLE devices nearby with their MAC addresses. Depending on your country, it may be illegal to monitor networks for MAC addresses, especially on networks that you do not own. Please check your country's laws (for US Section 18 U.S. Code § 2511) - "),t("a",{attrs:{href:"https://github.com/schollz/howmanypeoplearearound/issues/4",target:"_blank",rel:"noopener noreferrer"}},[e._v("discussion here"),t("OutboundLink")],1),e._v(".")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{394:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-sensors-ble.0fac0ddf.png"},395:function(e,t,a){e.exports=a.p+"assets/img/Theengs-Bridge-ble-gateway.659243b3.png"},396:function(e,t,a){e.exports=a.p+"assets/img/Theengs-Plug-OpenMQTTGateway.b78a5091.png"},397:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-mqtt-explorer-lywsd03mmc-atc.373ae7bf.png"},398:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-home-assistant-chart.d38cbd0f.png"},399:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-BLE-tracker-Home-Assistant.158960f9.png"},400:function(e,t,a){e.exports=a.p+"assets/img/KBeacon-app-configuration-moving.ddd3b980.jpg"},401:function(e,t,a){e.exports=a.p+"assets/img/KBeacon-app-configuration-moving2.5530d66f.jpg"},458:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"bluetooth-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bluetooth-gateway"}},[e._v("#")]),e._v(" Bluetooth gateway")]),e._v(" "),t("p",[e._v("The manufacturer agnostic Bluetooth Low Energy (BLE) gateway acts as a powerful BLE scanner and decoder of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(", allowing you to visualize and analyze information from a wide range of sensors.\nIt can also act as a device tracker and presence detection gateway by receiving nearby BLE devices and trackers.")]),e._v(" "),t("p",[e._v("Data are transmitted to an MQTT broker, where it can be used to trigger events and rules, as well as displayed, stored and processed in your favorite controller (Home Assistant, OpenHAB, Jeedom, Domoticz, ioBroker or any MQTT compatible software).")]),e._v(" "),t("p",[e._v("With the ability to monitor and analyze data such as temperature, humidity, moisture, luminance, weight, pressure, fine particles, and more, the BLE gateway provides a flexible and customizable solution for integrating BLE technology into your control and monitoring systems.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(394),alt:"BLE sensors and devices"}})]),e._v(" "),t("h2",{attrs:{id:"products-powered-by-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#products-powered-by-openmqttgateway"}},[e._v("#")]),e._v(" Products powered by OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"theengs-bridge-ble-gateway-with-external-antenna"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-bridge-ble-gateway-with-external-antenna"}},[e._v("#")]),e._v(" Theengs Bridge, BLE gateway with external antenna")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerfull BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(395),alt:"Theengs bridge view"}})])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug-ble-gateway-and-smart-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug-ble-gateway-and-smart-plug"}},[e._v("#")]),e._v(" Theengs Plug, BLE gateway and Smart Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" brings the following features:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(" supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:a(396),alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Disable or enable the BLE gateway (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to deactivate the BLE gateway:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"enabled\":false}'")])]),e._v(" "),t("p",[e._v("If you want to activate the BLE gateway:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"enabled\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"}},[e._v("#")]),e._v(" Receiving signals from "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices_by_brand.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible BLE sensors"),t("OutboundLink")],1),e._v(" to publish it to an MQTT broker.")]),e._v(" "),t("p",[e._v("To receive data from BLE sensors you can use an ESP32-based device with a programming USB port or use a Serial adapter.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is also available preloaded and configured with the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(", a smart plug that acts as a BLE gateway and energy monitoring device.")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Follow the "),t("RouterLink",{attrs:{to:"/upload/web-install.html"}},[e._v("Upload")]),e._v(" and "),t("RouterLink",{attrs:{to:"/upload/portal.html"}},[e._v("Configuration")]),e._v(" steps.")],1)]),e._v(" "),t("li",[t("p",[e._v("Download an MQTT client like MQTT explorer.")])]),e._v(" "),t("li",[t("p",[e._v("You should see data coming in your broker.")])])]),e._v(" "),t("p",[t("img",{attrs:{src:a(397),alt:"LYWSD03MMC MQTT data view"}})]),e._v(" "),t("p",[e._v("Once the data has been transmitted to the MQTT broker, it can be easily integrated with your preferred controller. For example, the data can be automatically discovered and made available within popular controllers, example below with Home Assistant.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(398),alt:"Home Assistant chart"}})]),e._v(" "),t("p",[e._v("Examples of compatible sensors among [our list](https://decoder.theengs.io/devices/devices_by_brand.html: Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale, iBBQ, TPMS")]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-for-device-tracker-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-for-device-tracker-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices for Device Tracker detection")]),e._v(" "),t("p",[e._v("The gateway will detect BLE trackers from Tile, Nut, TagIt, iTAG, Gigaset G-Tag, TicWatch GTH (Pro), Teltonika FMT100 vehicle tracker and Bosch Nyon eBike computers, as well as other devices with additional properties decoding like Mi Band, Amazfit, RuuviTag and others indicated as Device Trackers in the "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible BLE devices list"),t("OutboundLink")],1),e._v(", and automatically create a device tracker entity following the Home Assistant discovery convention (if auto discovery is activated).")]),e._v(" "),t("p",[e._v("The devicen tracker entity created can be attached to a person to leverage presence detection. The "),t("code",[e._v("away")]),e._v(" or "),t("code",[e._v("not home")]),e._v(" state is triggered if the BLE tracker is not detected during the timer defined by "),t("code",[e._v("presenceawaytimer")]),e._v(".")]),e._v(" "),t("p",[t("img",{attrs:{src:a(399),alt:"Away home Home assistant view"}})]),e._v(" "),t("p",[e._v("By default "),t("code",[e._v("presenceawaytimer")]),e._v(" is set to 120s, you can change it from the slider in your controller or with the following command (ms)")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"presenceawaytimer\":66000}'")])]),e._v(" "),t("p",[e._v("Generally BLE devices will not broadcast if they are paired so you may need to ensure your beacons is unpaired/disconnected before it will be seen by the gateway.")]),e._v(" "),t("p",[e._v("Note that you can find apps to simulate beacons and do some tests like "),t("a",{attrs:{href:"https://play.google.com/store/apps/details?id=net.alea.beaconsimulator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Beacon simulator"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Apple iOS version >=10 devices advertise without an extra MAC address app, nevertheless this address "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/issues/71",target:"_blank",rel:"noopener noreferrer"}},[e._v("changes randomly"),t("OutboundLink")],1),e._v(" and can currently only be used with "),t("a",{attrs:{href:"https://gateway.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(" and its "),t("a",{attrs:{href:"https://gateway.theengs.io/use/use.html#getting-identity-resolving-key-irk-for-apple-watch-iphone-and-ipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identity MAC Address and Identity Resolving Key"),t("OutboundLink")],1),e._v(" feature.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("presenceawaytimer")]),e._v(" is also used to reset the state of the PIR/motion sensors to "),t("code",[e._v("off")]),e._v(" when using HA MQTT discovery convention. If the Sensor does not detect a motion, its state will be automatically set to "),t("code",[e._v("off")]),e._v(" after the "),t("code",[e._v("presenceawaytimer")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-for-presence-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-for-presence-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices for Presence detection")]),e._v(" "),t("p",[e._v('To do this activate the "BT: Publish HASS presence" switch in your controller or send the following MQTT command to your broker: mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"hasspresence":true}\'')]),e._v(" "),t("h2",{attrs:{id:"receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"}},[e._v("#")]),e._v(" Receiving signals from BLE devices with accelerometers for movement detection")]),e._v(" "),t("p",[e._v("The gateway is designed to detect BLE trackers from BlueCharm and automatically create a binary sensor entity in accordance with the Home Assistant discovery convention, provided that auto discovery is enabled.")]),e._v(" "),t("p",[e._v("The binary sensor entity's state will be set to on or off based on whether the BLE beacon's x-axis acceleration value is detected during the time period defined by the movingtimer parameter.")]),e._v(" "),t("p",[e._v("By default, the movingtimer parameter is set to 60 seconds (60,000 ms). To modify this value, use the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"movingtimer\":66000}'")])]),e._v(" "),t("p",[e._v("To ensure proper functionality, configure the beacon using the KBeacon or KBeaconPro app (depending on your specific sensor) with the following settings:")]),e._v(" "),t("ul",[t("li",[e._v('In the General tab, set the Trigger Command to "motion".')]),e._v(" "),t("li",[e._v('In the Slot tab, enable advertisement with the Beacon Type set to "KSensor", the Trigger Only Advertisement option set to "YES", and the Sensor Axis set to "ON".')])]),e._v(" "),t("p",[t("img",{attrs:{src:a(400),alt:"KBeacon trigger settings"}})]),e._v(" "),t("p",[t("img",{attrs:{src:a(401),alt:"KBeacon details"}})]),e._v(" "),t("h2",{attrs:{id:"setting-a-white-or-black-list"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-a-white-or-black-list"}},[e._v("#")]),e._v(" Setting a white or black list")]),e._v(" "),t("p",[e._v("A black list is a list of MAC addresses that will never be published by OMG\nto set black list\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"black-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[e._v("A white list is a list of MAC addresses permitted to be published by OMG\nto set white list\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"white-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[e._v("to temporarily disable white/black list\n"),t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"ignoreWBlist\":true}'")])]),e._v(" "),t("p",[e._v("to enable white/black list back\n"),t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"ignoreWBlist\":false}'")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("So as to keep your white/black list persistent you can publish it with the retain option of MQTT (-r with mosquitto_pub or retain check box of MQTT Explorer)\n"),t("code",[e._v('mosquitto_pub -r -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"white-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}\'')])]),e._v(" "),t("p",[t("strong",[e._v("NOTE")]),e._v(": Only when sending a white/black list should the retain option be set. All other commands to any OpenMQTTGateway gateway "),t("strong",[e._v("must not")]),e._v(" have the retain option set. To persist such other command settings, read "),t("a",{attrs:{href:"https://docs.openmqttgateway.com/use/ble.html#store-ble-configuration-into-the-gateway",target:"_blank",rel:"noopener noreferrer"}},[e._v("the following section"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between BLE scans and force a scan (available with HA discovery)")]),e._v(" "),t("p",[e._v("Example if you want the BLE to scan every 66 seconds:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":66000}'")])]),e._v(" "),t("p",[e._v("you can also force a scan to be done by the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":0}'")])]),e._v(" "),t("p",[e._v("Changing the interval between scans will deactivate adaptive scanning.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("p",[e._v("Once the forced scan has completed, the previous scan interval value will be restored. Forcing a scan command trigger also a BLE connect process after the scan (see below).")]),e._v(" "),t("p",[e._v("The default value "),t("code",[e._v("TimeBtwRead")]),e._v(" is set into config_BT.h or into your .ini file for platformio users.")]),e._v(" "),t("p",[e._v("If you want to scan continuously for BLE devices, for example for beacon location you can set the interval to 100ms:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"interval\":100}'")])]),e._v(" "),t("p",[e._v("In this case you should deactivate the BLE connection mechanism to avoid concurrency between scan and connections (see chapter below, bleconnect).")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("For certain devices like LYWSD03MMC OpenMQTTGateway use a connection (due to the fact that the advertized data are encrypted), this connection mechanism is launched after every "),t("code",[e._v("TimeBtwConnect")]),e._v(" per default, you can modify it by following the procedure below.")])]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between connection attempts (default: 60min, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change the time between BLE connect you can change it by MQTT, if you want the BLE connect time to be every 300s:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"intervalcnct\":300000}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway publishes all the BLE devices scanned or only the detected sensors (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"onlysensors\":true}'")])]),e._v(" "),t("p",[e._v("The gateway will publish only detected sensors and trackers like Mi Flora, Mi jia, Mi Band, LYWSD03MMC... or trackers like Tile, Nut, TagIt or iTag, and not any other other BLE devices. This is useful if you don't use the gateway for presence detection with unrecognised trackers.")]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"}},[e._v("#")]),e._v(" Setting if the gateway publishes known devices which randomly change their MAC address (default: false)")]),e._v(" "),t("p",[e._v("The default is false, as such changing MAC addresses cannot be related to specific devices.")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"randommacs\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway use adaptive scanning (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("Adaptive scanning lets the gateway decide for you the best passive "),t("code",[e._v("interval")]),e._v(" and active "),t("code",[e._v("intervalacts")]),e._v(" scan interval, depending on the characteristics of your devices.\nThe gateway retrieves your devices' information from "),t("a",{attrs:{href:"https://decoder.theengs.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Decoder"),t("OutboundLink")],1),e._v(" and adapts its parameters accordingly if a device that requires it is detected.\nFor example a door or a PIR sensor will require continuous scanning, so if detected the gateway is going to reduce its time between scans to the minimum. Or your devices may also require active scanning to retrieve data, in this case the gateway will also trigger active scans at regular intervals.")]),e._v(" "),t("p",[e._v("If you want to change this characteristic (default:true):")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"adaptivescan\":false}'")])]),e._v(" "),t("p",[e._v("Setting Adaptive scanning to "),t("code",[e._v("false")]),e._v(" will automatically put the gateway to continuous active scanning if no additional manual changes have already been applied.")]),e._v(" "),t("p",[e._v("An overview with background information to better understand the different setting used:")]),e._v(" "),t("p",[t("strong",[e._v("Passive scanning:")]),e._v(" With this scanning mode the gateway picks up any freely available broadcasts sent out by devices, without any interaction with the devices. The interval for this is set with "),t("a",{attrs:{href:"#setting-the-time-between-ble-scans-and-force-a-scan"}},[e._v('{"interval":66000}')])]),e._v(" "),t("p",[t("strong",[e._v("Active scanning:")]),e._v(" With this scanning mode the gateway sends out requests for sensor broadcasts first, before then picking up the broadcast advertisement data. Some devices require this request before they send out all data in their broadcasts. The interval for this active scanning with request first is set by "),t("a",{attrs:{href:"#setting-the-time-between-active-scanning"}},[e._v('{"intervalacts":300000}')])]),e._v(" "),t("p",[e._v("Setting "),t("a",{attrs:{href:"#advanced-publishing-advertisement-and-advanced-data-default-false"}},[e._v("Publishing advertisement and advanced data")]),e._v(" to true will show you additional data about which of your devices require active scanning and/or continuous scanning, so that you can tune these setting to your devices and your individual requirements of their data.")]),e._v(" "),t("p",[t("strong",[e._v('"cont":true')]),e._v(' - the device requires continuous scanning. If passive ({"interval":100}) or active ({"intervalacts":100}) depends on the additional device specification.')]),e._v(" "),t("p",[t("strong",[e._v('"acts":true')]),e._v(" - the device requires active scanning to broadcast all of it's data for decoding.")]),e._v(" "),t("h2",{attrs:{id:"setting-the-time-between-active-scanning-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-time-between-active-scanning-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the time between active scanning (available with HA discovery)")]),e._v(" "),t("p",[e._v("If you have passive scanning activated, but also have some devices which require active scanning, this defines the time interval between two intermittent active scans.")]),e._v(" "),t("p",[e._v("Example for setting the active scan interval time to every 5 minutes:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"intervalacts\":300000}'")])]),e._v(" "),t("p",[e._v("Changing the active scan interval will deactivate adaptive scanning.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("The active scan interval "),t("code",[e._v("intervalacts")]),e._v(" can only bet set equal to or higher than the passive scan interval "),t("code",[e._v("interval")]),e._v(", as any lower value would not make any sense.")])]),e._v(" "),t("h2",{attrs:{id:"setting-the-duration-of-a-scan-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-duration-of-a-scan-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting the duration of a scan (available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change the default duration of each scan cycle to 5 seconds")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"scanduration\":5000}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway connects to BLE devices eligibles (default: true, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to change this characteristic:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"bleconnect\":false}'")])]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" Setting if the gateway publish into Home Assistant Home presence topic (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to publish to Home Assistant presence topic, you can activate this function by the HASS interface (this command is auto discovered), "),t("RouterLink",{attrs:{to:"/integrate/home_assistant.html#mqtt-room-presence"}},[e._v("here is a yaml example")]),e._v(".\nOr by an MQTT command.")],1),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"hasspresence\":true}'")])]),e._v(" "),t("p",[e._v("To change presence publication topic, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"prestopic":"presence/"}\'')])]),e._v(" "),t("p",[e._v("To use iBeacon UUID for presence, instead of sender (random) MAC address, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"presuseuuid\":true}'")])]),e._v(" "),t("p",[e._v("This will change usual payload for iBeacon from:\n"),t("code",[e._v('{"id":"60:87:57:4C:9B:C2","mac_type":1,"rssi":-78,"distance":7.85288,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}')]),e._v("\nTo:\n"),t("code",[e._v('{"id":"1de4b189115e45f6b44e509352269977","mac_type":1,"rssi":-78,"distance":7.85288,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66,"mac":"60:87:57:4C:9B:C2"}')]),e._v('\nNote: the MAC address is put in "mac" field.')]),e._v(" "),t("h2",{attrs:{id:"setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"}},[e._v("#")]),e._v(" Setting if the gateway uses iBeacon UUID as topic, instead of (random) MAC address (default: false)")]),e._v(" "),t("p",[e._v("By default, iBeacon are published like other devices, using a topic based on the MAC address of the sender.\nBut modern phones randomize their Bluetooth MAC address making it difficult to track iBeacon.")]),e._v(" "),t("p",[e._v("For example, the 2 following messages corresponds to the same iBeacon, but with different MAC and topics:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/BTtoMQTT/58782076BC24 {"id":"58:78:20:76:BC:24","mac_type":1,"rssi":-79,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\nhome/OpenMQTTGateway/BTtoMQTT/5210A84690AC {"id":"52:10:A8:46:90:AC","mac_type":1,"rssi":-77,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br")])]),t("p",[e._v("To use iBeacon UUID as topic, use this MQTT command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubuuid4topic\":true}'")])]),e._v(" "),t("p",[e._v("Resulting in such messages (for the same iBeacon as previously):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/BTtoMQTT/1de4b189115e45f6b44e509352269977 {"id":"52:10:A8:46:90:AC","mac_type":1,"rssi":-76,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\nhome/OpenMQTTGateway/BTtoMQTT/1de4b189115e45f6b44e509352269977 {"id":"7B:63:C6:82:DC:57","mac_type":1,"rssi":-83,"brand":"GENERIC","model":"iBeacon","model_id":"IBEACON","mfid":"4c00","uuid":"1de4b189115e45f6b44e509352269977","major":0,"minor":0,"txpower":-66}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br")])]),t("h2",{attrs:{id:"setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"}},[e._v("#")]),e._v(" Setting the minimum RSSI accepted to publish device data (default:-100)")]),e._v(" "),t("p",[e._v("If you want to change the minimum RSSI value accepted for a device to be published, you can change it by MQTT. For example if you want to set -80")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"minrssi\":-80}'")])]),e._v(" "),t("p",[e._v("you can also accept all the devices by the following command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"minrssi\":-200}'")])]),e._v(" "),t("p",[e._v("The default value is set into config_BT.h")]),e._v(" "),t("h2",{attrs:{id:"store-ble-configuration-into-the-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#store-ble-configuration-into-the-gateway"}},[e._v("#")]),e._v(" Store BLE configuration into the gateway")]),e._v(" "),t("p",[e._v("OpenMQTTGateway has the capability to save the current configuration and reload it at startup.")]),e._v(" "),t("p",[e._v("To store the running configuration into the gateway, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"save\":true}'")])]),e._v(" "),t("p",[e._v("At any time, you can reload the stored configuration with the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"load\":true}'")])]),e._v(" "),t("p",[e._v("If you want to erase the stored configuration, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"erase\":true}'")]),e._v("\nNote that it will not change the running configuration, only ensure default configuration is used at next startup.")]),e._v(" "),t("p",[e._v("By the way, if you want to load the default built-in configuration (on any board, not only ESP32), use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"init\":true}'")]),e._v("\nNote that it will not change the stored configuration, "),t("code",[e._v("erase")]),e._v(" or "),t("code",[e._v("save")]),e._v(" is still needed to overwrite the saved configuration.")]),e._v(" "),t("h2",{attrs:{id:"controlling-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#controlling-devices"}},[e._v("#")]),e._v(" Controlling devices")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("To control devices reliably, set the interval between scans to at least 5 seconds and the scan duration to 1 second to ensure commands are successfully transmitted to your devices.")])]),e._v(" "),t("h2",{attrs:{id:"read-write-ble-characteristics-over-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#read-write-ble-characteristics-over-mqtt"}},[e._v("#")]),e._v(" Read/write BLE characteristics over MQTT")]),e._v(" "),t("p",[e._v("The gateway can read and write BLE characteristics from devices and provide the results in an MQTT message.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("These actions will be taken on the next BLE connection, which occurs after scanning and after the scan count is reached, "),t("a",{attrs:{href:"#setting-the-number-of-scans-between-connection-attempts"}},[e._v("see above to set this")]),e._v(".\nThis can be overridden by providing an (optional) parameter "),t("code",[e._v('"immediate": true')]),e._v(" within the command. This will cause the BLE scan to stop if currently in progress, allowing the command to be immediately processed. All other connection commands in queue will also be processed for the same device, commands for other devices will be deferred until the next normally scheduled connection.")]),e._v(" "),t("p",[t("strong",[e._v("Note")]),e._v(' Some devices need to have the MAC address type specified. You can find this type by checking the log/MQTT data and looking for "mac_type". The mac_type of your device can be seen by setting '),t("code",[e._v("pubadvdata")]),e._v(" to "),t("code",[e._v("true")]),e._v(" with an MQTT command (see Publishing advertisement data), or with the macro "),t("code",[e._v("pubBLEAdvData true")]),e._v(". By default the type is 0 but some devices use different type values. You must specify the correct type to connect successfully."),t("br"),e._v("\nTo specify the MAC address type add the parameter "),t("code",[e._v('"mac_type"')]),e._v(" to the command. For example "),t("code",[e._v('"mac_type": 1')]),e._v(" to connect with a device with the MAC address type of 1.")])]),e._v(" "),t("h3",{attrs:{id:"example-write-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-write-command"}},[e._v("#")]),e._v(" Example write command")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "ble_write_address":"AA:BB:CC:DD:EE:FF",\n "ble_write_service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "ble_write_char":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "ble_write_value":"TEST",\n "value_type":"STRING",\n "ttl":4,\n "immediate":true }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br")])]),t("p",[e._v("Response:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "characteristic":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "write":"TEST",\n "success":true\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br")])]),t("h3",{attrs:{id:"example-read-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-read-command"}},[e._v("#")]),e._v(" Example read command")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "ble_read_address":"AA:BB:CC:DD:EE:FF",\n "ble_read_service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "ble_read_char":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "value_type":"STRING",\n "ttl": 2 }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("p",[e._v("Response:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "service":"cba20d00-224d-11e6-9fb8-0002a5d5c51b",\n "characteristic":"cba20002-224d-11e6-9fb8-0002a5d5c51b",\n "read":"TEST",\n "success":true\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("ttl")]),e._v(" parameter is the number of attempts to connect (defaults to 1), which occur after the BLE scan completes."),t("br"),e._v(" "),t("code",[e._v("value_type")]),e._v(" can be one of: STRING, HEX, INT, FLOAT. Default is STRING if omitted in the message.")])]),e._v(" "),t("h2",{attrs:{id:"switchbot-bot-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-bot-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Bot control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Bot devices are automatically discovered and available as a device in the Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Press")]),e._v(" "),t("li",[e._v("On")]),e._v(" "),t("li",[e._v("Off")]),e._v(" "),t("li",[e._v("Up")]),e._v(" "),t("li",[e._v("Down")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the SwitchBot mode is changed the ESP32 must be restarted.")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-bot-state-to-on"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-state-to-on"}},[e._v("#")]),e._v(" Set the SwitchBot Bot state to ON:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"on",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-state-to-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-state-to-off"}},[e._v("#")]),e._v(" Set the SwitchBot Bot state to OFF:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"off",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-press"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-press"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to PRESS:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"press",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-go-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-go-up"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to go UP:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"up",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-bot-to-go-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-bot-to-go-down"}},[e._v("#")]),e._v(" Set the SwitchBot Bot to go DOWN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"X1",\n "cmd":"down",\n "id":"AA:BB:CC:DD:EE:FF"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("Response (assuming success):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "state":"on"\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("h2",{attrs:{id:"switchbot-blind-tilt-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-blind-tilt-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Blind Tilt control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Blind Tilt devices are automatically discovered and available as a device in the settings Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Open")]),e._v(" "),t("li",[e._v("Close down")]),e._v(" "),t("li",[e._v("Set a percentage")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-open"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-open"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to OPEN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"open",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-close-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-close-down"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to CLOSE_DOWN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"close_down",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-close-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-close-up"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to CLOSE_UP:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"close_up",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt state to a percentage (0-100):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":55,\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-blind-tilt-to-stop"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-blind-tilt-to-stop"}},[e._v("#")]),e._v(" Set the SwitchBot Blind Tilt to Stop:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W270160X",\n "tilt":"stop",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"response-assuming-success"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-assuming-success"}},[e._v("#")]),e._v(" Response (assuming success):")]),e._v(" "),t("p",[e._v("The Switchbot Blind Tilt response :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "tilt":55,\n "open":90,\n "direction":"up"\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("h2",{attrs:{id:"switchbot-curtain-2-3-control-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switchbot-curtain-2-3-control-available-with-ha-discovery"}},[e._v("#")]),e._v(" SwitchBot Curtain (2/3) control (available with HA discovery)")]),e._v(" "),t("p",[e._v("SwitchBot Curtain (2/3) devices are automatically discovered and available as a device in the settings Home Assistant Settings menu. The following commands are supported:")]),e._v(" "),t("ul",[t("li",[e._v("Set a percentage")])]),e._v(" "),t("p",[e._v("The device can also be controlled over MQTT with a simplified BLE write command.")]),e._v(" "),t("h3",{attrs:{id:"set-the-switchbot-curtain-state-to-open"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-state-to-open"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain state to OPEN:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"open",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-state-to-close"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-state-to-close"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain state to CLOSE:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"close",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-to-a-percentage-0-100"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-to-a-percentage-0-100"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain to a percentage (0-100):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":55,\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"set-the-switchbot-curtain-to-stop"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-the-switchbot-curtain-to-stop"}},[e._v("#")]),e._v(" Set the SwitchBot Curtain to Stop:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT -m \'{\n "model_id":"W070160X",\n "position":"stop",\n "id":"AA:BB:CC:DD:EE:FF"\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("h3",{attrs:{id:"response-assuming-success-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-assuming-success-2"}},[e._v("#")]),e._v(" Response (assuming success):")]),e._v(" "),t("p",[e._v("The Switchbot Curtain response :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "id":"AA:BB:CC:DD:EE:FF",\n "position":55,\n}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("h2",{attrs:{id:"advanced-setting-up-an-external-decoder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-setting-up-an-external-decoder"}},[e._v("#")]),e._v(" ADVANCED: Setting up an external decoder")]),e._v(" "),t("p",[e._v("This advanced option is used to publish raw radio frames on a specific topic to be decoded by an external decoder instead of the integrated one.")]),e._v(" "),t("p",[e._v("To enable external decoder:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"extDecoderEnable\":true}'")])]),e._v(" "),t("p",[e._v('To change the default external decoder topic to "undecoded":')]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m \'{"extDecoderTopic":"undecoded"}\'')])]),e._v(" "),t("h2",{attrs:{id:"advanced-filtering-out-connectable-devices-default-false"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-filtering-out-connectable-devices-default-false"}},[e._v("#")]),e._v(" ADVANCED: Filtering out connectable devices (default: false)")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/integrate/openhab2.html"}},[e._v("With OpenHAB integration")]),e._v(", this configuration is highly recommended, otherwise you may encounter incomplete data.")],1),e._v(" "),t("p",[e._v("If you want to enable this feature:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"filterConnectable\":true}'")])]),e._v(" "),t("h2",{attrs:{id:"advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}},[e._v("#")]),e._v(" ADVANCED: Advertisement and advanced data (default: false, available with HA discovery)")]),e._v(" "),t("p",[e._v("If you want to enable this feature:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubadvdata\":true}'")])]),e._v(" "),t("p",[e._v("This will publish extensive information about the device:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"11:22:33:44:55:66"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"mac_type"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"adv_type"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Qingping Motion & Light"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"rssi"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("-93")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servicedata"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"88121122334455660201520f0126090403000000"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servicedatauuid"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0xfdcd"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"brand"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Qingping"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"model"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Motion & Light"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"model_id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"CGPR1"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"lux"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("3")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"batt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("82")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("To stop publishing advertisement data:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{\"pubadvdata\":false}'")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("All product and company names are trademarks or registered trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("We strongly encourage the use of a white-list (see below) so as to collect data from your devices only and not from other MAC addresses.\nBy default the gateway scans the advertizing BLE devices nearby with their MAC addresses. Depending on your country, it may be illegal to monitor networks for MAC addresses, especially on networks that you do not own. Please check your country's laws (for US Section 18 U.S. Code § 2511) - "),t("a",{attrs:{href:"https://github.com/schollz/howmanypeoplearearound/issues/4",target:"_blank",rel:"noopener noreferrer"}},[e._v("discussion here"),t("OutboundLink")],1),e._v(".")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/24.c7122817.js b/dev/assets/js/24.c5f9e1a7.js similarity index 89% rename from dev/assets/js/24.c7122817.js rename to dev/assets/js/24.c5f9e1a7.js index f8a94ee2..e39a9db9 100644 --- a/dev/assets/js/24.c7122817.js +++ b/dev/assets/js/24.c5f9e1a7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{375:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf1.47444089.png"},376:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf2.0b5d6723.png"},377:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf3.374ee8dd.png"},378:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_ble.161a7c67.png"},439:function(e,t,r){"use strict";r.r(t);var a=r(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#devices"}},[e._v("#")]),e._v(" Devices")]),e._v(" "),t("p",[e._v("You can take a look to the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenMQTTGateway compatible website"),t("OutboundLink")],1),e._v(" to have a view of the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("supported devices"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Added to that is an overview of devices supported by OpenMQTTGateway:")]),e._v(" "),t("h2",{attrs:{id:"for-radio-frequency-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-radio-frequency-devices"}},[e._v("#")]),e._v(" For radio frequency devices")]),e._v(" "),t("p",[e._v("OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipsets are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an "),t("a",{attrs:{href:"https://wiki.pilight.org/devices",target:"_blank",rel:"noopener noreferrer"}},[e._v("huge list"),t("OutboundLink")],1),e._v(".\nNote that for the moment RF, RF2 and Pilight can not be activated on the same boards together.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(375),alt:"boards",title:":size=250%"}}),e._v(" "),t("img",{attrs:{src:r(376),alt:"boards",title:":size=250%"}}),e._v(" "),t("img",{attrs:{src:r(377),alt:"boards",title:":size=250%"}})]),e._v(" "),t("h2",{attrs:{id:"for-ble-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-ble-devices"}},[e._v("#")]),e._v(" For BLE devices")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is able to scan all the BLE devices that advertise their data so as to do presence detection.\nAdded to that it retrieves the measures from the devices mentioned and linked to below. By default the data are read from the advertisements (no or very little impact on device battery life). For some devices we may connect briefly only to retrieve one or several parameters.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway currently supports the decoding of "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("more than 100 Bluetooth devices"),t("OutboundLink")],1),e._v(", which include popular devices like Mi Flora, Xiaomi scales, Inkbird, Govee and ThermoPro thermo-hygrometers and BBQ thermometers, SwitchBot devices status and many more.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("ul",[t("li",[e._v("(2) See https://github.com/atc1441/ATC_MiThermometer")]),e._v(" "),t("li",[e._v("(3) See https://github.com/pvvx/ATC_MiThermometer")])])]),e._v(" "),t("p",[t("img",{attrs:{src:r(378),alt:"devices",title:":size=250%"}})]),e._v(" "),t("h2",{attrs:{id:"for-infrared-ir-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-infrared-ir-devices"}},[e._v("#")]),e._v(" For infrared IR devices")]),e._v(" "),t("p",[e._v("The list of supported devices for ESP is "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" for Arduino boards, as there is also the possibility of using raw and global cache (ESP) sending possibilities of this gateway is huge!")]),e._v(" "),t("h2",{attrs:{id:"lora"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lora"}},[e._v("#")]),e._v(" LORA")]),e._v(" "),t("p",[e._v("LoRa is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{374:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf1.47444089.png"},375:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf2.0b5d6723.png"},376:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_rf3.374ee8dd.png"},377:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_devices_ble.161a7c67.png"},439:function(e,t,r){"use strict";r.r(t);var a=r(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#devices"}},[e._v("#")]),e._v(" Devices")]),e._v(" "),t("p",[e._v("You can take a look to the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenMQTTGateway compatible website"),t("OutboundLink")],1),e._v(" to have a view of the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("supported devices"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Added to that is an overview of devices supported by OpenMQTTGateway:")]),e._v(" "),t("h2",{attrs:{id:"for-radio-frequency-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-radio-frequency-devices"}},[e._v("#")]),e._v(" For radio frequency devices")]),e._v(" "),t("p",[e._v("OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipsets are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an "),t("a",{attrs:{href:"https://wiki.pilight.org/devices",target:"_blank",rel:"noopener noreferrer"}},[e._v("huge list"),t("OutboundLink")],1),e._v(".\nNote that for the moment RF, RF2 and Pilight can not be activated on the same boards together.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(374),alt:"boards",title:":size=250%"}}),e._v(" "),t("img",{attrs:{src:r(375),alt:"boards",title:":size=250%"}}),e._v(" "),t("img",{attrs:{src:r(376),alt:"boards",title:":size=250%"}})]),e._v(" "),t("h2",{attrs:{id:"for-ble-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-ble-devices"}},[e._v("#")]),e._v(" For BLE devices")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is able to scan all the BLE devices that advertise their data so as to do presence detection.\nAdded to that it retrieves the measures from the devices mentioned and linked to below. By default the data are read from the advertisements (no or very little impact on device battery life). For some devices we may connect briefly only to retrieve one or several parameters.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway currently supports the decoding of "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("more than 100 Bluetooth devices"),t("OutboundLink")],1),e._v(", which include popular devices like Mi Flora, Xiaomi scales, Inkbird, Govee and ThermoPro thermo-hygrometers and BBQ thermometers, SwitchBot devices status and many more.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("ul",[t("li",[e._v("(2) See https://github.com/atc1441/ATC_MiThermometer")]),e._v(" "),t("li",[e._v("(3) See https://github.com/pvvx/ATC_MiThermometer")])])]),e._v(" "),t("p",[t("img",{attrs:{src:r(377),alt:"devices",title:":size=250%"}})]),e._v(" "),t("h2",{attrs:{id:"for-infrared-ir-devices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#for-infrared-ir-devices"}},[e._v("#")]),e._v(" For infrared IR devices")]),e._v(" "),t("p",[e._v("The list of supported devices for ESP is "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" for Arduino boards, as there is also the possibility of using raw and global cache (ESP) sending possibilities of this gateway is huge!")]),e._v(" "),t("h2",{attrs:{id:"lora"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lora"}},[e._v("#")]),e._v(" LORA")]),e._v(" "),t("p",[e._v("LoRa is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/26.60581abf.js b/dev/assets/js/26.2b046c45.js similarity index 91% rename from dev/assets/js/26.60581abf.js rename to dev/assets/js/26.2b046c45.js index eed7251e..089c2f30 100644 --- a/dev/assets/js/26.60581abf.js +++ b/dev/assets/js/26.2b046c45.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{267:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},373:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Logo.0bf74c4e.png"},374:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Warning.a0afd25c.png"},436:function(a,s,e){"use strict";e.r(s);var t=e(14),r=Object(t.a)({},(function(){var a=this,s=a._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"m5-boards"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#m5-boards"}},[a._v("#")]),a._v(" M5 Boards")]),a._v(" "),s("p",[a._v("M5 boards, manufactured by "),s("a",{attrs:{href:"https://m5stack.com/",target:"_blank",rel:"noopener noreferrer"}},[a._v("M5Stack"),s("OutboundLink")],1),a._v(" are inexpensive, well featured boards based on ESP32.")]),a._v(" "),s("h2",{attrs:{id:"m5stickc-and-m5stack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#m5stickc-and-m5stack"}},[a._v("#")]),a._v(" M5StickC and M5Stack")]),a._v(" "),s("p",[a._v("M5StickC and M5Stack are supported by OpenMQTTGateway and provide the following features:")]),a._v(" "),s("h3",{attrs:{id:"_3-low-power-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#_3-low-power-modes"}},[a._v("#")]),a._v(" 3 low power modes")]),a._v(" "),s("h4",{attrs:{id:"always-on-display"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#always-on-display"}},[a._v("#")]),a._v(" Always ON display")]),a._v(" "),s("p",[a._v("The display is always ON but decrease its brightness when not processing.")]),a._v(" "),s("h4",{attrs:{id:"on-display-when-processing"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#on-display-when-processing"}},[a._v("#")]),a._v(" ON display when processing")]),a._v(" "),s("p",[a._v("The display is OFF when not processing and the ESP32 is put in low power mode.")]),a._v(" "),s("h4",{attrs:{id:"always-off-display"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#always-off-display"}},[a._v("#")]),a._v(" Always OFF display")]),a._v(" "),s("p",[a._v("The display is always OFF, if the board has a led, the led is used when processing.")]),a._v(" "),s("p",[a._v("To change the low power mode you can do it by "),s("a",{attrs:{href:"../use/boards#low-power-mode-for-m5-boards"}},[a._v("MQTT")]),a._v(" or by pushing the middle button (btn B) of the M5Stack and the top button (btn B) of the M5Stick C")]),a._v(" "),s("h3",{attrs:{id:"start-screen"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#start-screen"}},[a._v("#")]),a._v(" Start screen")]),a._v(" "),s("p",[s("img",{attrs:{src:e(373),alt:"MStack core logo"}})]),a._v(" "),s("h3",{attrs:{id:"sleep-screen"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sleep-screen"}},[a._v("#")]),a._v(" Sleep screen")]),a._v(" "),s("p",[a._v("The screen brightness is put to a minimum so as to reduce power consumption.\n"),s("img",{attrs:{src:e(267),alt:"M5Stack core brightness"}})]),a._v(" "),s("h3",{attrs:{id:"log-display-in-case-of-warning"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#log-display-in-case-of-warning"}},[a._v("#")]),a._v(" Log display in case of warning")]),a._v(" "),s("p",[a._v("If the gateway detects a warning or an error the sleep go out the sleep screen and show the message with a red (error) or orange (warning) background.\n"),s("img",{attrs:{src:e(374),alt:"M5 Stack core warning"}})]),a._v(" "),s("p",[a._v("The M5Stick support low power mode 2 but its display is not supported for the moment.")])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{267:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},379:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Logo.0bf74c4e.png"},380:function(a,s,e){a.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Warning.a0afd25c.png"},443:function(a,s,e){"use strict";e.r(s);var t=e(14),r=Object(t.a)({},(function(){var a=this,s=a._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"m5-boards"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#m5-boards"}},[a._v("#")]),a._v(" M5 Boards")]),a._v(" "),s("p",[a._v("M5 boards, manufactured by "),s("a",{attrs:{href:"https://m5stack.com/",target:"_blank",rel:"noopener noreferrer"}},[a._v("M5Stack"),s("OutboundLink")],1),a._v(" are inexpensive, well featured boards based on ESP32.")]),a._v(" "),s("h2",{attrs:{id:"m5stickc-and-m5stack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#m5stickc-and-m5stack"}},[a._v("#")]),a._v(" M5StickC and M5Stack")]),a._v(" "),s("p",[a._v("M5StickC and M5Stack are supported by OpenMQTTGateway and provide the following features:")]),a._v(" "),s("h3",{attrs:{id:"_3-low-power-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#_3-low-power-modes"}},[a._v("#")]),a._v(" 3 low power modes")]),a._v(" "),s("h4",{attrs:{id:"always-on-display"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#always-on-display"}},[a._v("#")]),a._v(" Always ON display")]),a._v(" "),s("p",[a._v("The display is always ON but decrease its brightness when not processing.")]),a._v(" "),s("h4",{attrs:{id:"on-display-when-processing"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#on-display-when-processing"}},[a._v("#")]),a._v(" ON display when processing")]),a._v(" "),s("p",[a._v("The display is OFF when not processing and the ESP32 is put in low power mode.")]),a._v(" "),s("h4",{attrs:{id:"always-off-display"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#always-off-display"}},[a._v("#")]),a._v(" Always OFF display")]),a._v(" "),s("p",[a._v("The display is always OFF, if the board has a led, the led is used when processing.")]),a._v(" "),s("p",[a._v("To change the low power mode you can do it by "),s("a",{attrs:{href:"../use/boards#low-power-mode-for-m5-boards"}},[a._v("MQTT")]),a._v(" or by pushing the middle button (btn B) of the M5Stack and the top button (btn B) of the M5Stick C")]),a._v(" "),s("h3",{attrs:{id:"start-screen"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#start-screen"}},[a._v("#")]),a._v(" Start screen")]),a._v(" "),s("p",[s("img",{attrs:{src:e(379),alt:"MStack core logo"}})]),a._v(" "),s("h3",{attrs:{id:"sleep-screen"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sleep-screen"}},[a._v("#")]),a._v(" Sleep screen")]),a._v(" "),s("p",[a._v("The screen brightness is put to a minimum so as to reduce power consumption.\n"),s("img",{attrs:{src:e(267),alt:"M5Stack core brightness"}})]),a._v(" "),s("h3",{attrs:{id:"log-display-in-case-of-warning"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#log-display-in-case-of-warning"}},[a._v("#")]),a._v(" Log display in case of warning")]),a._v(" "),s("p",[a._v("If the gateway detects a warning or an error the sleep go out the sleep screen and show the message with a red (error) or orange (warning) background.\n"),s("img",{attrs:{src:e(380),alt:"M5 Stack core warning"}})]),a._v(" "),s("p",[a._v("The M5Stick support low power mode 2 but its display is not supported for the moment.")])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/28.afe597be.js b/dev/assets/js/28.db22406f.js similarity index 95% rename from dev/assets/js/28.afe597be.js rename to dev/assets/js/28.db22406f.js index 731d5df8..f0812047 100644 --- a/dev/assets/js/28.afe597be.js +++ b/dev/assets/js/28.db22406f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{393:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_menu.f1eb2987.png"},394:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_enter_parameters.e94d359c.png"},395:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_save.cb8305ec.png"},454:function(t,e,a){"use strict";a.r(e);var s=a(14),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"wifi-and-mqtt-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi-and-mqtt-configuration"}},[t._v("#")]),t._v(" Wifi and MQTT configuration")]),t._v(" "),e("h2",{attrs:{id:"configuration-portal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-portal"}},[t._v("#")]),t._v(" Configuration portal")]),t._v(" "),e("p",[t._v("Once loaded into your ESP, and if you don't use the manual configuration, you have to set your network parameters with WiFi Manager portal.")]),t._v(" "),e("p",[t._v("From your smartphone, search for  OpenMQTTGateway or OMG_ WiFi network and connect to it without password, or if you are using a device sold by Theengs or the macro "),e("code",[t._v("-DWM_PWD_FROM_MAC=true")]),t._v(", the password will be the last eight digits of the device MAC Address with upper case.\nExample, the password would be "),e("code",[t._v("CCDDEEFF")]),t._v(" for a MAC Address "),e("code",[t._v("AABBCCDDEEFF")]),t._v(".\nFor the Theengs Plug, the MAC Address can be found on the device sticker, and for all the devices, it is printed on the serial monitor logs.")]),t._v(" "),e("p",[t._v('Once connected to the WiFi, a web page should appear. On Android, you may also have a popup asking you if you want to connect to it without an internet connection. Answer yes always/all the time. If the web page doesn\'t appear, click on the WiFi Access Point and "Manage router".')]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("For boards with an ethernet port you can also access to the Wifi Manager portal through the LAN board IP address.")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(393),alt:"WiFi manager menu"}})]),t._v(" "),e("ul",[e("li",[t._v("Click on Configure WiFi")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(394),alt:"WiFi manager parameters"}})]),t._v(" "),e("ul",[e("li",[t._v("Select your WiFi")]),t._v(" "),e("li",[t._v("Set your WiFi password")])]),t._v(" "),e("p",[t._v("::: note\nIf the board is connected by ethernet, the Wifi and password can be empty. If you fill them the board will use this wifi as a fallback connectivity method.\n:::")]),t._v(" "),e("ul",[e("li",[t._v("Set your MQTT Server IP or domain name (for Home Assistant you can enter "),e("code",[t._v("homeassistant.local")]),t._v(" if your server is configured with mDNS)")]),t._v(" "),e("li",[t._v("Set your MQTT Server Port (default: 1883)")]),t._v(" "),e("li",[t._v("Set your MQTT Server username (optional, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your MQTT Server password (optional, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your MQTT base topic if you need to change it (you must keep the / at the end) (default: home/, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your gateway name if you need to change it")]),t._v(" "),e("li",[t._v("Set your gateway password (default: empty, 8 characters minimum, 64 maximum), this password is used for\n"),e("ul",[e("li",[t._v("Local and remote OTA")]),t._v(" "),e("li",[t._v('WebUI login (login:"admin", password: "")')]),t._v(" "),e("li",[t._v("WiFi Manager Access Point password after initial config")])])]),t._v(" "),e("li",[t._v("Set the MQTT secure connection box to select whether or not the connection should be secure")]),t._v(" "),e("li",[t._v("Set the certificate validation to select wether or not you want to validate the server identity with a certificate")]),t._v(" "),e("li",[t._v("Copy/paste the MQTT server certificate in the MQTT server cert box (only required if using a secure connection), be sure to include the "),e("code",[t._v("-----BEGIN CERTIFICATE-----")]),t._v(" and "),e("code",[t._v("-----END CERTIFICATE-----")]),t._v(" markers")]),t._v(" "),e("li",[t._v("Add your certificates")]),t._v(" "),e("li",[t._v("Click on save")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(395),alt:"WiFi manager save"}})]),t._v(" "),e("p",[t._v("The ESP restart and connect to your network. Note that your credentials are saved into the ESP memory, if you want to redo the configuration you have to erase the ESP memory with the flash download tool.")]),t._v(" "),e("p",[t._v("Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("home/OpenMQTTGateway/LWT Online \n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Note that the web portal appears only on first boot, if you want to configure again the setting you can do a long press on TRIGGER_GPIO, "),e("RouterLink",{attrs:{to:"/use/gateway.html#erase-the-esp-settings"}},[t._v("erase the settings")]),t._v(" or Reset the configuration from the WebUI.")],1),t._v(" "),e("h2",{attrs:{id:"build-time-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#build-time-configuration"}},[t._v("#")]),t._v(" Build time configuration")]),t._v(" "),e("p",[t._v("You can configure your MQTT server credentials and network configuration before building the application. It can be done either in Arduino or in Platformio IDE thought the User_config.h file. Note that with Platformio IDE you can also set your credentials into the platformio.ini file or an *_env.ini file, here is an example with the Olimex ESP32 gateway:")]),t._v(" "),e("div",{staticClass:"language-ini line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-ini"}},[e("code",[e("span",{pre:!0,attrs:{class:"token section"}},[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token section-name selector"}},[t._v("env:esp32-olimex-gtw-ble")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")])]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("platform")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("${com.esp32_platform}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("platform_packages")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("${com.esp32_platform_packages}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("board")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("esp32-gateway")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("board_build.partitions")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("min_spiffs.csv")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("lib_deps")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v("\n ${com-esp.lib_deps}\n ${libraries.ble}\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("build_flags")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v("\n ${com-esp.build_flags}\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DZgatewayBT")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"BT"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DLED_INFO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("33'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DLED_INFO_ON")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("1'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DESP32_ETHERNET")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("true'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_SERVER")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"11.22.33.44"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_USER")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"salut"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_PASS")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"atoi"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DGateway_Name")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"OpenMQTTGateway_ESP32_OLM_GTW"\'')]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br"),e("span",{staticClass:"line-number"},[t._v("8")]),e("br"),e("span",{staticClass:"line-number"},[t._v("9")]),e("br"),e("span",{staticClass:"line-number"},[t._v("10")]),e("br"),e("span",{staticClass:"line-number"},[t._v("11")]),e("br"),e("span",{staticClass:"line-number"},[t._v("12")]),e("br"),e("span",{staticClass:"line-number"},[t._v("13")]),e("br"),e("span",{staticClass:"line-number"},[t._v("14")]),e("br"),e("span",{staticClass:"line-number"},[t._v("15")]),e("br"),e("span",{staticClass:"line-number"},[t._v("16")]),e("br"),e("span",{staticClass:"line-number"},[t._v("17")]),e("br"),e("span",{staticClass:"line-number"},[t._v("18")]),e("br")])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{402:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_menu.f1eb2987.png"},403:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_enter_parameters.e94d359c.png"},404:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTGateway_Wifi_Manager_save.cb8305ec.png"},459:function(t,e,a){"use strict";a.r(e);var s=a(14),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"wifi-and-mqtt-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi-and-mqtt-configuration"}},[t._v("#")]),t._v(" Wifi and MQTT configuration")]),t._v(" "),e("h2",{attrs:{id:"configuration-portal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-portal"}},[t._v("#")]),t._v(" Configuration portal")]),t._v(" "),e("p",[t._v("Once loaded into your ESP, and if you don't use the manual configuration, you have to set your network parameters with WiFi Manager portal.")]),t._v(" "),e("p",[t._v("From your smartphone, search for  OpenMQTTGateway or OMG_ WiFi network and connect to it without password, or if you are using a device sold by Theengs or the macro "),e("code",[t._v("-DWM_PWD_FROM_MAC=true")]),t._v(", the password will be the last eight digits of the device MAC Address with upper case.\nExample, the password would be "),e("code",[t._v("CCDDEEFF")]),t._v(" for a MAC Address "),e("code",[t._v("AABBCCDDEEFF")]),t._v(".\nFor the Theengs Plug, the MAC Address can be found on the device sticker, and for all the devices, it is printed on the serial monitor logs.")]),t._v(" "),e("p",[t._v('Once connected to the WiFi, a web page should appear. On Android, you may also have a popup asking you if you want to connect to it without an internet connection. Answer yes always/all the time. If the web page doesn\'t appear, click on the WiFi Access Point and "Manage router".')]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("For boards with an ethernet port you can also access to the Wifi Manager portal through the LAN board IP address.")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(402),alt:"WiFi manager menu"}})]),t._v(" "),e("ul",[e("li",[t._v("Click on Configure WiFi")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(403),alt:"WiFi manager parameters"}})]),t._v(" "),e("ul",[e("li",[t._v("Select your WiFi")]),t._v(" "),e("li",[t._v("Set your WiFi password")])]),t._v(" "),e("p",[t._v("::: note\nIf the board is connected by ethernet, the Wifi and password can be empty. If you fill them the board will use this wifi as a fallback connectivity method.\n:::")]),t._v(" "),e("ul",[e("li",[t._v("Set your MQTT Server IP or domain name (for Home Assistant you can enter "),e("code",[t._v("homeassistant.local")]),t._v(" if your server is configured with mDNS)")]),t._v(" "),e("li",[t._v("Set your MQTT Server Port (default: 1883)")]),t._v(" "),e("li",[t._v("Set your MQTT Server username (optional, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your MQTT Server password (optional, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your MQTT base topic if you need to change it (you must keep the / at the end) (default: home/, 64 characters maximum)")]),t._v(" "),e("li",[t._v("Set your gateway name if you need to change it")]),t._v(" "),e("li",[t._v("Set your gateway password (default: empty, 8 characters minimum, 64 maximum), this password is used for\n"),e("ul",[e("li",[t._v("Local and remote OTA")]),t._v(" "),e("li",[t._v('WebUI login (login:"admin", password: "")')]),t._v(" "),e("li",[t._v("WiFi Manager Access Point password after initial config")])])]),t._v(" "),e("li",[t._v("Set the MQTT secure connection box to select whether or not the connection should be secure")]),t._v(" "),e("li",[t._v("Set the certificate validation to select wether or not you want to validate the server identity with a certificate")]),t._v(" "),e("li",[t._v("Copy/paste the MQTT server certificate in the MQTT server cert box (only required if using a secure connection), be sure to include the "),e("code",[t._v("-----BEGIN CERTIFICATE-----")]),t._v(" and "),e("code",[t._v("-----END CERTIFICATE-----")]),t._v(" markers")]),t._v(" "),e("li",[t._v("Add your certificates")]),t._v(" "),e("li",[t._v("Click on save")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(404),alt:"WiFi manager save"}})]),t._v(" "),e("p",[t._v("The ESP restart and connect to your network. Note that your credentials are saved into the ESP memory, if you want to redo the configuration you have to erase the ESP memory with the flash download tool.")]),t._v(" "),e("p",[t._v("Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("home/OpenMQTTGateway/LWT Online \n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Note that the web portal appears only on first boot, if you want to configure again the setting you can do a long press on TRIGGER_GPIO, "),e("RouterLink",{attrs:{to:"/use/gateway.html#erase-the-esp-settings"}},[t._v("erase the settings")]),t._v(" or Reset the configuration from the WebUI.")],1),t._v(" "),e("h2",{attrs:{id:"build-time-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#build-time-configuration"}},[t._v("#")]),t._v(" Build time configuration")]),t._v(" "),e("p",[t._v("You can configure your MQTT server credentials and network configuration before building the application. It can be done either in Arduino or in Platformio IDE thought the User_config.h file. Note that with Platformio IDE you can also set your credentials into the platformio.ini file or an *_env.ini file, here is an example with the Olimex ESP32 gateway:")]),t._v(" "),e("div",{staticClass:"language-ini line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-ini"}},[e("code",[e("span",{pre:!0,attrs:{class:"token section"}},[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token section-name selector"}},[t._v("env:esp32-olimex-gtw-ble")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")])]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("platform")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("${com.esp32_platform}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("platform_packages")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("${com.esp32_platform_packages}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("board")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("esp32-gateway")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("board_build.partitions")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("min_spiffs.csv")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("lib_deps")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v("\n ${com-esp.lib_deps}\n ${libraries.ble}\n"),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("build_flags")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),t._v("\n ${com-esp.build_flags}\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DZgatewayBT")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"BT"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DLED_INFO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("33'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DLED_INFO_ON")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("1'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DESP32_ETHERNET")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v("true'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_SERVER")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"11.22.33.44"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_USER")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"salut"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DMQTT_PASS")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"atoi"\'')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key attr-name"}},[t._v("'-DGateway_Name")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token value attr-value"}},[t._v('"OpenMQTTGateway_ESP32_OLM_GTW"\'')]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br"),e("span",{staticClass:"line-number"},[t._v("8")]),e("br"),e("span",{staticClass:"line-number"},[t._v("9")]),e("br"),e("span",{staticClass:"line-number"},[t._v("10")]),e("br"),e("span",{staticClass:"line-number"},[t._v("11")]),e("br"),e("span",{staticClass:"line-number"},[t._v("12")]),e("br"),e("span",{staticClass:"line-number"},[t._v("13")]),e("br"),e("span",{staticClass:"line-number"},[t._v("14")]),e("br"),e("span",{staticClass:"line-number"},[t._v("15")]),e("br"),e("span",{staticClass:"line-number"},[t._v("16")]),e("br"),e("span",{staticClass:"line-number"},[t._v("17")]),e("br"),e("span",{staticClass:"line-number"},[t._v("18")]),e("br")])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/30.808298fd.js b/dev/assets/js/30.fc20dd21.js similarity index 99% rename from dev/assets/js/30.808298fd.js rename to dev/assets/js/30.fc20dd21.js index 05a80171..f506d558 100644 --- a/dev/assets/js/30.808298fd.js +++ b/dev/assets/js/30.fc20dd21.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{412:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial1.4ba30145.jpg"},413:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial2.2746e668.jpg"},414:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_Pilight_Digoo-DG-R8S.be97bb23.png"},467:function(e,t,a){"use strict";a.r(t);var s=a(14),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"rf-gateways-433mhz-315mhz-868mhz-915mhz"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateways-433mhz-315mhz-868mhz-915mhz"}},[e._v("#")]),e._v(" RF gateways (433mhz/315mhz/868mhz/915mhz)")]),e._v(" "),t("h2",{attrs:{id:"what-is-an-rf-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-is-an-rf-gateway"}},[e._v("#")]),e._v(" What is an RF gateway")]),e._v(" "),t("p",[e._v("An RF (Radio Frequency) gateway is a device that facilitates communication between RF devices and other communication protocols, such as MQTT in this context. Operating at specific frequencies like 433MHz, 315MHz, 868MHz, and 915MHz, these gateways can receive signals from various RF devices, decode them, and then forward the decoded data to systems like Home Assistant, OpenHAB, or any other MQTT-based system.")]),e._v(" "),t("p",[e._v("The primary advantage of using an RF gateway is its ability to bridge the gap between the world of RF devices, which might include sensors, remote controls, and other RF-based gadgets, and modern smart home systems or applications. This enables users to integrate a wide range of devices into their smart home setup, even if those devices were not originally designed for such integration.")]),e._v(" "),t("p",[e._v("In the context of the 433MHz MQTT gateway, the device not only decodes RF signals but also allows for seamless integration with MQTT systems. This means that signals from RF devices can be easily published to MQTT topics, and likewise, MQTT messages can be translated into RF signals for transmission. This two-way communication capability makes the gateway a powerful tool for expanding the capabilities of both RF devices and MQTT systems.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway leverages several libraries for RF communication:")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Library")]),e._v(" "),t("th",[e._v("Description")]),e._v(" "),t("th",[e._v("Device Support")]),e._v(" "),t("th",[e._v("Resource Requirements")]),e._v(" "),t("th",[e._v("Flexibility")]),e._v(" "),t("th",[e._v("Integration Capabilities")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("RTL_433")]),e._v(" "),t("td",[e._v("Maintained and performant library supporting receiving 433Mhz but also other frequencies (does not support sending)")]),e._v(" "),t("td",[e._v("Wide range of devices")]),e._v(" "),t("td",[e._v("Moderate")]),e._v(" "),t("td",[e._v("Decodes various protocols")]),e._v(" "),t("td",[e._v("Can be integrated with systems supporting Home Assistant Auto Discovery")])]),e._v(" "),t("tr",[t("td",[e._v("RCSwitch")]),e._v(" "),t("td",[e._v("Arduino library for 433MHz module communication.")]),e._v(" "),t("td",[e._v("Basic devices")]),e._v(" "),t("td",[e._v("Lightweight")]),e._v(" "),t("td",[e._v("Basic encoding and decoding")]),e._v(" "),t("td",[e._v("Basic integration")])]),e._v(" "),t("tr",[t("td",[e._v("Pilight")]),e._v(" "),t("td",[e._v("Open-source solution for device control and data retrieval.")]),e._v(" "),t("td",[e._v("Broad range of devices and protocols")]),e._v(" "),t("td",[e._v("Moderate")]),e._v(" "),t("td",[e._v("Offers raw and protocol-specific data handling")]),e._v(" "),t("td",[e._v("Structured data")])]),e._v(" "),t("tr",[t("td",[e._v("RF2")]),e._v(" "),t("td",[e._v("Library focused on KaKu devices and protocol.")]),e._v(" "),t("td",[e._v("Specific devices and protocols")]),e._v(" "),t("td",[e._v("Lightweight")]),e._v(" "),t("td",[e._v("Decoding and encoding capabilities")]),e._v(" "),t("td",[e._v("Basic integration")])])])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("RTL_433 library can only receive data, RCSwitch, PiLight, RF2 can receive and transmit.")])]),e._v(" "),t("h2",{attrs:{id:"common-parameters-accross-modules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#common-parameters-accross-modules"}},[e._v("#")]),e._v(" Common parameters accross modules")]),e._v(" "),t("h3",{attrs:{id:"change-default-frequency-sx127x-and-cc1101"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-default-frequency-sx127x-and-cc1101"}},[e._v("#")]),e._v(" Change default frequency (SX127X and CC1101)")]),e._v(" "),t("p",[e._v("The frequency can be can changed by sending an MQTT message or through the WebUI. Parameter is "),t("code",[e._v("frequency")]),e._v(" and valid values are 300-348 Mhz, 387-464Mhz and 779-928Mhz. Actual frequency support will depend on your board")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"frequency":315.026}')])]),e._v(" "),t("p",[e._v("Note that with CC1101 this frequency will be used as the default sending frequency.")]),e._v(" "),t("h3",{attrs:{id:"changing-active-receiver-modules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changing-active-receiver-modules"}},[e._v("#")]),e._v(" Changing Active Receiver Modules")]),e._v(" "),t("p",[e._v("Switching of the active transceiver (RTL_433 receiver only) module is available between the RF, RF2, and (RTL_433 or Pilight) gateway modules, allowing for changing of signal decoders without redeploying the OpenMQTTGateway package. Sending a JSON message to the command topic will change the active transceiver module.")]),e._v(" "),t("p",[e._v('To change the RF gateway module, which will receive, send a json message to the RF gateway module command subject (home/OpenMQTTGateway/commands/MQTTtoRF/config) with the corresponding value of the key "active"')]),e._v(" "),t("p",[e._v("1 - PiLight"),t("br"),e._v("\n2 - RF"),t("br"),e._v("\n3 - RTL_433"),t("br"),e._v("\n4 - RF2")]),e._v(" "),t("p",[e._v("Example to receive from the RF gateway:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRF/config" -m \'{"active":2}\'')])]),e._v(" "),t("p",[e._v("Example to receive from the Pilight gateway:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRF/config" -m \'{"active":1}\'')])]),e._v(" "),t("p",[e._v("The active receiver can also be changed with the WebUI.")]),e._v(" "),t("p",[e._v("The OpenMQTTGateway RFtoMQTT status message contains a key "),t("code",[e._v("active")]),e._v(" which is the current active receiver module.\nThere is example configuration entry for Homea Assistant in the intergrations doc.")]),e._v(" "),t("h2",{attrs:{id:"rtl-433-device-decoders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rtl-433-device-decoders"}},[e._v("#")]),e._v(" RTL_433 device decoders")]),e._v(" "),t("p",[e._v("This feature is only available on a ESP32 based device with a supported transceiver connected due to the resource requirements of the rtl_433 device decoders. At the present time only Pulse Position Modulation (OOK_PPM), Pulse Width Modulation (OOK_PWM) and Pulse Manchester Zero Bit (OOK_PULSE_MANCHESTER_ZEROBIT) based decoders are available.")]),e._v(" "),t("h3",{attrs:{id:"supported-hardware-combinations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-hardware-combinations"}},[e._v("#")]),e._v(" Supported hardware combinations")]),e._v(" "),t("ul",[t("li",[e._v("ESP32 based device with a CC1101 transceiver")]),e._v(" "),t("li",[e._v("Heltec WiFi LoRa 32 (V2.1) and LilyGo LoRa 32 V2.1")]),e._v(" "),t("li",[e._v("ESP32 DOIT DevKit V1 and Ai-Thinker R01 (SX1278)")]),e._v(" "),t("li",[e._v("ESP32 + SX1278/SX1276")])]),e._v(" "),t("h3",{attrs:{id:"supported-decoders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-decoders"}},[e._v("#")]),e._v(" Supported Decoders")]),e._v(" "),t("p",[e._v("For the most recent support decoder list please check the "),t("a",{attrs:{href:"https://github.com/NorthernMan54/rtl_433_ESP?tab=readme-ov-file#ook-signal-device-decoders",target:"_blank",rel:"noopener noreferrer"}},[e._v("rtl_433_esp"),t("OutboundLink")],1),e._v(" repository.")]),e._v(" "),t("h3",{attrs:{id:"change-signal-rssi-threshold-delta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-signal-rssi-threshold-delta"}},[e._v("#")]),e._v(" Change Signal RSSI Threshold Delta")]),e._v(" "),t("p",[e._v("Delta applied to RSSI floor noise level to determine start and end of signal, defaults to 9db.")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"rssithreshold": 9}')])]),e._v(" "),t("h3",{attrs:{id:"retrieve-current-status-of-receiver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-current-status-of-receiver"}},[e._v("#")]),e._v(" Retrieve current status of receiver")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"status":1}')])]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{"model":"status",\n"protocol":"debug",\n"debug":0, - rtl_433 verbose setting\n"duration":11799327, - duration of current signal\n"Gap length":-943575, - duration of gap between current signal\n"rssi":-38, - most recent received signal strength\n"train":1, - signal processing train #\n"messageCount":3, - total number of signals received\n"totalSignals":9, - RegOokFix signal quality count ( of 10 )\n"ignoredSignals":0, - RegOokFix signal quality ignored signals\n"unparsedSignals":3, - RegOokFix signal quality unparseable signals\n"_enabledReceiver":1, - which receiver is enabled\n"receiveMode":0, - is the receiver currently receiving a signal\n"currentRssi":-89, - current rssi level\n"rssiThreshold":-82, - minimum rssi level to start signal processing\n"pulses":0, - how many pulses have been received in the current signal\n"StackHighWaterMark":5528, - ESP32 Stack\n"freeMem":112880} - ESP32 memory available\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br"),t("span",{staticClass:"line-number"},[e._v("17")]),t("br"),t("span",{staticClass:"line-number"},[e._v("18")]),t("br")])]),t("h2",{attrs:{id:"rcswitch-based-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rcswitch-based-gateway"}},[e._v("#")]),e._v(" RCSwitch based gateway")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"https://github.com/1technophile/rc-switch.git",target:"_blank",rel:"noopener noreferrer"}},[e._v("RCSwitch"),t("OutboundLink")],1),e._v(" library is an Arduino library that facilitates communication with 433MHz RF modules. It is designed to be lightweight and easy to use, making it suitable for basic RF communication tasks. The library supports both sending and receiving of RF signals, allowing for integration with various RF devices such as remote controls, sensors, and switches.")]),e._v(" "),t("p",[e._v("To enable this module during compilation, add the flag "),t("code",[e._v("'-DZgatewayRF=\"RF\"'")]),e._v(" or uncomment the line "),t("code",[e._v('#define ZgatewayRF "RF"')]),e._v(" in the "),t("code",[e._v("User_config.h")]),e._v(" file.")]),e._v(" "),t("p",[e._v("Other useful definitions can be:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("#define RF_DISABLE_TRANSMIT")]),e._v(" To disable the transmit functions and free up the pin for other uses, add (or uncomment) this line to the "),t("code",[e._v("config_rf.h")]),e._v(" file.")]),e._v(" "),t("li",[t("code",[e._v("#define repeatRFwMQTT true")]),e._v(" To enable repeating the RF signal received by the gateway, set this parameter to true in the "),t("code",[e._v("config_rf.h")]),e._v(" file.")]),e._v(" "),t("li",[t("code",[e._v("#define RF_on_HAS_as_DeviceTrigger")]),e._v(" To send a Home Assistant Device Trigger Message for each RF signal received, add (or uncomment) this line in the "),t("code",[e._v("config_rf.h")]),e._v(" file. Note that this action also depends on the "),t("code",[e._v("ZmqttDiscovery")]),e._v(" settings.")]),e._v(" "),t("li",[t("code",[e._v("#define RF_on_HAS_as_MQTTSensor")]),e._v(" To send a Home Assistant MQTT sensor message for each RF signal received, add (or uncomment) this line in the "),t("code",[e._v("config_rf.h")]),e._v(" file. Note that this action also depends on the "),t("code",[e._v("ZmqttDiscovery")]),e._v(" settings.")])]),e._v(" "),t("h3",{attrs:{id:"handling-rf-signal-over-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#handling-rf-signal-over-mqtt"}},[e._v("#")]),e._v(" Handling RF signal over MQTT")]),e._v(" "),t("p",[e._v("In this chapter, the process of receiving and sending RF signals using MQTT will be explored. By subscribing to MQTT topics and publishing messages, RF devices can be seamlessly integrated with an MQTT broker.")]),e._v(" "),t("h4",{attrs:{id:"receiving-data-from-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal"}},[e._v("#")]),e._v(" Receiving Data from RF Signal")]),e._v(" "),t("p",[e._v("To receive data from an RF signal, follow these steps:")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Subscribe to all messages using mosquitto or open your MQTT client software:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" mosquitto_sub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" +/"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# -v")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])]),e._v(" "),t("li",[t("p",[e._v("Generate your RF signals by pressing a remote button or other RF device. You should see output similar to:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[e._v("home/OpenMQTTGateway/433toMQTT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1315156")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"length"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("24")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"delay"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("317")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])])]),e._v(" "),t("h4",{attrs:{id:"send-data-by-mqtt-to-convert-it-to-an-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-to-an-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it to an RF signal")]),e._v(" "),t("p",[e._v("To send an RF signal using MQTT, you can publish a message to the topic "),t("code",[e._v("home/OpenMQTTGateway/commands/MQTTto433")]),e._v(" with the desired value. For example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'{\"value\":1315156}'")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("This command will send the RF code "),t("code",[e._v("1315156")]),e._v(" using the default parameters (protocol 1, delay 350).")]),e._v(" "),t("p",[e._v("When publishing data via MQTT, the Arduino IDE serial monitor will display the received value and the corresponding MQTT topic:")]),e._v(" "),t("p",[t("img",{attrs:{src:a(412),alt:"Serial data"}})]),e._v(" "),t("p",[e._v("In this example, the Arduino receives the value "),t("code",[e._v("1315156")]),e._v(" on the MQTT topic "),t("code",[e._v("MQTTto433")]),e._v(" and transmits the data via RF.")]),e._v(" "),t("p",[e._v("Similarly, when receiving data via 433MHz, the Arduino IDE serial monitor will show the received data:")]),e._v(" "),t("p",[t("img",{attrs:{src:a(413),alt:"Serial data 2"}})]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-with-advanced-rf-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-rf-parameters"}},[e._v("#")]),e._v(" Send data by MQTT with advanced RF parameters")]),e._v(" "),t("p",[e._v("RF sending supports three advanced parameters: bits length, RF protocol, and RF pulse length.")]),e._v(" "),t("ul",[t("li",[e._v("To use a different bits number, include "),t("code",[e._v('"length":24')]),e._v(" in your payload.")]),e._v(" "),t("li",[e._v("To use a different RCSwitch protocol, include "),t("code",[e._v('"protocol":2')]),e._v(" in your payload.")]),e._v(" "),t("li",[e._v("To use a different pulse length, include "),t("code",[e._v('"delay":315')]),e._v(" in your payload.")])]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":2,"length":24,"delay":315}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("This command will make RCSwitch use protocol 2 with a pulse length of 315ms and a bits number of 24.")]),e._v(" "),t("h4",{attrs:{id:"repeat-the-rf-signal-several-time"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repeat-the-rf-signal-several-time"}},[e._v("#")]),e._v(" Repeat the RF signal several time")]),e._v(" "),t("p",[e._v('You can add a "repeat" key/value to the MQTTto433 JSON message to override the default number of repeats. Ensure that '),t("code",[e._v("repeatRFwMQTT")]),e._v(" is enabled at compile time.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":1,"length":24,"delay":317,"repeat":10}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h4",{attrs:{id:"set-transmit-and-receive-frequency-and-transmit-power-of-cc1101-transceiver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-transmit-and-receive-frequency-and-transmit-power-of-cc1101-transceiver"}},[e._v("#")]),e._v(" Set Transmit and Receive Frequency and Transmit Power of CC1101 Transceiver")]),e._v(" "),t("p",[e._v("The default transmit frequency of the CC1101 module is 433.92 MHz. This can be changed by including the desired frequency in the transmit message. The parameter is "),t("code",[e._v("frequency")]),e._v(", and valid values are 300-348 MHz, 387-464 MHz, and 779-928 MHz. Actual frequency support will depend on your CC1101 board.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1150,"protocol":6,"length":12,"delay":450,"repeat":8,"frequency":303.732}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("The default receive frequency of the CC1101 module is also 433.92 MHz. This can be changed by sending a message with the desired frequency. The parameter is "),t("code",[e._v("frequency")]),e._v(", and valid values are 300-348 MHz, 387-464 MHz, and 779-928 MHz. Actual frequency support will depend on your CC1101 board.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTtoRF/config"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'{\"frequency\":433.92}'")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("Messages received will include the frequency, and when transmitting on a different frequency, the module will return to the receive frequency afterward. For example, transmit messages on 303.732 MHz and then receive messages on 433.92 MHz.")]),e._v(" "),t("p",[e._v("Example received message:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("4534142")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"length"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("26")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"delay"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("356")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"frequency"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("315.026")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("You can also adjust the transmit power (tx-power) in decibels (dB) for a transmission. The parameter is "),t("code",[e._v("cc1101_pa")]),e._v(", and valid values in decibels are -30, -20, -15, -10, -6, 0, 5, 7, 10, 11, and 12. The default is the maximum value. Adjusting the transmit power can help reduce range and minimize disturbances with other nearby devices.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":2,"length":24,"delay":315,"cc1101_pa":5}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"pilight-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pilight-gateway"}},[e._v("#")]),e._v(" Pilight gateway")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-rf-signal-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal-2"}},[e._v("#")]),e._v(" Receiving data from RF signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see :")]),e._v(" "),t("p",[t("img",{attrs:{src:a(414),alt:"Digoo DG R8S data"}})]),e._v(" "),t("h4",{attrs:{id:"enabling-raw-packet-return-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-raw-packet-return-support"}},[e._v("#")]),e._v(" Enabling RAW packet return support")]),e._v(" "),t("p",[e._v("First, you need to compile a binary with "),t("code",[e._v("Pilight_rawEnabled true")]),e._v(" uncommented in config_RF.h.")]),e._v(" "),t("p",[e._v("Once the device is online and the active receiver is Pilght, you can toggle raw packet return.\nIf current active receiver is not Pilight the toggle command will be ignored and harmless error message will be published.")]),e._v(" "),t("p",[e._v("You can turn on the RAW packet return support with the following MQTT command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"rawEnabled":true}\'')])]),e._v(" "),t("p",[e._v("The returned JSON looks like this:\n"),t("code",[e._v('Client (null) received PUBLISH (d0, q0, r0, m0, \'home/OpenMQTTGateway/PilighttoMQTT\', ... (176 bytes)) {"format":"RAW","rawlen":106,"pulsesString":"c:0102010102020202020101010101010102020201020102020202020201010101010101010101010102010102010201020201010203;p:521,944,1924,3845@"}')])]),e._v(" "),t("p",[e._v("The pulseString format is Pilight's native. For those who are not familiar with it:\nc:* are the indexes for the p:* array, which are the different pulse length. (e.g. pulse[0] = 521ms, pulse[1]=944ms..., so c[0], which is a '0' = 521ms pulse, c[1], which is a '1' =944ms pulse etc)")]),e._v(" "),t("p",[e._v("After gathering all the packets you need, simply turn off the RAW packet support via MQTT:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"rawEnabled":false}\'')])]),e._v(" "),t("h3",{attrs:{id:"limit-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-protocols"}},[e._v("#")]),e._v(" Limit Protocols")]),e._v(" "),t("p",[e._v("It is possible to limit the protocols that Pilight will respond to, this can help reduce noise from unwanted devices and in some cases disable conflicting protocols.")]),e._v(" "),t("h4",{attrs:{id:"available-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#available-protocols"}},[e._v("#")]),e._v(" Available protocols")]),e._v(" "),t("p",[e._v("To list the available protocols on the Serial -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"available":true}\'')])]),e._v(" "),t("h4",{attrs:{id:"limit-protocols-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-protocols-2"}},[e._v("#")]),e._v(" Limit protocols")]),e._v(" "),t("p",[e._v("To limit the protocols, send a JSON array of protocols as below -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols -m \'{"limit": ["array", "of", "protocols"]}\'')])]),e._v(" "),t("p",[e._v("eg: "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"limit":["tfa", "ev1527"}\'')])]),e._v(" "),t("h4",{attrs:{id:"reset-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reset-protocols"}},[e._v("#")]),e._v(" Reset protocols")]),e._v(" "),t("p",[e._v("To reset and listen to all protocols -\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols -m \'{"reset": true}\'')])]),e._v(" "),t("h4",{attrs:{id:"enabled-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabled-protocols"}},[e._v("#")]),e._v(" Enabled protocols")]),e._v(" "),t("p",[e._v("To list the enabled protocols on the Serial -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"enabled":true}\'')])]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-transmit-a-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-transmit-a-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to transmit a RF signal")]),e._v(" "),t("h4",{attrs:{id:"using-a-known-protocol"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-known-protocol"}},[e._v("#")]),e._v(" Using a known protocol")]),e._v(" "),t("p",[t("strong",[e._v("ON")]),e._v(" "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"on\\":1}","protocol":"elro_400_switch"}\'')])]),e._v(" "),t("p",[t("strong",[e._v("OFF")]),e._v(" "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"off\\":1}","protocol":"elro_400_switch"}\'')])]),e._v(" "),t("p",[e._v("These commands will transmit by RF the signals to actuate an elro_400 switch.")]),e._v(" "),t("p",[e._v("With a different frequency (CC1101 only):\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"off\\":1}","protocol":"elro_400_switch","frequency":315.026}\'')])]),e._v(" "),t("h4",{attrs:{id:"using-a-raw-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-raw-signal"}},[e._v("#")]),e._v(" Using a raw signal")]),e._v(" "),t("p",[e._v('You can transmit raw signal data by using the "raw" protocol. This uses the Pilight pulse train string format. One such example string, representing a transmission for Nexus protocol weather stations, looks like this: '),t("code",[e._v("c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@")]),e._v(". This string represents pulses and gaps directly.")]),e._v(" "),t("p",[e._v("Each number in the list after "),t("code",[e._v("p:")]),e._v(" that ends with "),t("code",[e._v(";")]),e._v(" stands for "),t("strong",[e._v("p")]),e._v("ulse and gap lengths in microseconds (µs). In this example, we have a list containing lengths of 500µs, 1000µs, 2000µs, and 4000µs.")]),e._v(" "),t("p",[e._v("Each number after "),t("code",[e._v("c:")]),e._v(" and ended by "),t("code",[e._v(";")]),e._v(" represents a "),t("strong",[e._v("c")]),e._v("ode that references the "),t("code",[e._v("p:")]),e._v(" list by index. In this example, the first 4 numbers after "),t("code",[e._v("c:")]),e._v(" are 0, 3, 0, and 2, which reference "),t("code",[e._v("p:")]),e._v("[0] = 500, "),t("code",[e._v("p:")]),e._v("[3] = 4000, "),t("code",[e._v("p:")]),e._v("[0] = 500, and "),t("code",[e._v("p:")]),e._v("[2] = 2000, respectively. In the language of digital radio transceiving, the most basic unit is usually a pulse and gap pair; in other words, 0s and 1s are represented by a pulse followed by a gap (lack of pulse) and the time lengths of these pulses and gaps. Different protocols have different pulse lengths and gap lengths representing 0, and a different one representing 1. Because of this pulse-gap nature, the codes in "),t("code",[e._v("c:")]),e._v(" must be taken as pairs; the first number in a pair represents the length of the pulse, and the second number the subsequent gap. In this example, the first pair, 03, represents a pulse of 500µs followed by a gap of 4000µs. The next pair, 02, represents a pulse of 500µs followed by a gap of 2000µs.")]),e._v(" "),t("p",[e._v("The number after "),t("code",[e._v("r:")]),e._v(" represents how many times the message in the string is to be "),t("strong",[e._v("r")]),e._v("epeated. The "),t("code",[e._v("r:")]),e._v(" block is optional. The default number of repeats if "),t("code",[e._v("r:")]),e._v(" is not specified is 10. Greater than about 100 repeats will cause a crash due to memory usage. If this example were written without specifying repeats, it would look like this: "),t("code",[e._v('{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000@"}')])]),e._v(" "),t("p",[e._v("The entire string must end in a "),t("code",[e._v("@")]),e._v(". Each block must end in a "),t("code",[e._v(";")]),e._v(", but if it is the last block in the string, the "),t("code",[e._v("@")]),e._v(" replaces the "),t("code",[e._v(";")]),e._v(". Since the "),t("code",[e._v("r:")]),e._v(" block is optional, this last block could be either "),t("code",[e._v("p:")]),e._v(" or "),t("code",[e._v("r:")]),e._v(".")]),e._v(" "),t("p",[e._v("The JSON for the MQTT message to "),t("code",[e._v("home/OpenMQTTGateway/commands/MQTTtoPilight")]),e._v(' should specify the pulse train string as the value for the "raw" key: '),t("code",[e._v('{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@"}')]),e._v(".")]),e._v(" "),t("p",[e._v("e.g. "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@"}\'')])]),e._v(" "),t("h2",{attrs:{id:"rf-with-sonoff-rf-bridge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-with-sonoff-rf-bridge"}},[e._v("#")]),e._v(" RF with SONOFF RF BRIDGE")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-rf-signal-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal-3"}},[e._v("#")]),e._v(" Receiving data from RF signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/SRFBtoMQTT {"raw":"2B660186042E00E7E5","value":"59365","delay":"1111","val_Thigh":"390","val_Tlow":"1070"}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("The first parameter is the raw value extracted from the RF module of the Sonoff bridge. The data are in hexadecimal and correspond to the details below:\nhttps://www.itead.cc/wiki/images/5/5e/RF_Universal_Transeceive_Module_Serial_Protocol_v1.0.pdf\nOpenMQTTGateway process the raw value to extract the other decimal values that can be reused to reproduce a signal (raw value can also be reused).")]),e._v(" "),t("p",[e._v("NOTE: currently the device doesn't receive correct values from Switches remote control")]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on RF signal")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSRFB" -m \'{"value":1315156}\'')])]),e._v(" "),t("p",[e._v("This command will send by RF the code 1315156 and use the default parameters:\nRepeat = 1\nLow time= 320\nHigh time= 900\nSYNC = 9500")]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-with-advanced-rf-parameters-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-rf-parameters-2"}},[e._v("#")]),e._v(" Send data by MQTT with advanced RF parameters")]),e._v(" "),t("p",[e._v('RF bridge sending support four advanced parameters; Repeat, Low time, High time & Sync\nif you want to repeat your signal sending put into your json payload "repeat":2, 2 means 2 repetitions of signal')]),e._v(" "),t("p",[e._v('if you want to use a low time of 315 put inside your json payload "Tlow":315')]),e._v(" "),t("p",[e._v('if you want to use a high time of 845 put inside your json payload "Thigh":845')]),e._v(" "),t("p",[e._v('if you want to use a sync time of 9123 put inside your json payload "Tsyn":9123')]),e._v(" "),t("p",[e._v("Example:\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSRFB/Tlow_315/Thigh_845/Tsyn_9123 -m \'{"value":"33151562","delay":"9123","val_Thigh":"845","val_Tlow":"315"}\'')]),e._v("\nwill make RF Bridge send a signal with the use of listed parameters 315, 845, 9123...")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSRFB/Raw -m \'{"raw":"267A013603B6140551"}\'')]),e._v("\nwill make RF Bridge send a signal with the use of advanced parameters defined in the raw string")]),e._v(" "),t("h2",{attrs:{id:"rf2-gateway-kaku"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf2-gateway-kaku"}},[e._v("#")]),e._v(" RF2 gateway KAKU")]),e._v(" "),t("p",[e._v("RF2 gateway enables to send command to RF devices with the KAKU protocol. DIO chacon devices are an example.\nIt uses the same pinout as the RF gateway and both gateways can be used on the same setup.")]),e._v(" "),t("p",[e._v("Receiving RF codes with the KAKU protocol is not compatible with ZgatewayRF , so as to get the code of your remotes you should comment ZgatewayRF in User_config.h.\nTransmitting can be done with both ZgatewayRF and ZgatewayRF2")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-kaku-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-kaku-signal"}},[e._v("#")]),e._v(" Receiving data from KAKU signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see :")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/RF2toMQTT {"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":0}')])]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-kaku-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-kaku-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on KAKU signal")]),e._v(" "),t("p",[e._v("Once you get the infos publish the parameters with MQTT like that for off:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":0}"')])]),e._v(" "),t("p",[e._v("for on:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":1}"')])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{412:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial1.4ba30145.jpg"},413:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial2.2746e668.jpg"},414:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_Pilight_Digoo-DG-R8S.be97bb23.png"},469:function(e,t,a){"use strict";a.r(t);var s=a(14),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"rf-gateways-433mhz-315mhz-868mhz-915mhz"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateways-433mhz-315mhz-868mhz-915mhz"}},[e._v("#")]),e._v(" RF gateways (433mhz/315mhz/868mhz/915mhz)")]),e._v(" "),t("h2",{attrs:{id:"what-is-an-rf-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-is-an-rf-gateway"}},[e._v("#")]),e._v(" What is an RF gateway")]),e._v(" "),t("p",[e._v("An RF (Radio Frequency) gateway is a device that facilitates communication between RF devices and other communication protocols, such as MQTT in this context. Operating at specific frequencies like 433MHz, 315MHz, 868MHz, and 915MHz, these gateways can receive signals from various RF devices, decode them, and then forward the decoded data to systems like Home Assistant, OpenHAB, or any other MQTT-based system.")]),e._v(" "),t("p",[e._v("The primary advantage of using an RF gateway is its ability to bridge the gap between the world of RF devices, which might include sensors, remote controls, and other RF-based gadgets, and modern smart home systems or applications. This enables users to integrate a wide range of devices into their smart home setup, even if those devices were not originally designed for such integration.")]),e._v(" "),t("p",[e._v("In the context of the 433MHz MQTT gateway, the device not only decodes RF signals but also allows for seamless integration with MQTT systems. This means that signals from RF devices can be easily published to MQTT topics, and likewise, MQTT messages can be translated into RF signals for transmission. This two-way communication capability makes the gateway a powerful tool for expanding the capabilities of both RF devices and MQTT systems.")]),e._v(" "),t("p",[e._v("OpenMQTTGateway leverages several libraries for RF communication:")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Library")]),e._v(" "),t("th",[e._v("Description")]),e._v(" "),t("th",[e._v("Device Support")]),e._v(" "),t("th",[e._v("Resource Requirements")]),e._v(" "),t("th",[e._v("Flexibility")]),e._v(" "),t("th",[e._v("Integration Capabilities")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("RTL_433")]),e._v(" "),t("td",[e._v("Maintained and performant library supporting receiving 433Mhz but also other frequencies (does not support sending)")]),e._v(" "),t("td",[e._v("Wide range of devices")]),e._v(" "),t("td",[e._v("Moderate")]),e._v(" "),t("td",[e._v("Decodes various protocols")]),e._v(" "),t("td",[e._v("Can be integrated with systems supporting Home Assistant Auto Discovery")])]),e._v(" "),t("tr",[t("td",[e._v("RCSwitch")]),e._v(" "),t("td",[e._v("Arduino library for 433MHz module communication.")]),e._v(" "),t("td",[e._v("Basic devices")]),e._v(" "),t("td",[e._v("Lightweight")]),e._v(" "),t("td",[e._v("Basic encoding and decoding")]),e._v(" "),t("td",[e._v("Basic integration")])]),e._v(" "),t("tr",[t("td",[e._v("Pilight")]),e._v(" "),t("td",[e._v("Open-source solution for device control and data retrieval.")]),e._v(" "),t("td",[e._v("Broad range of devices and protocols")]),e._v(" "),t("td",[e._v("Moderate")]),e._v(" "),t("td",[e._v("Offers raw and protocol-specific data handling")]),e._v(" "),t("td",[e._v("Structured data")])]),e._v(" "),t("tr",[t("td",[e._v("RF2")]),e._v(" "),t("td",[e._v("Library focused on KaKu devices and protocol.")]),e._v(" "),t("td",[e._v("Specific devices and protocols")]),e._v(" "),t("td",[e._v("Lightweight")]),e._v(" "),t("td",[e._v("Decoding and encoding capabilities")]),e._v(" "),t("td",[e._v("Basic integration")])])])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("RTL_433 library can only receive data, RCSwitch, PiLight, RF2 can receive and transmit.")])]),e._v(" "),t("h2",{attrs:{id:"common-parameters-accross-modules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#common-parameters-accross-modules"}},[e._v("#")]),e._v(" Common parameters accross modules")]),e._v(" "),t("h3",{attrs:{id:"change-default-frequency-sx127x-and-cc1101"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-default-frequency-sx127x-and-cc1101"}},[e._v("#")]),e._v(" Change default frequency (SX127X and CC1101)")]),e._v(" "),t("p",[e._v("The frequency can be can changed by sending an MQTT message or through the WebUI. Parameter is "),t("code",[e._v("frequency")]),e._v(" and valid values are 300-348 Mhz, 387-464Mhz and 779-928Mhz. Actual frequency support will depend on your board")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"frequency":315.026}')])]),e._v(" "),t("p",[e._v("Note that with CC1101 this frequency will be used as the default sending frequency.")]),e._v(" "),t("h3",{attrs:{id:"changing-active-receiver-modules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changing-active-receiver-modules"}},[e._v("#")]),e._v(" Changing Active Receiver Modules")]),e._v(" "),t("p",[e._v("Switching of the active transceiver (RTL_433 receiver only) module is available between the RF, RF2, and (RTL_433 or Pilight) gateway modules, allowing for changing of signal decoders without redeploying the OpenMQTTGateway package. Sending a JSON message to the command topic will change the active transceiver module.")]),e._v(" "),t("p",[e._v('To change the RF gateway module, which will receive, send a json message to the RF gateway module command subject (home/OpenMQTTGateway/commands/MQTTtoRF/config) with the corresponding value of the key "active"')]),e._v(" "),t("p",[e._v("1 - PiLight"),t("br"),e._v("\n2 - RF"),t("br"),e._v("\n3 - RTL_433"),t("br"),e._v("\n4 - RF2")]),e._v(" "),t("p",[e._v("Example to receive from the RF gateway:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRF/config" -m \'{"active":2}\'')])]),e._v(" "),t("p",[e._v("Example to receive from the Pilight gateway:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRF/config" -m \'{"active":1}\'')])]),e._v(" "),t("p",[e._v("The active receiver can also be changed with the WebUI.")]),e._v(" "),t("p",[e._v("The OpenMQTTGateway RFtoMQTT status message contains a key "),t("code",[e._v("active")]),e._v(" which is the current active receiver module.\nThere is example configuration entry for Homea Assistant in the intergrations doc.")]),e._v(" "),t("h2",{attrs:{id:"rtl-433-device-decoders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rtl-433-device-decoders"}},[e._v("#")]),e._v(" RTL_433 device decoders")]),e._v(" "),t("p",[e._v("This feature is only available on a ESP32 based device with a supported transceiver connected due to the resource requirements of the rtl_433 device decoders. At the present time only Pulse Position Modulation (OOK_PPM), Pulse Width Modulation (OOK_PWM) and Pulse Manchester Zero Bit (OOK_PULSE_MANCHESTER_ZEROBIT) based decoders are available.")]),e._v(" "),t("h3",{attrs:{id:"supported-hardware-combinations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-hardware-combinations"}},[e._v("#")]),e._v(" Supported hardware combinations")]),e._v(" "),t("ul",[t("li",[e._v("ESP32 based device with a CC1101 transceiver")]),e._v(" "),t("li",[e._v("Heltec WiFi LoRa 32 (V2.1) and LilyGo LoRa 32 V2.1")]),e._v(" "),t("li",[e._v("ESP32 DOIT DevKit V1 and Ai-Thinker R01 (SX1278)")]),e._v(" "),t("li",[e._v("ESP32 + SX1278/SX1276")])]),e._v(" "),t("h3",{attrs:{id:"supported-decoders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-decoders"}},[e._v("#")]),e._v(" Supported Decoders")]),e._v(" "),t("p",[e._v("For the most recent support decoder list please check the "),t("a",{attrs:{href:"https://github.com/NorthernMan54/rtl_433_ESP?tab=readme-ov-file#ook-signal-device-decoders",target:"_blank",rel:"noopener noreferrer"}},[e._v("rtl_433_esp"),t("OutboundLink")],1),e._v(" repository.")]),e._v(" "),t("h3",{attrs:{id:"change-signal-rssi-threshold-delta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-signal-rssi-threshold-delta"}},[e._v("#")]),e._v(" Change Signal RSSI Threshold Delta")]),e._v(" "),t("p",[e._v("Delta applied to RSSI floor noise level to determine start and end of signal, defaults to 9db.")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"rssithreshold": 9}')])]),e._v(" "),t("h3",{attrs:{id:"retrieve-current-status-of-receiver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-current-status-of-receiver"}},[e._v("#")]),e._v(" Retrieve current status of receiver")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/commands/MQTTtoRF/config {"status":1}')])]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{"model":"status",\n"protocol":"debug",\n"debug":0, - rtl_433 verbose setting\n"duration":11799327, - duration of current signal\n"Gap length":-943575, - duration of gap between current signal\n"rssi":-38, - most recent received signal strength\n"train":1, - signal processing train #\n"messageCount":3, - total number of signals received\n"totalSignals":9, - RegOokFix signal quality count ( of 10 )\n"ignoredSignals":0, - RegOokFix signal quality ignored signals\n"unparsedSignals":3, - RegOokFix signal quality unparseable signals\n"_enabledReceiver":1, - which receiver is enabled\n"receiveMode":0, - is the receiver currently receiving a signal\n"currentRssi":-89, - current rssi level\n"rssiThreshold":-82, - minimum rssi level to start signal processing\n"pulses":0, - how many pulses have been received in the current signal\n"StackHighWaterMark":5528, - ESP32 Stack\n"freeMem":112880} - ESP32 memory available\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br"),t("span",{staticClass:"line-number"},[e._v("17")]),t("br"),t("span",{staticClass:"line-number"},[e._v("18")]),t("br")])]),t("h2",{attrs:{id:"rcswitch-based-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rcswitch-based-gateway"}},[e._v("#")]),e._v(" RCSwitch based gateway")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"https://github.com/1technophile/rc-switch.git",target:"_blank",rel:"noopener noreferrer"}},[e._v("RCSwitch"),t("OutboundLink")],1),e._v(" library is an Arduino library that facilitates communication with 433MHz RF modules. It is designed to be lightweight and easy to use, making it suitable for basic RF communication tasks. The library supports both sending and receiving of RF signals, allowing for integration with various RF devices such as remote controls, sensors, and switches.")]),e._v(" "),t("p",[e._v("To enable this module during compilation, add the flag "),t("code",[e._v("'-DZgatewayRF=\"RF\"'")]),e._v(" or uncomment the line "),t("code",[e._v('#define ZgatewayRF "RF"')]),e._v(" in the "),t("code",[e._v("User_config.h")]),e._v(" file.")]),e._v(" "),t("p",[e._v("Other useful definitions can be:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("#define RF_DISABLE_TRANSMIT")]),e._v(" To disable the transmit functions and free up the pin for other uses, add (or uncomment) this line to the "),t("code",[e._v("config_rf.h")]),e._v(" file.")]),e._v(" "),t("li",[t("code",[e._v("#define repeatRFwMQTT true")]),e._v(" To enable repeating the RF signal received by the gateway, set this parameter to true in the "),t("code",[e._v("config_rf.h")]),e._v(" file.")]),e._v(" "),t("li",[t("code",[e._v("#define RF_on_HAS_as_DeviceTrigger")]),e._v(" To send a Home Assistant Device Trigger Message for each RF signal received, add (or uncomment) this line in the "),t("code",[e._v("config_rf.h")]),e._v(" file. Note that this action also depends on the "),t("code",[e._v("ZmqttDiscovery")]),e._v(" settings.")]),e._v(" "),t("li",[t("code",[e._v("#define RF_on_HAS_as_MQTTSensor")]),e._v(" To send a Home Assistant MQTT sensor message for each RF signal received, add (or uncomment) this line in the "),t("code",[e._v("config_rf.h")]),e._v(" file. Note that this action also depends on the "),t("code",[e._v("ZmqttDiscovery")]),e._v(" settings.")])]),e._v(" "),t("h3",{attrs:{id:"handling-rf-signal-over-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#handling-rf-signal-over-mqtt"}},[e._v("#")]),e._v(" Handling RF signal over MQTT")]),e._v(" "),t("p",[e._v("In this chapter, the process of receiving and sending RF signals using MQTT will be explored. By subscribing to MQTT topics and publishing messages, RF devices can be seamlessly integrated with an MQTT broker.")]),e._v(" "),t("h4",{attrs:{id:"receiving-data-from-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal"}},[e._v("#")]),e._v(" Receiving Data from RF Signal")]),e._v(" "),t("p",[e._v("To receive data from an RF signal, follow these steps:")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Subscribe to all messages using mosquitto or open your MQTT client software:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" mosquitto_sub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" +/"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# -v")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])]),e._v(" "),t("li",[t("p",[e._v("Generate your RF signals by pressing a remote button or other RF device. You should see output similar to:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[e._v("home/OpenMQTTGateway/433toMQTT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1315156")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"length"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("24")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"delay"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("317")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])])]),e._v(" "),t("h4",{attrs:{id:"send-data-by-mqtt-to-convert-it-to-an-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-to-an-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it to an RF signal")]),e._v(" "),t("p",[e._v("To send an RF signal using MQTT, you can publish a message to the topic "),t("code",[e._v("home/OpenMQTTGateway/commands/MQTTto433")]),e._v(" with the desired value. For example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'{\"value\":1315156}'")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("This command will send the RF code "),t("code",[e._v("1315156")]),e._v(" using the default parameters (protocol 1, delay 350).")]),e._v(" "),t("p",[e._v("When publishing data via MQTT, the Arduino IDE serial monitor will display the received value and the corresponding MQTT topic:")]),e._v(" "),t("p",[t("img",{attrs:{src:a(412),alt:"Serial data"}})]),e._v(" "),t("p",[e._v("In this example, the Arduino receives the value "),t("code",[e._v("1315156")]),e._v(" on the MQTT topic "),t("code",[e._v("MQTTto433")]),e._v(" and transmits the data via RF.")]),e._v(" "),t("p",[e._v("Similarly, when receiving data via 433MHz, the Arduino IDE serial monitor will show the received data:")]),e._v(" "),t("p",[t("img",{attrs:{src:a(413),alt:"Serial data 2"}})]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-with-advanced-rf-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-rf-parameters"}},[e._v("#")]),e._v(" Send data by MQTT with advanced RF parameters")]),e._v(" "),t("p",[e._v("RF sending supports three advanced parameters: bits length, RF protocol, and RF pulse length.")]),e._v(" "),t("ul",[t("li",[e._v("To use a different bits number, include "),t("code",[e._v('"length":24')]),e._v(" in your payload.")]),e._v(" "),t("li",[e._v("To use a different RCSwitch protocol, include "),t("code",[e._v('"protocol":2')]),e._v(" in your payload.")]),e._v(" "),t("li",[e._v("To use a different pulse length, include "),t("code",[e._v('"delay":315')]),e._v(" in your payload.")])]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":2,"length":24,"delay":315}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("This command will make RCSwitch use protocol 2 with a pulse length of 315ms and a bits number of 24.")]),e._v(" "),t("h4",{attrs:{id:"repeat-the-rf-signal-several-time"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repeat-the-rf-signal-several-time"}},[e._v("#")]),e._v(" Repeat the RF signal several time")]),e._v(" "),t("p",[e._v('You can add a "repeat" key/value to the MQTTto433 JSON message to override the default number of repeats. Ensure that '),t("code",[e._v("repeatRFwMQTT")]),e._v(" is enabled at compile time.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":1,"length":24,"delay":317,"repeat":10}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h4",{attrs:{id:"set-transmit-and-receive-frequency-and-transmit-power-of-cc1101-transceiver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-transmit-and-receive-frequency-and-transmit-power-of-cc1101-transceiver"}},[e._v("#")]),e._v(" Set Transmit and Receive Frequency and Transmit Power of CC1101 Transceiver")]),e._v(" "),t("p",[e._v("The default transmit frequency of the CC1101 module is 433.92 MHz. This can be changed by including the desired frequency in the transmit message. The parameter is "),t("code",[e._v("frequency")]),e._v(", and valid values are 300-348 MHz, 387-464 MHz, and 779-928 MHz. Actual frequency support will depend on your CC1101 board.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1150,"protocol":6,"length":12,"delay":450,"repeat":8,"frequency":303.732}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("The default receive frequency of the CC1101 module is also 433.92 MHz. This can be changed by sending a message with the desired frequency. The parameter is "),t("code",[e._v("frequency")]),e._v(", and valid values are 300-348 MHz, 387-464 MHz, and 779-928 MHz. Actual frequency support will depend on your CC1101 board.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTtoRF/config"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'{\"frequency\":433.92}'")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("Messages received will include the frequency, and when transmitting on a different frequency, the module will return to the receive frequency afterward. For example, transmit messages on 303.732 MHz and then receive messages on 433.92 MHz.")]),e._v(" "),t("p",[e._v("Example received message:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("4534142")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"length"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("26")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"delay"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("356")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"frequency"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("315.026")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("You can also adjust the transmit power (tx-power) in decibels (dB) for a transmission. The parameter is "),t("code",[e._v("cc1101_pa")]),e._v(", and valid values in decibels are -30, -20, -15, -10, -6, 0, 5, 7, 10, 11, and 12. The default is the maximum value. Adjusting the transmit power can help reduce range and minimize disturbances with other nearby devices.")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language-sh line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("mosquitto_pub "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"home/OpenMQTTGateway/commands/MQTTto433"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('\'{"value":1315156,"protocol":2,"length":24,"delay":315,"cc1101_pa":5}\'')]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"pilight-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pilight-gateway"}},[e._v("#")]),e._v(" Pilight gateway")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-rf-signal-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal-2"}},[e._v("#")]),e._v(" Receiving data from RF signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see :")]),e._v(" "),t("p",[t("img",{attrs:{src:a(414),alt:"Digoo DG R8S data"}})]),e._v(" "),t("h4",{attrs:{id:"enabling-raw-packet-return-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-raw-packet-return-support"}},[e._v("#")]),e._v(" Enabling RAW packet return support")]),e._v(" "),t("p",[e._v("First, you need to compile a binary with "),t("code",[e._v("Pilight_rawEnabled true")]),e._v(" uncommented in config_RF.h.")]),e._v(" "),t("p",[e._v("Once the device is online and the active receiver is Pilght, you can toggle raw packet return.\nIf current active receiver is not Pilight the toggle command will be ignored and harmless error message will be published.")]),e._v(" "),t("p",[e._v("You can turn on the RAW packet return support with the following MQTT command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"rawEnabled":true}\'')])]),e._v(" "),t("p",[e._v("The returned JSON looks like this:\n"),t("code",[e._v('Client (null) received PUBLISH (d0, q0, r0, m0, \'home/OpenMQTTGateway/PilighttoMQTT\', ... (176 bytes)) {"format":"RAW","rawlen":106,"pulsesString":"c:0102010102020202020101010101010102020201020102020202020201010101010101010101010102010102010201020201010203;p:521,944,1924,3845@"}')])]),e._v(" "),t("p",[e._v("The pulseString format is Pilight's native. For those who are not familiar with it:\nc:* are the indexes for the p:* array, which are the different pulse length. (e.g. pulse[0] = 521ms, pulse[1]=944ms..., so c[0], which is a '0' = 521ms pulse, c[1], which is a '1' =944ms pulse etc)")]),e._v(" "),t("p",[e._v("After gathering all the packets you need, simply turn off the RAW packet support via MQTT:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"rawEnabled":false}\'')])]),e._v(" "),t("h3",{attrs:{id:"limit-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-protocols"}},[e._v("#")]),e._v(" Limit Protocols")]),e._v(" "),t("p",[e._v("It is possible to limit the protocols that Pilight will respond to, this can help reduce noise from unwanted devices and in some cases disable conflicting protocols.")]),e._v(" "),t("h4",{attrs:{id:"available-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#available-protocols"}},[e._v("#")]),e._v(" Available protocols")]),e._v(" "),t("p",[e._v("To list the available protocols on the Serial -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"available":true}\'')])]),e._v(" "),t("h4",{attrs:{id:"limit-protocols-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-protocols-2"}},[e._v("#")]),e._v(" Limit protocols")]),e._v(" "),t("p",[e._v("To limit the protocols, send a JSON array of protocols as below -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols -m \'{"limit": ["array", "of", "protocols"]}\'')])]),e._v(" "),t("p",[e._v("eg: "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"limit":["tfa", "ev1527"}\'')])]),e._v(" "),t("h4",{attrs:{id:"reset-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reset-protocols"}},[e._v("#")]),e._v(" Reset protocols")]),e._v(" "),t("p",[e._v("To reset and listen to all protocols -\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols -m \'{"reset": true}\'')])]),e._v(" "),t("h4",{attrs:{id:"enabled-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabled-protocols"}},[e._v("#")]),e._v(" Enabled protocols")]),e._v(" "),t("p",[e._v("To list the enabled protocols on the Serial -")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight/protocols" -m \'{"enabled":true}\'')])]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-transmit-a-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-transmit-a-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to transmit a RF signal")]),e._v(" "),t("h4",{attrs:{id:"using-a-known-protocol"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-known-protocol"}},[e._v("#")]),e._v(" Using a known protocol")]),e._v(" "),t("p",[t("strong",[e._v("ON")]),e._v(" "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"on\\":1}","protocol":"elro_400_switch"}\'')])]),e._v(" "),t("p",[t("strong",[e._v("OFF")]),e._v(" "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"off\\":1}","protocol":"elro_400_switch"}\'')])]),e._v(" "),t("p",[e._v("These commands will transmit by RF the signals to actuate an elro_400 switch.")]),e._v(" "),t("p",[e._v("With a different frequency (CC1101 only):\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"message":"{\\"systemcode\\":12,\\"unitcode\\":22,\\"off\\":1}","protocol":"elro_400_switch","frequency":315.026}\'')])]),e._v(" "),t("h4",{attrs:{id:"using-a-raw-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-raw-signal"}},[e._v("#")]),e._v(" Using a raw signal")]),e._v(" "),t("p",[e._v('You can transmit raw signal data by using the "raw" protocol. This uses the Pilight pulse train string format. One such example string, representing a transmission for Nexus protocol weather stations, looks like this: '),t("code",[e._v("c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@")]),e._v(". This string represents pulses and gaps directly.")]),e._v(" "),t("p",[e._v("Each number in the list after "),t("code",[e._v("p:")]),e._v(" that ends with "),t("code",[e._v(";")]),e._v(" stands for "),t("strong",[e._v("p")]),e._v("ulse and gap lengths in microseconds (µs). In this example, we have a list containing lengths of 500µs, 1000µs, 2000µs, and 4000µs.")]),e._v(" "),t("p",[e._v("Each number after "),t("code",[e._v("c:")]),e._v(" and ended by "),t("code",[e._v(";")]),e._v(" represents a "),t("strong",[e._v("c")]),e._v("ode that references the "),t("code",[e._v("p:")]),e._v(" list by index. In this example, the first 4 numbers after "),t("code",[e._v("c:")]),e._v(" are 0, 3, 0, and 2, which reference "),t("code",[e._v("p:")]),e._v("[0] = 500, "),t("code",[e._v("p:")]),e._v("[3] = 4000, "),t("code",[e._v("p:")]),e._v("[0] = 500, and "),t("code",[e._v("p:")]),e._v("[2] = 2000, respectively. In the language of digital radio transceiving, the most basic unit is usually a pulse and gap pair; in other words, 0s and 1s are represented by a pulse followed by a gap (lack of pulse) and the time lengths of these pulses and gaps. Different protocols have different pulse lengths and gap lengths representing 0, and a different one representing 1. Because of this pulse-gap nature, the codes in "),t("code",[e._v("c:")]),e._v(" must be taken as pairs; the first number in a pair represents the length of the pulse, and the second number the subsequent gap. In this example, the first pair, 03, represents a pulse of 500µs followed by a gap of 4000µs. The next pair, 02, represents a pulse of 500µs followed by a gap of 2000µs.")]),e._v(" "),t("p",[e._v("The number after "),t("code",[e._v("r:")]),e._v(" represents how many times the message in the string is to be "),t("strong",[e._v("r")]),e._v("epeated. The "),t("code",[e._v("r:")]),e._v(" block is optional. The default number of repeats if "),t("code",[e._v("r:")]),e._v(" is not specified is 10. Greater than about 100 repeats will cause a crash due to memory usage. If this example were written without specifying repeats, it would look like this: "),t("code",[e._v('{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000@"}')])]),e._v(" "),t("p",[e._v("The entire string must end in a "),t("code",[e._v("@")]),e._v(". Each block must end in a "),t("code",[e._v(";")]),e._v(", but if it is the last block in the string, the "),t("code",[e._v("@")]),e._v(" replaces the "),t("code",[e._v(";")]),e._v(". Since the "),t("code",[e._v("r:")]),e._v(" block is optional, this last block could be either "),t("code",[e._v("p:")]),e._v(" or "),t("code",[e._v("r:")]),e._v(".")]),e._v(" "),t("p",[e._v("The JSON for the MQTT message to "),t("code",[e._v("home/OpenMQTTGateway/commands/MQTTtoPilight")]),e._v(' should specify the pulse train string as the value for the "raw" key: '),t("code",[e._v('{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@"}')]),e._v(".")]),e._v(" "),t("p",[e._v("e.g. "),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m \'{"raw":"c:03020202010102020102010101010101010202020201020102020202020101010201010202;p:500,1000,2000,4000;r:12@"}\'')])]),e._v(" "),t("h2",{attrs:{id:"rf-with-sonoff-rf-bridge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-with-sonoff-rf-bridge"}},[e._v("#")]),e._v(" RF with SONOFF RF BRIDGE")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-rf-signal-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-rf-signal-3"}},[e._v("#")]),e._v(" Receiving data from RF signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/SRFBtoMQTT {"raw":"2B660186042E00E7E5","value":"59365","delay":"1111","val_Thigh":"390","val_Tlow":"1070"}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("The first parameter is the raw value extracted from the RF module of the Sonoff bridge. The data are in hexadecimal and correspond to the details below:\nhttps://www.itead.cc/wiki/images/5/5e/RF_Universal_Transeceive_Module_Serial_Protocol_v1.0.pdf\nOpenMQTTGateway process the raw value to extract the other decimal values that can be reused to reproduce a signal (raw value can also be reused).")]),e._v(" "),t("p",[e._v("NOTE: currently the device doesn't receive correct values from Switches remote control")]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-rf-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-rf-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on RF signal")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSRFB" -m \'{"value":1315156}\'')])]),e._v(" "),t("p",[e._v("This command will send by RF the code 1315156 and use the default parameters:\nRepeat = 1\nLow time= 320\nHigh time= 900\nSYNC = 9500")]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-with-advanced-rf-parameters-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-rf-parameters-2"}},[e._v("#")]),e._v(" Send data by MQTT with advanced RF parameters")]),e._v(" "),t("p",[e._v('RF bridge sending support four advanced parameters; Repeat, Low time, High time & Sync\nif you want to repeat your signal sending put into your json payload "repeat":2, 2 means 2 repetitions of signal')]),e._v(" "),t("p",[e._v('if you want to use a low time of 315 put inside your json payload "Tlow":315')]),e._v(" "),t("p",[e._v('if you want to use a high time of 845 put inside your json payload "Thigh":845')]),e._v(" "),t("p",[e._v('if you want to use a sync time of 9123 put inside your json payload "Tsyn":9123')]),e._v(" "),t("p",[e._v("Example:\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSRFB/Tlow_315/Thigh_845/Tsyn_9123 -m \'{"value":"33151562","delay":"9123","val_Thigh":"845","val_Tlow":"315"}\'')]),e._v("\nwill make RF Bridge send a signal with the use of listed parameters 315, 845, 9123...")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSRFB/Raw -m \'{"raw":"267A013603B6140551"}\'')]),e._v("\nwill make RF Bridge send a signal with the use of advanced parameters defined in the raw string")]),e._v(" "),t("h2",{attrs:{id:"rf2-gateway-kaku"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf2-gateway-kaku"}},[e._v("#")]),e._v(" RF2 gateway KAKU")]),e._v(" "),t("p",[e._v("RF2 gateway enables to send command to RF devices with the KAKU protocol. DIO chacon devices are an example.\nIt uses the same pinout as the RF gateway and both gateways can be used on the same setup.")]),e._v(" "),t("p",[e._v("Receiving RF codes with the KAKU protocol is not compatible with ZgatewayRF , so as to get the code of your remotes you should comment ZgatewayRF in User_config.h.\nTransmitting can be done with both ZgatewayRF and ZgatewayRF2")]),e._v(" "),t("h3",{attrs:{id:"receiving-data-from-kaku-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-kaku-signal"}},[e._v("#")]),e._v(" Receiving data from KAKU signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:")]),e._v(" "),t("p",[t("code",[e._v("sudo mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your RF signals by pressing a remote button or other and you will see :")]),e._v(" "),t("p",[t("code",[e._v('home/OpenMQTTGateway/RF2toMQTT {"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":0}')])]),e._v(" "),t("h3",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-kaku-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-kaku-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on KAKU signal")]),e._v(" "),t("p",[e._v("Once you get the infos publish the parameters with MQTT like that for off:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":0}"')])]),e._v(" "),t("p",[e._v("for on:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":1}"')])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/33.66867073.js b/dev/assets/js/33.c924d541.js similarity index 86% rename from dev/assets/js/33.66867073.js rename to dev/assets/js/33.c924d541.js index ebad47ab..624e75cf 100644 --- a/dev/assets/js/33.66867073.js +++ b/dev/assets/js/33.c924d541.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{267:function(t,a,e){t.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},380:function(t,a,e){t.exports=e.p+"assets/img/OpenMQTTgateway_M5_Atom_Board.043db6b5.png"},443:function(t,a,e){"use strict";e.r(a);var s=e(14),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"ble-gateway"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ble-gateway"}},[t._v("#")]),t._v(" BLE gateway")]),t._v(" "),a("h2",{attrs:{id:"compatible-parts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),a("p",[a("strong",[t._v("The ESP32 has an integrated BLE module")]),t._v(", with this board the BLE gateway don't need any additional hardware. Making it the "),a("strong",[t._v("advised board for BLE")]),t._v(".")]),t._v(" "),a("p",[t._v("You can use a barebone ESP32 or some nice looking products like the ones below (from M5Stack):")]),t._v(" "),a("p",[a("img",{attrs:{src:e(380),alt:"M5 Atom"}}),t._v(" "),a("img",{attrs:{src:e(267),alt:"M5 Stack Core"}})]),t._v(" "),a("p",[t._v("For Arduino and ESP8266, we previously used HM10, this module is no longer supported by OpenMQTTGateway, prefer an ESP32.")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{267:function(t,a,e){t.exports=e.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},381:function(t,a,e){t.exports=e.p+"assets/img/OpenMQTTgateway_M5_Atom_Board.043db6b5.png"},444:function(t,a,e){"use strict";e.r(a);var s=e(14),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"ble-gateway"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ble-gateway"}},[t._v("#")]),t._v(" BLE gateway")]),t._v(" "),a("h2",{attrs:{id:"compatible-parts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),a("p",[a("strong",[t._v("The ESP32 has an integrated BLE module")]),t._v(", with this board the BLE gateway don't need any additional hardware. Making it the "),a("strong",[t._v("advised board for BLE")]),t._v(".")]),t._v(" "),a("p",[t._v("You can use a barebone ESP32 or some nice looking products like the ones below (from M5Stack):")]),t._v(" "),a("p",[a("img",{attrs:{src:e(381),alt:"M5 Atom"}}),t._v(" "),a("img",{attrs:{src:e(267),alt:"M5 Stack Core"}})]),t._v(" "),a("p",[t._v("For Arduino and ESP8266, we previously used HM10, this module is no longer supported by OpenMQTTGateway, prefer an ESP32.")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/35.a43edc6f.js b/dev/assets/js/35.790d5635.js similarity index 99% rename from dev/assets/js/35.a43edc6f.js rename to dev/assets/js/35.790d5635.js index 929f487a..438baa73 100644 --- a/dev/assets/js/35.a43edc6f.js +++ b/dev/assets/js/35.790d5635.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{384:function(t,e,r){t.exports=r.p+"assets/img/OpenMQTTgateway_ESP32_Addon_RF.4cc8bb49.png"},385:function(t,e,r){t.exports=r.p+"assets/img/OpenMQTTgateway_ESP8266_Addon_RF.7c4ca06a.png"},448:function(t,e,r){"use strict";r.r(e);var a=r(14),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"rf-gateway-433mhz-315mhz"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateway-433mhz-315mhz"}},[t._v("#")]),t._v(" RF gateway (433mhz/315mhz)")]),t._v(" "),e("h2",{attrs:{id:"protocols-modules-and-library"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#protocols-modules-and-library"}},[t._v("#")]),t._v(" Protocols, modules and library")]),t._v(" "),e("p",[t._v("RTL_433 covers OOK protocols detailed "),e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("here")]),t._v(" and supports auto-discovery following Home Assistant convention. The other libraries/modules are more for advanced users.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Protocols")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Assembly/Soldering required")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Heltec LORA V2 433Mhz")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")])]),t._v(" "),e("tr",[e("td",[t._v("LILYGO® LoRa32 V2.1_1.6.1 433 Mhz")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + SX127X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + CC1101")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP8266 + Basic RF modules (SRX, STX, XD RF, FS1000A")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP8266 + CC1101 (might have lower range than with SRX/STX above)")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + Basic RF modules (SRX, STX, XD RF, FS1000A")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you want to try the RTL_433 module with a combination or a board outside of this list, verify that it has an SX1278 or a SX1276")])]),t._v(" "),e("p",[t._v("Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX1262 module.")]),t._v(" "),e("h2",{attrs:{id:"assembly-soldering-required-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#assembly-soldering-required-parts"}},[t._v("#")]),t._v(" Assembly/soldering required parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module")]),t._v(" "),e("th",[t._v("Purpose")]),t._v(" "),e("th",[t._v("Compatible modules")]),t._v(" "),e("th",[t._v("Receiver Switching")]),t._v(" "),e("th",[t._v("Where to Buy")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("SRX882 or SRX882S (recommended)")]),t._v(" "),e("td",[t._v("433Mhz Receiver")]),t._v(" "),e("td",[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("STX882 (recommended)")]),t._v(" "),e("td",[t._v("433Mhz Transmitter")]),t._v(" "),e("td",[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("CC1101")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("SX1276/SX1278")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")])]),t._v(" "),e("td",[t._v("Not Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("LilyGo/Heltec")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")])]),t._v(" "),e("td",[t._v("Not Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])])])]),t._v(" "),e("h3",{attrs:{id:"srx-stx-pinout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#srx-stx-pinout"}},[t._v("#")]),t._v(" SRX STX Pinout")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Receiver Pin")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Emitter Pin")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("ESP8266")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D2/"),e("strong",[t._v("D3")]),t._v("/D1/D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("RX")]),t._v("/D2")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("27")]),t._v("/26")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("12")])]),t._v(" "),e("tr",[e("td",[t._v("RF BRIDGE")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("RF BRIDGE "),e("a",{attrs:{href:"https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack",target:"_blank",rel:"noopener noreferrer"}},[t._v("DIRECT HACK"),e("OutboundLink")],1)]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("4")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")])]),t._v(" "),e("tr",[e("td",[t._v("SONOFF RFR3")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("4")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("RF WIFI GATEWAY")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])])])]),t._v(" "),e("p",[t._v("Connect the Emitter and Receiver to a 5V or 3.3V supply source, check datasheet of your modules to confirm ("),e("strong",[t._v("3.3V")]),t._v(" for CC1101), and the ground of your supply source to the ground of your board.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("With SRX882S receiver connect the CS pin to 3.3V")])]),t._v(" "),e("h3",{attrs:{id:"cc1101-pinout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cc1101-pinout"}},[t._v("#")]),t._v(" CC1101 Pinout")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Receiver Pin(GDO2)")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Emitter Pin(GDO0)")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("SCK")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("VCC")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("MOSI")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("MISO")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("CSN")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("GND")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("ESP8266")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D2/"),e("strong",[t._v("D3")]),t._v("/D1/D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("RX")]),t._v("/D2")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("3V3")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D7")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D6")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("D27")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D12")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D18")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("3V3")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D23")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D19")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])])])]),t._v(" "),e("p",[t._v("To use the CC1101 module, "),e("code",[t._v("ZradioCC1101")]),t._v(" must be uncomment in the "),e("code",[t._v("User_config.h")]),t._v(" or added to the "),e("code",[t._v("build_flags")]),t._v(".\nMore information about the "),e("a",{attrs:{href:"https://github.com/LSatan/SmartRC-CC1101-Driver-Lib#wiring",target:"_blank",rel:"noopener noreferrer"}},[t._v("CC1101 wiring"),e("OutboundLink")],1),t._v(". ( Please note that with OMG we are recommending CC1101 GDO2 to be connected to ESP32 D27 and GDO0 to be connected to D12, this is different than the LSatan diagram. This is due to the ESP32 using D2 as part of the boot process. )")]),t._v(" "),e("h2",{attrs:{id:"esp32-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#esp32-hardware-setup"}},[t._v("#")]),t._v(" ESP32 Hardware setup")]),t._v(" "),e("p",[e("img",{attrs:{src:r(384),alt:"Addon_RF"}})]),t._v(" "),e("h2",{attrs:{id:"esp8266-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#esp8266-hardware-setup"}},[t._v("#")]),t._v(" ESP8266 Hardware setup")]),t._v(" "),e("p",[t._v("If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.")]),t._v(" "),e("p",[t._v("With SRX882 some users reported that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.")]),t._v(" "),e("p",[e("img",{attrs:{src:r(385),alt:"Addon_RF"}})]),t._v(" "),e("h2",{attrs:{id:"sonoff-rf-bridge-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sonoff-rf-bridge-hardware-setup"}},[t._v("#")]),t._v(" SONOFF RF Bridge Hardware setup")]),t._v(" "),e("p",[t._v("Per default there is no need on modifying the RF Bridge hardware, unless you don't want to use the provided RF controller (EFM8BB1). Indeed if you want to extend the protocols supported by the bridge you can "),e("a",{attrs:{href:"https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack",target:"_blank",rel:"noopener noreferrer"}},[t._v("bypass this controller"),e("OutboundLink")],1),t._v(" and use the ESP8255 capacities to decode RF Signal.\nThe RF processing can be achieved after the modification by either RF, RF2 or Pilight gateways.")]),t._v(" "),e("h2",{attrs:{id:"sonoff-rfr3-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sonoff-rfr3-hardware-setup"}},[t._v("#")]),t._v(" SONOFF RFR3 Hardware setup")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Connect GPIO4 of the ESP8255 to the pin D0 of SYN470"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"wifi-rf-gateway-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi-rf-gateway-hardware-setup"}},[t._v("#")]),t._v(" WIFI RF GATEWAY Hardware setup")]),t._v(" "),e("p",[t._v("This board doesn't require any hardware modifications.")])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{384:function(t,e,r){t.exports=r.p+"assets/img/OpenMQTTgateway_ESP32_Addon_RF.4cc8bb49.png"},385:function(t,e,r){t.exports=r.p+"assets/img/OpenMQTTgateway_ESP8266_Addon_RF.7c4ca06a.png"},446:function(t,e,r){"use strict";r.r(e);var a=r(14),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"rf-gateway-433mhz-315mhz"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rf-gateway-433mhz-315mhz"}},[t._v("#")]),t._v(" RF gateway (433mhz/315mhz)")]),t._v(" "),e("h2",{attrs:{id:"protocols-modules-and-library"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#protocols-modules-and-library"}},[t._v("#")]),t._v(" Protocols, modules and library")]),t._v(" "),e("p",[t._v("RTL_433 covers OOK protocols detailed "),e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("here")]),t._v(" and supports auto-discovery following Home Assistant convention. The other libraries/modules are more for advanced users.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Protocols")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Assembly/Soldering required")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Heltec LORA V2 433Mhz")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")])]),t._v(" "),e("tr",[e("td",[t._v("LILYGO® LoRa32 V2.1_1.6.1 433 Mhz")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + SX127X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", receiving only")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + CC1101")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP8266 + Basic RF modules (SRX, STX, XD RF, FS1000A")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP8266 + CC1101 (might have lower range than with SRX/STX above)")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32 + Basic RF modules (SRX, STX, XD RF, FS1000A")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you want to try the RTL_433 module with a combination or a board outside of this list, verify that it has an SX1278 or a SX1276")])]),t._v(" "),e("p",[t._v("Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX1262 module.")]),t._v(" "),e("h2",{attrs:{id:"assembly-soldering-required-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#assembly-soldering-required-parts"}},[t._v("#")]),t._v(" Assembly/soldering required parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module")]),t._v(" "),e("th",[t._v("Purpose")]),t._v(" "),e("th",[t._v("Compatible modules")]),t._v(" "),e("th",[t._v("Receiver Switching")]),t._v(" "),e("th",[t._v("Where to Buy")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("SRX882 or SRX882S (recommended)")]),t._v(" "),e("td",[t._v("433Mhz Receiver")]),t._v(" "),e("td",[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("STX882 (recommended)")]),t._v(" "),e("td",[t._v("433Mhz Transmitter")]),t._v(" "),e("td",[t._v("RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("CC1101")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")]),t._v(", RF(RCSwitch), RF2(KaKu), Pilight")]),t._v(" "),e("td",[t._v("Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("SX1276/SX1278")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")])]),t._v(" "),e("td",[t._v("Not Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("LilyGo/Heltec")]),t._v(" "),e("td",[t._v("433Mhz Transceiver")]),t._v(" "),e("td",[e("a",{attrs:{href:"../use/rf#supported-decoders"}},[t._v("RTL_433")])]),t._v(" "),e("td",[t._v("Not Supported")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])])])]),t._v(" "),e("h3",{attrs:{id:"srx-stx-pinout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#srx-stx-pinout"}},[t._v("#")]),t._v(" SRX STX Pinout")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Receiver Pin")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Emitter Pin")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("ESP8266")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D2/"),e("strong",[t._v("D3")]),t._v("/D1/D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("RX")]),t._v("/D2")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("27")]),t._v("/26")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("12")])]),t._v(" "),e("tr",[e("td",[t._v("RF BRIDGE")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("RF BRIDGE "),e("a",{attrs:{href:"https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack",target:"_blank",rel:"noopener noreferrer"}},[t._v("DIRECT HACK"),e("OutboundLink")],1)]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("4")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")])]),t._v(" "),e("tr",[e("td",[t._v("SONOFF RFR3")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("4")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("RF WIFI GATEWAY")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])])])]),t._v(" "),e("p",[t._v("Connect the Emitter and Receiver to a 5V or 3.3V supply source, check datasheet of your modules to confirm ("),e("strong",[t._v("3.3V")]),t._v(" for CC1101), and the ground of your supply source to the ground of your board.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("With SRX882S receiver connect the CS pin to 3.3V")])]),t._v(" "),e("h3",{attrs:{id:"cc1101-pinout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cc1101-pinout"}},[t._v("#")]),t._v(" CC1101 Pinout")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Board")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Receiver Pin(GDO2)")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Emitter Pin(GDO0)")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("SCK")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("VCC")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("MOSI")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("MISO")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("CSN")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("GND")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("ESP8266")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D2/"),e("strong",[t._v("D3")]),t._v("/D1/D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("RX")]),t._v("/D2")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("3V3")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D7")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D6")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D8")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])]),t._v(" "),e("tr",[e("td",[t._v("ESP32")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("D27")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D12")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D18")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[e("strong",[t._v("3V3")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D23")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D19")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])])])]),t._v(" "),e("p",[t._v("To use the CC1101 module, "),e("code",[t._v("ZradioCC1101")]),t._v(" must be uncomment in the "),e("code",[t._v("User_config.h")]),t._v(" or added to the "),e("code",[t._v("build_flags")]),t._v(".\nMore information about the "),e("a",{attrs:{href:"https://github.com/LSatan/SmartRC-CC1101-Driver-Lib#wiring",target:"_blank",rel:"noopener noreferrer"}},[t._v("CC1101 wiring"),e("OutboundLink")],1),t._v(". ( Please note that with OMG we are recommending CC1101 GDO2 to be connected to ESP32 D27 and GDO0 to be connected to D12, this is different than the LSatan diagram. This is due to the ESP32 using D2 as part of the boot process. )")]),t._v(" "),e("h2",{attrs:{id:"esp32-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#esp32-hardware-setup"}},[t._v("#")]),t._v(" ESP32 Hardware setup")]),t._v(" "),e("p",[e("img",{attrs:{src:r(384),alt:"Addon_RF"}})]),t._v(" "),e("h2",{attrs:{id:"esp8266-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#esp8266-hardware-setup"}},[t._v("#")]),t._v(" ESP8266 Hardware setup")]),t._v(" "),e("p",[t._v("If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.")]),t._v(" "),e("p",[t._v("With SRX882 some users reported that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.")]),t._v(" "),e("p",[e("img",{attrs:{src:r(385),alt:"Addon_RF"}})]),t._v(" "),e("h2",{attrs:{id:"sonoff-rf-bridge-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sonoff-rf-bridge-hardware-setup"}},[t._v("#")]),t._v(" SONOFF RF Bridge Hardware setup")]),t._v(" "),e("p",[t._v("Per default there is no need on modifying the RF Bridge hardware, unless you don't want to use the provided RF controller (EFM8BB1). Indeed if you want to extend the protocols supported by the bridge you can "),e("a",{attrs:{href:"https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack",target:"_blank",rel:"noopener noreferrer"}},[t._v("bypass this controller"),e("OutboundLink")],1),t._v(" and use the ESP8255 capacities to decode RF Signal.\nThe RF processing can be achieved after the modification by either RF, RF2 or Pilight gateways.")]),t._v(" "),e("h2",{attrs:{id:"sonoff-rfr3-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sonoff-rfr3-hardware-setup"}},[t._v("#")]),t._v(" SONOFF RFR3 Hardware setup")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Connect GPIO4 of the ESP8255 to the pin D0 of SYN470"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"wifi-rf-gateway-hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi-rf-gateway-hardware-setup"}},[t._v("#")]),t._v(" WIFI RF GATEWAY Hardware setup")]),t._v(" "),e("p",[t._v("This board doesn't require any hardware modifications.")])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/39.20ae555e.js b/dev/assets/js/39.e500259f.js similarity index 97% rename from dev/assets/js/39.20ae555e.js rename to dev/assets/js/39.e500259f.js index 9e17e405..0d3a38d6 100644 --- a/dev/assets/js/39.20ae555e.js +++ b/dev/assets/js/39.e500259f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{267:function(e,t,o){e.exports=o.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},404:function(e,t,o){e.exports=o.p+"assets/img/OpenMQTTgateway_M5_StickC_Board_Display_Text.82873002.png"},458:function(e,t,o){"use strict";o.r(t);var a=o(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"boards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boards"}},[e._v("#")]),e._v(" Boards")]),e._v(" "),t("h2",{attrs:{id:"esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp"}},[e._v("#")]),e._v(" ESP")]),e._v(" "),t("h3",{attrs:{id:"erasing-the-flash"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#erasing-the-flash"}},[e._v("#")]),e._v(" Erasing the flash")]),e._v(" "),t("p",[e._v("So as to erase the flash memory on ESP boards you may do a long press to TRIGGER_GPIO button or connect the pin TRIGGER_GPIO to the ground during several seconds.")]),e._v(" "),t("p",[e._v("On M5Stack boards you may do a long press to these buttons in low power mode 0 (see below how to go to low power mode 0):")]),e._v(" "),t("ul",[t("li",[e._v("Button B on M5StickC and M5StickC Plus (GPIO 37)")]),e._v(" "),t("li",[e._v("Button C on M5Stack (GPIO 37)")]),e._v(" "),t("li",[e._v("Button lateral on M5stick (GPIO 35)")])]),e._v(" "),t("p",[e._v("You can also do a long press when powering the board to reset it, this press must be done during the first 5 seconds after the start.")]),e._v(" "),t("h3",{attrs:{id:"wifi-interference-on-sensors-when-using-an-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wifi-interference-on-sensors-when-using-an-esp"}},[e._v("#")]),e._v(" Wifi interference on sensors when using an ESP")]),e._v(" "),t("p",[e._v("Certain sensors like HC-SR501 is prone to generate false signals / triggers when used on a ESP with Wifi enabled. To reduce or eliminate the effect the board must be put into Wifi B/G with lower TX power.")]),e._v(" "),t("p",[e._v("This can be achieved with the following macro, "),t("code",[e._v("WifiGMode")]),e._v(" defined true and "),t("code",[e._v("WifiPower")]),e._v(" to e.g. WIFI_POWER_11dBm (ESP32) or 11 (ESP8266).")]),e._v(" "),t("p",[e._v("Since the WiFi protocol is persisted in the flash of the ESP you have to run at least once with "),t("code",[e._v("WiFiGMode")]),e._v(" defined "),t("strong",[e._v("false")]),e._v(" to get Band N back.")]),e._v(" "),t("h3",{attrs:{id:"low-power-mode-for-esp32"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#low-power-mode-for-esp32"}},[e._v("#")]),e._v(" Low power mode for ESP32")]),e._v(" "),t("p",[e._v("OpenMQTTGateway support a low power mode for ESP32, the boards needs to have the macro "),t("code",[e._v("DEFAULT_LOW_POWER_MODE")]),e._v(" defined at "),t("code",[e._v("ALWAYS_ON")]),e._v(", "),t("code",[e._v("INTERVAL")]),e._v(" or "),t("code",[e._v("ACTION")]),e._v(" to use it. More information about the modes is available into User_config.h.")]),e._v(" "),t("p",[e._v("When available this mode can be set by MQTT:")]),e._v(" "),t("ul",[t("li",[e._v("Normal mode (per default)")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":0, "save":true}\'')])]),e._v(" "),t("ul",[t("li",[e._v("Low Power mode wake up from interval defined by DEEP_SLEEP_IN_US and pins defined by ESP32_EXT0_WAKE_PIN and/or ESP32_EXT1_WAKE_PIN")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":1, "save":true}\'')])]),e._v(" "),t("ul",[t("li",[e._v("Low Power mode wake up from pins defined by ESP32_EXT0_WAKE_PIN and/or ESP32_EXT1_WAKE_PIN")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":2, "save":true}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("A low power mode switch is automatically created by discovery with Home Assistant, you may experience a delay between the command and the state update due to the fact that the update will be received and acknowledged when the device woke up.\nIf you are publishing the state change while the device is asleep use the retain flag. This way the device will retrieve the powermode command at wake up.")])]),e._v(" "),t("p",[e._v("The default sleep time is defined by the macro "),t("code",[e._v("DEEP_SLEEP_IN_US")]),e._v(" (default 60s)")]),e._v(" "),t("p",[e._v("We can also use an external sensor state to wake-up the ESP, this is defined by macro "),t("code",[e._v("ESP32_EXT0_WAKE_PIN/ESP32_EXT1_WAKE_PIN")]),e._v(", the level is defined by the macro "),t("code",[e._v("ESP32_EXT0_WAKE_PIN_STATE/ESP32_EXT0_WAKE_PIN_STATE")]),e._v(" (default to HIGH).")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("If you change the default low power mode to INTERVAL or ACTION and your credential are not set or not correct, the ESP32 will not connect to the broker and the only way to change the low power mode will be a new erase/upload.")])]),e._v(" "),t("h2",{attrs:{id:"m5stickc-m5stickc-plus-or-m5stack"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#m5stickc-m5stickc-plus-or-m5stack"}},[e._v("#")]),e._v(" M5StickC, M5StickC Plus or M5Stack")]),e._v(" "),t("h3",{attrs:{id:"behaviour"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#behaviour"}},[e._v("#")]),e._v(" Behaviour")]),e._v(" "),t("p",[e._v("If the connection of the board to WiFi and MQTT is successful you will see the logo with text like below:")]),e._v(" "),t("p",[t("img",{attrs:{src:o(267),alt:"boards"}})]),e._v(" "),t("p",[e._v("The same behaviour apply to M5StickC and M5StickC Plus")]),e._v(" "),t("p",[t("img",{attrs:{src:o(404),alt:"boards"}})]),e._v(" "),t("h3",{attrs:{id:"setting-the-log-output"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-log-output"}},[e._v("#")]),e._v(" Setting the log output")]),e._v(" "),t("p",[e._v("Per default the log of the M5 boards is going to the LCD display with Errors and Warnings only, if you want to change the output at build time you can do it in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/development/main/config_M5.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_M5.h"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("You can also change it by MQTT. For example if you want to set to LCD")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoM5/config -m '{\"log-display\":true}'")])]),e._v(" "),t("p",[e._v("you can also revert it to the serial monitor:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoM5/config -m '{\"log-display\":false}'")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{267:function(e,t,o){e.exports=o.p+"assets/img/OpenMQTTgateway_M5_Stack_Board_Display_Text.7a6039b8.png"},393:function(e,t,o){e.exports=o.p+"assets/img/OpenMQTTgateway_M5_StickC_Board_Display_Text.82873002.png"},457:function(e,t,o){"use strict";o.r(t);var a=o(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"boards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boards"}},[e._v("#")]),e._v(" Boards")]),e._v(" "),t("h2",{attrs:{id:"esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp"}},[e._v("#")]),e._v(" ESP")]),e._v(" "),t("h3",{attrs:{id:"erasing-the-flash"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#erasing-the-flash"}},[e._v("#")]),e._v(" Erasing the flash")]),e._v(" "),t("p",[e._v("So as to erase the flash memory on ESP boards you may do a long press to TRIGGER_GPIO button or connect the pin TRIGGER_GPIO to the ground during several seconds.")]),e._v(" "),t("p",[e._v("On M5Stack boards you may do a long press to these buttons in low power mode 0 (see below how to go to low power mode 0):")]),e._v(" "),t("ul",[t("li",[e._v("Button B on M5StickC and M5StickC Plus (GPIO 37)")]),e._v(" "),t("li",[e._v("Button C on M5Stack (GPIO 37)")]),e._v(" "),t("li",[e._v("Button lateral on M5stick (GPIO 35)")])]),e._v(" "),t("p",[e._v("You can also do a long press when powering the board to reset it, this press must be done during the first 5 seconds after the start.")]),e._v(" "),t("h3",{attrs:{id:"wifi-interference-on-sensors-when-using-an-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wifi-interference-on-sensors-when-using-an-esp"}},[e._v("#")]),e._v(" Wifi interference on sensors when using an ESP")]),e._v(" "),t("p",[e._v("Certain sensors like HC-SR501 is prone to generate false signals / triggers when used on a ESP with Wifi enabled. To reduce or eliminate the effect the board must be put into Wifi B/G with lower TX power.")]),e._v(" "),t("p",[e._v("This can be achieved with the following macro, "),t("code",[e._v("WifiGMode")]),e._v(" defined true and "),t("code",[e._v("WifiPower")]),e._v(" to e.g. WIFI_POWER_11dBm (ESP32) or 11 (ESP8266).")]),e._v(" "),t("p",[e._v("Since the WiFi protocol is persisted in the flash of the ESP you have to run at least once with "),t("code",[e._v("WiFiGMode")]),e._v(" defined "),t("strong",[e._v("false")]),e._v(" to get Band N back.")]),e._v(" "),t("h3",{attrs:{id:"low-power-mode-for-esp32"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#low-power-mode-for-esp32"}},[e._v("#")]),e._v(" Low power mode for ESP32")]),e._v(" "),t("p",[e._v("OpenMQTTGateway support a low power mode for ESP32, the boards needs to have the macro "),t("code",[e._v("DEFAULT_LOW_POWER_MODE")]),e._v(" defined at "),t("code",[e._v("ALWAYS_ON")]),e._v(", "),t("code",[e._v("INTERVAL")]),e._v(" or "),t("code",[e._v("ACTION")]),e._v(" to use it. More information about the modes is available into User_config.h.")]),e._v(" "),t("p",[e._v("When available this mode can be set by MQTT:")]),e._v(" "),t("ul",[t("li",[e._v("Normal mode (per default)")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":0, "save":true}\'')])]),e._v(" "),t("ul",[t("li",[e._v("Low Power mode wake up from interval defined by DEEP_SLEEP_IN_US and pins defined by ESP32_EXT0_WAKE_PIN and/or ESP32_EXT1_WAKE_PIN")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":1, "save":true}\'')])]),e._v(" "),t("ul",[t("li",[e._v("Low Power mode wake up from pins defined by ESP32_EXT0_WAKE_PIN and/or ESP32_EXT1_WAKE_PIN")])]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"powermode":2, "save":true}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("A low power mode switch is automatically created by discovery with Home Assistant, you may experience a delay between the command and the state update due to the fact that the update will be received and acknowledged when the device woke up.\nIf you are publishing the state change while the device is asleep use the retain flag. This way the device will retrieve the powermode command at wake up.")])]),e._v(" "),t("p",[e._v("The default sleep time is defined by the macro "),t("code",[e._v("DEEP_SLEEP_IN_US")]),e._v(" (default 60s)")]),e._v(" "),t("p",[e._v("We can also use an external sensor state to wake-up the ESP, this is defined by macro "),t("code",[e._v("ESP32_EXT0_WAKE_PIN/ESP32_EXT1_WAKE_PIN")]),e._v(", the level is defined by the macro "),t("code",[e._v("ESP32_EXT0_WAKE_PIN_STATE/ESP32_EXT0_WAKE_PIN_STATE")]),e._v(" (default to HIGH).")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("If you change the default low power mode to INTERVAL or ACTION and your credential are not set or not correct, the ESP32 will not connect to the broker and the only way to change the low power mode will be a new erase/upload.")])]),e._v(" "),t("h2",{attrs:{id:"m5stickc-m5stickc-plus-or-m5stack"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#m5stickc-m5stickc-plus-or-m5stack"}},[e._v("#")]),e._v(" M5StickC, M5StickC Plus or M5Stack")]),e._v(" "),t("h3",{attrs:{id:"behaviour"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#behaviour"}},[e._v("#")]),e._v(" Behaviour")]),e._v(" "),t("p",[e._v("If the connection of the board to WiFi and MQTT is successful you will see the logo with text like below:")]),e._v(" "),t("p",[t("img",{attrs:{src:o(267),alt:"boards"}})]),e._v(" "),t("p",[e._v("The same behaviour apply to M5StickC and M5StickC Plus")]),e._v(" "),t("p",[t("img",{attrs:{src:o(393),alt:"boards"}})]),e._v(" "),t("h3",{attrs:{id:"setting-the-log-output"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-log-output"}},[e._v("#")]),e._v(" Setting the log output")]),e._v(" "),t("p",[e._v("Per default the log of the M5 boards is going to the LCD display with Errors and Warnings only, if you want to change the output at build time you can do it in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/development/main/config_M5.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_M5.h"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("You can also change it by MQTT. For example if you want to set to LCD")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoM5/config -m '{\"log-display\":true}'")])]),e._v(" "),t("p",[e._v("you can also revert it to the serial monitor:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoM5/config -m '{\"log-display\":false}'")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/40.fb172c18.js b/dev/assets/js/40.8a64d460.js similarity index 85% rename from dev/assets/js/40.fb172c18.js rename to dev/assets/js/40.8a64d460.js index 80ca7168..338c1c0e 100644 --- a/dev/assets/js/40.fb172c18.js +++ b/dev/assets/js/40.8a64d460.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{407:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial_2G_1.80def2ff.jpg"},408:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial_2G_2.48b36c44.jpg"},463:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"gsm-2g-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#gsm-2g-gateway"}},[e._v("#")]),e._v(" GSM 2G gateway")]),e._v(" "),t("h2",{attrs:{id:"receiving-sms-from-2g"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-sms-from-2g"}},[e._v("#")]),e._v(" Receiving SMS from 2G")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:\n"),t("code",[e._v("mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your SMS by sending an SMS to the phone number of the A6/A7 SIM card you will see :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/2GtoMQTT {"phone":"+33123456789","date":"2018/04/22,16:17:51+02","message":"Hello OpenMQTTGateway"}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}},[e._v("#")]),e._v(" Send data by MQTT to send an SMS message with A6/7")]),e._v(" "),t("p",[t("code",[e._v('sudo mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTto2G -m \'{"phone":"+33123456789","date":"2018/04/22,16:17:51+02","message":"hello"}\'')])]),e._v(" "),t("p",[e._v('This command will send by SMS the sentence "hello" and use the phone number 0123456789')]),e._v(" "),t("p",[e._v("Arduino IDE serial data received when publishing data by MQTT")]),e._v(" "),t("p",[t("img",{attrs:{src:a(407),alt:""}})]),e._v(" "),t("p",[e._v("Arduino IDE serial data received when receiving SMS")]),e._v(" "),t("p",[t("img",{attrs:{src:a(408),alt:""}})])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{406:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial_2G_1.80def2ff.jpg"},407:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial_2G_2.48b36c44.jpg"},461:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"gsm-2g-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#gsm-2g-gateway"}},[e._v("#")]),e._v(" GSM 2G gateway")]),e._v(" "),t("h2",{attrs:{id:"receiving-sms-from-2g"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-sms-from-2g"}},[e._v("#")]),e._v(" Receiving SMS from 2G")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:\n"),t("code",[e._v("mosquitto_sub -t +/# -v")])]),e._v(" "),t("p",[e._v("Generate your SMS by sending an SMS to the phone number of the A6/A7 SIM card you will see :")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('home/OpenMQTTGateway/2GtoMQTT {"phone":"+33123456789","date":"2018/04/22,16:17:51+02","message":"Hello OpenMQTTGateway"}\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}},[e._v("#")]),e._v(" Send data by MQTT to send an SMS message with A6/7")]),e._v(" "),t("p",[t("code",[e._v('sudo mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTto2G -m \'{"phone":"+33123456789","date":"2018/04/22,16:17:51+02","message":"hello"}\'')])]),e._v(" "),t("p",[e._v('This command will send by SMS the sentence "hello" and use the phone number 0123456789')]),e._v(" "),t("p",[e._v("Arduino IDE serial data received when publishing data by MQTT")]),e._v(" "),t("p",[t("img",{attrs:{src:a(406),alt:""}})]),e._v(" "),t("p",[e._v("Arduino IDE serial data received when receiving SMS")]),e._v(" "),t("p",[t("img",{attrs:{src:a(407),alt:""}})])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/42.12812fe5.js b/dev/assets/js/42.650f94e4.js similarity index 99% rename from dev/assets/js/42.12812fe5.js rename to dev/assets/js/42.650f94e4.js index 7f53b7ce..f8453bd6 100644 --- a/dev/assets/js/42.12812fe5.js +++ b/dev/assets/js/42.650f94e4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{358:function(t,a){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABmAAAACSCAMAAABlqfVbAAACplBMVEX4+Pj39/f19fXy8vLv7+/t7e3r6+vp6eno6Ojn5+f5+fn09PTx8fHw8PD29vb+/v7////u7u79/f3q6urm5ubj4+Ph4eHg4ODf39/e3t7k5OSgoKD6+vqdnZ3AwMDBwcHa2tqpqan8/PyxsbHMzMx7e3t5eXkxMTFNTU13d3fb29vGxsYtLS0AAACCgoLExMTIyMiDg4Ovr6+ysrK3t7fd3d1KSkqcnJzQ0NA3NzewsLDl5eVgYGDV1dUhISF1dXWXl5fCwsLW1tY8PDxDQ0ONjY2VlZW/v7+fn58iIiLs7Ox8fHwsLCxbW1vX19fz8/Nubm6+vr5RUVFeXl6Ojo5qamp+fn7JyclUVFTi4uJHR0dLS0sdHR0SEhKnp6d9fX2JiYltbW2FhYVxcXG4uLhoaGhzc3O7u7tiYmKPj4/FxcU7OzuBgYGTk5ORkZFnZ2eSkpLNzc3Ozs5YWFiQkJDT09NWVla8vLykpKTDw8NGRkbY2Ni0tLSenp6Li4tra2ulpaVISEjR0dF4eHiGhoZjY2N/f3+qqqrS0tKWlpazs7OamppZWVlmZmZsbGx2dnarq6umpqbU1NStra26urpFRUVycnJfX1+AgIDHx8eYmJiKiorc3NxPT0+EhITZ2dlMTEyhoaHPz890dHS1tbVwcHB6eno1NTXLy8tlZWU/Pz+ZmZk6Ojr7+/vN6c6f1KF7xH5huGVRsVVMr1Dr9utctl+k1qbc791xv3TI5smHh4e2trZcXFyMjIyDyIbr9uz2+/aNzJCPzZL0+vWbm5ujo6OIiIisrKyl16fm9OeV0Jd/xoLl8+b9/v35/PmioqL0+vTK58yCx4Xh8uFhYWE0NDRSUlLP6dD5/Prt9+1Vs1m03bau26/A48Hw+PGoqKiUlJTKyspf5M7bAAAV6ElEQVR4AezaCWprIQCGUa+a0cTaudn/Rh+FB8iQKEMo4DlLCD9+QW8IW0x5tz8cTyzreNjvcopbCOd7DGWKoVhKz1J+51DS5ZoXxvWSyuNj49wNBUOZWwqWEsJWayxLI9Y6ODZmhoKhWErHUsL/ObC48bFhKGOGYik9SxEYBAaBeQpLcUWGKzJckT2FpXjkxyM/Hvmfw1LCFlN8aSzuJQ4/UzaUMUPpl4KlbDG9vvkxeHv9ncP5npmhYCj9UrCUUEt+b9Dec6l3/5mGmaFgKP1SsJRQ0+6jQfvYpbrdDcw2MRQMpV8KlhLiZf/ZoH3uL/FBYCaGgqH0S8FSQrkevhq0r8O1PAjMxFAwlH4pWEoo+fjdoH0f88PA9EPBUMZLwVJCyaefBu3nNAhMPxQMxVIYLUVgnkdgEBgE5tYa3AaB6YeCoVgKAzeBQWAQGAQGgfljCAwCg8AgMAgMAoPAIDAIDAgMAoPAIDAIDAKDwCAwCMzKEBgEBoFBYBAYBAaBQWAQGBAYBAaBQWAQGAQGgUFgEJiVITAIDAKDwCAwCAwCg8AgMCAwCAwCg8AgMAgMAoPAIDBLQ2AQGAQGgUFg/rF33m9tXPkejobQ5Kucj8aNh0i54tDW6N4YUGSwggUYUi6myLhg9t5rjFcCGxcENrFZrw2OsRfc0uOe3nus7b333vvun7IzZ4Rn8CBBGI+ex+H7bolEDswP8z7nnXJGKrzbAwvkeCUQiyIw7J7/hBV8RRyLCAqMmFxuG2MoMFJxNoyUlDowH5aVlX9iZcpArKqAFZjfy5Eewv9f/61w72rx/xYCY6sojtISpKWySoIV5OoAA2GzKNZNsQa/b4XlycW6MWTK3IEJrqlhSFK7NgTcX7cOKAknCc3XBqne6+A8lQ4NjQDY+lVN4eYHlmMB8AcbkR7i3rWBhx56aH3OQw//j6XAWBDFemBaNuQDcN5X1xpuK5KwAKSqdtgMiWLdFGt0RDZan1zIGOumzB2Yzk250OCbwyHzMcY8bVi5JQ8pad8qAay4rsuBrOptXVgA3WUuEOlt+GSLtiv+9//+30JgLIhiPTBsexEAqadqBZeX7ejNwQKo3emEjZAo9ptixsbJxboxZEqawPR+KgoNX6xv4TYEI26kgm/uV0fs6oaKv3chqeC7BzAnZIOQYc/qT1oIjAVRrAcm91OFAEJ7nVDg+2oYPjrSVh9shESx3xQzNk4u1o0hU9IEJrKxTIIKq6nZHwLckeAsNiwvK28drGQA4tVDba3DyG5oDh8I8BvThnbyC2egM9y2Wlb/7vKDTT13QCW3Ps+glSs2MmNcTvSR8COHZAB3Kn+z87CE2baH0SoP5oZs8H16z5GOhs9YCIydomiBCcWhEg8hf5faG3b0GIdgQLyIhyAYHssCpKPNrWMjTP2tOx9sau0rgMKRemUzfhkAGxlrLa8/AsAdOTLevMsFjHtB2CtKBkxxRyoOtYU7A1w6fDzc5mfGfa1pdKsmF4vGkCnpA1NYVguV3JgvnsqGym2NnD9aV8yAeM+JoNuT01vtYCsiR9nMMxjp3olcVnBSGRccLKvOzmJQGT6lhia4qQJJjONiE5+V5OEDXYCrd7uE3IlTs20PKIzkgZjDBlWGT/usryKzSxRTYNDY6wImNy2HxtRpKITKJEyT03umQx4+WwmETmwY5o7t51qAybNDXJ6sC4hrI5Oy555tlYD7/IYzOS4ZGHlsCQhbRcmAKe7zOx6X5ODJJyYOefjQ2UnjvtY0ulWTi0VjyJT0gXFHN3MoRI/xVDa0bPFDoWJXEIjvWgrAKy5ePLnFPTMwUTEzVJzPRXBNNUOSp7xQ4DWdoxwaxnHb1XHjBxmG+9S97N7SbtqeypLHRkDMZYMmQ4v1S2Q2iWIKDD92lHXUPw2NuzaInZzd27eCQcBq9nEAfkWY0DPtqgfPdgFT42KLijDJmaVyrAXuC2IokBcpBGGrKBkwxX1BtGa0tREK41Mw7Gs9MNYnF+vGkCnpA5Mb6QYgldVCtyGsEdJsGNXkYPvGgfg4AL6+ENDGGgMj1Y9CwVM1imAsDwL9iofsP9l08ZIE8zhtKyMxdW+zLI95e8nBxBw2HNmjymBXYKyLYg4M8gfXVYt7rMZxylWRzss+DiB3sB0KWX3tCF3h07/lFSnhWTLG9zHtz47CHRNDtcGEraJkwBT3+atQuDqWnZwgjPtaD4z1ycW6MWRK2sCwmiIAtWUSUh1ueL0Q9F/hYkwSMTauSHPBrQWm8NzK5E4X75Pc0dMFDba0P7LWK5nHia3whgvFSxkA8/aSg4k5bMi6shLWA2OnKKbAoPHAruVIsjKSDQ0ePPzItdUyRmKuZJeMv5UT23BJ0qaRfgi842IjesQIO0XJgCnJ3alPEIZ9re9i65OLdWPIlPSBgS/SAr45ipQ2xEM3v2YVzzUrGqyZeQYTXBPW0ANj2nu5Pacc5nFig/LzD7xw/LAE8/bmHRi6I2c9MLaKYg7Mf/S+yGZdiyi/9EhAf3xiRmDgaHy56aRf1t0Kxe0PDImSSVNMgTHu6+Rr65PL3MaQKZYD49wbRXckF3MfblR5kvvklW0bs8yXyAr73NAwncHotGwZMY+b3iDLn3jVZd4eBWa+T0UJAmvtCYx1UcyBYdVbzrWbz2AEXZGskVMOCIy/JVDu077I9KNar/2BIVEyaUqaMxivvoutTy7WjSFT0gdGnMsW1bDUNozudeqXLUMAsiK1gDkwS15rn/HemAZP1ekbO1OMMzkgiW1mPTts2t7878HQ5zoIXn/DlsBYF8UcmIpzyxvrOwyTin6lVd1m3rN55sDIWRwKT553YbxGvwcTCdIVdftFsdeUNIEx7mu9CBYnF+vGkClzB0Yqe6jPh9Q2tIxV6gsvQgBc58UOqdw2MzAIac8ztPDke+NCj6dLJajkD/rM48RBjfBnSd+weXvWV5ER1gNjXRQtMGL5F9DyZgiQSgNw7tzODKvIlPfV2vvGxyQ+Jf4dW8oMgUlORu1KYIK79FVkkSBoTZD9omTIFHNg9H2tB8bq5GLdGGLuwCD61oQTQNpF6/KktnQ8BIC/XZbPsqrP3hwYqWcinzmir+bMCEyJWKouHRub9MDT9ebb3DRObKXgbLWEjjO9LvP2QM/BZD4wNogiAiMeSnDIBc++EwKrPuUAlu9qh4DtOw2Fgrr9y2S4Ht/WBeTEzrjQcfiiZAgMAnWPcvHMhPZsBG/cVgk9MPRUg+2i2G+KOTDGfa0HxvrkQsbYH5jcXbVIZ4N4cnpsiCXHAA7l6drOw3ljJTP/DpyBA+HmhmzMCEzyMoc8tKop3LRqSDaP07aSd6xZ+eGdMG1PjNjpAWF/YGwWRZsZlolnqfeHUKEdlAamL5KNakuRpeK61vAL++4Xr4++IB7BNgaGDUXKw21RdSyrHGwtLwvCEJiQF4S9othvijkw+r7WA2N9crn9jaHvg+GbR2/RRw4RH/PvgxEf/GERqWwEROYDc/tOLmTM7R0YTJZKmBv6NGUKDDtaBCP02bgUGAuTy+IwhgJj/dtc+INP4+MPBQZLS/NhDenUJBYLFBgxuSxmYygw9I2W6aHA0DdaUmAsQN9oSYFB4Yvv0nfyzwv6Tv4B+k5+CoyFyWXxGUOBISgwBAWGoMAQFBiCoMAQFBiCAkNQYAgKDEGBISgwBAWGoMAsZggKDEGBISgwBAWGoMAQFBiCAkNQYAgKDEFQYAgKDEGBISgwBAWGoMAQFBiCAkNQYBYnBAWGoMAQFBiCAkNQYAgKDEGBISgw773/wYfXE9c//OD99yAgKDAkColCphCWA/O59z+f0Pn8+58DQYEhUUgUMoWwHpgvJG7mCyAoMCQKiUKmEBYD88UvJcx86YsgKDAkColCphBWAvPl64nZuP5lEBQYEoVEIVOIhQfmy4lUkA4UGBKFRCFTiIUH5ovXE6m4/kUQFBgShUQhU4gFBuZLidR8CQQFhkQhUcgUYmGB+UIiHV8AQYEhUUgUMoVYSGA+l0jP50BQYEgUEoVMIRYQmPcT6XkfBAXm4yYKEYrbFhgyhQKj8/lEej4/H1lLkAr2maYppINw3tcWLq9fzwCwysHWpqplmOZIfXl5mfp2WVVT69g6KCx/rjncdFEdrcJqonYEJvOiOOJufEQI2T/Y2jrol6EZEj4QcApFlJedhyUodIUFpQ4otLw44bAlMPabYj8EL+kbAuAoDSfxQmOkrrUse6GBeS8xF+9BJ14EQbTU4XpsBUqS9qaxofsrS5AOgje8tpzxS2dLAFZcNyk7vnq2AhrtX7vHI22P5SDvXLXk6Vd/XrntUBYcjdsCDCq5q3JtDIz9olBgLMCKY+2y3H4yAKDia4c8bEWkgasvow60fP2UA0BoCknk50+9taXUrsDYb0p6Lt8HwhIdxdc2XSuBjrTVB0Fu5Hm5f4cTuBRdQGBMp7NpT2jPbHCJbfcIe1ESmuNwQwxJCzHS64JCtMqD+2MiLaGdTqjwzUUAnHv7UbSZA6zGC/e5WqhU7OqGSn8NszEw9otCgbFAYUxIUBvJUiSJQqH7gg+eKvHS1TsCwBtCkqG+El5iR2DsN8V+CMfEiy2O0hLoDEw4IRj1Aksm8uC6N38BgfkgYeYb3wS+9e1Ekg+gs318QCh9OU6BuVU8fTdUfGNujCqRUciLFELFEyiAQjyEjcPJOSEYcUPljp5+KDiv+ADIq9vCTV/PBtyRikNt4c4Alw4fD7f5mdXA2C8KBcYCIw/cAYWcsSAKI3lQUKcIV9UKKMgPhFR3RmHg5sAIm8SPLQbGflPsh5gRGOfOWmiEQoDjK0FWFMACAvNhYha+812DDR8abXh+ygnw7z0ad6gzgsEGHjje2lcA99e/3xRyPNzcWr8MKqFweE2Q+R9RL+IF41PlpE0qoj/wTB9V3rVhBDr8Sj80xtUzGD8M+LZKACt+dQVzfDaWA/f5HY9LcvDkExOHPHzo7KSFwGRaFHWUNyj+WflDhoJjEoj5UftsB3iWDIUlj90wxxVZJ6YMmwOTeVPc+0OdrRfzjzY1jXMoU0v45DC75T2iwNSWSdDoGhdnMMGd0kICcz0xgx/9+CeJxE9/9vNf6DZch854y/d9QPf3WpI2hBUuuNXdGzrYIU+uynefrOZ4/IceefUOz40zmJLdLnk47gyeHZAxK4QUjRUA/Ve4CMyJEuhURrIhqDhXALxyvNoBwHiL3zeYj+QFtAtHGYDR1kaxs6YsBCbDohgDw70l0u7lIOaFx//mkHlWkFdseJEDSzb8UqwasS8wmTfFfbLI4XziE4f4kr0j6OrJZStOtN/qwFBg+NcHAOM9mI5jk1hIYG6S4Vv41U8UGX79m98KGwTQ8QZ932f4Ya375sONrGMuAA+ddl9ZAoEyIh4Ox9Uhnni3Ov+tDD7IMRtEPBzuVSPRPdgtktJUghsM/a4CgoJzlQDY+r61z250wXCLf3wfS14wcZ+/CoWrY9nmecNSYOwXxRAYdBz0VoKYD6Fw+MDzmMb1rCZOcE349wEuTmO82dx95g8VtgUm86aI98EzDBg9LaYWPOm91YGhwPj6XJhmXUy5AOU/w2HtDEbI8K0//ulbf/75r/+S0Lk+wwbn27mufZLJBuUHAHxR8c87G5qnV0aqQ7R1b2uCQS+IFHj8v+sC2IuxAuaIvjam7+iKc89DkNPrZxC4Greu3SESMuBl2j2aJO5IEBDzhsXAZF4UY2Dw0AYHiPnB140FGASOeDGDBlu6u0pCEnZ0M7crMJk3RbwPesXcImxBzvgtDgwFhm+OYgbZp/ILz4djBRbuwQgZfpT46590GQQfzrABtf0DUaQ+3Ig7wOP9HqFBMjCey9lQSRMYQqwFAo+q9+jzRCcEYkmQwGtcL9YR35Kt3YezJzCZF0UdVXMVuOugGzkHxwMMxDzpjhUm17s3cCTRFh9O037eZUNgMm+KKTB0BmNTYLojuTDCip52nXhJfumEy8IqMiFDIvG3v+syqHww0wbpwR25ZhvY9uQF07gDnt3rmeOrF28EBo0HXZCe5OkCQ4g46POB/lPTztfe9otb/DYFJvOiqKNOTzn5oXNufrlC+S8+GjQvyNVCB/M6ZE0I+wNjvymmwKDxNRvuwVBgWM12BiMVO6X2/Rx8f7uF52D++o8fpV+0LmxAtIbBnWrJh9j7BbFw5z93ZE8HRiz1aPOzWQND3P30TYFhNakfbvFOQSCq4o1C5al9Yrh7HbczMDaLoo6SDpY3/esH2YEAQ86OOzE3tMBdnxdYcbIvK6pcNwqyURtx9VVbzmAyb4opMLSKzJbA5Ee6YcS5uR0lcQDxEjue5LcTIlom3bhEJqg8W4BUTG5ZCpWO+gG49uYC+iqy7TXs1gWGRLkNqI0t1S+RVfbmQODq9d+4ROaLtAg1UtyDcW9pB8Cn0otCpiy6wBRNcRhp/B6HOIPZPGLDZ5HZCiH1TOQz/ui5Sqjw/LevDRn2+VezIeAPrRD/eLFttQP8SN+9EgZ2c6hoz8FU9+bg1gWGRLkN4A2RAlkueLWYqX3JR5LKbfd44DqzVVJH9OQz8RlDswaGHS3LVUY+k14UMmWxBaYl4oMRp3cpoN+DoU9Tvm0/7BKh1ron3NC5v80PQUfkh1BhFcqHXZaP3ePUH7UVT/I3N2TDlsCQKLfBh13qn1B4wW38sEuxaqTpteWYPTBQnl9URq42ikKfpkyBie50woxYRbZIvg+GELf4/93e3eS0DYRxHHbz5bSBaFC+piwRK47BAbgQF2DdI7BiAwEb6uY4vUnFbhbEtrC6YZ7nCNFf+UkjS697MLgHwxAuWuKiJS5a4iY/bvIjMJYiMImmqo+pmoDAGIqhWMonCUw41MccAgJjKIZiKZ8mMOFQ1R+pjEFgDMVQLGUQgQnNn48eS5uAwBiKoVhKfwLT88OP3wGBMRRDsZTBBCa87t+SKbztXwMCYyiGYikDCEziaf/8UtXVy/P+KSAwQ4aCwFiKwNBCYDAUS0FgEBgEBoFBYBAYBOarQWAQGAQGgUFgEBgEBoFBYEBgEBgEBoFBYBAYBAaBQWDImcAgMAgMAoPAIDAIDAKDwIDAIDAIDAKDwCAwCAwCg8CQM4FBYBAYBAaBQWAQGAQGgQGBQWAQGAQGgUFgEBgEBoEhZwKDwCAwCAwCg8AgMAgMAgMCg8AgMAgMAoPAIDAIDAJDtgQGgUFgEBgEBoFBYBAYBCaGALEzMIbSzlAshUQUGAQGgfl/BGa+CwF2847AGEonQ7EU0qUUi9Nye+Gn4GJbnrYGxlC6GYqlkC6lGJ3MNuVjIHOP5WZ2MmoJjKH0YCiWQrqUYjmeruPt3f3lw18y9XB5f3cb19PxsiUwhtKDoVgK6VKK5WKyOo9XN9e/yNb1zVU8X00Wy+JoYAylD0OxFNKlFN9G47PVerPdxfiTLMW4227Wq7Nxy8PHD0PpxVAshWQpxfscJtNZOf9OtublbDp5/9toCYyh9GEolkKylH8vU6QQ8oi1OwAAAABJRU5ErkJggg=="},431:function(t,a,s){"use strict";s.r(a);var n=s(14),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integrate-openhab2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrate-openhab2"}},[t._v("#")]),t._v(" Integrate OPENHAB2")]),t._v(" "),a("h2",{attrs:{id:"auto-discovery-through-home-assistant-convention"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#auto-discovery-through-home-assistant-convention"}},[t._v("#")]),t._v(" Auto discovery through home assistant convention")]),t._v(" "),a("p",[t._v("OpenMQTTGateway support autodiscovery of things for OpenHAB 2.4, so as to do that it rely on home assistant auto discovery convention.\nSo as to use the autodiscovery function you need to have:")]),t._v(" "),a("ul",[a("li",[t._v("The Jinga transformation addon installed")]),t._v(" "),a("li",[t._v("The Json transformation addon installed")])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("If you are connecting to BLE devices it is highly recommended to set "),a("code",[t._v("filterConnectable")]),t._v(" to "),a("code",[t._v("true")]),t._v(" in "),a("RouterLink",{attrs:{to:"/use/ble.html#advanced-filter-out-connectable-devices"}},[t._v("BT configuration")]),t._v(". Otherwise you may encounter incomplete data.")],1)]),t._v(" "),a("p",[t._v("The things will appear in the inbox of the paperUI, add them and links the channels. You should see them into the control panel for further usage.\n"),a("img",{attrs:{src:s(358),alt:"OpenHAB integration"}})]),t._v(" "),a("h2",{attrs:{id:"mqtt-2-manual-setup-openhab2-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-2-manual-setup-openhab2-4"}},[t._v("#")]),t._v(" MQTT 2 manual setup >=Openhab2.4")]),t._v(" "),a("p",[t._v("You should have an MQTT broker installed (either mosquitto or the OpenHAB2 embedded one)")]),t._v(" "),a("p",[t._v("In paper UI")]),t._v(" "),a("ul",[a("li",[t._v("In bindings add the MQTT Things binding")]),t._v(" "),a("li",[t._v("Inbox > MQTT Things binding > Add manually >MQTT Broker : configure your broker")]),t._v(" "),a("li",[t._v("Inbox > MQTT Things binding > Add manually >Generic MQTT Thing : select your previously configured broker as a bridge and enter your thing definition (example RF plug, weather station, PIR sensor)")]),t._v(" "),a("li",[t._v('Configuration > Things > "Your thing" : click on + and add one channel for each thing parameter (example for a weather station, you will have one channel for the temperature, one channel for the humidity etc..)')]),t._v(" "),a("li",[t._v("For a state channel define the MQTT topic like this:")])]),t._v(" "),a("h2",{attrs:{id:"for-a-mi-flora-or-mi-jia-temperature"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#for-a-mi-flora-or-mi-jia-temperature"}},[t._v("#")]),t._v(" For a mi flora or mi jia temperature :")]),t._v(" "),a("p",[a("code",[t._v("home/+/BTtoMQTT/C47C9999D1B8")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on show more")])]),t._v(" "),a("li",[a("p",[t._v('And add in "Incoming values transformation"')])])]),t._v(" "),a("p",[a("code",[t._v("JSONPATH:$.tem")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on Save")])]),t._v(" "),a("li",[a("p",[t._v("Repeat for each channels and each things")])]),t._v(" "),a("li",[a("p",[t._v('Configuration > Things > "Your thing" : click on a channel and add 1 or several items per channel defining what you want to display in the sitemap\nor')])]),t._v(" "),a("li",[a("p",[t._v("Define your items in an item file like this by referring to your MQTT things channels:\nFor a mi flora and mi jia")])])]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MI JIA")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" humidity\t\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Humidité air[%.1f %%]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("water"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:humidite-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" temperature \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Température[%.1f °C]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("temperature"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:temperature-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" battery \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Batterie capteur[%.1f %]"')]),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("volt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:batterie-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MI FLORA")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" humidity_P\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Hygrométrie plante[%.1f %%]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("water"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:humidite-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" temperature_P \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Température plante[%.1f °C]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("temperature"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:temperature-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" fertility_P\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Fertilité plante[%.1f uS/cm]"')]),t._v(" \t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:fertilite-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" lux_P\t\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Luminiosité plante[%.1f lux]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:lux-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br")])]),a("h2",{attrs:{id:"for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}},[t._v("#")]),t._v(' For a switch channel, add a channel by choosing the type "On/Off switch"')]),t._v(" "),a("p",[t._v("define the MQTT state topic like this:\n"),a("code",[t._v("home/+/433toMQTT")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on show more")])]),t._v(" "),a("li",[a("p",[t._v('add in "Incoming values transformation"\n'),a("code",[t._v("JSONPATH:$.value")])])]),t._v(" "),a("li",[a("p",[t._v("define the command topic like this:\n"),a("code",[t._v("home/+/commands/MQTTto433")])])]),t._v(" "),a("li",[a("p",[t._v("add the value corresponding to ON state and to OFF state\n1312081\n1312084")])]),t._v(" "),a("li",[a("p",[t._v("Click on Save")])]),t._v(" "),a("li",[a("p",[t._v("Repeat for each channels and each things")])]),t._v(" "),a("li",[a("p",[t._v('Configuration > Things > "Your thing" : click on a channel and add 1 or several switch per channel\nor')])]),t._v(" "),a("li",[a("p",[t._v("Define your items in an item file like this by referring to your MQTT thing channel:")])])]),t._v(" "),a("p",[a("code",[t._v('Switch OMGSwitch "Prise 1" {channel="mqtt:topic:08998877:Power1"}')])]),t._v(" "),a("h1",{attrs:{id:"presence-detection-from-rickitaly"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#presence-detection-from-rickitaly"}},[t._v("#")]),t._v(" Presence detection (from @rickitaly)")]),t._v(" "),a("p",[t._v("in thing file:")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Thing")]),t._v(" mqtt"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("topic"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("omgentrance "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mqtt"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("broker"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("localBroker"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Channels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Type")]),t._v(" string "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" blepresence "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"People Presence"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" stateTopic"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/home_presence/OpenMQTTGatewayEntrance"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[t._v("in item file")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BLE Entrance Detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:omgentrance:blepresence"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Switch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Presence_Keys_Rick")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Rick\'s Keys"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("People")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" gKeys"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("expire"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"240s,OFF"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br")])]),a("p",[t._v("In rule file:")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[t._v("rule "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BLE Presence Detector"')]),t._v("\nwhen\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Item")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),t._v(" received update\nthen\nval "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" msg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("state as "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("StringType")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("toString\nval "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transform")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"JSONPATH"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$.id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" msg"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("toString\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("==")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"xx:xx:xx:xx:xx:xx"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Presence_Keys_Rick")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("postUpdate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nend\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br")])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{372:function(t,a){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABmAAAACSCAMAAABlqfVbAAACplBMVEX4+Pj39/f19fXy8vLv7+/t7e3r6+vp6eno6Ojn5+f5+fn09PTx8fHw8PD29vb+/v7////u7u79/f3q6urm5ubj4+Ph4eHg4ODf39/e3t7k5OSgoKD6+vqdnZ3AwMDBwcHa2tqpqan8/PyxsbHMzMx7e3t5eXkxMTFNTU13d3fb29vGxsYtLS0AAACCgoLExMTIyMiDg4Ovr6+ysrK3t7fd3d1KSkqcnJzQ0NA3NzewsLDl5eVgYGDV1dUhISF1dXWXl5fCwsLW1tY8PDxDQ0ONjY2VlZW/v7+fn58iIiLs7Ox8fHwsLCxbW1vX19fz8/Nubm6+vr5RUVFeXl6Ojo5qamp+fn7JyclUVFTi4uJHR0dLS0sdHR0SEhKnp6d9fX2JiYltbW2FhYVxcXG4uLhoaGhzc3O7u7tiYmKPj4/FxcU7OzuBgYGTk5ORkZFnZ2eSkpLNzc3Ozs5YWFiQkJDT09NWVla8vLykpKTDw8NGRkbY2Ni0tLSenp6Li4tra2ulpaVISEjR0dF4eHiGhoZjY2N/f3+qqqrS0tKWlpazs7OamppZWVlmZmZsbGx2dnarq6umpqbU1NStra26urpFRUVycnJfX1+AgIDHx8eYmJiKiorc3NxPT0+EhITZ2dlMTEyhoaHPz890dHS1tbVwcHB6eno1NTXLy8tlZWU/Pz+ZmZk6Ojr7+/vN6c6f1KF7xH5huGVRsVVMr1Dr9utctl+k1qbc791xv3TI5smHh4e2trZcXFyMjIyDyIbr9uz2+/aNzJCPzZL0+vWbm5ujo6OIiIisrKyl16fm9OeV0Jd/xoLl8+b9/v35/PmioqL0+vTK58yCx4Xh8uFhYWE0NDRSUlLP6dD5/Prt9+1Vs1m03bau26/A48Hw+PGoqKiUlJTKyspf5M7bAAAV6ElEQVR4AezaCWprIQCGUa+a0cTaudn/Rh+FB8iQKEMo4DlLCD9+QW8IW0x5tz8cTyzreNjvcopbCOd7DGWKoVhKz1J+51DS5ZoXxvWSyuNj49wNBUOZWwqWEsJWayxLI9Y6ODZmhoKhWErHUsL/ObC48bFhKGOGYik9SxEYBAaBeQpLcUWGKzJckT2FpXjkxyM/Hvmfw1LCFlN8aSzuJQ4/UzaUMUPpl4KlbDG9vvkxeHv9ncP5npmhYCj9UrCUUEt+b9Dec6l3/5mGmaFgKP1SsJRQ0+6jQfvYpbrdDcw2MRQMpV8KlhLiZf/ZoH3uL/FBYCaGgqH0S8FSQrkevhq0r8O1PAjMxFAwlH4pWEoo+fjdoH0f88PA9EPBUMZLwVJCyaefBu3nNAhMPxQMxVIYLUVgnkdgEBgE5tYa3AaB6YeCoVgKAzeBQWAQGAQGgfljCAwCg8AgMAgMAoPAIDAIDAgMAoPAIDAIDAKDwCAwCMzKEBgEBoFBYBAYBAaBQWAQGBAYBAaBQWAQGAQGgUFgEJiVITAIDAKDwCAwCAwCg8AgMCAwCAwCg8AgMAgMAoPAIDBLQ2AQGAQGgUFg/rF33m9tXPkejobQ5Kucj8aNh0i54tDW6N4YUGSwggUYUi6myLhg9t5rjFcCGxcENrFZrw2OsRfc0uOe3nus7b333vvun7IzZ4Rn8CBBGI+ex+H7bolEDswP8z7nnXJGKrzbAwvkeCUQiyIw7J7/hBV8RRyLCAqMmFxuG2MoMFJxNoyUlDowH5aVlX9iZcpArKqAFZjfy5Eewv9f/61w72rx/xYCY6sojtISpKWySoIV5OoAA2GzKNZNsQa/b4XlycW6MWTK3IEJrqlhSFK7NgTcX7cOKAknCc3XBqne6+A8lQ4NjQDY+lVN4eYHlmMB8AcbkR7i3rWBhx56aH3OQw//j6XAWBDFemBaNuQDcN5X1xpuK5KwAKSqdtgMiWLdFGt0RDZan1zIGOumzB2Yzk250OCbwyHzMcY8bVi5JQ8pad8qAay4rsuBrOptXVgA3WUuEOlt+GSLtiv+9//+30JgLIhiPTBsexEAqadqBZeX7ejNwQKo3emEjZAo9ptixsbJxboxZEqawPR+KgoNX6xv4TYEI26kgm/uV0fs6oaKv3chqeC7BzAnZIOQYc/qT1oIjAVRrAcm91OFAEJ7nVDg+2oYPjrSVh9shESx3xQzNk4u1o0hU9IEJrKxTIIKq6nZHwLckeAsNiwvK28drGQA4tVDba3DyG5oDh8I8BvThnbyC2egM9y2Wlb/7vKDTT13QCW3Ps+glSs2MmNcTvSR8COHZAB3Kn+z87CE2baH0SoP5oZs8H16z5GOhs9YCIydomiBCcWhEg8hf5faG3b0GIdgQLyIhyAYHssCpKPNrWMjTP2tOx9sau0rgMKRemUzfhkAGxlrLa8/AsAdOTLevMsFjHtB2CtKBkxxRyoOtYU7A1w6fDzc5mfGfa1pdKsmF4vGkCnpA1NYVguV3JgvnsqGym2NnD9aV8yAeM+JoNuT01vtYCsiR9nMMxjp3olcVnBSGRccLKvOzmJQGT6lhia4qQJJjONiE5+V5OEDXYCrd7uE3IlTs20PKIzkgZjDBlWGT/usryKzSxRTYNDY6wImNy2HxtRpKITKJEyT03umQx4+WwmETmwY5o7t51qAybNDXJ6sC4hrI5Oy555tlYD7/IYzOS4ZGHlsCQhbRcmAKe7zOx6X5ODJJyYOefjQ2UnjvtY0ulWTi0VjyJT0gXFHN3MoRI/xVDa0bPFDoWJXEIjvWgrAKy5ePLnFPTMwUTEzVJzPRXBNNUOSp7xQ4DWdoxwaxnHb1XHjBxmG+9S97N7SbtqeypLHRkDMZYMmQ4v1S2Q2iWIKDD92lHXUPw2NuzaInZzd27eCQcBq9nEAfkWY0DPtqgfPdgFT42KLijDJmaVyrAXuC2IokBcpBGGrKBkwxX1BtGa0tREK41Mw7Gs9MNYnF+vGkCnpA5Mb6QYgldVCtyGsEdJsGNXkYPvGgfg4AL6+ENDGGgMj1Y9CwVM1imAsDwL9iofsP9l08ZIE8zhtKyMxdW+zLI95e8nBxBw2HNmjymBXYKyLYg4M8gfXVYt7rMZxylWRzss+DiB3sB0KWX3tCF3h07/lFSnhWTLG9zHtz47CHRNDtcGEraJkwBT3+atQuDqWnZwgjPtaD4z1ycW6MWRK2sCwmiIAtWUSUh1ueL0Q9F/hYkwSMTauSHPBrQWm8NzK5E4X75Pc0dMFDba0P7LWK5nHia3whgvFSxkA8/aSg4k5bMi6shLWA2OnKKbAoPHAruVIsjKSDQ0ePPzItdUyRmKuZJeMv5UT23BJ0qaRfgi842IjesQIO0XJgCnJ3alPEIZ9re9i65OLdWPIlPSBgS/SAr45ipQ2xEM3v2YVzzUrGqyZeQYTXBPW0ANj2nu5Pacc5nFig/LzD7xw/LAE8/bmHRi6I2c9MLaKYg7Mf/S+yGZdiyi/9EhAf3xiRmDgaHy56aRf1t0Kxe0PDImSSVNMgTHu6+Rr65PL3MaQKZYD49wbRXckF3MfblR5kvvklW0bs8yXyAr73NAwncHotGwZMY+b3iDLn3jVZd4eBWa+T0UJAmvtCYx1UcyBYdVbzrWbz2AEXZGskVMOCIy/JVDu077I9KNar/2BIVEyaUqaMxivvoutTy7WjSFT0gdGnMsW1bDUNozudeqXLUMAsiK1gDkwS15rn/HemAZP1ekbO1OMMzkgiW1mPTts2t7878HQ5zoIXn/DlsBYF8UcmIpzyxvrOwyTin6lVd1m3rN55sDIWRwKT553YbxGvwcTCdIVdftFsdeUNIEx7mu9CBYnF+vGkClzB0Yqe6jPh9Q2tIxV6gsvQgBc58UOqdw2MzAIac8ztPDke+NCj6dLJajkD/rM48RBjfBnSd+weXvWV5ER1gNjXRQtMGL5F9DyZgiQSgNw7tzODKvIlPfV2vvGxyQ+Jf4dW8oMgUlORu1KYIK79FVkkSBoTZD9omTIFHNg9H2tB8bq5GLdGGLuwCD61oQTQNpF6/KktnQ8BIC/XZbPsqrP3hwYqWcinzmir+bMCEyJWKouHRub9MDT9ebb3DRObKXgbLWEjjO9LvP2QM/BZD4wNogiAiMeSnDIBc++EwKrPuUAlu9qh4DtOw2Fgrr9y2S4Ht/WBeTEzrjQcfiiZAgMAnWPcvHMhPZsBG/cVgk9MPRUg+2i2G+KOTDGfa0HxvrkQsbYH5jcXbVIZ4N4cnpsiCXHAA7l6drOw3ljJTP/DpyBA+HmhmzMCEzyMoc8tKop3LRqSDaP07aSd6xZ+eGdMG1PjNjpAWF/YGwWRZsZlolnqfeHUKEdlAamL5KNakuRpeK61vAL++4Xr4++IB7BNgaGDUXKw21RdSyrHGwtLwvCEJiQF4S9othvijkw+r7WA2N9crn9jaHvg+GbR2/RRw4RH/PvgxEf/GERqWwEROYDc/tOLmTM7R0YTJZKmBv6NGUKDDtaBCP02bgUGAuTy+IwhgJj/dtc+INP4+MPBQZLS/NhDenUJBYLFBgxuSxmYygw9I2W6aHA0DdaUmAsQN9oSYFB4Yvv0nfyzwv6Tv4B+k5+CoyFyWXxGUOBISgwBAWGoMAQFBiCoMAQFBiCAkNQYAgKDEGBISgwBAWGoMAsZggKDEGBISgwBAWGoMAQFBiCAkNQYAgKDEFQYAgKDEGBISgwBAWGoMAQFBiCAkNQYBYnBAWGoMAQFBiCAkNQYAgKDEGBISgw773/wYfXE9c//OD99yAgKDAkColCphCWA/O59z+f0Pn8+58DQYEhUUgUMoWwHpgvJG7mCyAoMCQKiUKmEBYD88UvJcx86YsgKDAkColCphBWAvPl64nZuP5lEBQYEoVEIVOIhQfmy4lUkA4UGBKFRCFTiIUH5ovXE6m4/kUQFBgShUQhU4gFBuZLidR8CQQFhkQhUcgUYmGB+UIiHV8AQYEhUUgUMoVYSGA+l0jP50BQYEgUEoVMIRYQmPcT6XkfBAXm4yYKEYrbFhgyhQKj8/lEej4/H1lLkAr2maYppINw3tcWLq9fzwCwysHWpqplmOZIfXl5mfp2WVVT69g6KCx/rjncdFEdrcJqonYEJvOiOOJufEQI2T/Y2jrol6EZEj4QcApFlJedhyUodIUFpQ4otLw44bAlMPabYj8EL+kbAuAoDSfxQmOkrrUse6GBeS8xF+9BJ14EQbTU4XpsBUqS9qaxofsrS5AOgje8tpzxS2dLAFZcNyk7vnq2AhrtX7vHI22P5SDvXLXk6Vd/XrntUBYcjdsCDCq5q3JtDIz9olBgLMCKY+2y3H4yAKDia4c8bEWkgasvow60fP2UA0BoCknk50+9taXUrsDYb0p6Lt8HwhIdxdc2XSuBjrTVB0Fu5Hm5f4cTuBRdQGBMp7NpT2jPbHCJbfcIe1ESmuNwQwxJCzHS64JCtMqD+2MiLaGdTqjwzUUAnHv7UbSZA6zGC/e5WqhU7OqGSn8NszEw9otCgbFAYUxIUBvJUiSJQqH7gg+eKvHS1TsCwBtCkqG+El5iR2DsN8V+CMfEiy2O0hLoDEw4IRj1Aksm8uC6N38BgfkgYeYb3wS+9e1Ekg+gs318QCh9OU6BuVU8fTdUfGNujCqRUciLFELFEyiAQjyEjcPJOSEYcUPljp5+KDiv+ADIq9vCTV/PBtyRikNt4c4Alw4fD7f5mdXA2C8KBcYCIw/cAYWcsSAKI3lQUKcIV9UKKMgPhFR3RmHg5sAIm8SPLQbGflPsh5gRGOfOWmiEQoDjK0FWFMACAvNhYha+812DDR8abXh+ygnw7z0ad6gzgsEGHjje2lcA99e/3xRyPNzcWr8MKqFweE2Q+R9RL+IF41PlpE0qoj/wTB9V3rVhBDr8Sj80xtUzGD8M+LZKACt+dQVzfDaWA/f5HY9LcvDkExOHPHzo7KSFwGRaFHWUNyj+WflDhoJjEoj5UftsB3iWDIUlj90wxxVZJ6YMmwOTeVPc+0OdrRfzjzY1jXMoU0v45DC75T2iwNSWSdDoGhdnMMGd0kICcz0xgx/9+CeJxE9/9vNf6DZch854y/d9QPf3WpI2hBUuuNXdGzrYIU+uynefrOZ4/IceefUOz40zmJLdLnk47gyeHZAxK4QUjRUA/Ve4CMyJEuhURrIhqDhXALxyvNoBwHiL3zeYj+QFtAtHGYDR1kaxs6YsBCbDohgDw70l0u7lIOaFx//mkHlWkFdseJEDSzb8UqwasS8wmTfFfbLI4XziE4f4kr0j6OrJZStOtN/qwFBg+NcHAOM9mI5jk1hIYG6S4Vv41U8UGX79m98KGwTQ8QZ932f4Ya375sONrGMuAA+ddl9ZAoEyIh4Ox9Uhnni3Ov+tDD7IMRtEPBzuVSPRPdgtktJUghsM/a4CgoJzlQDY+r61z250wXCLf3wfS14wcZ+/CoWrY9nmecNSYOwXxRAYdBz0VoKYD6Fw+MDzmMb1rCZOcE349wEuTmO82dx95g8VtgUm86aI98EzDBg9LaYWPOm91YGhwPj6XJhmXUy5AOU/w2HtDEbI8K0//ulbf/75r/+S0Lk+wwbn27mufZLJBuUHAHxR8c87G5qnV0aqQ7R1b2uCQS+IFHj8v+sC2IuxAuaIvjam7+iKc89DkNPrZxC4Greu3SESMuBl2j2aJO5IEBDzhsXAZF4UY2Dw0AYHiPnB140FGASOeDGDBlu6u0pCEnZ0M7crMJk3RbwPesXcImxBzvgtDgwFhm+OYgbZp/ILz4djBRbuwQgZfpT46590GQQfzrABtf0DUaQ+3Ig7wOP9HqFBMjCey9lQSRMYQqwFAo+q9+jzRCcEYkmQwGtcL9YR35Kt3YezJzCZF0UdVXMVuOugGzkHxwMMxDzpjhUm17s3cCTRFh9O037eZUNgMm+KKTB0BmNTYLojuTDCip52nXhJfumEy8IqMiFDIvG3v+syqHww0wbpwR25ZhvY9uQF07gDnt3rmeOrF28EBo0HXZCe5OkCQ4g46POB/lPTztfe9otb/DYFJvOiqKNOTzn5oXNufrlC+S8+GjQvyNVCB/M6ZE0I+wNjvymmwKDxNRvuwVBgWM12BiMVO6X2/Rx8f7uF52D++o8fpV+0LmxAtIbBnWrJh9j7BbFw5z93ZE8HRiz1aPOzWQND3P30TYFhNakfbvFOQSCq4o1C5al9Yrh7HbczMDaLoo6SDpY3/esH2YEAQ86OOzE3tMBdnxdYcbIvK6pcNwqyURtx9VVbzmAyb4opMLSKzJbA5Ee6YcS5uR0lcQDxEjue5LcTIlom3bhEJqg8W4BUTG5ZCpWO+gG49uYC+iqy7TXs1gWGRLkNqI0t1S+RVfbmQODq9d+4ROaLtAg1UtyDcW9pB8Cn0otCpiy6wBRNcRhp/B6HOIPZPGLDZ5HZCiH1TOQz/ui5Sqjw/LevDRn2+VezIeAPrRD/eLFttQP8SN+9EgZ2c6hoz8FU9+bg1gWGRLkN4A2RAlkueLWYqX3JR5LKbfd44DqzVVJH9OQz8RlDswaGHS3LVUY+k14UMmWxBaYl4oMRp3cpoN+DoU9Tvm0/7BKh1ron3NC5v80PQUfkh1BhFcqHXZaP3ePUH7UVT/I3N2TDlsCQKLfBh13qn1B4wW38sEuxaqTpteWYPTBQnl9URq42ikKfpkyBie50woxYRbZIvg+GELf4/93e3eS0DYRxHHbz5bSBaFC+piwRK47BAbgQF2DdI7BiAwEb6uY4vUnFbhbEtrC6YZ7nCNFf+UkjS697MLgHwxAuWuKiJS5a4iY/bvIjMJYiMImmqo+pmoDAGIqhWMonCUw41MccAgJjKIZiKZ8mMOFQ1R+pjEFgDMVQLGUQgQnNn48eS5uAwBiKoVhKfwLT88OP3wGBMRRDsZTBBCa87t+SKbztXwMCYyiGYikDCEziaf/8UtXVy/P+KSAwQ4aCwFiKwNBCYDAUS0FgEBgEBoFBYBAYBOarQWAQGAQGgUFgEBgEBoFBYEBgEBgEBoFBYBAYBAaBQWDImcAgMAgMAoPAIDAIDAKDwIDAIDAIDAKDwCAwCAwCg8CQM4FBYBAYBAaBQWAQGAQGgQGBQWAQGAQGgUFgEBgEBoEhZwKDwCAwCAwCg8AgMAgMAgMCg8AgMAgMAoPAIDAIDAJDtgQGgUFgEBgEBoFBYBAYBCaGALEzMIbSzlAshUQUGAQGgfl/BGa+CwF2847AGEonQ7EU0qUUi9Nye+Gn4GJbnrYGxlC6GYqlkC6lGJ3MNuVjIHOP5WZ2MmoJjKH0YCiWQrqUYjmeruPt3f3lw18y9XB5f3cb19PxsiUwhtKDoVgK6VKK5WKyOo9XN9e/yNb1zVU8X00Wy+JoYAylD0OxFNKlFN9G47PVerPdxfiTLMW4227Wq7Nxy8PHD0PpxVAshWQpxfscJtNZOf9OtublbDp5/9toCYyh9GEolkKylH8vU6QQ8oi1OwAAAABJRU5ErkJggg=="},431:function(t,a,s){"use strict";s.r(a);var n=s(14),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integrate-openhab2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrate-openhab2"}},[t._v("#")]),t._v(" Integrate OPENHAB2")]),t._v(" "),a("h2",{attrs:{id:"auto-discovery-through-home-assistant-convention"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#auto-discovery-through-home-assistant-convention"}},[t._v("#")]),t._v(" Auto discovery through home assistant convention")]),t._v(" "),a("p",[t._v("OpenMQTTGateway support autodiscovery of things for OpenHAB 2.4, so as to do that it rely on home assistant auto discovery convention.\nSo as to use the autodiscovery function you need to have:")]),t._v(" "),a("ul",[a("li",[t._v("The Jinga transformation addon installed")]),t._v(" "),a("li",[t._v("The Json transformation addon installed")])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("If you are connecting to BLE devices it is highly recommended to set "),a("code",[t._v("filterConnectable")]),t._v(" to "),a("code",[t._v("true")]),t._v(" in "),a("RouterLink",{attrs:{to:"/use/ble.html#advanced-filter-out-connectable-devices"}},[t._v("BT configuration")]),t._v(". Otherwise you may encounter incomplete data.")],1)]),t._v(" "),a("p",[t._v("The things will appear in the inbox of the paperUI, add them and links the channels. You should see them into the control panel for further usage.\n"),a("img",{attrs:{src:s(372),alt:"OpenHAB integration"}})]),t._v(" "),a("h2",{attrs:{id:"mqtt-2-manual-setup-openhab2-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-2-manual-setup-openhab2-4"}},[t._v("#")]),t._v(" MQTT 2 manual setup >=Openhab2.4")]),t._v(" "),a("p",[t._v("You should have an MQTT broker installed (either mosquitto or the OpenHAB2 embedded one)")]),t._v(" "),a("p",[t._v("In paper UI")]),t._v(" "),a("ul",[a("li",[t._v("In bindings add the MQTT Things binding")]),t._v(" "),a("li",[t._v("Inbox > MQTT Things binding > Add manually >MQTT Broker : configure your broker")]),t._v(" "),a("li",[t._v("Inbox > MQTT Things binding > Add manually >Generic MQTT Thing : select your previously configured broker as a bridge and enter your thing definition (example RF plug, weather station, PIR sensor)")]),t._v(" "),a("li",[t._v('Configuration > Things > "Your thing" : click on + and add one channel for each thing parameter (example for a weather station, you will have one channel for the temperature, one channel for the humidity etc..)')]),t._v(" "),a("li",[t._v("For a state channel define the MQTT topic like this:")])]),t._v(" "),a("h2",{attrs:{id:"for-a-mi-flora-or-mi-jia-temperature"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#for-a-mi-flora-or-mi-jia-temperature"}},[t._v("#")]),t._v(" For a mi flora or mi jia temperature :")]),t._v(" "),a("p",[a("code",[t._v("home/+/BTtoMQTT/C47C9999D1B8")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on show more")])]),t._v(" "),a("li",[a("p",[t._v('And add in "Incoming values transformation"')])])]),t._v(" "),a("p",[a("code",[t._v("JSONPATH:$.tem")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on Save")])]),t._v(" "),a("li",[a("p",[t._v("Repeat for each channels and each things")])]),t._v(" "),a("li",[a("p",[t._v('Configuration > Things > "Your thing" : click on a channel and add 1 or several items per channel defining what you want to display in the sitemap\nor')])]),t._v(" "),a("li",[a("p",[t._v("Define your items in an item file like this by referring to your MQTT things channels:\nFor a mi flora and mi jia")])])]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MI JIA")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" humidity\t\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Humidité air[%.1f %%]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("water"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:humidite-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" temperature \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Température[%.1f °C]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("temperature"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:temperature-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" battery \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Batterie capteur[%.1f %]"')]),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("volt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:dc2222e6:batterie-mijia"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MI FLORA")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" humidity_P\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Hygrométrie plante[%.1f %%]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("water"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:humidite-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" temperature_P \t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Température plante[%.1f °C]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("temperature"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:temperature-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" fertility_P\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Fertilité plante[%.1f uS/cm]"')]),t._v(" \t "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:fertilite-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Number")]),t._v(" lux_P\t\t"),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Luminiosité plante[%.1f lux]"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:1fb33334:lux-miflora"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br")])]),a("h2",{attrs:{id:"for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}},[t._v("#")]),t._v(' For a switch channel, add a channel by choosing the type "On/Off switch"')]),t._v(" "),a("p",[t._v("define the MQTT state topic like this:\n"),a("code",[t._v("home/+/433toMQTT")])]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Click on show more")])]),t._v(" "),a("li",[a("p",[t._v('add in "Incoming values transformation"\n'),a("code",[t._v("JSONPATH:$.value")])])]),t._v(" "),a("li",[a("p",[t._v("define the command topic like this:\n"),a("code",[t._v("home/+/commands/MQTTto433")])])]),t._v(" "),a("li",[a("p",[t._v("add the value corresponding to ON state and to OFF state\n1312081\n1312084")])]),t._v(" "),a("li",[a("p",[t._v("Click on Save")])]),t._v(" "),a("li",[a("p",[t._v("Repeat for each channels and each things")])]),t._v(" "),a("li",[a("p",[t._v('Configuration > Things > "Your thing" : click on a channel and add 1 or several switch per channel\nor')])]),t._v(" "),a("li",[a("p",[t._v("Define your items in an item file like this by referring to your MQTT thing channel:")])])]),t._v(" "),a("p",[a("code",[t._v('Switch OMGSwitch "Prise 1" {channel="mqtt:topic:08998877:Power1"}')])]),t._v(" "),a("h1",{attrs:{id:"presence-detection-from-rickitaly"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#presence-detection-from-rickitaly"}},[t._v("#")]),t._v(" Presence detection (from @rickitaly)")]),t._v(" "),a("p",[t._v("in thing file:")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Thing")]),t._v(" mqtt"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("topic"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("omgentrance "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mqtt"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("broker"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("localBroker"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Channels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Type")]),t._v(" string "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" blepresence "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"People Presence"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" stateTopic"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"home/home_presence/OpenMQTTGatewayEntrance"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[t._v("in item file")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BLE Entrance Detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" channel"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqtt:topic:omgentrance:blepresence"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Switch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Presence_Keys_Rick")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Rick\'s Keys"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token generics"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("People")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" gKeys"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("expire"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"240s,OFF"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br")])]),a("p",[t._v("In rule file:")]),t._v(" "),a("div",{staticClass:"language-java line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-java"}},[a("code",[t._v("rule "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BLE Presence Detector"')]),t._v("\nwhen\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Item")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),t._v(" received update\nthen\nval "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" msg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OMG_BLE_Entrance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("state as "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("StringType")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("toString\nval "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("String")]),t._v(" id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transform")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"JSONPATH"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$.id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" msg"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("toString\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("==")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"xx:xx:xx:xx:xx:xx"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Presence_Keys_Rick")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("postUpdate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nend\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br")])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/43.45a01259.js b/dev/assets/js/43.2b960116.js similarity index 89% rename from dev/assets/js/43.45a01259.js rename to dev/assets/js/43.2b960116.js index 65f9c264..5c1014fc 100644 --- a/dev/assets/js/43.45a01259.js +++ b/dev/assets/js/43.2b960116.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{379:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_controllers.3b7dc536.png"},440:function(e,t,r){"use strict";r.r(t);var o=r(14),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"controller"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#controller"}},[e._v("#")]),e._v(" Controller")]),e._v(" "),t("p",[e._v("MQTT enables you to connect easily a controller so as to monitor, control and automate scenarios.")]),e._v(" "),t("p",[e._v("The following controllers (and many other software) are compatible with MQTT:")]),e._v(" "),t("p",[t("img",{attrs:{src:r(379),alt:"controllers"}})]),e._v(" "),t("p",[e._v("OpenMQTTGateway is independent from these projects, you have the liberty of choice among all the compatible software.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.openhab.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenHAB"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.home-assistant.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("Home Assistant"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.domoticz.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Domoticz"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.jeedom.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Jeedom"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://nodered.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Node Red"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://fhem.de",target:"_blank",rel:"noopener noreferrer"}},[e._v("FHEM"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{373:function(e,t,r){e.exports=r.p+"assets/img/OpenMQTTGateway_controllers.3b7dc536.png"},438:function(e,t,r){"use strict";r.r(t);var o=r(14),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"controller"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#controller"}},[e._v("#")]),e._v(" Controller")]),e._v(" "),t("p",[e._v("MQTT enables you to connect easily a controller so as to monitor, control and automate scenarios.")]),e._v(" "),t("p",[e._v("The following controllers (and many other software) are compatible with MQTT:")]),e._v(" "),t("p",[t("img",{attrs:{src:r(373),alt:"controllers"}})]),e._v(" "),t("p",[e._v("OpenMQTTGateway is independent from these projects, you have the liberty of choice among all the compatible software.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.openhab.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenHAB"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.home-assistant.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("Home Assistant"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.domoticz.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Domoticz"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.jeedom.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Jeedom"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://nodered.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Node Red"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://fhem.de",target:"_blank",rel:"noopener noreferrer"}},[e._v("FHEM"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/44.790d8d70.js b/dev/assets/js/44.d74b2006.js similarity index 93% rename from dev/assets/js/44.790d8d70.js rename to dev/assets/js/44.d74b2006.js index d68c37cf..4cf00b24 100644 --- a/dev/assets/js/44.790d8d70.js +++ b/dev/assets/js/44.d74b2006.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{381:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTgateway_ESP8266_Addon_2G.48dafe5f.png"},444:function(t,e,a){"use strict";a.r(e);var r=a(14),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"gsm-2g-gateway"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#gsm-2g-gateway"}},[t._v("#")]),t._v(" GSM 2G gateway")]),t._v(" "),e("h2",{attrs:{id:"compatible-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module")]),t._v(" "),e("th",[t._v("Purpose")]),t._v(" "),e("th",[t._v("Where to Buy")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("A6")]),t._v(" "),e("td",[t._v("GSM GPRS module")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("A7")]),t._v(" "),e("td",[t._v("GSM GPRS module with GPS")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])])])]),t._v(" "),e("h2",{attrs:{id:"hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hardware-setup"}},[t._v("#")]),t._v(" Hardware setup")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module Pin")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("NodeMCU / ESP8266 Pin")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("H_RXD")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D6")])]),t._v(" "),e("tr",[e("td",[t._v("H_TXD")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D7")])]),t._v(" "),e("tr",[e("td",[t._v("GND")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])]),t._v(" "),e("tr",[e("td",[t._v("VCC5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("MOSFET driven by D5")])])])]),t._v(" "),e("p",[t._v("For VCC5 you can power it directly all the time with an USB cable or use a MOSFET like "),e("a",{attrs:{href:"https://gitlab.com/stavros/A6-ESP8266-breakout/raw/master/images/schematic.png",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("Don't use the nodemcu/wemos 5V pin for the A6/7 power, use a dedicated power supply for both or dedicated to the A6/7 with at least 2 amps ability.")]),t._v(" "),e("p",[t._v("So as to start your A6/7 module press the red button for 4 seconds, or link the PWR_KEY GPIO to VCC5.0 for the same time.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(381),alt:"Addon_2G"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{378:function(t,e,a){t.exports=a.p+"assets/img/OpenMQTTgateway_ESP8266_Addon_2G.48dafe5f.png"},442:function(t,e,a){"use strict";a.r(e);var r=a(14),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"gsm-2g-gateway"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#gsm-2g-gateway"}},[t._v("#")]),t._v(" GSM 2G gateway")]),t._v(" "),e("h2",{attrs:{id:"compatible-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module")]),t._v(" "),e("th",[t._v("Purpose")]),t._v(" "),e("th",[t._v("Where to Buy")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("A6")]),t._v(" "),e("td",[t._v("GSM GPRS module")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])]),t._v(" "),e("tr",[e("td",[t._v("A7")]),t._v(" "),e("td",[t._v("GSM GPRS module with GPS")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),e("OutboundLink")],1)])])])]),t._v(" "),e("h2",{attrs:{id:"hardware-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hardware-setup"}},[t._v("#")]),t._v(" Hardware setup")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Module Pin")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("NodeMCU / ESP8266 Pin")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("H_RXD")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D6")])]),t._v(" "),e("tr",[e("td",[t._v("H_TXD")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("D7")])]),t._v(" "),e("tr",[e("td",[t._v("GND")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("GND")])]),t._v(" "),e("tr",[e("td",[t._v("VCC5")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("MOSFET driven by D5")])])])]),t._v(" "),e("p",[t._v("For VCC5 you can power it directly all the time with an USB cable or use a MOSFET like "),e("a",{attrs:{href:"https://gitlab.com/stavros/A6-ESP8266-breakout/raw/master/images/schematic.png",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("Don't use the nodemcu/wemos 5V pin for the A6/7 power, use a dedicated power supply for both or dedicated to the A6/7 with at least 2 amps ability.")]),t._v(" "),e("p",[t._v("So as to start your A6/7 module press the red button for 4 seconds, or link the PWR_KEY GPIO to VCC5.0 for the same time.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(378),alt:"Addon_2G"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/45.aa140053.js b/dev/assets/js/45.d5688125.js similarity index 99% rename from dev/assets/js/45.aa140053.js rename to dev/assets/js/45.d5688125.js index 0390f350..ca8715dd 100644 --- a/dev/assets/js/45.aa140053.js +++ b/dev/assets/js/45.d5688125.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{405:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-OTA-Update-Home-Assistant.1b857c45.png"},461:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"system-commands-esp-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-commands-esp-only"}},[e._v("#")]),e._v(" System commands (ESP only)")]),e._v(" "),t("h2",{attrs:{id:"restart-the-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#restart-the-esp"}},[e._v("#")]),e._v(" Restart the ESP")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"restart"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("h2",{attrs:{id:"erase-the-esp-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#erase-the-esp-settings"}},[e._v("#")]),e._v(" Erase the ESP settings")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"erase"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("h2",{attrs:{id:"retrieve-current-status-of-the-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-current-status-of-the-esp"}},[e._v("#")]),e._v(" Retrieve current status of the ESP")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"status"}\'')])]),e._v(" "),t("h2",{attrs:{id:"auto-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-discovery"}},[e._v("#")]),e._v(" Auto discovery")]),e._v(" "),t("p",[e._v("You can deactivate the MQTT auto-discovery function, which enables you to create devices/entities with the Home Assistant convention automatically. This function is set to "),t("code",[e._v("true")]),e._v(" at startup for 30 minutes unless you deactivate it.")]),e._v(" "),t("h3",{attrs:{id:"deactivate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deactivate"}},[e._v("#")]),e._v(" Deactivate")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":false}\'')])]),e._v(" "),t("h3",{attrs:{id:"activate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#activate"}},[e._v("#")]),e._v(" Activate")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":true}\'')])]),e._v(" "),t("p",[e._v("If you want the settings to be kept upon gateway restart, you can save the state by adding "),t("code",[e._v('"save":true')]),e._v(" (ESP32 only).\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":false, "save":true}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Auto discovery is enabled by default on release binaries and platformio.")])]),e._v(" "),t("h2",{attrs:{id:"activate-offline-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#activate-offline-mode"}},[e._v("#")]),e._v(" Activate Offline mode")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"offline":true,"save":true}\'')])]),e._v(" "),t("h2",{attrs:{id:"change-the-wifi-credentials"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-wifi-credentials"}},[e._v("#")]),e._v(" Change the WiFi credentials")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"wifi_ssid":"ssid", "wifi_pass":"password"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the new connection fails the gateway will fallback to the previous connection.")])]),e._v(" "),t("h2",{attrs:{id:"change-the-gateway-password"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-gateway-password"}},[e._v("#")]),e._v(" Change the gateway password")]),e._v(" "),t("p",[e._v("The password must be 8 characters minimum.")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"gw_pass":"12345678"}\'')])]),e._v(" "),t("h2",{attrs:{id:"change-the-mqtt-broker-credentials"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-mqtt-broker-credentials"}},[e._v("#")]),e._v(" Change the MQTT broker credentials")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_user": "user_name",\n "mqtt_pass": "password",\n "mqtt_server": "host",\n "mqtt_port": "port",\n "mqtt_validate": false,\n "mqtt_secure": false\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("By default this function is not available on the pre built binary of RFBridge, in order to have less code size and enable to have OTA update working properly. So as to enable it remove from the rf bridge env:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("build_flags = '-UMQTTsetMQTT'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the new connection fails the gateway will fallback to the previous connection.")])]),e._v(" "),t("h2",{attrs:{id:"change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"}},[e._v("#")]),e._v(" Change the MQTT main topic, discovery prefix, and or gateway name")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_topic": "topic/",\n "discovery_prefix": "prefix",\n "gateway_name": "name"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("This will change the subscribed and published mqtt_topic/gateway_name that the gateway uses. No parameters are mandatory, the current topic or gateway name will be used if not supplied.")])]),e._v(" "),t("h2",{attrs:{id:"switching-brokers-and-using-signed-and-client-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switching-brokers-and-using-signed-and-client-certificates"}},[e._v("#")]),e._v(" Switching brokers and using signed and client certificates")]),e._v(" "),t("p",[e._v("In the "),t("code",[e._v("user_config.h")]),e._v(" file it is possible to specify multiple MQTT brokers and client certificates.\nAdditionally, support for multiple brokers and client certificates has been added. To use this, it is required that the server certificate, client certificate, and client key are provided as their own constant string value as demonstrated in the file."),t("br"),e._v("\nTo add more than one broker and switch between them it is necessary to provide all of the relevant certificates/keys and add their respective variable names in the "),t("code",[e._v("cnt_parameters_array")]),e._v(" structure, as shown in "),t("code",[e._v("user_config.h")]),e._v("..")]),e._v(" "),t("p",[e._v("To switch between these connections with an MQTT command message, the format is as follows:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_user": "user",\n "mqtt_pass": "password",\n "mqtt_server": "host",\n "mqtt_port": "port",\n "mqtt_secure": true,\n "mqtt_validate": true,\n "cnt_index":1,\n "save_cnt": true\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("cnt_index")]),e._v(" value corresponds to the 0 to 2 index of the "),t("code",[e._v("cnt_parameters_array")]),e._v(" in "),t("code",[e._v("user_config.h")]),e._v(".\n0 being the default index, containing the onboarding parameters.")])]),e._v(" "),t("p",[e._v("To read the connection parameters:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "cnt_index":1,\n "read_cnt": true\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("To test a connection change without saving:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "cnt_index":1,\n "test_cnt": true\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the client can't connect to the MQTT broker corresponding to the current "),t("code",[e._v("cnt_index")]),e._v(", it will increment the index to the next valid connection set and restart with it.")])]),e._v(" "),t("h2",{attrs:{id:"saving-loading-connection-parameters-certificates-at-runtime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#saving-loading-connection-parameters-certificates-at-runtime"}},[e._v("#")]),e._v(" Saving/Loading connection parameters/certificates at runtime")]),e._v(" "),t("p",[e._v("This chapter details the process for managing certificates/connections parameters used for secure MQTT communication with OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"storing-and-loading-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storing-and-loading-certificates"}},[e._v("#")]),e._v(" Storing and Loading Certificates")]),e._v(" "),t("ul",[t("li",[e._v("Flash Memory Storage:\nCertificates can be saved to the flash memory using specific indices. Valid indices for storing certificates are 1 and 2, as 0 is reserved for the default certificate.")]),e._v(" "),t("li",[e._v("RAM Memory Loading:\nCertificates can be loaded from RAM, where valid indices range from 0 to 2. The device publishes a hash of the certificate to the broker to verify its identity. If the connection using the current certificate fails, the device will revert to the previous certificate.")])]),e._v(" "),t("h3",{attrs:{id:"use-case-changing-a-group-of-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-changing-a-group-of-certificates"}},[e._v("#")]),e._v(" Use Case: Changing a Group of Certificates")]),e._v(" "),t("p",[e._v("When updating certificates, follow these steps to ensure that the new certificates are correctly loaded and used:")]),e._v(" "),t("ol",[t("li",[e._v("Push Certificates via MQTT:\nSend the new certificates one by one through MQTT, using indices 1 or 2. Replace newline characters (\\n) in the certificates with spaces.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"mqtt_server_cert"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"-----BEGIN CERTIFICATE----- MIIDQTCC----END CERTIFICATE-----"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("p",[e._v("Accepted certificates are:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("mqtt_server_cert")])]),e._v(" "),t("li",[t("code",[e._v("mqtt_client_cert")])]),e._v(" "),t("li",[t("code",[e._v("mqtt_client_key")])]),e._v(" "),t("li",[t("code",[e._v("ota_server_cert")])])]),e._v(" "),t("ol",{attrs:{start:"2"}},[t("li",[e._v("Verify Certificates in RAM:\nAfter pushing the certificates, verify that they have been correctly loaded into RAM.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"read_cnt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("Test and Save Certificates:\nOnce verification is complete, test the connection using the new certificates. If the connection is successful, send the command to save the certificates to flash.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"save_cnt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("ol",{attrs:{start:"4"}},[t("li",[t("p",[e._v("Broker Connection:\nThe broker will attempt to use the newly received certificates for the connection.")])]),e._v(" "),t("li",[t("p",[e._v("Successful Connection Handling:\nIf the connection is successful, the certificates are permanently stored in the flash memory at the specified index.")])]),e._v(" "),t("li",[t("p",[e._v("Handling Connection Failures:\nIf the connection fails, the device will revert to the previously used certificate index, and the new certificates will not be saved.")])])]),e._v(" "),t("h1",{attrs:{id:"firmware-update-from-mqtt-esp-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firmware-update-from-mqtt-esp-only"}},[e._v("#")]),e._v(" Firmware update from MQTT (ESP only)")]),e._v(" "),t("p",[e._v("When the gateway used is from a standard ESP32 environment "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/development/environments.ini",target:"_blank",rel:"noopener noreferrer"}},[e._v("listed and defined here"),t("OutboundLink")],1),e._v(", it can be updated through a simple MQTT command:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "latest"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br")])]),t("p",[e._v("This would download the latest version firmware binary from Github and install it.\nIt can be used with version 1.5.0 and above.")]),e._v(" "),t("p",[e._v("Note that this update option is also autodiscovered through Home Assistant convention, you can update directly from the device page with 2 clicks.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(405),alt:"Home Assistant OTA Update"}})]),e._v(" "),t("p",[e._v("You can also indicate the target version to update:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "v1.2.0"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br")])]),t("p",[e._v("OpenMQTTGateway checks at start and every hour if an update is available.")]),e._v(" "),t("p",[e._v("Alternatively if you want to choose the update URL you can use the command below (ESP32 and ESP8266):")]),e._v(" "),t("p",[e._v("Without certificate, in this case the gateway will use the ota_server_cert certificate defined in default_ota_cert.h")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "test",\n "password": "OTAPASSWORD",\n "url": "https://github.com/1technophile/OpenMQTTGateway/releases/download/v0.9.12/esp32dev-ble-firmware.bin"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("With certificate (replace the \\n in the certificate by spaces to publish it easily):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "test",\n "password": "OTAPASSWORD",\n "url": "https://github.com/1technophile/OpenMQTTGateway/releases/download/v0.9.12/esp32dev-ble-firmware.bin",\n "ota_server_cert": "-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4= -----END CERTIFICATE-----"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("A bash script is available "),t("a",{attrs:{href:"ota_command_cert.zip"}},[e._v("here also")]),e._v(" to simplify the use of the "),t("code",[e._v("server_cert")]),e._v(" parameter.")]),e._v(" "),t("p",[e._v("Alternatively the OTA certificate can also be saved with the cnt_index for future use:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/config" -m \'{\n "cnt_index": 1,\n "save_cnt":true,\n "ota_server_cert": "-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4= -----END CERTIFICATE-----"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("The other connection parameters corresponding to the index need to be valid for the save function to work. This command will switch to connection parameters of index 1.")]),e._v(" "),t("p",[e._v("To enable this functionality, "),t("code",[e._v("MQTT_HTTPS_FW_UPDATE")]),e._v(" will need to be defined or the line that defines in in user_config.h will need to be uncommented.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If using an unsecure MQTT broker it is "),t("strong",[e._v("highly recommended")]),e._v(" to disable the password checking by setting the macro "),t("code",[e._v("MQTT_HTTPS_FW_UPDATE_USE_PASSWORD")]),e._v(" to 0 (default is 1 (enabled)), otherwise a clear text password may be sent over the network.")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("server_cert")]),e._v(" parameter is optional. If the update server has changed or certificate updated or not set in "),t("code",[e._v("user_config.h")]),e._v(" then you can provide the certificate here.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("The pre-built binaries for "),t("strong",[e._v("rfbridge")]),e._v(" and "),t("strong",[e._v("avatto-bakeey-ir")]),e._v(" have the above WiFi and MQTT broker credentials and the Firmware update via MQTT options disabled. This is due to the restricted available flash, so as to still be able to use OTA firmware updates for these boards.")])]),e._v(" "),t("h1",{attrs:{id:"communication-layers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#communication-layers"}},[e._v("#")]),e._v(" Communication layers")]),e._v(" "),t("h2",{attrs:{id:"mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt"}},[e._v("#")]),e._v(" MQTT")]),e._v(" "),t("p",[e._v("OpenMQTTGateway uses per default MQTT on top of Ethernet or WiFi for communicating (default: true).\nThe MQTT communication can be deactivated with the following command:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"mqtt":false}\'')]),e._v("\nOnce activated the MQTT API is no longer accessible")]),e._v(" "),t("h2",{attrs:{id:"serial"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#serial"}},[e._v("#")]),e._v(" Serial")]),e._v(" "),t("p",[e._v("Added to MQTT, OpenMQTTGateway cans use Serial to transmit or receive json data (default: false):\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"serial":true}\'')])]),e._v(" "),t("p",[e._v("The build need to have the following macro:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" '-DZgatewaySERIAL=\"SERIAL\"'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("An example scenario is a slave offline ESP32 dedicated to RF decoding connected to another online ESP32 through Serial.")]),e._v(" "),t("h1",{attrs:{id:"indicators"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#indicators"}},[e._v("#")]),e._v(" Indicators")]),e._v(" "),t("h2",{attrs:{id:"change-the-led-indicator-brightness"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-led-indicator-brightness"}},[e._v("#")]),e._v(" Change the LED indicator brightness")]),e._v(" "),t("p",[e._v("Minimum: 0, Maximum: 255, Default defined by DEFAULT_ADJ_BRIGHTNESS")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"brightness":200}\'')])]),e._v(" "),t("h2",{attrs:{id:"understanding-led-indicators-in-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-led-indicators-in-openmqttgateway"}},[e._v("#")]),e._v(" Understanding LED Indicators in OpenMQTTGateway")]),e._v(" "),t("p",[e._v("With boards having one or several RGB Led, OpenMQTTGateway uses them to provide visual feedback about its current state. This guide will help you interpret these LED signals to understand what's happening with your gateway.")]),e._v(" "),t("h2",{attrs:{id:"led-color-guide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#led-color-guide"}},[e._v("#")]),e._v(" LED Color Guide")]),e._v(" "),t("p",[e._v("OpenMQTTGateway uses a variety of colors to indicate different states:")]),e._v(" "),t("p",[e._v("Green (0x00FF00): Indicates normal operation or successful connections\nBlue (0x0000FF): Shows processing or offline status\nOrange (0xFFA500): Indicates waiting states or minor issues\nYellow (0xFFFF00): Used during the onboarding process\nRed (0xFF0000): Signals an error state\nMagenta (0xFF00FF): Indicates local Over-The-Air (OTA) updates\nPurple (0x8000FF): Shows remote OTA updates are in progress")]),e._v(" "),t("h2",{attrs:{id:"understanding-gateway-states"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-gateway-states"}},[e._v("#")]),e._v(" Understanding Gateway States")]),e._v(" "),t("p",[e._v("Here's what different LED behaviors mean:")]),e._v(" "),t("h3",{attrs:{id:"power-on"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#power-on"}},[e._v("#")]),e._v(" Power On")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: The gateway is powered and operational")]),e._v(" "),t("h3",{attrs:{id:"processing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processing"}},[e._v("#")]),e._v(" Processing")]),e._v(" "),t("p",[e._v("Color: Blue\nBehavior: Blinking (3 times)\nMeaning: The gateway is processing data")]),e._v(" "),t("h3",{attrs:{id:"waiting-for-onboarding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#waiting-for-onboarding"}},[e._v("#")]),e._v(" Waiting for Onboarding")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Solid light\nMeaning: The gateway is ready to be set up")]),e._v(" "),t("h3",{attrs:{id:"onboarding-in-progress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#onboarding-in-progress"}},[e._v("#")]),e._v(" Onboarding in Progress")]),e._v(" "),t("p",[e._v("Color: Yellow\nBehavior: Solid light\nMeaning: The gateway is being configured")]),e._v(" "),t("h3",{attrs:{id:"network-connected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#network-connected"}},[e._v("#")]),e._v(" Network Connected")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: Successfully connected to the network")]),e._v(" "),t("h3",{attrs:{id:"network-disconnected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#network-disconnected"}},[e._v("#")]),e._v(" Network Disconnected")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Blinking\nMeaning: Lost connection to the network")]),e._v(" "),t("h3",{attrs:{id:"mqtt-broker-connected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-broker-connected"}},[e._v("#")]),e._v(" MQTT Broker Connected")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: Successfully connected to the MQTT broker")]),e._v(" "),t("h3",{attrs:{id:"mqtt-broker-disconnected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-broker-disconnected"}},[e._v("#")]),e._v(" MQTT Broker Disconnected")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Blinking\nMeaning: Lost connection to the MQTT broker")]),e._v(" "),t("h3",{attrs:{id:"offline"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#offline"}},[e._v("#")]),e._v(" Offline")]),e._v(" "),t("p",[e._v("Color: Blue\nBehavior: Blinking\nMeaning: The gateway is offline")]),e._v(" "),t("h3",{attrs:{id:"local-ota-update"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-ota-update"}},[e._v("#")]),e._v(" Local OTA Update")]),e._v(" "),t("p",[e._v("Color: Magenta\nBehavior: Blinking\nMeaning: A local Over-The-Air update is in progress")]),e._v(" "),t("h3",{attrs:{id:"remote-ota-update"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remote-ota-update"}},[e._v("#")]),e._v(" Remote OTA Update")]),e._v(" "),t("p",[e._v("Color: Purple\nBehavior: Blinking\nMeaning: A remote Over-The-Air update is in progress")]),e._v(" "),t("h3",{attrs:{id:"error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#error"}},[e._v("#")]),e._v(" Error")]),e._v(" "),t("p",[e._v("Color: Red\nBehavior: Blinking (3 times)\nMeaning: An error has occurred")]),e._v(" "),t("h3",{attrs:{id:"actuator-on-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#actuator-on-off"}},[e._v("#")]),e._v(" Actuator On/Off")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Depends on actuator state\nMeaning: Indicates the state of a connected actuator")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{405:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway-OTA-Update-Home-Assistant.1b857c45.png"},460:function(e,t,a){"use strict";a.r(t);var s=a(14),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"system-commands-esp-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-commands-esp-only"}},[e._v("#")]),e._v(" System commands (ESP only)")]),e._v(" "),t("h2",{attrs:{id:"restart-the-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#restart-the-esp"}},[e._v("#")]),e._v(" Restart the ESP")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"restart"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("h2",{attrs:{id:"erase-the-esp-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#erase-the-esp-settings"}},[e._v("#")]),e._v(" Erase the ESP settings")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"erase"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.")])]),e._v(" "),t("h2",{attrs:{id:"retrieve-current-status-of-the-esp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-current-status-of-the-esp"}},[e._v("#")]),e._v(" Retrieve current status of the ESP")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"cmd":"status"}\'')])]),e._v(" "),t("h2",{attrs:{id:"auto-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-discovery"}},[e._v("#")]),e._v(" Auto discovery")]),e._v(" "),t("p",[e._v("You can deactivate the MQTT auto-discovery function, which enables you to create devices/entities with the Home Assistant convention automatically. This function is set to "),t("code",[e._v("true")]),e._v(" at startup for 30 minutes unless you deactivate it.")]),e._v(" "),t("h3",{attrs:{id:"deactivate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deactivate"}},[e._v("#")]),e._v(" Deactivate")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":false}\'')])]),e._v(" "),t("h3",{attrs:{id:"activate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#activate"}},[e._v("#")]),e._v(" Activate")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":true}\'')])]),e._v(" "),t("p",[e._v("If you want the settings to be kept upon gateway restart, you can save the state by adding "),t("code",[e._v('"save":true')]),e._v(" (ESP32 only).\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"disc":false, "save":true}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Auto discovery is enabled by default on release binaries and platformio.")])]),e._v(" "),t("h2",{attrs:{id:"activate-offline-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#activate-offline-mode"}},[e._v("#")]),e._v(" Activate Offline mode")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"offline":true,"save":true}\'')])]),e._v(" "),t("h2",{attrs:{id:"change-the-wifi-credentials"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-wifi-credentials"}},[e._v("#")]),e._v(" Change the WiFi credentials")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"wifi_ssid":"ssid", "wifi_pass":"password"}\'')])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the new connection fails the gateway will fallback to the previous connection.")])]),e._v(" "),t("h2",{attrs:{id:"change-the-gateway-password"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-gateway-password"}},[e._v("#")]),e._v(" Change the gateway password")]),e._v(" "),t("p",[e._v("The password must be 8 characters minimum.")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"gw_pass":"12345678"}\'')])]),e._v(" "),t("h2",{attrs:{id:"change-the-mqtt-broker-credentials"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-mqtt-broker-credentials"}},[e._v("#")]),e._v(" Change the MQTT broker credentials")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_user": "user_name",\n "mqtt_pass": "password",\n "mqtt_server": "host",\n "mqtt_port": "port",\n "mqtt_validate": false,\n "mqtt_secure": false\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("By default this function is not available on the pre built binary of RFBridge, in order to have less code size and enable to have OTA update working properly. So as to enable it remove from the rf bridge env:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("build_flags = '-UMQTTsetMQTT'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the new connection fails the gateway will fallback to the previous connection.")])]),e._v(" "),t("h2",{attrs:{id:"change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"}},[e._v("#")]),e._v(" Change the MQTT main topic, discovery prefix, and or gateway name")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_topic": "topic/",\n "discovery_prefix": "prefix",\n "gateway_name": "name"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("INFO")]),e._v(" "),t("p",[e._v("This will change the subscribed and published mqtt_topic/gateway_name that the gateway uses. No parameters are mandatory, the current topic or gateway name will be used if not supplied.")])]),e._v(" "),t("h2",{attrs:{id:"switching-brokers-and-using-signed-and-client-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#switching-brokers-and-using-signed-and-client-certificates"}},[e._v("#")]),e._v(" Switching brokers and using signed and client certificates")]),e._v(" "),t("p",[e._v("In the "),t("code",[e._v("user_config.h")]),e._v(" file it is possible to specify multiple MQTT brokers and client certificates.\nAdditionally, support for multiple brokers and client certificates has been added. To use this, it is required that the server certificate, client certificate, and client key are provided as their own constant string value as demonstrated in the file."),t("br"),e._v("\nTo add more than one broker and switch between them it is necessary to provide all of the relevant certificates/keys and add their respective variable names in the "),t("code",[e._v("cnt_parameters_array")]),e._v(" structure, as shown in "),t("code",[e._v("user_config.h")]),e._v("..")]),e._v(" "),t("p",[e._v("To switch between these connections with an MQTT command message, the format is as follows:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "mqtt_user": "user",\n "mqtt_pass": "password",\n "mqtt_server": "host",\n "mqtt_port": "port",\n "mqtt_secure": true,\n "mqtt_validate": true,\n "cnt_index":1,\n "save_cnt": true\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("cnt_index")]),e._v(" value corresponds to the 0 to 2 index of the "),t("code",[e._v("cnt_parameters_array")]),e._v(" in "),t("code",[e._v("user_config.h")]),e._v(".\n0 being the default index, containing the onboarding parameters.")])]),e._v(" "),t("p",[e._v("To read the connection parameters:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "cnt_index":1,\n "read_cnt": true\n }\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("To test a connection change without saving:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m\n\'{\n "cnt_index":1,\n "test_cnt": true\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If the client can't connect to the MQTT broker corresponding to the current "),t("code",[e._v("cnt_index")]),e._v(", it will increment the index to the next valid connection set and restart with it.")])]),e._v(" "),t("h2",{attrs:{id:"saving-loading-connection-parameters-certificates-at-runtime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#saving-loading-connection-parameters-certificates-at-runtime"}},[e._v("#")]),e._v(" Saving/Loading connection parameters/certificates at runtime")]),e._v(" "),t("p",[e._v("This chapter details the process for managing certificates/connections parameters used for secure MQTT communication with OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"storing-and-loading-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storing-and-loading-certificates"}},[e._v("#")]),e._v(" Storing and Loading Certificates")]),e._v(" "),t("ul",[t("li",[e._v("Flash Memory Storage:\nCertificates can be saved to the flash memory using specific indices. Valid indices for storing certificates are 1 and 2, as 0 is reserved for the default certificate.")]),e._v(" "),t("li",[e._v("RAM Memory Loading:\nCertificates can be loaded from RAM, where valid indices range from 0 to 2. The device publishes a hash of the certificate to the broker to verify its identity. If the connection using the current certificate fails, the device will revert to the previous certificate.")])]),e._v(" "),t("h3",{attrs:{id:"use-case-changing-a-group-of-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-changing-a-group-of-certificates"}},[e._v("#")]),e._v(" Use Case: Changing a Group of Certificates")]),e._v(" "),t("p",[e._v("When updating certificates, follow these steps to ensure that the new certificates are correctly loaded and used:")]),e._v(" "),t("ol",[t("li",[e._v("Push Certificates via MQTT:\nSend the new certificates one by one through MQTT, using indices 1 or 2. Replace newline characters (\\n) in the certificates with spaces.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"mqtt_server_cert"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"-----BEGIN CERTIFICATE----- MIIDQTCC----END CERTIFICATE-----"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("p",[e._v("Accepted certificates are:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("mqtt_server_cert")])]),e._v(" "),t("li",[t("code",[e._v("mqtt_client_cert")])]),e._v(" "),t("li",[t("code",[e._v("mqtt_client_key")])]),e._v(" "),t("li",[t("code",[e._v("ota_server_cert")])])]),e._v(" "),t("ol",{attrs:{start:"2"}},[t("li",[e._v("Verify Certificates in RAM:\nAfter pushing the certificates, verify that they have been correctly loaded into RAM.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"read_cnt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("Test and Save Certificates:\nOnce verification is complete, test the connection using the new certificates. If the connection is successful, send the command to save the certificates to flash.")])]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"cnt_index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"save_cnt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])]),t("ol",{attrs:{start:"4"}},[t("li",[t("p",[e._v("Broker Connection:\nThe broker will attempt to use the newly received certificates for the connection.")])]),e._v(" "),t("li",[t("p",[e._v("Successful Connection Handling:\nIf the connection is successful, the certificates are permanently stored in the flash memory at the specified index.")])]),e._v(" "),t("li",[t("p",[e._v("Handling Connection Failures:\nIf the connection fails, the device will revert to the previously used certificate index, and the new certificates will not be saved.")])])]),e._v(" "),t("h1",{attrs:{id:"firmware-update-from-mqtt-esp-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firmware-update-from-mqtt-esp-only"}},[e._v("#")]),e._v(" Firmware update from MQTT (ESP only)")]),e._v(" "),t("p",[e._v("When the gateway used is from a standard ESP32 environment "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/development/environments.ini",target:"_blank",rel:"noopener noreferrer"}},[e._v("listed and defined here"),t("OutboundLink")],1),e._v(", it can be updated through a simple MQTT command:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "latest"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br")])]),t("p",[e._v("This would download the latest version firmware binary from Github and install it.\nIt can be used with version 1.5.0 and above.")]),e._v(" "),t("p",[e._v("Note that this update option is also autodiscovered through Home Assistant convention, you can update directly from the device page with 2 clicks.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(405),alt:"Home Assistant OTA Update"}})]),e._v(" "),t("p",[e._v("You can also indicate the target version to update:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "v1.2.0"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br")])]),t("p",[e._v("OpenMQTTGateway checks at start and every hour if an update is available.")]),e._v(" "),t("p",[e._v("Alternatively if you want to choose the update URL you can use the command below (ESP32 and ESP8266):")]),e._v(" "),t("p",[e._v("Without certificate, in this case the gateway will use the ota_server_cert certificate defined in default_ota_cert.h")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "test",\n "password": "OTAPASSWORD",\n "url": "https://github.com/1technophile/OpenMQTTGateway/releases/download/v0.9.12/esp32dev-ble-firmware.bin"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("With certificate (replace the \\n in the certificate by spaces to publish it easily):")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/firmware_update" -m \'{\n "version": "test",\n "password": "OTAPASSWORD",\n "url": "https://github.com/1technophile/OpenMQTTGateway/releases/download/v0.9.12/esp32dev-ble-firmware.bin",\n "ota_server_cert": "-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4= -----END CERTIFICATE-----"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("A bash script is available "),t("a",{attrs:{href:"ota_command_cert.zip"}},[e._v("here also")]),e._v(" to simplify the use of the "),t("code",[e._v("server_cert")]),e._v(" parameter.")]),e._v(" "),t("p",[e._v("Alternatively the OTA certificate can also be saved with the cnt_index for future use:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway_ESP32_BLE/commands/MQTTtoSYS/config" -m \'{\n "cnt_index": 1,\n "save_cnt":true,\n "ota_server_cert": "-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4= -----END CERTIFICATE-----"\n}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br")])]),t("p",[e._v("The other connection parameters corresponding to the index need to be valid for the save function to work. This command will switch to connection parameters of index 1.")]),e._v(" "),t("p",[e._v("To enable this functionality, "),t("code",[e._v("MQTT_HTTPS_FW_UPDATE")]),e._v(" will need to be defined or the line that defines in in user_config.h will need to be uncommented.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If using an unsecure MQTT broker it is "),t("strong",[e._v("highly recommended")]),e._v(" to disable the password checking by setting the macro "),t("code",[e._v("MQTT_HTTPS_FW_UPDATE_USE_PASSWORD")]),e._v(" to 0 (default is 1 (enabled)), otherwise a clear text password may be sent over the network.")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("server_cert")]),e._v(" parameter is optional. If the update server has changed or certificate updated or not set in "),t("code",[e._v("user_config.h")]),e._v(" then you can provide the certificate here.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("The pre-built binaries for "),t("strong",[e._v("rfbridge")]),e._v(" and "),t("strong",[e._v("avatto-bakeey-ir")]),e._v(" have the above WiFi and MQTT broker credentials and the Firmware update via MQTT options disabled. This is due to the restricted available flash, so as to still be able to use OTA firmware updates for these boards.")])]),e._v(" "),t("h1",{attrs:{id:"communication-layers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#communication-layers"}},[e._v("#")]),e._v(" Communication layers")]),e._v(" "),t("h2",{attrs:{id:"mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt"}},[e._v("#")]),e._v(" MQTT")]),e._v(" "),t("p",[e._v("OpenMQTTGateway uses per default MQTT on top of Ethernet or WiFi for communicating (default: true).\nThe MQTT communication can be deactivated with the following command:\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"mqtt":false}\'')]),e._v("\nOnce activated the MQTT API is no longer accessible")]),e._v(" "),t("h2",{attrs:{id:"serial"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#serial"}},[e._v("#")]),e._v(" Serial")]),e._v(" "),t("p",[e._v("Added to MQTT, OpenMQTTGateway cans use Serial to transmit or receive json data (default: false):\n"),t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"serial":true}\'')])]),e._v(" "),t("p",[e._v("The build need to have the following macro:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" '-DZgatewaySERIAL=\"SERIAL\"'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("An example scenario is a slave offline ESP32 dedicated to RF decoding connected to another online ESP32 through Serial.")]),e._v(" "),t("h1",{attrs:{id:"indicators"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#indicators"}},[e._v("#")]),e._v(" Indicators")]),e._v(" "),t("h2",{attrs:{id:"change-the-led-indicator-brightness"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#change-the-led-indicator-brightness"}},[e._v("#")]),e._v(" Change the LED indicator brightness")]),e._v(" "),t("p",[e._v("Minimum: 0, Maximum: 255, Default defined by DEFAULT_ADJ_BRIGHTNESS")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m \'{"brightness":200}\'')])]),e._v(" "),t("h2",{attrs:{id:"understanding-led-indicators-in-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-led-indicators-in-openmqttgateway"}},[e._v("#")]),e._v(" Understanding LED Indicators in OpenMQTTGateway")]),e._v(" "),t("p",[e._v("With boards having one or several RGB Led, OpenMQTTGateway uses them to provide visual feedback about its current state. This guide will help you interpret these LED signals to understand what's happening with your gateway.")]),e._v(" "),t("h2",{attrs:{id:"led-color-guide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#led-color-guide"}},[e._v("#")]),e._v(" LED Color Guide")]),e._v(" "),t("p",[e._v("OpenMQTTGateway uses a variety of colors to indicate different states:")]),e._v(" "),t("p",[e._v("Green (0x00FF00): Indicates normal operation or successful connections\nBlue (0x0000FF): Shows processing or offline status\nOrange (0xFFA500): Indicates waiting states or minor issues\nYellow (0xFFFF00): Used during the onboarding process\nRed (0xFF0000): Signals an error state\nMagenta (0xFF00FF): Indicates local Over-The-Air (OTA) updates\nPurple (0x8000FF): Shows remote OTA updates are in progress")]),e._v(" "),t("h2",{attrs:{id:"understanding-gateway-states"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-gateway-states"}},[e._v("#")]),e._v(" Understanding Gateway States")]),e._v(" "),t("p",[e._v("Here's what different LED behaviors mean:")]),e._v(" "),t("h3",{attrs:{id:"power-on"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#power-on"}},[e._v("#")]),e._v(" Power On")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: The gateway is powered and operational")]),e._v(" "),t("h3",{attrs:{id:"processing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processing"}},[e._v("#")]),e._v(" Processing")]),e._v(" "),t("p",[e._v("Color: Blue\nBehavior: Blinking (3 times)\nMeaning: The gateway is processing data")]),e._v(" "),t("h3",{attrs:{id:"waiting-for-onboarding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#waiting-for-onboarding"}},[e._v("#")]),e._v(" Waiting for Onboarding")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Solid light\nMeaning: The gateway is ready to be set up")]),e._v(" "),t("h3",{attrs:{id:"onboarding-in-progress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#onboarding-in-progress"}},[e._v("#")]),e._v(" Onboarding in Progress")]),e._v(" "),t("p",[e._v("Color: Yellow\nBehavior: Solid light\nMeaning: The gateway is being configured")]),e._v(" "),t("h3",{attrs:{id:"network-connected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#network-connected"}},[e._v("#")]),e._v(" Network Connected")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: Successfully connected to the network")]),e._v(" "),t("h3",{attrs:{id:"network-disconnected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#network-disconnected"}},[e._v("#")]),e._v(" Network Disconnected")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Blinking\nMeaning: Lost connection to the network")]),e._v(" "),t("h3",{attrs:{id:"mqtt-broker-connected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-broker-connected"}},[e._v("#")]),e._v(" MQTT Broker Connected")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Solid light\nMeaning: Successfully connected to the MQTT broker")]),e._v(" "),t("h3",{attrs:{id:"mqtt-broker-disconnected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mqtt-broker-disconnected"}},[e._v("#")]),e._v(" MQTT Broker Disconnected")]),e._v(" "),t("p",[e._v("Color: Orange\nBehavior: Blinking\nMeaning: Lost connection to the MQTT broker")]),e._v(" "),t("h3",{attrs:{id:"offline"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#offline"}},[e._v("#")]),e._v(" Offline")]),e._v(" "),t("p",[e._v("Color: Blue\nBehavior: Blinking\nMeaning: The gateway is offline")]),e._v(" "),t("h3",{attrs:{id:"local-ota-update"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-ota-update"}},[e._v("#")]),e._v(" Local OTA Update")]),e._v(" "),t("p",[e._v("Color: Magenta\nBehavior: Blinking\nMeaning: A local Over-The-Air update is in progress")]),e._v(" "),t("h3",{attrs:{id:"remote-ota-update"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remote-ota-update"}},[e._v("#")]),e._v(" Remote OTA Update")]),e._v(" "),t("p",[e._v("Color: Purple\nBehavior: Blinking\nMeaning: A remote Over-The-Air update is in progress")]),e._v(" "),t("h3",{attrs:{id:"error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#error"}},[e._v("#")]),e._v(" Error")]),e._v(" "),t("p",[e._v("Color: Red\nBehavior: Blinking (3 times)\nMeaning: An error has occurred")]),e._v(" "),t("h3",{attrs:{id:"actuator-on-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#actuator-on-off"}},[e._v("#")]),e._v(" Actuator On/Off")]),e._v(" "),t("p",[e._v("Color: Green\nBehavior: Depends on actuator state\nMeaning: Indicates the state of a connected actuator")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/46.0cba8cae.js b/dev/assets/js/46.a3d8b6f4.js similarity index 98% rename from dev/assets/js/46.0cba8cae.js rename to dev/assets/js/46.a3d8b6f4.js index c7543f7e..bbc0ef56 100644 --- a/dev/assets/js/46.0cba8cae.js +++ b/dev/assets/js/46.a3d8b6f4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{406:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial3.296590cd.jpg"},462:function(e,t,a){"use strict";a.r(t);var s=a(14),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ir-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ir-gateway"}},[e._v("#")]),e._v(" IR gateway")]),e._v(" "),t("p",[e._v("There is two methods for finding the IR codes you want to replicate:")]),e._v(" "),t("ol",[t("li",[e._v("Point the remote control to an IR receiver see "),t("a",{attrs:{href:"#receiving-data-from-ir-signal"}},[e._v("Receiving data from IR signal")]),e._v(" & "),t("a",{attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("Send data by MQTT to convert it on IR signal")])]),e._v(" "),t("li",[e._v("Find the code corresponding to your devices with IR global cache database https://irdb.globalcache.com/ see "),t("a",{attrs:{href:"#send-data-by-mqtt-from-global-cach%C3%A9-database-to-convert-it-on-ir-signal"}},[e._v("Send data by MQTT from Global cache database to convert it on IR signal")])])]),e._v(" "),t("p",[e._v("Here is the "),t("a",{attrs:{href:"https://docs.google.com/spreadsheets/d/1rTDZIG8rm0dSf4vP7HdTdM4-aRY1nDWH4jK28_WRwHQ/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("List of protocols"),t("OutboundLink")],1),e._v(" supported by OMG, even if your device brand is not in the list you can still use raw IR data or GlobalCache database.")]),e._v(" "),t("h2",{attrs:{id:"receiving-data-from-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-ir-signal"}},[e._v("#")]),e._v(" Receiving data from IR signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:\n"),t("code",[e._v("mosquitto_sub -t +/# -v")]),e._v("\nAnd press your IR remote control in front of the receiver led you should see the following messages for example:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[e._v("home/OpenMQTTGateway/IRtoMQTT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("875849879")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol_name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v("SAMSUNG"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"bits"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("32")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"raw"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"4534,4432,612,518,614,516,616,1618,618,1616,618,512,618,1618,608,524,612,518,616,514,618,512,616,1618,616,1618,618,514,616,1618,616,514,616,514,618,512,616,1618,618,1618,618,514,610,1622,616,514,618,514,614,516,616,1618,618,512,618,512,618,1616,550,580,618,1616,612,1624,618,1616,618"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("With an hexadecimal value:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("9938405643")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("55")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"bits"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("35")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"hex"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0x25060090B"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol_name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"TECO"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("To receive big dump of raw data you need first to modify the "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L41",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" and uncomment DumpMode true")]),e._v(" "),t("p",[e._v("Unknown protocols are filtered by default, if you want to see the unknown protocols set into "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/config_IR.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define pubIRunknownPrtcl true")]),e._v(" instead of false")]),e._v(" "),t("p",[t("img",{attrs:{src:a(406),alt:"IR serial"}})]),e._v(" "),t("p",[e._v("You can take this code and try to reproduce it with the gateway either by using "),t("a",{attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("decimal value")]),e._v(" or the "),t("a",{attrs:{href:"#send-raw-ir-data-by-mqtt"}},[e._v("raw value")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on IR signal")]),e._v(" "),t("p",[e._v("With the IR gateway you need to put on the topic the protocol_name you want to use to send the signal, the different protocols implemented are "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266/blob/f9d7e5c622670132731e3f9c64d9132128eb320c/src/IRremoteESP8266.h#L299",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Exhaustive list "),t("a",{attrs:{href:"https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1910001295",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("For example if I want to send a command to a Sony TV you can use the following command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"value":551489775,"protocol_name":"SONY"}\'')])]),e._v(" "),t("p",[e._v("The code after the -m represent the payload you want to send.")]),e._v(" "),t("p",[e._v("You could alternatively use an hex value (bits is the number of hexadecimal values):\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"hex":"0x250600090B","bits":5,"protocol_name":"TECO"}\'')])]),e._v(" "),t("p",[e._v("or")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"hex":"0xA6BCF20040600020000000000519","bits":14,"protocol_name":"HAIER_AC_YRW02"}\'')])]),e._v(" "),t("p",[e._v("If you don’t want to use special parameters for IR just use value key, the protocol per default is NEC")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m '{\"value\":551489775}'")])]),e._v(" "),t("p",[e._v("NOTE: on Arduino Uno most of the protocols are not enable per default due to memory constraints (it is not the case for MEGA), to enable them go to "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/main/User_config.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("User_config.h"),t("OutboundLink")],1),e._v(" and uncomment the #define corresponding the protocols you want:")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_COOLIX")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Whynter")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_LG")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Sony")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_DISH")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_RC5")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Sharp")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("IR_SAMSUNG")])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br")])]),t("h2",{attrs:{id:"send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"}},[e._v("#")]),e._v(" Send data by MQTT from Global Caché database to convert it on IR signal")]),e._v(" "),t("p",[e._v("The website https://irdb.globalcache.com/ contains an important database of IR codes of various devices brand. By registering and asking the code you will receive a code as the example below:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("code1: sendir,1:1,1,38000,1,69,340,169,20,20,20,20,20,64,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,64,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,1544,340,85,20,3663\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("Extract this part of the code:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("38000,1,69,340,169,20,20,20,20,20,64,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,64,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,1544,340,85,20,3663\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("and publish it to MQTT with the subject containing IR_GC:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"raw":"38000,1,1,171,171,21,64,21,21,21,21,21,21,21,21,21,21,21,21,21,64,21,64,21,21,21,21,21,21,21,21,21,21,21,21,21,64,21,21,21,21,21,21,21,64,21,21,21,21,21,21,21,21,21,64,21,64,21,64,21,21,21,64,21,64,21,64,21,64,21,1114","protocol_name":"GC"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("You should be able to command your devices without having listened with the IR receiver or if your protocol is unknown by the IRremote library")]),e._v(" "),t("h2",{attrs:{id:"send-data-by-mqtt-with-advanced-ir-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-ir-parameters"}},[e._v("#")]),e._v(" Send data by MQTT with advanced IR parameters")]),e._v(" "),t("p",[e._v("IR sending support two advanced parameters; bits length and repeat number.")]),e._v(" "),t("p",[e._v("The example below will send the following advanced parameters bits: 14 and repeat:4 times for a Sony protocol:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"value":551489775,"protocol_name":"NEC","repeat":4,"bits":14}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"send-raw-ir-data-by-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-raw-ir-data-by-mqtt"}},[e._v("#")]),e._v(" Send raw IR data by MQTT")]),e._v(" "),t("p",[e._v("Publish your code like below")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"raw":"8850,4450,600,550,550,550,600,1600,600,550,600,500,600,500,600,550,600,500,600,1650,600,1600,600,550,600,1600,600,1650,600,1600,600,1650,600,1600,600,550,600,500,600,550,550,1650,600,500,600,550,600,500,600,550,550,1650,600,1650,550,1650,600,550,550,1650,600,1650,550,1650,600,1650,600","protocol_name":"Raw"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("With big raw array you may cross the limit of default payload size. In this case the gateway will not receive the message or will not send it to the broker.\nIn this case the best way is to use hex values instead, but if you can't you may change the parameters below:\nIn User_config.h replace:")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("JSON_MSG_BUFFER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token expression"}},[t("span",{pre:!0,attrs:{class:"token number"}},[e._v("512")])])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("by")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("JSON_MSG_BUFFER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token expression"}},[t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1280")])])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"repeat-the-ir-signal-openmqttgateway-receive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repeat-the-ir-signal-openmqttgateway-receive"}},[e._v("#")]),e._v(" Repeat the IR signal OpenMQTTGateway receive")]),e._v(" "),t("p",[e._v("So as to repeat the IR signal received by the gateway once set the following parameter to true in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define repeatIRwMQTT true")])]),e._v(" "),t("h2",{attrs:{id:"raw-ir-signal-forwarding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#raw-ir-signal-forwarding"}},[e._v("#")]),e._v(" Raw IR signal forwarding")]),e._v(" "),t("p",[e._v("So as to repeat the raw IR signal received by the gateway, uncomment and set the following parameter to true in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define RawDirectForward true")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{408:function(e,t,a){e.exports=a.p+"assets/img/OpenMQTTGateway_serial3.296590cd.jpg"},463:function(e,t,a){"use strict";a.r(t);var s=a(14),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ir-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ir-gateway"}},[e._v("#")]),e._v(" IR gateway")]),e._v(" "),t("p",[e._v("There is two methods for finding the IR codes you want to replicate:")]),e._v(" "),t("ol",[t("li",[e._v("Point the remote control to an IR receiver see "),t("a",{attrs:{href:"#receiving-data-from-ir-signal"}},[e._v("Receiving data from IR signal")]),e._v(" & "),t("a",{attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("Send data by MQTT to convert it on IR signal")])]),e._v(" "),t("li",[e._v("Find the code corresponding to your devices with IR global cache database https://irdb.globalcache.com/ see "),t("a",{attrs:{href:"#send-data-by-mqtt-from-global-cach%C3%A9-database-to-convert-it-on-ir-signal"}},[e._v("Send data by MQTT from Global cache database to convert it on IR signal")])])]),e._v(" "),t("p",[e._v("Here is the "),t("a",{attrs:{href:"https://docs.google.com/spreadsheets/d/1rTDZIG8rm0dSf4vP7HdTdM4-aRY1nDWH4jK28_WRwHQ/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("List of protocols"),t("OutboundLink")],1),e._v(" supported by OMG, even if your device brand is not in the list you can still use raw IR data or GlobalCache database.")]),e._v(" "),t("h2",{attrs:{id:"receiving-data-from-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#receiving-data-from-ir-signal"}},[e._v("#")]),e._v(" Receiving data from IR signal")]),e._v(" "),t("p",[e._v("Subscribe to all the messages with mosquitto or open your MQTT client software:\n"),t("code",[e._v("mosquitto_sub -t +/# -v")]),e._v("\nAnd press your IR remote control in front of the receiver led you should see the following messages for example:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[e._v("home/OpenMQTTGateway/IRtoMQTT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("875849879")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol_name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v("SAMSUNG"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"bits"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("32")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"raw"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"4534,4432,612,518,614,516,616,1618,618,1616,618,512,618,1618,608,524,612,518,616,514,618,512,616,1618,616,1618,618,514,616,1618,616,514,616,514,618,512,616,1618,618,1618,618,514,610,1622,616,514,618,514,614,516,616,1618,618,512,618,512,618,1616,550,580,618,1616,612,1624,618,1616,618"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("With an hexadecimal value:")]),e._v(" "),t("div",{staticClass:"language-json line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("9938405643")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("55")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"bits"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("35")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"hex"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0x25060090B"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"protocol_name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"TECO"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("To receive big dump of raw data you need first to modify the "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L41",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" and uncomment DumpMode true")]),e._v(" "),t("p",[e._v("Unknown protocols are filtered by default, if you want to see the unknown protocols set into "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/config_IR.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define pubIRunknownPrtcl true")]),e._v(" instead of false")]),e._v(" "),t("p",[t("img",{attrs:{src:a(408),alt:"IR serial"}})]),e._v(" "),t("p",[e._v("You can take this code and try to reproduce it with the gateway either by using "),t("a",{attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("decimal value")]),e._v(" or the "),t("a",{attrs:{href:"#send-raw-ir-data-by-mqtt"}},[e._v("raw value")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"send-data-by-mqtt-to-convert-it-on-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-to-convert-it-on-ir-signal"}},[e._v("#")]),e._v(" Send data by MQTT to convert it on IR signal")]),e._v(" "),t("p",[e._v("With the IR gateway you need to put on the topic the protocol_name you want to use to send the signal, the different protocols implemented are "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266/blob/f9d7e5c622670132731e3f9c64d9132128eb320c/src/IRremoteESP8266.h#L299",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Exhaustive list "),t("a",{attrs:{href:"https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1910001295",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("For example if I want to send a command to a Sony TV you can use the following command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"value":551489775,"protocol_name":"SONY"}\'')])]),e._v(" "),t("p",[e._v("The code after the -m represent the payload you want to send.")]),e._v(" "),t("p",[e._v("You could alternatively use an hex value (bits is the number of hexadecimal values):\n"),t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"hex":"0x250600090B","bits":5,"protocol_name":"TECO"}\'')])]),e._v(" "),t("p",[e._v("or")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"hex":"0xA6BCF20040600020000000000519","bits":14,"protocol_name":"HAIER_AC_YRW02"}\'')])]),e._v(" "),t("p",[e._v("If you don’t want to use special parameters for IR just use value key, the protocol per default is NEC")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m '{\"value\":551489775}'")])]),e._v(" "),t("p",[e._v("NOTE: on Arduino Uno most of the protocols are not enable per default due to memory constraints (it is not the case for MEGA), to enable them go to "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/main/User_config.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("User_config.h"),t("OutboundLink")],1),e._v(" and uncomment the #define corresponding the protocols you want:")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_COOLIX")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Whynter")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_LG")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Sony")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_DISH")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_RC5")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("//#define IR_Sharp")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("IR_SAMSUNG")])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br")])]),t("h2",{attrs:{id:"send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"}},[e._v("#")]),e._v(" Send data by MQTT from Global Caché database to convert it on IR signal")]),e._v(" "),t("p",[e._v("The website https://irdb.globalcache.com/ contains an important database of IR codes of various devices brand. By registering and asking the code you will receive a code as the example below:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("code1: sendir,1:1,1,38000,1,69,340,169,20,20,20,20,20,64,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,64,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,1544,340,85,20,3663\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("Extract this part of the code:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("38000,1,69,340,169,20,20,20,20,20,64,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,64,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,64,20,64,20,64,20,64,20,64,20,64,20,1544,340,85,20,3663\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("and publish it to MQTT with the subject containing IR_GC:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"raw":"38000,1,1,171,171,21,64,21,21,21,21,21,21,21,21,21,21,21,21,21,64,21,64,21,21,21,21,21,21,21,21,21,21,21,21,21,64,21,21,21,21,21,21,21,64,21,21,21,21,21,21,21,21,21,64,21,64,21,64,21,21,21,64,21,64,21,64,21,64,21,1114","protocol_name":"GC"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("You should be able to command your devices without having listened with the IR receiver or if your protocol is unknown by the IRremote library")]),e._v(" "),t("h2",{attrs:{id:"send-data-by-mqtt-with-advanced-ir-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-data-by-mqtt-with-advanced-ir-parameters"}},[e._v("#")]),e._v(" Send data by MQTT with advanced IR parameters")]),e._v(" "),t("p",[e._v("IR sending support two advanced parameters; bits length and repeat number.")]),e._v(" "),t("p",[e._v("The example below will send the following advanced parameters bits: 14 and repeat:4 times for a Sony protocol:")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"value":551489775,"protocol_name":"NEC","repeat":4,"bits":14}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"send-raw-ir-data-by-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-raw-ir-data-by-mqtt"}},[e._v("#")]),e._v(" Send raw IR data by MQTT")]),e._v(" "),t("p",[e._v("Publish your code like below")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m \'{"raw":"8850,4450,600,550,550,550,600,1600,600,550,600,500,600,500,600,550,600,500,600,1650,600,1600,600,550,600,1600,600,1650,600,1600,600,1650,600,1600,600,550,600,500,600,550,550,1650,600,500,600,550,600,500,600,550,550,1650,600,1650,550,1650,600,550,550,1650,600,1650,550,1650,600,1650,600","protocol_name":"Raw"}\'\n')])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("With big raw array you may cross the limit of default payload size. In this case the gateway will not receive the message or will not send it to the broker.\nIn this case the best way is to use hex values instead, but if you can't you may change the parameters below:\nIn User_config.h replace:")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("JSON_MSG_BUFFER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token expression"}},[t("span",{pre:!0,attrs:{class:"token number"}},[e._v("512")])])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("p",[e._v("by")]),e._v(" "),t("div",{staticClass:"language-cpp line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-cpp"}},[t("code",[t("span",{pre:!0,attrs:{class:"token macro property"}},[t("span",{pre:!0,attrs:{class:"token directive-hash"}},[e._v("#")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token directive keyword"}},[e._v("define")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token macro-name"}},[e._v("JSON_MSG_BUFFER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token expression"}},[t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1280")])])]),e._v("\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br")])]),t("h2",{attrs:{id:"repeat-the-ir-signal-openmqttgateway-receive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repeat-the-ir-signal-openmqttgateway-receive"}},[e._v("#")]),e._v(" Repeat the IR signal OpenMQTTGateway receive")]),e._v(" "),t("p",[e._v("So as to repeat the IR signal received by the gateway once set the following parameter to true in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define repeatIRwMQTT true")])]),e._v(" "),t("h2",{attrs:{id:"raw-ir-signal-forwarding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#raw-ir-signal-forwarding"}},[e._v("#")]),e._v(" Raw IR signal forwarding")]),e._v(" "),t("p",[e._v("So as to repeat the raw IR signal received by the gateway, uncomment and set the following parameter to true in "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/091b317660fd201a30e2cd0e15424a13c5a6bd71/config_IR.h#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_IR.h"),t("OutboundLink")],1),e._v(" "),t("code",[e._v("#define RawDirectForward true")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/48.da7eba11.js b/dev/assets/js/48.f87659b7.js similarity index 99% rename from dev/assets/js/48.da7eba11.js rename to dev/assets/js/48.f87659b7.js index d25eab51..13ea28ff 100644 --- a/dev/assets/js/48.da7eba11.js +++ b/dev/assets/js/48.f87659b7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{426:function(e,t,a){"use strict";a.r(t);var r=a(14),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used "),t("a",{attrs:{href:"http://mqtt.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("MQTT"),t("OutboundLink")],1),e._v(" protocol.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/OpenMQTTGateway.png",alt:"Overview of the protocols and compatible controllers"}})]),e._v(" "),t("h1",{attrs:{id:"what-is-an-mqtt-gateway-or-bridge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-is-an-mqtt-gateway-or-bridge"}},[e._v("#")]),e._v(" What is an MQTT gateway or bridge ?")]),e._v(" "),t("p",[e._v("MQTT, short for Message Queuing Telemetry Transport, is a lightweight messaging protocol ideal for IoT devices.")]),e._v(" "),t("p",[e._v("An MQTT gateway or bridge plays a pivotal role in the MQTT ecosystem:")]),e._v(" "),t("ul",[t("li",[e._v("Protocol Translation: It converts non-MQTT protocols (like LoRa or Bluetooth) into MQTT, enabling broader network communication.")]),e._v(" "),t("li",[e._v("Data Aggregation: Combines data from multiple devices into single messages, optimizing network use.")]),e._v(" "),t("li",[e._v("Security: Incorporates features like SSL/TLS encryption to safeguard data during transmission.")]),e._v(" "),t("li",[e._v("Device Management: Handles tasks like firmware updates and remote configuration changes.")])]),e._v(" "),t("p",[e._v("In essence, an MQTT gateway ensures smooth communication between devices and MQTT brokers, enhancing the efficiency and security of IoT systems.")]),e._v(" "),t("h1",{attrs:{id:"what-openmqttgateway-can-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-openmqttgateway-can-do"}},[e._v("#")]),e._v(" What OpenMQTTGateway can do ?")]),e._v(" "),t("p",[e._v("OpenMQTTGateway integrates with established technologies, such as 433mhz/315mhz protocols and infrared (IR), allowing you to upgrade and repurpose older devices. Additionally, OMG is compatible with modern technologies like Bluetooth Low Energy (BLE) and LoRa.")]),e._v(" "),t("p",[e._v("To have an overview of the supported PIR, door, water, temperature, smoke sensors, sirens, rings, beacons, switches & weather stations you can take a look to the\n"),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible devices list"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("You can run OpenMQTTGateway on a wide variety of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("boards"),t("OutboundLink")],1),e._v(", ESP32, ESP8266, ESP32S3, ESP32C3.\nBLE to MQTT gateway can also run on Raspberry Pi, Windows or Unix computers thanks to "),t("a",{attrs:{href:"https://theengs.github.io/gateway/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Using MQTT, you can seamlessly integrate with home automation platforms such as OpenHAB, Home Assistant, and others, or with IoT software like Node-Red.")]),e._v(" "),t("h1",{attrs:{id:"use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases"}},[e._v("#")]),e._v(" Use cases")]),e._v(" "),t("p",[e._v("Leveraging OpenMQTTGateway with a controller allows you to:")]),e._v(" "),t("ul",[t("li",[e._v("Monitor a garden with a Mi Flora BLE sensor and control an irrigation valve depending on the soil moisture,")]),e._v(" "),t("li",[e._v("Trigger a fan depending on the temperature and humidity thanks to a Mi Jia/LYWSD03MMC BLE sensor,")]),e._v(" "),t("li",[e._v("Follow your meat temperature when cooking with an Inkbird IBBQ")]),e._v(" "),t("li",[e._v("Alert yourself by a controller notification if the temperature of a fridge or freezer is too high,")]),e._v(" "),t("li",[e._v("Detect a beacon/smartwatch so as to trigger a special scenario when you come home,")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=noUROhtf0E0&t=18s",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lose weight with the help of a complete log system"),t("OutboundLink")],1),e._v(", video from "),t("a",{attrs:{href:"https://www.youtube.com/channel/UCu7_D0o48KbfhpEohoP7YSQ",target:"_blank",rel:"noopener noreferrer"}},[e._v("@Andreas Spiess"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Detect opened door or windows through 433mhz or BLE and alert yourself when leaving")]),e._v(" "),t("li",[e._v("Detect water leakage or smoke remotely")]),e._v(" "),t("li",[e._v("Actionate a siren if something is going wrong")]),e._v(" "),t("li",[e._v("Detect if your far mailbox has been opened by the postman with LoRa")]),e._v(" "),t("li",[e._v("Make smart your old TV or AC system through infrared control")]),e._v(" "),t("li",[e._v("Monitor vehicle tire pressure")])]),e._v(" "),t("p",[e._v("The limit is your imagination 😀")]),e._v(" "),t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[e._v("Under the hood, OpenMQTTGateway offers features such as:")]),e._v(" "),t("ul",[t("li",[e._v("Deduplication")]),e._v(" "),t("li",[e._v("Simple and lite API")]),e._v(" "),t("li",[e._v("Strong integrations with libraries used")]),e._v(" "),t("li",[e._v("Signal forward/repeat")]),e._v(" "),t("li",[e._v("Wifi web portal onboarding")]),e._v(" "),t("li",[e._v("Web portal configuration")]),e._v(" "),t("li",[e._v("Whitelist & Blacklist management")]),e._v(" "),t("li",[e._v("Secure connections")]),e._v(" "),t("li",[e._v("Over the air updates")]),e._v(" "),t("li",[e._v("Local or cloud, your choice")])]),e._v(" "),t("h2",{attrs:{id:"using-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-openmqttgateway"}},[e._v("#")]),e._v(" Using OpenMQTTGateway ?")]),e._v(" "),t("p",[e._v("Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests will receive priority attention, plus you'll gain insider access to our roadmap.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("iframe",{staticStyle:{border:"0","border-radius":"6px"},attrs:{src:"https://github.com/sponsors/theengs/button",title:"Sponsor Theengs",height:"32",width:"228"}})]),e._v(" "),t("h2",{attrs:{id:"products-powered-by-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#products-powered-by-openmqttgateway"}},[e._v("#")]),e._v(" Products powered by OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"theengs-bridge-ble-gateway-with-external-antenna"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-bridge-ble-gateway-with-external-antenna"}},[e._v("#")]),e._v(" Theengs Bridge, BLE gateway with external antenna")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerfull BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/Theengs-Bridge-ble-gateway.png",alt:"Theengs bridge view"}})])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug-ble-gateway-and-smart-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug-ble-gateway-and-smart-plug"}},[e._v("#")]),e._v(" Theengs Plug, BLE gateway and Smart Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" brings the following features:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(" supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/Theengs-Plug-OpenMQTTGateway.png",alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"media"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#media"}},[e._v("#")]),e._v(" Media")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://hackaday.com/2023/01/13/arduino-library-brings-rtl_433-to-the-esp32",target:"_blank",rel:"noopener noreferrer"}},[e._v("Hackaday - ARDUINO LIBRARY BRINGS RTL_433 TO THE ESP32"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.cnx-software.com/2023/01/14/esp32-board-with-lora-433-mhz-sensors/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CNX Software - 433 MHz is not dead! Using an ESP32 board with LoRa module to talk to 433 MHz sensors"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.rtl-sdr.com/rtl_433-ported-to-esp32-microcontrollers-with-cc1101-or-sx127x-transceiver-chips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("RTL_433 PORTED TO ESP32 MICROCONTROLLERS WITH CC1101 OR SX127X TRANSCEIVER CHIPS"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lwn.net/Articles/921497/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Using low-cost wireless sensors in the unlicensed bands"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.electronics-lab.com/smart-plug-esp32-openmqttgateway-serving-as-an-ble-mqtt-gateway-and-a-power-meter/",target:"_blank",rel:"noopener noreferrer"}},[e._v("SMART PLUG ESP32 OPENMQTTGATEWAY SERVING AS AN BLE MQTT GATEWAY AND A POWER METER"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug"}},[e._v("#")]),e._v(" Theengs Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=nUwMt9p2U7o&t=427s",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/nUwMt9p2U7o/0.jpg",alt:"Theengs Plug video ElektroMaker"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"_433mhz-and-ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_433mhz-and-ble"}},[e._v("#")]),e._v(" 433Mhz and BLE")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=_gdXR1uklaY",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/_gdXR1uklaY/0.jpg",alt:"433Mhz and BLE gateway video by Andreas Spiess"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ble"}},[e._v("#")]),e._v(" BLE")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=noUROhtf0E0",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/noUROhtf0E0/0.jpg",alt:"BLE gateway video by Andreas Spiess"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"_433mhz"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_433mhz"}},[e._v("#")]),e._v(" 433Mhz")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=H-JXWbWjJYE",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/H-JXWbWjJYE/0.jpg",alt:"RTL_433 video by TECH MIND"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"lora"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lora"}},[e._v("#")]),e._v(" LORA")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=6DftaHxDawM",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/6DftaHxDawM/0.jpg",alt:"LORA video by Priceless Toolkit"}}),t("OutboundLink")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("The material and information contained in this documentation is for general information purposes only. You should not rely upon the material or information on this documentation as a basis for making any business, legal or any other decisions. There is no warranty given on this documentation content. If you decide to follow the information and materials given it is at your own risk. I will not be liable for any false, inaccurate, inappropriate or incomplete information presented on this website.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{427:function(e,t,a){"use strict";a.r(t);var r=a(14),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used "),t("a",{attrs:{href:"http://mqtt.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("MQTT"),t("OutboundLink")],1),e._v(" protocol.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/OpenMQTTGateway.png",alt:"Overview of the protocols and compatible controllers"}})]),e._v(" "),t("h1",{attrs:{id:"what-is-an-mqtt-gateway-or-bridge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-is-an-mqtt-gateway-or-bridge"}},[e._v("#")]),e._v(" What is an MQTT gateway or bridge ?")]),e._v(" "),t("p",[e._v("MQTT, short for Message Queuing Telemetry Transport, is a lightweight messaging protocol ideal for IoT devices.")]),e._v(" "),t("p",[e._v("An MQTT gateway or bridge plays a pivotal role in the MQTT ecosystem:")]),e._v(" "),t("ul",[t("li",[e._v("Protocol Translation: It converts non-MQTT protocols (like LoRa or Bluetooth) into MQTT, enabling broader network communication.")]),e._v(" "),t("li",[e._v("Data Aggregation: Combines data from multiple devices into single messages, optimizing network use.")]),e._v(" "),t("li",[e._v("Security: Incorporates features like SSL/TLS encryption to safeguard data during transmission.")]),e._v(" "),t("li",[e._v("Device Management: Handles tasks like firmware updates and remote configuration changes.")])]),e._v(" "),t("p",[e._v("In essence, an MQTT gateway ensures smooth communication between devices and MQTT brokers, enhancing the efficiency and security of IoT systems.")]),e._v(" "),t("h1",{attrs:{id:"what-openmqttgateway-can-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-openmqttgateway-can-do"}},[e._v("#")]),e._v(" What OpenMQTTGateway can do ?")]),e._v(" "),t("p",[e._v("OpenMQTTGateway integrates with established technologies, such as 433mhz/315mhz protocols and infrared (IR), allowing you to upgrade and repurpose older devices. Additionally, OMG is compatible with modern technologies like Bluetooth Low Energy (BLE) and LoRa.")]),e._v(" "),t("p",[e._v("To have an overview of the supported PIR, door, water, temperature, smoke sensors, sirens, rings, beacons, switches & weather stations you can take a look to the\n"),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices",target:"_blank",rel:"noopener noreferrer"}},[e._v("compatible devices list"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("You can run OpenMQTTGateway on a wide variety of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("boards"),t("OutboundLink")],1),e._v(", ESP32, ESP8266, ESP32S3, ESP32C3.\nBLE to MQTT gateway can also run on Raspberry Pi, Windows or Unix computers thanks to "),t("a",{attrs:{href:"https://theengs.github.io/gateway/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Using MQTT, you can seamlessly integrate with home automation platforms such as OpenHAB, Home Assistant, and others, or with IoT software like Node-Red.")]),e._v(" "),t("h1",{attrs:{id:"use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases"}},[e._v("#")]),e._v(" Use cases")]),e._v(" "),t("p",[e._v("Leveraging OpenMQTTGateway with a controller allows you to:")]),e._v(" "),t("ul",[t("li",[e._v("Monitor a garden with a Mi Flora BLE sensor and control an irrigation valve depending on the soil moisture,")]),e._v(" "),t("li",[e._v("Trigger a fan depending on the temperature and humidity thanks to a Mi Jia/LYWSD03MMC BLE sensor,")]),e._v(" "),t("li",[e._v("Follow your meat temperature when cooking with an Inkbird IBBQ")]),e._v(" "),t("li",[e._v("Alert yourself by a controller notification if the temperature of a fridge or freezer is too high,")]),e._v(" "),t("li",[e._v("Detect a beacon/smartwatch so as to trigger a special scenario when you come home,")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=noUROhtf0E0&t=18s",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lose weight with the help of a complete log system"),t("OutboundLink")],1),e._v(", video from "),t("a",{attrs:{href:"https://www.youtube.com/channel/UCu7_D0o48KbfhpEohoP7YSQ",target:"_blank",rel:"noopener noreferrer"}},[e._v("@Andreas Spiess"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Detect opened door or windows through 433mhz or BLE and alert yourself when leaving")]),e._v(" "),t("li",[e._v("Detect water leakage or smoke remotely")]),e._v(" "),t("li",[e._v("Actionate a siren if something is going wrong")]),e._v(" "),t("li",[e._v("Detect if your far mailbox has been opened by the postman with LoRa")]),e._v(" "),t("li",[e._v("Make smart your old TV or AC system through infrared control")]),e._v(" "),t("li",[e._v("Monitor vehicle tire pressure")])]),e._v(" "),t("p",[e._v("The limit is your imagination 😀")]),e._v(" "),t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[e._v("Under the hood, OpenMQTTGateway offers features such as:")]),e._v(" "),t("ul",[t("li",[e._v("Deduplication")]),e._v(" "),t("li",[e._v("Simple and lite API")]),e._v(" "),t("li",[e._v("Strong integrations with libraries used")]),e._v(" "),t("li",[e._v("Signal forward/repeat")]),e._v(" "),t("li",[e._v("Wifi web portal onboarding")]),e._v(" "),t("li",[e._v("Web portal configuration")]),e._v(" "),t("li",[e._v("Whitelist & Blacklist management")]),e._v(" "),t("li",[e._v("Secure connections")]),e._v(" "),t("li",[e._v("Over the air updates")]),e._v(" "),t("li",[e._v("Local or cloud, your choice")])]),e._v(" "),t("h2",{attrs:{id:"using-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-openmqttgateway"}},[e._v("#")]),e._v(" Using OpenMQTTGateway ?")]),e._v(" "),t("p",[e._v("Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests will receive priority attention, plus you'll gain insider access to our roadmap.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("iframe",{staticStyle:{border:"0","border-radius":"6px"},attrs:{src:"https://github.com/sponsors/theengs/button",title:"Sponsor Theengs",height:"32",width:"228"}})]),e._v(" "),t("h2",{attrs:{id:"products-powered-by-openmqttgateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#products-powered-by-openmqttgateway"}},[e._v("#")]),e._v(" Products powered by OpenMQTTGateway")]),e._v(" "),t("h3",{attrs:{id:"theengs-bridge-ble-gateway-with-external-antenna"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-bridge-ble-gateway-with-external-antenna"}},[e._v("#")]),e._v(" Theengs Bridge, BLE gateway with external antenna")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerfull BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/Theengs-Bridge-ble-gateway.png",alt:"Theengs bridge view"}})])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug-ble-gateway-and-smart-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug-ble-gateway-and-smart-plug"}},[e._v("#")]),e._v(" Theengs Plug, BLE gateway and Smart Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" brings the following features:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/devices/ble-devices/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluetooth devices"),t("OutboundLink")],1),e._v(" supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"img/Theengs-Plug-OpenMQTTGateway.png",alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"media"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#media"}},[e._v("#")]),e._v(" Media")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://hackaday.com/2023/01/13/arduino-library-brings-rtl_433-to-the-esp32",target:"_blank",rel:"noopener noreferrer"}},[e._v("Hackaday - ARDUINO LIBRARY BRINGS RTL_433 TO THE ESP32"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.cnx-software.com/2023/01/14/esp32-board-with-lora-433-mhz-sensors/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CNX Software - 433 MHz is not dead! Using an ESP32 board with LoRa module to talk to 433 MHz sensors"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.rtl-sdr.com/rtl_433-ported-to-esp32-microcontrollers-with-cc1101-or-sx127x-transceiver-chips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("RTL_433 PORTED TO ESP32 MICROCONTROLLERS WITH CC1101 OR SX127X TRANSCEIVER CHIPS"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lwn.net/Articles/921497/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Using low-cost wireless sensors in the unlicensed bands"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.electronics-lab.com/smart-plug-esp32-openmqttgateway-serving-as-an-ble-mqtt-gateway-and-a-power-meter/",target:"_blank",rel:"noopener noreferrer"}},[e._v("SMART PLUG ESP32 OPENMQTTGATEWAY SERVING AS AN BLE MQTT GATEWAY AND A POWER METER"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"theengs-plug"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#theengs-plug"}},[e._v("#")]),e._v(" Theengs Plug")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=nUwMt9p2U7o&t=427s",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/nUwMt9p2U7o/0.jpg",alt:"Theengs Plug video ElektroMaker"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"_433mhz-and-ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_433mhz-and-ble"}},[e._v("#")]),e._v(" 433Mhz and BLE")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=_gdXR1uklaY",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/_gdXR1uklaY/0.jpg",alt:"433Mhz and BLE gateway video by Andreas Spiess"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ble"}},[e._v("#")]),e._v(" BLE")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=noUROhtf0E0",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/noUROhtf0E0/0.jpg",alt:"BLE gateway video by Andreas Spiess"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"_433mhz"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_433mhz"}},[e._v("#")]),e._v(" 433Mhz")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=H-JXWbWjJYE",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/H-JXWbWjJYE/0.jpg",alt:"RTL_433 video by TECH MIND"}}),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"lora"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lora"}},[e._v("#")]),e._v(" LORA")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.youtube.com/watch?v=6DftaHxDawM",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.youtube.com/vi/6DftaHxDawM/0.jpg",alt:"LORA video by Priceless Toolkit"}}),t("OutboundLink")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("The material and information contained in this documentation is for general information purposes only. You should not rely upon the material or information on this documentation as a basis for making any business, legal or any other decisions. There is no warranty given on this documentation content. If you decide to follow the information and materials given it is at your own risk. I will not be liable for any false, inaccurate, inappropriate or incomplete information presented on this website.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/49.c03deaf6.js b/dev/assets/js/49.be3c6616.js similarity index 97% rename from dev/assets/js/49.c03deaf6.js rename to dev/assets/js/49.be3c6616.js index 7f7e6490..26109a33 100644 --- a/dev/assets/js/49.c03deaf6.js +++ b/dev/assets/js/49.be3c6616.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{430:function(e,t,r){"use strict";r.r(t);var o=r(14),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"adding-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-protocols"}},[e._v("#")]),e._v(" Adding protocols")]),e._v(" "),t("p",[e._v("Adding your device protocol to OpenMQTTGateway enables it to increase interoperability and to create new use cases with your device. Below you will find some guidance to do that.")]),e._v(" "),t("h2",{attrs:{id:"rf-or-ir"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-or-ir"}},[e._v("#")]),e._v(" RF or IR")]),e._v(" "),t("p",[e._v("For adding RF and IR protocols to OpenMQTTGateway the best way is to do a pull request to "),t("a",{attrs:{href:"https://github.com/1technophile/rc-switch",target:"_blank",rel:"noopener noreferrer"}},[e._v("RCSwitch"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/pilight/pilight",target:"_blank",rel:"noopener noreferrer"}},[e._v("Pilight"),t("OutboundLink")],1),e._v(" for RF, and "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266",target:"_blank",rel:"noopener noreferrer"}},[e._v("IRRemoteESP8266"),t("OutboundLink")],1),e._v(" for IR.")]),e._v(" "),t("h2",{attrs:{id:"ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ble"}},[e._v("#")]),e._v(" BLE")]),e._v(" "),t("p",[e._v("For BLE message decoding OpenMQTTGateway uses the "),t("a",{attrs:{href:"https://decoder.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Decoder"),t("OutboundLink")],1),e._v(" library. New device decoder pull requests can be submitted directly to the "),t("a",{attrs:{href:"https://github.com/theengs/decoder",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub repository"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Currently we support the reading of advertizing BLE devices, advertizing means that the BLE device broadcasts regularly its sensor data without the need of a BLE connection.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{433:function(e,t,r){"use strict";r.r(t);var o=r(14),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"adding-protocols"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-protocols"}},[e._v("#")]),e._v(" Adding protocols")]),e._v(" "),t("p",[e._v("Adding your device protocol to OpenMQTTGateway enables it to increase interoperability and to create new use cases with your device. Below you will find some guidance to do that.")]),e._v(" "),t("h2",{attrs:{id:"rf-or-ir"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rf-or-ir"}},[e._v("#")]),e._v(" RF or IR")]),e._v(" "),t("p",[e._v("For adding RF and IR protocols to OpenMQTTGateway the best way is to do a pull request to "),t("a",{attrs:{href:"https://github.com/1technophile/rc-switch",target:"_blank",rel:"noopener noreferrer"}},[e._v("RCSwitch"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/pilight/pilight",target:"_blank",rel:"noopener noreferrer"}},[e._v("Pilight"),t("OutboundLink")],1),e._v(" for RF, and "),t("a",{attrs:{href:"https://github.com/crankyoldgit/IRremoteESP8266",target:"_blank",rel:"noopener noreferrer"}},[e._v("IRRemoteESP8266"),t("OutboundLink")],1),e._v(" for IR.")]),e._v(" "),t("h2",{attrs:{id:"ble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ble"}},[e._v("#")]),e._v(" BLE")]),e._v(" "),t("p",[e._v("For BLE message decoding OpenMQTTGateway uses the "),t("a",{attrs:{href:"https://decoder.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Decoder"),t("OutboundLink")],1),e._v(" library. New device decoder pull requests can be submitted directly to the "),t("a",{attrs:{href:"https://github.com/theengs/decoder",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub repository"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Currently we support the reading of advertizing BLE devices, advertizing means that the BLE device broadcasts regularly its sensor data without the need of a BLE connection.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/51.f851c3ef.js b/dev/assets/js/51.91585bcb.js similarity index 99% rename from dev/assets/js/51.f851c3ef.js rename to dev/assets/js/51.91585bcb.js index 27341a90..aac9c727 100644 --- a/dev/assets/js/51.f851c3ef.js +++ b/dev/assets/js/51.91585bcb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{433:function(e,t,n){"use strict";n.r(t);var a=n(14),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"development-contributions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#development-contributions"}},[e._v("#")]),e._v(" Development contributions")]),e._v(" "),t("p",[e._v("We like pull requests from everyone. By participating in this project, you\nagree to follow the code of conduct below")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("code of conduct"),t("OutboundLink")],1)]),e._v(" "),t("p",[t("a",{attrs:{href:"https://google.github.io/styleguide/cppguide.html#Formatting",target:"_blank",rel:"noopener noreferrer"}},[e._v("code style guide"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v('So as to format automatically your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".')]),e._v(" "),t("p",[e._v("Fork the "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/tree/development",target:"_blank",rel:"noopener noreferrer"}},[e._v("development branch"),t("OutboundLink")],1),e._v(", then clone the repo")]),e._v(" "),t("p",[e._v("Make your modification,")]),e._v(" "),t("ul",[t("li",[e._v("If you want to add a new gateway, name it "),t("code",[e._v("ZgatewayXXX")]),e._v(", "),t("code",[e._v("XXX")]),e._v(" replaced by your gateway communication type, can be more than three letters")]),e._v(" "),t("li",[e._v("If you want to add a new sensor, name it "),t("code",[e._v("ZsensorYYY")]),e._v(", "),t("code",[e._v("YYY")]),e._v(" replaced by your sensor type, can be more than three letters")]),e._v(" "),t("li",[e._v("If you want to add a new actuator, name it "),t("code",[e._v("ZactuatorZZZ")]),e._v(", "),t("code",[e._v("ZZZ")]),e._v(" replaced by your actuator type, can be more than three letters")])]),e._v(" "),t("p",[e._v("Review your code, compile it for ESP32 and ESP8266")]),e._v(" "),t("p",[e._v("Test it locally on your hardware config")]),e._v(" "),t("p",[e._v("Emit a pull request")]),e._v(" "),t("p",[e._v("Verify the GitHub Actions CI compilation results")]),e._v(" "),t("p",[e._v("Request for review")]),e._v(" "),t("p",[e._v("We may suggest some changes, improvements or alternatives.")]),e._v(" "),t("p",[e._v("Some things that will increase the chance that your pull request is accepted:")]),e._v(" "),t("ul",[t("li",[e._v("Comment your code,")]),e._v(" "),t("li",[e._v("Ask eventually for design guidelines,")]),e._v(" "),t("li",[e._v("Write a "),t("a",{attrs:{href:"http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("good commit message"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"nightly-builds"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nightly-builds"}},[e._v("#")]),e._v(" Nightly builds")]),e._v(" "),t("p",[e._v("Nightly builds can be found "),t("a",{attrs:{href:"https://docs.openmqttgateway.com/dev/upload/web-install.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" for testing purposes only.\nThey are generated from the development branch nightly or from a particular pull request upon request.")]),e._v(" "),t("h2",{attrs:{id:"developer-certificate-of-origin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-certificate-of-origin"}},[e._v("#")]),e._v(" Developer Certificate Of Origin")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" By making a contribution to this project, I certify that:\n\n (a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n (b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n (c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n (d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br"),t("span",{staticClass:"line-number"},[e._v("17")]),t("br"),t("span",{staticClass:"line-number"},[e._v("18")]),t("br"),t("span",{staticClass:"line-number"},[e._v("19")]),t("br"),t("span",{staticClass:"line-number"},[e._v("20")]),t("br"),t("span",{staticClass:"line-number"},[e._v("21")]),t("br"),t("span",{staticClass:"line-number"},[e._v("22")]),t("br"),t("span",{staticClass:"line-number"},[e._v("23")]),t("br")])]),t("p",[e._v("This Developer Certificate Of Origin (DCO) was adopted on June 7, 2021.")]),e._v(" "),t("p",[e._v("The text of this license is available under the "),t("a",{attrs:{href:"http://creativecommons.org/licenses/by-sa/3.0/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Creative Commons Attribution-ShareAlike 3.0 Unported License"),t("OutboundLink")],1),e._v(". It is based on the Linux "),t("a",{attrs:{href:"http://elinux.org/Developer_Certificate_Of_Origin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Developer Certificate Of Origin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("To accept the DCO it is required to put a x between [ ] on "),t("code",[e._v("[ ] I accept the DCO")]),e._v(" in the PR template when submitting it. The [ ] is an opt-in box, so you have to manually accept it.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{434:function(e,t,n){"use strict";n.r(t);var a=n(14),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"development-contributions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#development-contributions"}},[e._v("#")]),e._v(" Development contributions")]),e._v(" "),t("p",[e._v("We like pull requests from everyone. By participating in this project, you\nagree to follow the code of conduct below")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("code of conduct"),t("OutboundLink")],1)]),e._v(" "),t("p",[t("a",{attrs:{href:"https://google.github.io/styleguide/cppguide.html#Formatting",target:"_blank",rel:"noopener noreferrer"}},[e._v("code style guide"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v('So as to format automatically your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".')]),e._v(" "),t("p",[e._v("Fork the "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/tree/development",target:"_blank",rel:"noopener noreferrer"}},[e._v("development branch"),t("OutboundLink")],1),e._v(", then clone the repo")]),e._v(" "),t("p",[e._v("Make your modification,")]),e._v(" "),t("ul",[t("li",[e._v("If you want to add a new gateway, name it "),t("code",[e._v("ZgatewayXXX")]),e._v(", "),t("code",[e._v("XXX")]),e._v(" replaced by your gateway communication type, can be more than three letters")]),e._v(" "),t("li",[e._v("If you want to add a new sensor, name it "),t("code",[e._v("ZsensorYYY")]),e._v(", "),t("code",[e._v("YYY")]),e._v(" replaced by your sensor type, can be more than three letters")]),e._v(" "),t("li",[e._v("If you want to add a new actuator, name it "),t("code",[e._v("ZactuatorZZZ")]),e._v(", "),t("code",[e._v("ZZZ")]),e._v(" replaced by your actuator type, can be more than three letters")])]),e._v(" "),t("p",[e._v("Review your code, compile it for ESP32 and ESP8266")]),e._v(" "),t("p",[e._v("Test it locally on your hardware config")]),e._v(" "),t("p",[e._v("Emit a pull request")]),e._v(" "),t("p",[e._v("Verify the GitHub Actions CI compilation results")]),e._v(" "),t("p",[e._v("Request for review")]),e._v(" "),t("p",[e._v("We may suggest some changes, improvements or alternatives.")]),e._v(" "),t("p",[e._v("Some things that will increase the chance that your pull request is accepted:")]),e._v(" "),t("ul",[t("li",[e._v("Comment your code,")]),e._v(" "),t("li",[e._v("Ask eventually for design guidelines,")]),e._v(" "),t("li",[e._v("Write a "),t("a",{attrs:{href:"http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("good commit message"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"nightly-builds"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nightly-builds"}},[e._v("#")]),e._v(" Nightly builds")]),e._v(" "),t("p",[e._v("Nightly builds can be found "),t("a",{attrs:{href:"https://docs.openmqttgateway.com/dev/upload/web-install.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" for testing purposes only.\nThey are generated from the development branch nightly or from a particular pull request upon request.")]),e._v(" "),t("h2",{attrs:{id:"developer-certificate-of-origin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-certificate-of-origin"}},[e._v("#")]),e._v(" Developer Certificate Of Origin")]),e._v(" "),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" By making a contribution to this project, I certify that:\n\n (a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n (b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n (c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n (d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br"),t("span",{staticClass:"line-number"},[e._v("17")]),t("br"),t("span",{staticClass:"line-number"},[e._v("18")]),t("br"),t("span",{staticClass:"line-number"},[e._v("19")]),t("br"),t("span",{staticClass:"line-number"},[e._v("20")]),t("br"),t("span",{staticClass:"line-number"},[e._v("21")]),t("br"),t("span",{staticClass:"line-number"},[e._v("22")]),t("br"),t("span",{staticClass:"line-number"},[e._v("23")]),t("br")])]),t("p",[e._v("This Developer Certificate Of Origin (DCO) was adopted on June 7, 2021.")]),e._v(" "),t("p",[e._v("The text of this license is available under the "),t("a",{attrs:{href:"http://creativecommons.org/licenses/by-sa/3.0/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Creative Commons Attribution-ShareAlike 3.0 Unported License"),t("OutboundLink")],1),e._v(". It is based on the Linux "),t("a",{attrs:{href:"http://elinux.org/Developer_Certificate_Of_Origin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Developer Certificate Of Origin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("To accept the DCO it is required to put a x between [ ] on "),t("code",[e._v("[ ] I accept the DCO")]),e._v(" in the PR template when submitting it. The [ ] is an opt-in box, so you have to manually accept it.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/53.0b6e49eb.js b/dev/assets/js/53.3adb747e.js similarity index 98% rename from dev/assets/js/53.0b6e49eb.js rename to dev/assets/js/53.3adb747e.js index 395994a6..6edd426f 100644 --- a/dev/assets/js/53.0b6e49eb.js +++ b/dev/assets/js/53.3adb747e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{438:function(e,t,a){"use strict";a.r(t);var n=a(14),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"boards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boards"}},[e._v("#")]),e._v(" Boards")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is not closed to one board or type of board, by using the power of the Arduino framework and libraries that are cross compatibles it let you many choice of hardware, from an ESP8266 to an ESP32.")]),e._v(" "),t("p",[e._v("You can take a look to the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenMQTTGateway compatible website"),t("OutboundLink")],1),e._v(" to have a view of the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("supported boards"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Moreover the gateways capacities can be extended with sensors; DHT, HC SR501, ADC, I2C bus, INA226, MQ2, TEMT6000, TSL2561, BME280/BMP280, HTU21D, AHTx0, DS1820\nor actuators; LED, relays, PWM.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Running on a computer")]),e._v(" "),t("p",[e._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a Raspberry Pi, Windows or Unix PC you can use "),t("a",{attrs:{href:"https://gateway.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Running on a tablet or phone")]),e._v(" "),t("p",[e._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use "),t("a",{attrs:{href:"https://app.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs App"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerful BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"/img/Theengs-Bridge-ble-gateway.png",alt:"Theengs bridge view"}})])]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" is available flashed with OpenMQTTGateway, and brings the functions below:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of Bluetooth devices supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"/img/Theengs-Plug-OpenMQTTGateway.png",alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v("\nThe plug is available in North America only, other regions are planned.")]),e._v(" "),t("p",[e._v("Choosing your board depends heavily on the technologies you want to use with it.\nTo have a good overview of the compatibilities per board you can refer to the compatible modules attributes of each "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("board"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("The choice between these boards will depend on your knowledge and your requirements in terms of reliability, situation, modules wanted and devices you already have. The table below present those (auto-generated)")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{436:function(e,t,a){"use strict";a.r(t);var n=a(14),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"boards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boards"}},[e._v("#")]),e._v(" Boards")]),e._v(" "),t("p",[e._v("OpenMQTTGateway is not closed to one board or type of board, by using the power of the Arduino framework and libraries that are cross compatibles it let you many choice of hardware, from an ESP8266 to an ESP32.")]),e._v(" "),t("p",[e._v("You can take a look to the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenMQTTGateway compatible website"),t("OutboundLink")],1),e._v(" to have a view of the "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("supported boards"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Moreover the gateways capacities can be extended with sensors; DHT, HC SR501, ADC, I2C bus, INA226, MQ2, TEMT6000, TSL2561, BME280/BMP280, HTU21D, AHTx0, DS1820\nor actuators; LED, relays, PWM.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Running on a computer")]),e._v(" "),t("p",[e._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a Raspberry Pi, Windows or Unix PC you can use "),t("a",{attrs:{href:"https://gateway.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs Gateway"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Running on a tablet or phone")]),e._v(" "),t("p",[e._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use "),t("a",{attrs:{href:"https://app.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs App"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" is a powerful BLE to MQTT gateway for over "),t("a",{attrs:{href:"https://decoder.theengs.io/devices/devices.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("100 sensors"),t("OutboundLink")],1),e._v(". Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"/img/Theengs-Bridge-ble-gateway.png",alt:"Theengs bridge view"}})])]),e._v(" "),t("p",[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v(" is available flashed with OpenMQTTGateway, and brings the functions below:")]),e._v(" "),t("ul",[t("li",[e._v("BLE to MQTT gateway, tens of Bluetooth devices supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,")]),e._v(" "),t("li",[e._v("Smart plug that can be controlled remotely,")]),e._v(" "),t("li",[e._v("Energy consumption monitoring,")]),e._v(" "),t("li",[e._v("Device tracker,")]),e._v(" "),t("li",[e._v("Presence detection (beta),")]),e._v(" "),t("li",[e._v("Local connectivity first.")])]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[t("img",{staticStyle:{"max-width":"100%",height:"auto"},attrs:{src:"/img/Theengs-Plug-OpenMQTTGateway.png",alt:"Theengs plug view"}})])]),e._v(" "),t("p",[e._v("Support the project by purchasing the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs bridge"),t("OutboundLink")],1),e._v(" or the "),t("a",{attrs:{href:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_blank",rel:"noopener noreferrer"}},[e._v("Theengs plug"),t("OutboundLink")],1),e._v("\nThe plug is available in North America only, other regions are planned.")]),e._v(" "),t("p",[e._v("Choosing your board depends heavily on the technologies you want to use with it.\nTo have a good overview of the compatibilities per board you can refer to the compatible modules attributes of each "),t("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/boards/",target:"_blank",rel:"noopener noreferrer"}},[e._v("board"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("The choice between these boards will depend on your knowledge and your requirements in terms of reliability, situation, modules wanted and devices you already have. The table below present those (auto-generated)")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/55.a83c3bcc.js b/dev/assets/js/55.502699e0.js similarity index 98% rename from dev/assets/js/55.a83c3bcc.js rename to dev/assets/js/55.502699e0.js index 79580453..facfe924 100644 --- a/dev/assets/js/55.a83c3bcc.js +++ b/dev/assets/js/55.502699e0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{441:function(t,e,a){"use strict";a.r(e);var n=a(14),r=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parts"}},[t._v("#")]),t._v(" Parts")]),t._v(" "),e("p",[t._v("Depending on the gateway you would like to setup and your board, you may need extra parts/module to add.")]),t._v(" "),e("p",[t._v("You can take a look to the "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenMQTTGateway compatible website"),e("OutboundLink")],1),t._v(" to have a view of the "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts/",target:"_blank",rel:"noopener noreferrer"}},[t._v("supported parts"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("Here is below the main parts reference.")]),t._v(" "),e("h2",{attrs:{id:"main-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#main-parts"}},[t._v("#")]),t._v(" Main parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Parts")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("RF")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("IR")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("BLE")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("LoRa")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("GSM")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("SRX882 / STX882")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("CC1101")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("38KHz IR emitter and receiver")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("SX1276 / SX1278")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("A6/A7")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("There is a wide range of parts available that may be compatible with OpenMQTTGateway, the ones "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts/",target:"_blank",rel:"noopener noreferrer"}},[t._v("listed"),e("OutboundLink")],1),t._v(" are the ones tested and for which you can ask for support. Indeed for other parts we may not have it so as to reproduce the issue, or in the worst case they may not be compatible.")])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{440:function(t,e,a){"use strict";a.r(e);var n=a(14),r=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parts"}},[t._v("#")]),t._v(" Parts")]),t._v(" "),e("p",[t._v("Depending on the gateway you would like to setup and your board, you may need extra parts/module to add.")]),t._v(" "),e("p",[t._v("You can take a look to the "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenMQTTGateway compatible website"),e("OutboundLink")],1),t._v(" to have a view of the "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts/",target:"_blank",rel:"noopener noreferrer"}},[t._v("supported parts"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("Here is below the main parts reference.")]),t._v(" "),e("h2",{attrs:{id:"main-parts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#main-parts"}},[t._v("#")]),t._v(" Main parts")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Parts")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("RF")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("IR")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("BLE")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("LoRa")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("GSM")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("SRX882 / STX882")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("CC1101")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("38KHz IR emitter and receiver")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("SX1276 / SX1278")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("A6/A7")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("X")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("There is a wide range of parts available that may be compatible with OpenMQTTGateway, the ones "),e("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts/",target:"_blank",rel:"noopener noreferrer"}},[t._v("listed"),e("OutboundLink")],1),t._v(" are the ones tested and for which you can ask for support. Indeed for other parts we may not have it so as to reproduce the issue, or in the worst case they may not be compatible.")])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/56.64c3f900.js b/dev/assets/js/56.1fe4be81.js similarity index 97% rename from dev/assets/js/56.64c3f900.js rename to dev/assets/js/56.1fe4be81.js index 208eddd2..b6842612 100644 --- a/dev/assets/js/56.64c3f900.js +++ b/dev/assets/js/56.1fe4be81.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{442:function(t,r,e){"use strict";e.r(r);var a=e(14),o=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"actuators"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#actuators"}},[t._v("#")]),t._v(" Actuators")]),t._v(" "),r("h2",{attrs:{id:"compatible-parts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Module")]),t._v(" "),r("th",[t._v("Purpose")]),t._v(" "),r("th",[t._v("Where to Buy")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("LED")]),t._v(" "),r("td",[t._v("Basic led")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("FASTLED")]),t._v(" "),r("td",[t._v("RGB Leds management")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("BUZZER")]),t._v(" "),r("td",[t._v("-")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("RELAY")]),t._v(" "),r("td",[t._v("Switch power circuit")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])])])]),t._v(" "),r("h2",{attrs:{id:"pinout"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pinout"}},[t._v("#")]),t._v(" Pinout")]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Module")]),t._v(" "),r("th",[t._v("Boards")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("RELAY")]),t._v(" "),r("td",[t._v("all output compatible pins")])]),t._v(" "),r("tr",[r("td",[t._v("FASTLED")]),t._v(" "),r("td",[t._v("all output compatible pins")])])])]),t._v(" "),r("p",[t._v("Vcc pin of the board and the Module to a 5V supply source\nGround pins of the board and the Module to the ground of the supply source.")]),t._v(" "),r("h2",{attrs:{id:"somfy-rts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#somfy-rts"}},[t._v("#")]),t._v(" Somfy RTS")]),t._v(" "),r("p",[t._v("For this actuator a 433.42 MHz RF transmitter is required.\nThe standard 433.92 MHz transmitter don't work.\nThe CC1101 Transceiver supports both 433.42 MHz and 433.92 MHz and can be used with the Somfy RTS actor.\nThe wiring of the hardware is described in the "),r("a",{attrs:{href:"rf"}},[t._v("RF gateway")]),t._v(".")])])}),[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{441:function(t,r,e){"use strict";e.r(r);var a=e(14),o=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"actuators"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#actuators"}},[t._v("#")]),t._v(" Actuators")]),t._v(" "),r("h2",{attrs:{id:"compatible-parts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Module")]),t._v(" "),r("th",[t._v("Purpose")]),t._v(" "),r("th",[t._v("Where to Buy")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("LED")]),t._v(" "),r("td",[t._v("Basic led")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("FASTLED")]),t._v(" "),r("td",[t._v("RGB Leds management")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("BUZZER")]),t._v(" "),r("td",[t._v("-")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])]),t._v(" "),r("tr",[r("td",[t._v("RELAY")]),t._v(" "),r("td",[t._v("Switch power circuit")]),t._v(" "),r("td",[r("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("parts list"),r("OutboundLink")],1)])])])]),t._v(" "),r("h2",{attrs:{id:"pinout"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pinout"}},[t._v("#")]),t._v(" Pinout")]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Module")]),t._v(" "),r("th",[t._v("Boards")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("RELAY")]),t._v(" "),r("td",[t._v("all output compatible pins")])]),t._v(" "),r("tr",[r("td",[t._v("FASTLED")]),t._v(" "),r("td",[t._v("all output compatible pins")])])])]),t._v(" "),r("p",[t._v("Vcc pin of the board and the Module to a 5V supply source\nGround pins of the board and the Module to the ground of the supply source.")]),t._v(" "),r("h2",{attrs:{id:"somfy-rts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#somfy-rts"}},[t._v("#")]),t._v(" Somfy RTS")]),t._v(" "),r("p",[t._v("For this actuator a 433.42 MHz RF transmitter is required.\nThe standard 433.92 MHz transmitter don't work.\nThe CC1101 Transceiver supports both 433.42 MHz and 433.92 MHz and can be used with the Somfy RTS actor.\nThe wiring of the hardware is described in the "),r("a",{attrs:{href:"rf"}},[t._v("RF gateway")]),t._v(".")])])}),[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/57.bbcbc292.js b/dev/assets/js/57.0ce2876c.js similarity index 93% rename from dev/assets/js/57.bbcbc292.js rename to dev/assets/js/57.0ce2876c.js index 8a7a5103..c9818ed9 100644 --- a/dev/assets/js/57.bbcbc292.js +++ b/dev/assets/js/57.0ce2876c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{446:function(t,a,e){"use strict";e.r(a);var r=e(14),o=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"lora-gateway"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lora-gateway"}},[t._v("#")]),t._v(" LoRa gateway")]),t._v(" "),a("h2",{attrs:{id:"compatible-parts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),a("p",[t._v("An ESP32 board with a LoRa module.\nIdeally a TTGO board with LoRa module included see "),a("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),a("OutboundLink")],1)]),t._v(" "),a("p",[t._v("With this kind of board there is no hardware modification needed.")])])}),[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{448:function(t,a,e){"use strict";e.r(a);var r=e(14),o=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"lora-gateway"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lora-gateway"}},[t._v("#")]),t._v(" LoRa gateway")]),t._v(" "),a("h2",{attrs:{id:"compatible-parts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#compatible-parts"}},[t._v("#")]),t._v(" Compatible parts")]),t._v(" "),a("p",[t._v("An ESP32 board with a LoRa module.\nIdeally a TTGO board with LoRa module included see "),a("a",{attrs:{href:"https://compatible.openmqttgateway.com/index.php/parts",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible parts list"),a("OutboundLink")],1)]),t._v(" "),a("p",[t._v("With this kind of board there is no hardware modification needed.")])])}),[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/60.7e3979c2.js b/dev/assets/js/60.8c063eb3.js similarity index 99% rename from dev/assets/js/60.7e3979c2.js rename to dev/assets/js/60.8c063eb3.js index 33a91194..d82026db 100644 --- a/dev/assets/js/60.7e3979c2.js +++ b/dev/assets/js/60.8c063eb3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{455:function(e,t,o){"use strict";o.r(t);var r=o(14),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("h2",{attrs:{id:"compilation-build-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#compilation-build-error"}},[e._v("#")]),e._v(" Compilation/build error")]),e._v(" "),t("p",[e._v("This badge "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Amaster+workflow%3ABuild",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=master",alt:"Build Status"}}),t("OutboundLink")],1),e._v(" show you the state of the compilation of the master and this one "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Adevelopment+workflow%3ABuild",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=development",alt:"Build Status"}}),t("OutboundLink")],1),e._v(" for the development branch.\nIf you see a green badge this means that the code compilation is OK with the configuration given in the "),t("code",[e._v("docs/platformio.ini")]),e._v(".\nCheck your environment, boards , libraries before submitting an issue or a question.")]),e._v(" "),t("h2",{attrs:{id:"esp32-compilation-errors-related-to-wifi"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp32-compilation-errors-related-to-wifi"}},[e._v("#")]),e._v(" ESP32 compilation errors related to WiFi")]),e._v(" "),t("p",[e._v("If you get one or several of the following errors:")]),e._v(" "),t("p",[t("code",[e._v("error: 'WIFI_STA' was not declared in this scope")])]),e._v(" "),t("p",[t("code",[e._v("error: 'class WiFiClass' has no member named 'mode'")])]),e._v(" "),t("p",[t("code",[e._v("error: no matching function for call to 'WiFiClass::macAddress()")])]),e._v(" "),t("p",[e._v("You have a conflict between Arduino default WiFi library and ESP32 one. So as to resolve this issue you should move or remove the Arduino WiFi library (Arduino Sketchbook folder\\libraries\\WiFi) in order to enable the IDE to take the one from ESP32 (Arduino Sketchbook folder\\hardware\\espressif\\arduino-esp32\\libraries\\WiFi)\nMore info on "),t("a",{attrs:{href:"https://community.openmqttgateway.com/t/esp32-compilation-error/144/5?u=1technophile",target:"_blank",rel:"noopener noreferrer"}},[e._v("this topic"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"not-able-to-send-or-receive-rf-or-ir"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#not-able-to-send-or-receive-rf-or-ir"}},[e._v("#")]),e._v(" Not able to send or receive RF or IR")]),e._v(" "),t("p",[e._v("→ Verify your power supply voltage with a multimeter, it should be 5V (can be 12V for FS1000A emitter), please note that on NodeMCU V3 the Vin does not supply 5V contrary to NodeMCU V1")]),e._v(" "),t("p",[e._v("→ Verify your wiring")]),e._v(" "),t("p",[e._v("→ To eliminate issues of OpenMQTTGateway or you home controller try uploading basic examples from the libraries directly (like "),t("a",{attrs:{href:"https://github.com/sui77/rc-switch/tree/master/examples/SendDemo",target:"_blank",rel:"noopener noreferrer"}},[e._v("SendDemo"),t("OutboundLink")],1),e._v(" for RF or IRSendDemo for IR) and execute them. If it doesn't work this means that you have mostly an issue related with your hardware or due to IDE/library version used.")]),e._v(" "),t("p",[e._v("Regarding the IR led emitter you can replace it with a normal led and see if it lights up when you send an MQTT command")]),e._v(" "),t("p",[e._v("→ If you are only unable to receive RF on nodemcu (or if it only works when a serial connection is active):")]),e._v(" "),t("p",[e._v("try with D2 instead of D3\nand put\n"),t("code",[e._v("#define RF_RECEIVER_GPIO 4 // D2 on nodemcu")]),e._v("\nin config_rf.h\ninstead of\n"),t("code",[e._v("#define RF_RECEIVER_GPIO 0 // D3 on nodemcu")])]),e._v(" "),t("h2",{attrs:{id:"repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"}},[e._v("#")]),e._v(" Repetitive MQTT disconnections or/and commands sent to the gateway not taken into account")]),e._v(" "),t("p",[e._v("Most probably a network issue, don't use a guest network and if going through a firewall check its rules. To put aside gateway issue, try to connect to a local broker on the same network.")]),e._v(" "),t("h2",{attrs:{id:"omg-ignores-messages-sent-to-it-via-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#omg-ignores-messages-sent-to-it-via-mqtt"}},[e._v("#")]),e._v(" OMG ignores messages sent to it via MQTT")]),e._v(" "),t("p",[e._v("This can happen if the messages are too big and exceed the internal buffer size limit. To fix this, check the size of the message you're sending (in bytes). Next, open "),t("code",[e._v("User_config.h")]),e._v(" and set "),t("code",[e._v("mqtt_max_payload_size")]),e._v(" to be greater than that size, e.g.:\n"),t("code",[e._v("#define mqtt_max_payload_size 1024")])]),e._v(" "),t("h2",{attrs:{id:"esp-continuous-restart-or-strange-behaviour"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp-continuous-restart-or-strange-behaviour"}},[e._v("#")]),e._v(" ESP Continuous restart or strange behaviour:")]),e._v(" "),t("p",[e._v("This can be due to corruption of the ESP flash memory, try to erase flash and upload OMG on it again.")]),e._v(" "),t("p",[e._v("If you didn't find your answer here post a question to the forum:\n"),t("a",{attrs:{href:"https://community.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/badge/community-forum-brightgreen.svg",alt:"Community forum"}}),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"esp-does-not-connect-to-broker-with-tls-enabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp-does-not-connect-to-broker-with-tls-enabled"}},[e._v("#")]),e._v(" ESP does not connect to broker with TLS enabled")]),e._v(" "),t("p",[e._v("If you get the following error:\n"),t("code",[e._v("W: failed, ssl error code=54")]),e._v(' ("Certificate is expired or not yet valid.")')]),e._v(" "),t("p",[e._v("This is most probable caused by the time of the esp is not correct/synchronized.\nThe esp uses the Network Time Protocol (NTP) to get the current time from a time server.\nIf you get this error ntp is not configured correctly in the gateway.\nUncomment "),t("code",[e._v('//# define NTP_SERVER "pool.ntp.org"')]),e._v(" to set the "),t("code",[e._v("pool.ntp.org")]),e._v(" as the time server.\nYou can also choose any other ntp time server you like.")]),e._v(" "),t("p",[e._v("It is normal that the time synchronization process takes some time and the MQTT connection will not be successful the first time.\nIf you set the ntp server for the gateway and keep getting the errors you should check your certificate validity duration.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{454:function(e,t,o){"use strict";o.r(t);var r=o(14),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("h2",{attrs:{id:"compilation-build-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#compilation-build-error"}},[e._v("#")]),e._v(" Compilation/build error")]),e._v(" "),t("p",[e._v("This badge "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Amaster+workflow%3ABuild",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=master",alt:"Build Status"}}),t("OutboundLink")],1),e._v(" show you the state of the compilation of the master and this one "),t("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Adevelopment+workflow%3ABuild",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=development",alt:"Build Status"}}),t("OutboundLink")],1),e._v(" for the development branch.\nIf you see a green badge this means that the code compilation is OK with the configuration given in the "),t("code",[e._v("docs/platformio.ini")]),e._v(".\nCheck your environment, boards , libraries before submitting an issue or a question.")]),e._v(" "),t("h2",{attrs:{id:"esp32-compilation-errors-related-to-wifi"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp32-compilation-errors-related-to-wifi"}},[e._v("#")]),e._v(" ESP32 compilation errors related to WiFi")]),e._v(" "),t("p",[e._v("If you get one or several of the following errors:")]),e._v(" "),t("p",[t("code",[e._v("error: 'WIFI_STA' was not declared in this scope")])]),e._v(" "),t("p",[t("code",[e._v("error: 'class WiFiClass' has no member named 'mode'")])]),e._v(" "),t("p",[t("code",[e._v("error: no matching function for call to 'WiFiClass::macAddress()")])]),e._v(" "),t("p",[e._v("You have a conflict between Arduino default WiFi library and ESP32 one. So as to resolve this issue you should move or remove the Arduino WiFi library (Arduino Sketchbook folder\\libraries\\WiFi) in order to enable the IDE to take the one from ESP32 (Arduino Sketchbook folder\\hardware\\espressif\\arduino-esp32\\libraries\\WiFi)\nMore info on "),t("a",{attrs:{href:"https://community.openmqttgateway.com/t/esp32-compilation-error/144/5?u=1technophile",target:"_blank",rel:"noopener noreferrer"}},[e._v("this topic"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"not-able-to-send-or-receive-rf-or-ir"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#not-able-to-send-or-receive-rf-or-ir"}},[e._v("#")]),e._v(" Not able to send or receive RF or IR")]),e._v(" "),t("p",[e._v("→ Verify your power supply voltage with a multimeter, it should be 5V (can be 12V for FS1000A emitter), please note that on NodeMCU V3 the Vin does not supply 5V contrary to NodeMCU V1")]),e._v(" "),t("p",[e._v("→ Verify your wiring")]),e._v(" "),t("p",[e._v("→ To eliminate issues of OpenMQTTGateway or you home controller try uploading basic examples from the libraries directly (like "),t("a",{attrs:{href:"https://github.com/sui77/rc-switch/tree/master/examples/SendDemo",target:"_blank",rel:"noopener noreferrer"}},[e._v("SendDemo"),t("OutboundLink")],1),e._v(" for RF or IRSendDemo for IR) and execute them. If it doesn't work this means that you have mostly an issue related with your hardware or due to IDE/library version used.")]),e._v(" "),t("p",[e._v("Regarding the IR led emitter you can replace it with a normal led and see if it lights up when you send an MQTT command")]),e._v(" "),t("p",[e._v("→ If you are only unable to receive RF on nodemcu (or if it only works when a serial connection is active):")]),e._v(" "),t("p",[e._v("try with D2 instead of D3\nand put\n"),t("code",[e._v("#define RF_RECEIVER_GPIO 4 // D2 on nodemcu")]),e._v("\nin config_rf.h\ninstead of\n"),t("code",[e._v("#define RF_RECEIVER_GPIO 0 // D3 on nodemcu")])]),e._v(" "),t("h2",{attrs:{id:"repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"}},[e._v("#")]),e._v(" Repetitive MQTT disconnections or/and commands sent to the gateway not taken into account")]),e._v(" "),t("p",[e._v("Most probably a network issue, don't use a guest network and if going through a firewall check its rules. To put aside gateway issue, try to connect to a local broker on the same network.")]),e._v(" "),t("h2",{attrs:{id:"omg-ignores-messages-sent-to-it-via-mqtt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#omg-ignores-messages-sent-to-it-via-mqtt"}},[e._v("#")]),e._v(" OMG ignores messages sent to it via MQTT")]),e._v(" "),t("p",[e._v("This can happen if the messages are too big and exceed the internal buffer size limit. To fix this, check the size of the message you're sending (in bytes). Next, open "),t("code",[e._v("User_config.h")]),e._v(" and set "),t("code",[e._v("mqtt_max_payload_size")]),e._v(" to be greater than that size, e.g.:\n"),t("code",[e._v("#define mqtt_max_payload_size 1024")])]),e._v(" "),t("h2",{attrs:{id:"esp-continuous-restart-or-strange-behaviour"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp-continuous-restart-or-strange-behaviour"}},[e._v("#")]),e._v(" ESP Continuous restart or strange behaviour:")]),e._v(" "),t("p",[e._v("This can be due to corruption of the ESP flash memory, try to erase flash and upload OMG on it again.")]),e._v(" "),t("p",[e._v("If you didn't find your answer here post a question to the forum:\n"),t("a",{attrs:{href:"https://community.openmqttgateway.com",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/badge/community-forum-brightgreen.svg",alt:"Community forum"}}),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"esp-does-not-connect-to-broker-with-tls-enabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#esp-does-not-connect-to-broker-with-tls-enabled"}},[e._v("#")]),e._v(" ESP does not connect to broker with TLS enabled")]),e._v(" "),t("p",[e._v("If you get the following error:\n"),t("code",[e._v("W: failed, ssl error code=54")]),e._v(' ("Certificate is expired or not yet valid.")')]),e._v(" "),t("p",[e._v("This is most probable caused by the time of the esp is not correct/synchronized.\nThe esp uses the Network Time Protocol (NTP) to get the current time from a time server.\nIf you get this error ntp is not configured correctly in the gateway.\nUncomment "),t("code",[e._v('//# define NTP_SERVER "pool.ntp.org"')]),e._v(" to set the "),t("code",[e._v("pool.ntp.org")]),e._v(" as the time server.\nYou can also choose any other ntp time server you like.")]),e._v(" "),t("p",[e._v("It is normal that the time synchronization process takes some time and the MQTT connection will not be successful the first time.\nIf you set the ntp server for the gateway and keep getting the errors you should check your certificate validity duration.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/61.5d8381b6.js b/dev/assets/js/61.1c13d9ac.js similarity index 98% rename from dev/assets/js/61.5d8381b6.js rename to dev/assets/js/61.1c13d9ac.js index 10d60302..eeaf5d82 100644 --- a/dev/assets/js/61.5d8381b6.js +++ b/dev/assets/js/61.1c13d9ac.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{459:function(t,e,o){"use strict";o.r(e);var r=o(14),a=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"option-1-upload-from-the-web"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-1-upload-from-the-web"}},[t._v("#")]),t._v(" (Option 1) Upload from the web")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Running on a tablet or phone")]),t._v(" "),e("p",[t._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use "),e("a",{attrs:{href:"https://app.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Theengs App"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If you are on macOS and have a LilyGo LoRa32 V2.1 board, make sure you have the "),e("a",{attrs:{href:"https://github.com/WCHSoftGroup/ch34xser_macos",target:"_blank",rel:"noopener noreferrer"}},[t._v("correct driver for the CH9102 Serial Chip"),e("OutboundLink")],1),t._v(" installed and selected in the popup when initiating the web install.\nTo finalise the driver installation don't forget the confirmation in the "),e("strong",[t._v("Security")]),t._v(" section of "),e("strong",[t._v("System Preferences")]),t._v(" after the restart.\nThe correct driver to then select in the popup of this web install is\n"),e("code",[t._v("/dev/cu.wchusbserialXXXXXXXXXXX")])])]),t._v(" "),e("p",[t._v("You can upload the firmware to your ESP device directly from here.")]),t._v(" "),e("ol",[e("li",[t._v("Plug in your ESP to a USB port.")]),t._v(" "),e("li",[t._v("Select the firmware in the box below.")]),t._v(" "),e("li",[t._v("Click the install button and choose the port that the ESP is connected to.")]),t._v(" "),e("li",[t._v("Wait until the process is complete.")]),t._v(" "),e("li",[t._v("Once completed you can configure your "),e("RouterLink",{attrs:{to:"/upload/portal.html"}},[t._v("WiFi and MQTT credentials")])],1)]),t._v(" "),e("web-uploader"),t._v(" "),e("p",[t._v("Upload powered by "),e("a",{attrs:{href:"https://esphome.github.io/esp-web-tools/",target:"_blank",rel:"noopener noreferrer"}},[t._v("ESP Web Tools"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"using-openmqttgateway"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#using-openmqttgateway"}},[t._v("#")]),t._v(" Using OpenMQTTGateway ?")]),t._v(" "),e("p",[t._v("Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests will receive priority attention, plus you'll gain insider access to our roadmap.")]),t._v(" "),e("div",{staticStyle:{"text-align":"center"}},[e("iframe",{staticStyle:{border:"0","border-radius":"6px"},attrs:{src:"https://github.com/sponsors/theengs/button",title:"Sponsor Theengs",height:"32",width:"228"}})]),t._v(" "),e("h2",{attrs:{id:"environments-characteristics"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#environments-characteristics"}},[t._v("#")]),t._v(" Environments characteristics")]),t._v(" "),e("p",[t._v("The auto-generated table below describes the libraries and the modules of each board configuration.")])],1)}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{455:function(t,e,o){"use strict";o.r(e);var r=o(14),a=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"option-1-upload-from-the-web"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-1-upload-from-the-web"}},[t._v("#")]),t._v(" (Option 1) Upload from the web")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Running on a tablet or phone")]),t._v(" "),e("p",[t._v("If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use "),e("a",{attrs:{href:"https://app.theengs.io/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Theengs App"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If you are on macOS and have a LilyGo LoRa32 V2.1 board, make sure you have the "),e("a",{attrs:{href:"https://github.com/WCHSoftGroup/ch34xser_macos",target:"_blank",rel:"noopener noreferrer"}},[t._v("correct driver for the CH9102 Serial Chip"),e("OutboundLink")],1),t._v(" installed and selected in the popup when initiating the web install.\nTo finalise the driver installation don't forget the confirmation in the "),e("strong",[t._v("Security")]),t._v(" section of "),e("strong",[t._v("System Preferences")]),t._v(" after the restart.\nThe correct driver to then select in the popup of this web install is\n"),e("code",[t._v("/dev/cu.wchusbserialXXXXXXXXXXX")])])]),t._v(" "),e("p",[t._v("You can upload the firmware to your ESP device directly from here.")]),t._v(" "),e("ol",[e("li",[t._v("Plug in your ESP to a USB port.")]),t._v(" "),e("li",[t._v("Select the firmware in the box below.")]),t._v(" "),e("li",[t._v("Click the install button and choose the port that the ESP is connected to.")]),t._v(" "),e("li",[t._v("Wait until the process is complete.")]),t._v(" "),e("li",[t._v("Once completed you can configure your "),e("RouterLink",{attrs:{to:"/upload/portal.html"}},[t._v("WiFi and MQTT credentials")])],1)]),t._v(" "),e("web-uploader"),t._v(" "),e("p",[t._v("Upload powered by "),e("a",{attrs:{href:"https://esphome.github.io/esp-web-tools/",target:"_blank",rel:"noopener noreferrer"}},[t._v("ESP Web Tools"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"using-openmqttgateway"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#using-openmqttgateway"}},[t._v("#")]),t._v(" Using OpenMQTTGateway ?")]),t._v(" "),e("p",[t._v("Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests will receive priority attention, plus you'll gain insider access to our roadmap.")]),t._v(" "),e("div",{staticStyle:{"text-align":"center"}},[e("iframe",{staticStyle:{border:"0","border-radius":"6px"},attrs:{src:"https://github.com/sponsors/theengs/button",title:"Sponsor Theengs",height:"32",width:"228"}})]),t._v(" "),e("h2",{attrs:{id:"environments-characteristics"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#environments-characteristics"}},[t._v("#")]),t._v(" Environments characteristics")]),t._v(" "),e("p",[t._v("The auto-generated table below describes the libraries and the modules of each board configuration.")])],1)}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/63.118c24b3.js b/dev/assets/js/63.2baa5b5a.js similarity index 99% rename from dev/assets/js/63.118c24b3.js rename to dev/assets/js/63.2baa5b5a.js index 927ce49d..25701af1 100644 --- a/dev/assets/js/63.118c24b3.js +++ b/dev/assets/js/63.2baa5b5a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{460:function(e,t,a){"use strict";a.r(t);var s=a(14),i=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"displays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#displays"}},[e._v("#")]),e._v(" Displays")]),e._v(" "),t("h2",{attrs:{id:"ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"}},[e._v("#")]),e._v(" SSD1306 Display (Heltec SX127X, LILYGO® LoRa32 boards, generic SSD1306 displays)")]),e._v(" "),t("p",[e._v("Several options are available for the display of information on the SSD1306 display. Some options are exclusive to each other, and when a different option is enabled, the current option is disabled.")]),e._v(" "),t("p",[e._v("The current SSD1306 display states are being published to the "),t("code",[e._v("SSD1306toMQTT")]),e._v(" topic, e.g.")]),e._v(" "),t("p",[t("code",[e._v('{"onstate":true,"brightness":50,"display-flip":true,"idlelogo":true,"log-oled":false,"json-oled":true}')])]),e._v(" "),t("h3",{attrs:{id:"display-on-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#display-on-off"}},[e._v("#")]),e._v(" Display ON/OFF")]),e._v(" "),t("p",[e._v("To turn the SSD1306 display on or off.")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DDISPLAY_STATE=true")]),e._v(".")]),e._v(" "),t("p",[e._v("MQTT Display OFF command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"onstate":false}')])]),e._v(" "),t("p",[e._v("MQTT Display ON command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"onstate":true}')])]),e._v(" "),t("h4",{attrs:{id:"usage-of-a-touch-gpio-display-blanking"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage-of-a-touch-gpio-display-blanking"}},[e._v("#")]),e._v(" Usage of a touch GPIO display blanking")]),e._v(" "),t("p",[e._v("Support can be enabled to use a GPIO pin as a simple touch sensor to enable the display. When enabled, the display will blank after 30 seconds, and when GPIO 2 is touched, the display will enable for 30 seconds. For testing a wire was connected to the GPIO pin.")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DDISPLAY_BLANKING=true")])]),e._v(" "),t("p",[e._v("Blanking Compiler Directives")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Directive")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("DISPLAY_BLANKING")]),e._v(" "),t("td",[e._v("false")]),e._v(" "),t("td",[e._v("Enables touch based display blanking")])]),e._v(" "),t("tr",[t("td",[e._v("DISPLAY_BLANKING_TOUCH_GPIO")]),e._v(" "),t("td",[e._v("2")]),e._v(" "),t("td",[e._v("GPIO pin to use the touch. Must be a touch supported GPIO pin")])]),e._v(" "),t("tr",[t("td",[e._v("DISPLAY_BLANKING_START")]),e._v(" "),t("td",[e._v("30")]),e._v(" "),t("td",[e._v("Seconds to wait before disabling the display")])])])]),e._v(" "),t("h3",{attrs:{id:"brightness"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#brightness"}},[e._v("#")]),e._v(" Brightness")]),e._v(" "),t("p",[e._v("The display brightness can be set between 0-100%.")]),e._v(" "),t("p",[e._v("It is recommended to set a value lower than 100 to extend the life of the OLED display. The default setting is 50.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_BRIGHTNESS=50")]),e._v(".")]),e._v(" "),t("p",[e._v("or with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"brightness":50}')])]),e._v(" "),t("h3",{attrs:{id:"metric-or-imperial-property-units"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metric-or-imperial-property-units"}},[e._v("#")]),e._v(" Metric or Imperial property units")]),e._v(" "),t("p",[e._v("To have applicable device properties displayed in Imperial units, e.g. °F for temperature.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_METRIC=false")]),e._v(".")]),e._v(" "),t("p",[e._v("As the display Metric setting is being defined in the WebUI part of OpenMQTTGateway changes need to be sent there with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoWebUI/config -m {"displayMetric":false}')])]),e._v(" "),t("h3",{attrs:{id:"rotating-the-display-by-180-degrees"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rotating-the-display-by-180-degrees"}},[e._v("#")]),e._v(" Rotating the display by 180 degrees")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_FLIP=false")]),e._v(".")]),e._v(" "),t("p",[e._v("or with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"display-flip":false}')])]),e._v(" "),t("h3",{attrs:{id:"display-idle-logo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#display-idle-logo"}},[e._v("#")]),e._v(" Display idle Logo")]),e._v(" "),t("p",[e._v("To display the OpenMQTTGateway logo during device display idle time. This reduces the likelihood of burn-in.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_IDLE_LOGO=true")]),e._v(".")]),e._v(" "),t("p",[e._v("or at runtime with")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"idlelogo":true}')])]),e._v(" "),t("h3",{attrs:{id:"setting-the-log-output"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-log-output"}},[e._v("#")]),e._v(" Setting the log output")]),e._v(" "),t("p",[e._v("The display of serial log messages to the display can be enabled via compiler directive "),t("code",[e._v("-DLOG_TO_OLED=true")]),e._v(" or via MQTT commands.")]),e._v(" "),t("p",[e._v("For example if you want to set the serial log to OLED")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"log-oled\":true}'")])]),e._v(" "),t("p",[e._v("you can also revert it back with")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"log-oled\":false}'")])]),e._v(" "),t("p",[e._v("The log level of the messages displayed is Errors and Warnings, and this can only be changed via the compiler directive "),t("code",[e._v("-DLOG_LEVEL_OLED=LOG_LEVEL_NOTICE")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"displaying-module-json-messages-default"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#displaying-module-json-messages-default"}},[e._v("#")]),e._v(" Displaying Module json messages (default)")]),e._v(" "),t("p",[e._v("The display of messages from various modules is also supported. Currently supported modules include "),t("code",[e._v("ZgatewayRTL_433")]),e._v(", "),t("code",[e._v("ZgatewayBT")]),e._v(" and "),t("code",[e._v("ZsensorBME280")]),e._v(".")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DJSON_TO_OLED=true")]),e._v(".")]),e._v(" "),t("p",[e._v("You can also change it by MQTT. For example if you want to display module json messages:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"json-oled\":true}'")])]),e._v(" "),t("p",[e._v("And to disable the display of module json messages:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"display-json\":false}'")])]),e._v(" "),t("h3",{attrs:{id:"store-the-current-display-configuration-in-the-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#store-the-current-display-configuration-in-the-gateway"}},[e._v("#")]),e._v(" Store the current display configuration in the gateway")]),e._v(" "),t("p",[e._v("To store the running display configuration into non-volatile storage on the gateway use the following command. This assures persistence across restarts.")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"save\":true}'")])]),e._v(" "),t("p",[e._v("At any time, you can reload the stored configuration with the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"load\":true}'")])]),e._v(" "),t("p",[e._v("If you want to erase the stored configuration, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"erase\":true}'")])]),e._v(" "),t("p",[e._v("Note that this will not change the running configuration, it only ensures that the default configuration is used at next startup.")]),e._v(" "),t("p",[e._v("If you want to load the default configuration use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"init\":true}'")])]),e._v(" "),t("p",[e._v("Note that this will not change the stored configuration, "),t("code",[e._v("erase")]),e._v(" or "),t("code",[e._v("save")]),e._v(" is still needed to overwrite the saved configuration.")]),e._v(" "),t("h3",{attrs:{id:"connecting-a-generic-ssd1306-display-to-esp32"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting-a-generic-ssd1306-display-to-esp32"}},[e._v("#")]),e._v(" Connecting a generic SSD1306 display to ESP32")]),e._v(" "),t("p",[e._v("It is possible to connect a generic SSD1306 display with resolution 128*64 to the hardware setups.\nThis example describes how to do it with the ESP32 board.")]),e._v(" "),t("ul",[t("li",[e._v("Connect the display to the ESP32 (display → ESP32):\n"),t("ul",[t("li",[e._v("VCC → 5V (or 3.3V, check your display documentation)")]),e._v(" "),t("li",[e._v("GND → GND")]),e._v(" "),t("li",[e._v("SCL → pin 22")]),e._v(" "),t("li",[e._v("SDA → pin 21")])])]),e._v(" "),t("li",[e._v("Modify the environment definition in "),t("code",[e._v("environments.ini")]),e._v(".\n"),t("ul",[t("li",[e._v("Add the display library:"),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("lib_deps =\n ${com-esp32.lib_deps}\n ...\n ${libraries.ssd1306}\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])])]),e._v(" "),t("li",[e._v("Add relevant build flags:"),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("build_flags =\n ${com-esp32.build_flags}\n ...\n; *** Generic SSD1306 OLED Options **\n '-DZdisplaySSD1306=\"GenericSSD1306\"'\n '-DOLED_SDA=21' ; SSD1306 pin SDA\n '-DOLED_SCL=22' ; SSD1306 pin SCL\n '-DGenericSSD1306=true'\n '-DJSON_TO_OLED=true'\n '-DDISPLAY_PAGE_INTERVAL=30'\n; '-DLOG_TO_OLED=true' ; Enable log to OLED\n; '-DLOG_LEVEL_OLED=LOG_LEVEL_NOTICE'\n; '-DDISPLAY_IDLE_LOGO=false'\n; '-DDISPLAY_BRIGHTNESS=80'\n; '-DDISPLAY_METRIC=false'\n; '-DDISPLAY_FLIP=false'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br")])])])])])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{462:function(e,t,a){"use strict";a.r(t);var s=a(14),i=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"displays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#displays"}},[e._v("#")]),e._v(" Displays")]),e._v(" "),t("h2",{attrs:{id:"ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"}},[e._v("#")]),e._v(" SSD1306 Display (Heltec SX127X, LILYGO® LoRa32 boards, generic SSD1306 displays)")]),e._v(" "),t("p",[e._v("Several options are available for the display of information on the SSD1306 display. Some options are exclusive to each other, and when a different option is enabled, the current option is disabled.")]),e._v(" "),t("p",[e._v("The current SSD1306 display states are being published to the "),t("code",[e._v("SSD1306toMQTT")]),e._v(" topic, e.g.")]),e._v(" "),t("p",[t("code",[e._v('{"onstate":true,"brightness":50,"display-flip":true,"idlelogo":true,"log-oled":false,"json-oled":true}')])]),e._v(" "),t("h3",{attrs:{id:"display-on-off"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#display-on-off"}},[e._v("#")]),e._v(" Display ON/OFF")]),e._v(" "),t("p",[e._v("To turn the SSD1306 display on or off.")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DDISPLAY_STATE=true")]),e._v(".")]),e._v(" "),t("p",[e._v("MQTT Display OFF command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"onstate":false}')])]),e._v(" "),t("p",[e._v("MQTT Display ON command:")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"onstate":true}')])]),e._v(" "),t("h4",{attrs:{id:"usage-of-a-touch-gpio-display-blanking"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage-of-a-touch-gpio-display-blanking"}},[e._v("#")]),e._v(" Usage of a touch GPIO display blanking")]),e._v(" "),t("p",[e._v("Support can be enabled to use a GPIO pin as a simple touch sensor to enable the display. When enabled, the display will blank after 30 seconds, and when GPIO 2 is touched, the display will enable for 30 seconds. For testing a wire was connected to the GPIO pin.")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DDISPLAY_BLANKING=true")])]),e._v(" "),t("p",[e._v("Blanking Compiler Directives")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Directive")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("DISPLAY_BLANKING")]),e._v(" "),t("td",[e._v("false")]),e._v(" "),t("td",[e._v("Enables touch based display blanking")])]),e._v(" "),t("tr",[t("td",[e._v("DISPLAY_BLANKING_TOUCH_GPIO")]),e._v(" "),t("td",[e._v("2")]),e._v(" "),t("td",[e._v("GPIO pin to use the touch. Must be a touch supported GPIO pin")])]),e._v(" "),t("tr",[t("td",[e._v("DISPLAY_BLANKING_START")]),e._v(" "),t("td",[e._v("30")]),e._v(" "),t("td",[e._v("Seconds to wait before disabling the display")])])])]),e._v(" "),t("h3",{attrs:{id:"brightness"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#brightness"}},[e._v("#")]),e._v(" Brightness")]),e._v(" "),t("p",[e._v("The display brightness can be set between 0-100%.")]),e._v(" "),t("p",[e._v("It is recommended to set a value lower than 100 to extend the life of the OLED display. The default setting is 50.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_BRIGHTNESS=50")]),e._v(".")]),e._v(" "),t("p",[e._v("or with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"brightness":50}')])]),e._v(" "),t("h3",{attrs:{id:"metric-or-imperial-property-units"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metric-or-imperial-property-units"}},[e._v("#")]),e._v(" Metric or Imperial property units")]),e._v(" "),t("p",[e._v("To have applicable device properties displayed in Imperial units, e.g. °F for temperature.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_METRIC=false")]),e._v(".")]),e._v(" "),t("p",[e._v("As the display Metric setting is being defined in the WebUI part of OpenMQTTGateway changes need to be sent there with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoWebUI/config -m {"displayMetric":false}')])]),e._v(" "),t("h3",{attrs:{id:"rotating-the-display-by-180-degrees"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rotating-the-display-by-180-degrees"}},[e._v("#")]),e._v(" Rotating the display by 180 degrees")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_FLIP=false")]),e._v(".")]),e._v(" "),t("p",[e._v("or with the runtime command")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"display-flip":false}')])]),e._v(" "),t("h3",{attrs:{id:"display-idle-logo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#display-idle-logo"}},[e._v("#")]),e._v(" Display idle Logo")]),e._v(" "),t("p",[e._v("To display the OpenMQTTGateway logo during device display idle time. This reduces the likelihood of burn-in.")]),e._v(" "),t("p",[e._v("This can be set with the compiler directive "),t("code",[e._v("-DDISPLAY_IDLE_LOGO=true")]),e._v(".")]),e._v(" "),t("p",[e._v("or at runtime with")]),e._v(" "),t("p",[t("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m {"idlelogo":true}')])]),e._v(" "),t("h3",{attrs:{id:"setting-the-log-output"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-the-log-output"}},[e._v("#")]),e._v(" Setting the log output")]),e._v(" "),t("p",[e._v("The display of serial log messages to the display can be enabled via compiler directive "),t("code",[e._v("-DLOG_TO_OLED=true")]),e._v(" or via MQTT commands.")]),e._v(" "),t("p",[e._v("For example if you want to set the serial log to OLED")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"log-oled\":true}'")])]),e._v(" "),t("p",[e._v("you can also revert it back with")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"log-oled\":false}'")])]),e._v(" "),t("p",[e._v("The log level of the messages displayed is Errors and Warnings, and this can only be changed via the compiler directive "),t("code",[e._v("-DLOG_LEVEL_OLED=LOG_LEVEL_NOTICE")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"displaying-module-json-messages-default"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#displaying-module-json-messages-default"}},[e._v("#")]),e._v(" Displaying Module json messages (default)")]),e._v(" "),t("p",[e._v("The display of messages from various modules is also supported. Currently supported modules include "),t("code",[e._v("ZgatewayRTL_433")]),e._v(", "),t("code",[e._v("ZgatewayBT")]),e._v(" and "),t("code",[e._v("ZsensorBME280")]),e._v(".")]),e._v(" "),t("p",[e._v("This can be enabled with the compiler directive "),t("code",[e._v("-DJSON_TO_OLED=true")]),e._v(".")]),e._v(" "),t("p",[e._v("You can also change it by MQTT. For example if you want to display module json messages:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"json-oled\":true}'")])]),e._v(" "),t("p",[e._v("And to disable the display of module json messages:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"display-json\":false}'")])]),e._v(" "),t("h3",{attrs:{id:"store-the-current-display-configuration-in-the-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#store-the-current-display-configuration-in-the-gateway"}},[e._v("#")]),e._v(" Store the current display configuration in the gateway")]),e._v(" "),t("p",[e._v("To store the running display configuration into non-volatile storage on the gateway use the following command. This assures persistence across restarts.")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"save\":true}'")])]),e._v(" "),t("p",[e._v("At any time, you can reload the stored configuration with the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"load\":true}'")])]),e._v(" "),t("p",[e._v("If you want to erase the stored configuration, use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"erase\":true}'")])]),e._v(" "),t("p",[e._v("Note that this will not change the running configuration, it only ensures that the default configuration is used at next startup.")]),e._v(" "),t("p",[e._v("If you want to load the default configuration use the command:")]),e._v(" "),t("p",[t("code",[e._v("mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306/config -m '{\"init\":true}'")])]),e._v(" "),t("p",[e._v("Note that this will not change the stored configuration, "),t("code",[e._v("erase")]),e._v(" or "),t("code",[e._v("save")]),e._v(" is still needed to overwrite the saved configuration.")]),e._v(" "),t("h3",{attrs:{id:"connecting-a-generic-ssd1306-display-to-esp32"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting-a-generic-ssd1306-display-to-esp32"}},[e._v("#")]),e._v(" Connecting a generic SSD1306 display to ESP32")]),e._v(" "),t("p",[e._v("It is possible to connect a generic SSD1306 display with resolution 128*64 to the hardware setups.\nThis example describes how to do it with the ESP32 board.")]),e._v(" "),t("ul",[t("li",[e._v("Connect the display to the ESP32 (display → ESP32):\n"),t("ul",[t("li",[e._v("VCC → 5V (or 3.3V, check your display documentation)")]),e._v(" "),t("li",[e._v("GND → GND")]),e._v(" "),t("li",[e._v("SCL → pin 22")]),e._v(" "),t("li",[e._v("SDA → pin 21")])])]),e._v(" "),t("li",[e._v("Modify the environment definition in "),t("code",[e._v("environments.ini")]),e._v(".\n"),t("ul",[t("li",[e._v("Add the display library:"),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("lib_deps =\n ${com-esp32.lib_deps}\n ...\n ${libraries.ssd1306}\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br")])])]),e._v(" "),t("li",[e._v("Add relevant build flags:"),t("div",{staticClass:"language- line-numbers-mode"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("build_flags =\n ${com-esp32.build_flags}\n ...\n; *** Generic SSD1306 OLED Options **\n '-DZdisplaySSD1306=\"GenericSSD1306\"'\n '-DOLED_SDA=21' ; SSD1306 pin SDA\n '-DOLED_SCL=22' ; SSD1306 pin SCL\n '-DGenericSSD1306=true'\n '-DJSON_TO_OLED=true'\n '-DDISPLAY_PAGE_INTERVAL=30'\n; '-DLOG_TO_OLED=true' ; Enable log to OLED\n; '-DLOG_LEVEL_OLED=LOG_LEVEL_NOTICE'\n; '-DDISPLAY_IDLE_LOGO=false'\n; '-DDISPLAY_BRIGHTNESS=80'\n; '-DDISPLAY_METRIC=false'\n; '-DDISPLAY_FLIP=false'\n")])]),e._v(" "),t("div",{staticClass:"line-numbers-wrapper"},[t("span",{staticClass:"line-number"},[e._v("1")]),t("br"),t("span",{staticClass:"line-number"},[e._v("2")]),t("br"),t("span",{staticClass:"line-number"},[e._v("3")]),t("br"),t("span",{staticClass:"line-number"},[e._v("4")]),t("br"),t("span",{staticClass:"line-number"},[e._v("5")]),t("br"),t("span",{staticClass:"line-number"},[e._v("6")]),t("br"),t("span",{staticClass:"line-number"},[e._v("7")]),t("br"),t("span",{staticClass:"line-number"},[e._v("8")]),t("br"),t("span",{staticClass:"line-number"},[e._v("9")]),t("br"),t("span",{staticClass:"line-number"},[e._v("10")]),t("br"),t("span",{staticClass:"line-number"},[e._v("11")]),t("br"),t("span",{staticClass:"line-number"},[e._v("12")]),t("br"),t("span",{staticClass:"line-number"},[e._v("13")]),t("br"),t("span",{staticClass:"line-number"},[e._v("14")]),t("br"),t("span",{staticClass:"line-number"},[e._v("15")]),t("br"),t("span",{staticClass:"line-number"},[e._v("16")]),t("br")])])])])])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/66.147c03e8.js b/dev/assets/js/66.6b3e6794.js similarity index 99% rename from dev/assets/js/66.147c03e8.js rename to dev/assets/js/66.6b3e6794.js index 81e68302..a25e5fc7 100644 --- a/dev/assets/js/66.147c03e8.js +++ b/dev/assets/js/66.6b3e6794.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{468:function(e,s,a){"use strict";a.r(s);var t=a(14),n=Object(t.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"rs232-serial-gateway"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rs232-serial-gateway"}},[e._v("#")]),e._v(" RS232/Serial gateway")]),e._v(" "),s("p",[e._v("The SERIAL gateway can be used to send and receive data from the serial connection to and from MQTT. Both softwareSerial as hardwareSerial are supported. HardwareSerial can be used for higher baud rates, but is limited to specific pins on most platforms.")]),e._v(" "),s("h2",{attrs:{id:"sending-an-serial-message"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sending-an-serial-message"}},[e._v("#")]),e._v(" Sending an SERIAL message")]),e._v(" "),s("p",[e._v("Simply publish the message you wish to transmit, minus the prefix and postfix. For example, to send the \"Turn On\" signal for a Mitsubishi XD221U projector, the code is simply '!' so you would use the command")]),e._v(" "),s("p",[s("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/XtoSERIAL -m \'{"value": "!"}\'')])]),e._v(" "),s("p",[e._v("It will automatically add the prefix and postfix you set in "),s("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/main/config_SERIAL.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_SERIAL.h"),s("OutboundLink")],1),e._v(".")]),e._v(" "),s("h2",{attrs:{id:"receiving-an-serial-message"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#receiving-an-serial-message"}},[e._v("#")]),e._v(" Receiving an SERIAL message")]),e._v(" "),s("p",[e._v("Two modes are available for receiving SERIAL messages.")]),e._v(" "),s("h3",{attrs:{id:"single-mqtt-message-mode-default"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#single-mqtt-message-mode-default"}},[e._v("#")]),e._v(" Single MQTT message mode (default)")]),e._v(" "),s("p",[e._v("To receive a message, subscribe to all with "),s("code",[e._v("mosquitto_sub -t +/# -v")]),e._v('\nand perform an action that should get a response from the device. For example, If I were to send the "Turn On" signal from earlier, I would receive back')]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),s("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"1"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("p",[e._v("Because this projector echoes back a received command to acknowledge. Some devices will send a NACK, or Negative Acknowledge, to confirm that they received your message but could not comply. That would look like")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),s("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"!:N"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("h3",{attrs:{id:"json-mode"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#json-mode"}},[e._v("#")]),e._v(" JSON mode")]),e._v(" "),s("p",[e._v("This mode can be used if the received message on the serial link is JSON. The JSON keys are used as separate MQTT sub-topics. For nested JSON this will be repeated for sub-keys up to the specified nesting level.")]),e._v(" "),s("p",[e._v("For example:")]),e._v(" "),s("p",[e._v("input received at serial link:")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("temperature"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("sens1"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("22")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" sens2"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("23")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" humidity"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("sens1"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("80")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" sens2"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("60")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("p",[e._v("output in case of max nesting level 1:")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT/temperature "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{sens1: 22, sens2: 23}"')]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{sens1: 80, sens2: 60}"')]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br"),s("span",{staticClass:"line-number"},[e._v("2")]),s("br")])]),s("p",[e._v("output in case of max nesting level 2 (or higher):")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT/temperature/sens1 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("22")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/temperature/sens2 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("23")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity/sens1 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("80")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity/sens2 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("60")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br"),s("span",{staticClass:"line-number"},[e._v("2")]),s("br"),s("span",{staticClass:"line-number"},[e._v("3")]),s("br"),s("span",{staticClass:"line-number"},[e._v("4")]),s("br")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{467:function(e,s,a){"use strict";a.r(s);var t=a(14),n=Object(t.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"rs232-serial-gateway"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rs232-serial-gateway"}},[e._v("#")]),e._v(" RS232/Serial gateway")]),e._v(" "),s("p",[e._v("The SERIAL gateway can be used to send and receive data from the serial connection to and from MQTT. Both softwareSerial as hardwareSerial are supported. HardwareSerial can be used for higher baud rates, but is limited to specific pins on most platforms.")]),e._v(" "),s("h2",{attrs:{id:"sending-an-serial-message"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sending-an-serial-message"}},[e._v("#")]),e._v(" Sending an SERIAL message")]),e._v(" "),s("p",[e._v("Simply publish the message you wish to transmit, minus the prefix and postfix. For example, to send the \"Turn On\" signal for a Mitsubishi XD221U projector, the code is simply '!' so you would use the command")]),e._v(" "),s("p",[s("code",[e._v('mosquitto_pub -t home/OpenMQTTGateway/commands/XtoSERIAL -m \'{"value": "!"}\'')])]),e._v(" "),s("p",[e._v("It will automatically add the prefix and postfix you set in "),s("a",{attrs:{href:"https://github.com/1technophile/OpenMQTTGateway/blob/master/main/config_SERIAL.h",target:"_blank",rel:"noopener noreferrer"}},[e._v("config_SERIAL.h"),s("OutboundLink")],1),e._v(".")]),e._v(" "),s("h2",{attrs:{id:"receiving-an-serial-message"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#receiving-an-serial-message"}},[e._v("#")]),e._v(" Receiving an SERIAL message")]),e._v(" "),s("p",[e._v("Two modes are available for receiving SERIAL messages.")]),e._v(" "),s("h3",{attrs:{id:"single-mqtt-message-mode-default"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#single-mqtt-message-mode-default"}},[e._v("#")]),e._v(" Single MQTT message mode (default)")]),e._v(" "),s("p",[e._v("To receive a message, subscribe to all with "),s("code",[e._v("mosquitto_sub -t +/# -v")]),e._v('\nand perform an action that should get a response from the device. For example, If I were to send the "Turn On" signal from earlier, I would receive back')]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),s("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"1"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("p",[e._v("Because this projector echoes back a received command to acknowledge. Some devices will send a NACK, or Negative Acknowledge, to confirm that they received your message but could not comply. That would look like")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),s("span",{pre:!0,attrs:{class:"token property"}},[e._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"!:N"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("h3",{attrs:{id:"json-mode"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#json-mode"}},[e._v("#")]),e._v(" JSON mode")]),e._v(" "),s("p",[e._v("This mode can be used if the received message on the serial link is JSON. The JSON keys are used as separate MQTT sub-topics. For nested JSON this will be repeated for sub-keys up to the specified nesting level.")]),e._v(" "),s("p",[e._v("For example:")]),e._v(" "),s("p",[e._v("input received at serial link:")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("temperature"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("sens1"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("22")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" sens2"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("23")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" humidity"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("sens1"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("80")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" sens2"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("60")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])]),s("p",[e._v("output in case of max nesting level 1:")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT/temperature "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{sens1: 22, sens2: 23}"')]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{sens1: 80, sens2: 60}"')]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br"),s("span",{staticClass:"line-number"},[e._v("2")]),s("br")])]),s("p",[e._v("output in case of max nesting level 2 (or higher):")]),e._v(" "),s("div",{staticClass:"language-json line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[e._v("home/OpenMQTTGateway/SERIALtoMQTT/temperature/sens1 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("22")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/temperature/sens2 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("23")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity/sens1 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("80")]),e._v("\nhome/OpenMQTTGateway/SERIALtoMQTT/humidity/sens2 "),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("60")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br"),s("span",{staticClass:"line-number"},[e._v("2")]),s("br"),s("span",{staticClass:"line-number"},[e._v("3")]),s("br"),s("span",{staticClass:"line-number"},[e._v("4")]),s("br")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/67.0d566ba2.js b/dev/assets/js/67.9685d727.js similarity index 98% rename from dev/assets/js/67.0d566ba2.js rename to dev/assets/js/67.9685d727.js index 8d16d4fa..ba5f3af2 100644 --- a/dev/assets/js/67.0d566ba2.js +++ b/dev/assets/js/67.9685d727.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{469:function(t,e,a){"use strict";a.r(e);var i=a(14),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"webui"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#webui"}},[t._v("#")]),t._v(" WebUI")]),t._v(" "),e("p",[t._v("For ESP32 based environments a WebUI is available to provide basic configuration and monitoring of your OpenMQTTGateway Device. Functions included are:")]),t._v(" "),e("ul",[e("li",[t._v("Configuration")]),t._v(" "),e("li",[t._v("Information")]),t._v(" "),e("li",[t._v("Firmware Upgrade")]),t._v(" "),e("li",[t._v("Console")]),t._v(" "),e("li",[t._v("Restart")])]),t._v(" "),e("h1",{attrs:{id:"login-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#login-authentication"}},[t._v("#")]),t._v(" Login Authentication")]),t._v(" "),e("p",[t._v("By default access to the WebUI uses basic authentication to control access to your OpenMQTTGateway Device. The login is "),e("code",[t._v("admin")]),t._v(" and the password is your "),e("code",[t._v("gateway password")]),t._v(" (if unchanged during onboarding there is no password).")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The communication with the WebUI is not encrypted, which means that your data may be visible on your local network.")])]),t._v(" "),e("h1",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h2",{attrs:{id:"wifi"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi"}},[t._v("#")]),t._v(" WiFi")]),t._v(" "),e("p",[t._v("Ability to change the SSID and password for your WiFi, if the change is unsuccessful it will revert back to the previous WiFi settings.")]),t._v(" "),e("h2",{attrs:{id:"mqtt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mqtt"}},[t._v("#")]),t._v(" MQTT")]),t._v(" "),e("p",[t._v("Ability to change the mqtt settings, if the change is unsuccessful it will revert back to the previous mqtt settings.")]),t._v(" "),e("h2",{attrs:{id:"webui-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#webui-2"}},[t._v("#")]),t._v(" WebUI")]),t._v(" "),e("p",[t._v("Ability to change the display of sensor to Metric or Imperial, and disable the WebUI Authentication")]),t._v(" "),e("h2",{attrs:{id:"bluetooth-low-energy-ble"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bluetooth-low-energy-ble"}},[t._v("#")]),t._v(" Bluetooth Low Energy - BLE")]),t._v(" "),e("p",[t._v("Ability to add the default AES BLE decryption key, and multiple per-device "),e("code",[t._v("macaddress:aeskey")]),t._v(" allowing for devices that cannot have their AES key changed.")]),t._v(" "),e("h2",{attrs:{id:"logging"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logging"}},[t._v("#")]),t._v(" Logging")]),t._v(" "),e("p",[t._v("Ability to temporarily change the logging level.")]),t._v(" "),e("h1",{attrs:{id:"information"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#information"}},[t._v("#")]),t._v(" Information")]),t._v(" "),e("p",[t._v("Details of OpenMQTTGateway Device status")]),t._v(" "),e("h1",{attrs:{id:"firmware-upgrade"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firmware-upgrade"}},[t._v("#")]),t._v(" Firmware Upgrade")]),t._v(" "),e("p",[t._v("Ability to upgrade firmware by URL or to latest version.")]),t._v(" "),e("h1",{attrs:{id:"console"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#console"}},[t._v("#")]),t._v(" Console")]),t._v(" "),e("p",[t._v("Ability to view messages from the OpenMQTTGateway console. The scope of messages visible in the UI is limited to just the OpenMQTTGateway codebase, messages from the ESP hardware or other libraries are not visible,")]),t._v(" "),e("p",[t._v("Ability to inject commands to OpenMQTTGateway for processing. The commands accepted are of the form mqtt topic then json message. And as you are already on the target device, you do not need to include the device name ie")]),t._v(" "),e("p",[e("code",[t._v('commands/MQTTtoSYS/config {"cmd":"restart"}')])]),t._v(" "),e("p",[t._v("This works for all modules in your environment.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{468:function(t,e,a){"use strict";a.r(e);var i=a(14),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"webui"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#webui"}},[t._v("#")]),t._v(" WebUI")]),t._v(" "),e("p",[t._v("For ESP32 based environments a WebUI is available to provide basic configuration and monitoring of your OpenMQTTGateway Device. Functions included are:")]),t._v(" "),e("ul",[e("li",[t._v("Configuration")]),t._v(" "),e("li",[t._v("Information")]),t._v(" "),e("li",[t._v("Firmware Upgrade")]),t._v(" "),e("li",[t._v("Console")]),t._v(" "),e("li",[t._v("Restart")])]),t._v(" "),e("h1",{attrs:{id:"login-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#login-authentication"}},[t._v("#")]),t._v(" Login Authentication")]),t._v(" "),e("p",[t._v("By default access to the WebUI uses basic authentication to control access to your OpenMQTTGateway Device. The login is "),e("code",[t._v("admin")]),t._v(" and the password is your "),e("code",[t._v("gateway password")]),t._v(" (if unchanged during onboarding there is no password).")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The communication with the WebUI is not encrypted, which means that your data may be visible on your local network.")])]),t._v(" "),e("h1",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h2",{attrs:{id:"wifi"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wifi"}},[t._v("#")]),t._v(" WiFi")]),t._v(" "),e("p",[t._v("Ability to change the SSID and password for your WiFi, if the change is unsuccessful it will revert back to the previous WiFi settings.")]),t._v(" "),e("h2",{attrs:{id:"mqtt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mqtt"}},[t._v("#")]),t._v(" MQTT")]),t._v(" "),e("p",[t._v("Ability to change the mqtt settings, if the change is unsuccessful it will revert back to the previous mqtt settings.")]),t._v(" "),e("h2",{attrs:{id:"webui-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#webui-2"}},[t._v("#")]),t._v(" WebUI")]),t._v(" "),e("p",[t._v("Ability to change the display of sensor to Metric or Imperial, and disable the WebUI Authentication")]),t._v(" "),e("h2",{attrs:{id:"bluetooth-low-energy-ble"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bluetooth-low-energy-ble"}},[t._v("#")]),t._v(" Bluetooth Low Energy - BLE")]),t._v(" "),e("p",[t._v("Ability to add the default AES BLE decryption key, and multiple per-device "),e("code",[t._v("macaddress:aeskey")]),t._v(" allowing for devices that cannot have their AES key changed.")]),t._v(" "),e("h2",{attrs:{id:"logging"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logging"}},[t._v("#")]),t._v(" Logging")]),t._v(" "),e("p",[t._v("Ability to temporarily change the logging level.")]),t._v(" "),e("h1",{attrs:{id:"information"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#information"}},[t._v("#")]),t._v(" Information")]),t._v(" "),e("p",[t._v("Details of OpenMQTTGateway Device status")]),t._v(" "),e("h1",{attrs:{id:"firmware-upgrade"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firmware-upgrade"}},[t._v("#")]),t._v(" Firmware Upgrade")]),t._v(" "),e("p",[t._v("Ability to upgrade firmware by URL or to latest version.")]),t._v(" "),e("h1",{attrs:{id:"console"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#console"}},[t._v("#")]),t._v(" Console")]),t._v(" "),e("p",[t._v("Ability to view messages from the OpenMQTTGateway console. The scope of messages visible in the UI is limited to just the OpenMQTTGateway codebase, messages from the ESP hardware or other libraries are not visible,")]),t._v(" "),e("p",[t._v("Ability to inject commands to OpenMQTTGateway for processing. The commands accepted are of the form mqtt topic then json message. And as you are already on the target device, you do not need to include the device name ie")]),t._v(" "),e("p",[e("code",[t._v('commands/MQTTtoSYS/config {"cmd":"restart"}')])]),t._v(" "),e("p",[t._v("This works for all modules in your environment.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/dev/assets/js/app.8949bcce.js b/dev/assets/js/app.2ffaf3d9.js similarity index 83% rename from dev/assets/js/app.8949bcce.js rename to dev/assets/js/app.2ffaf3d9.js index 2791e1ca..fed702ac 100644 --- a/dev/assets/js/app.8949bcce.js +++ b/dev/assets/js/app.2ffaf3d9.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],l=e[1],c=e[2],f=0,p=[];f
'};function o(t,e,n){return tn?n:t}function i(t){return 100*(-1+t)}n.configure=function(t){var e,n;for(e in t)void 0!==(n=t[e])&&t.hasOwnProperty(e)&&(r[e]=n);return this},n.status=null,n.set=function(t){var e=n.isStarted();t=o(t,r.minimum,1),n.status=1===t?null:t;var l=n.render(!e),c=l.querySelector(r.barSelector),u=r.speed,f=r.easing;return l.offsetWidth,a((function(e){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,function(t,e,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+i(t)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+i(t)+"%,0)"}:{"margin-left":i(t)+"%"}).transition="all "+e+"ms "+n,o}(t,u,f)),1===t?(s(l,{transition:"none",opacity:1}),l.offsetWidth,setTimeout((function(){s(l,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),e()}),u)}),u)):setTimeout(e,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var t=function(){setTimeout((function(){n.status&&(n.trickle(),t())}),r.trickleSpeed)};return r.trickle&&t(),this},n.done=function(t){return t||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(t){var e=n.status;return e?("number"!=typeof t&&(t=(1-e)*o(Math.random()*e,.1,.95)),e=o(e+t,0,.994),n.set(e)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},t=0,e=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===e&&n.start(),t++,e++,r.always((function(){0==--e?(t=0,n.done()):n.set((t-e)/t)})),this):this},n.render=function(t){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var e=document.createElement("div");e.id="nprogress",e.innerHTML=r.template;var o,a=e.querySelector(r.barSelector),l=t?"-100":i(n.status||0),u=document.querySelector(r.parent);return s(a,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=e.querySelector(r.spinnerSelector))&&p(o),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(e),e},n.remove=function(){u(document.documentElement,"nprogress-busy"),u(document.querySelector(r.parent),"nprogress-custom-parent");var t=document.getElementById("nprogress");t&&p(t)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var t=document.body.style,e="WebkitTransform"in t?"Webkit":"MozTransform"in t?"Moz":"msTransform"in t?"ms":"OTransform"in t?"O":"";return e+"Perspective"in t?"translate3d":e+"Transform"in t?"translate":"margin"};var a=function(){var t=[];function e(){var n=t.shift();n&&n(e)}return function(n){t.push(n),1==t.length&&e()}}(),s=function(){var t=["Webkit","O","Moz","ms"],e={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(t,e){return e.toUpperCase()})),e[n]||(e[n]=function(e){var n=document.body.style;if(e in n)return e;for(var r,o=t.length,i=e.charAt(0).toUpperCase()+e.slice(1);o--;)if((r=t[o]+i)in n)return r;return e}(n))}function r(t,e,r){e=n(e),t.style[e]=r}return function(t,e){var n,o,i=arguments;if(2==i.length)for(n in e)void 0!==(o=e[n])&&e.hasOwnProperty(n)&&r(t,n,o);else r(t,i[1],i[2])}}();function l(t,e){return("string"==typeof t?t:f(t)).indexOf(" "+e+" ")>=0}function c(t,e){var n=f(t),r=n+e;l(n,e)||(t.className=r.substring(1))}function u(t,e){var n,r=f(t);l(t,e)&&(n=r.replace(" "+e+" "," "),t.className=n.substring(1,n.length-1))}function f(t){return(" "+(t.className||"")+" ").replace(/\s+/gi," ")}function p(t){t&&t.parentNode&&t.parentNode.removeChild(t)}return n})?r.call(e,n,e,t):r)||(t.exports=o)},function(t,e,n){"use strict";var r=n(0),o=n(45).f,i=n(12),a=n(92),s=n(32),l=n(60),c=n(120);t.exports=function(t,e){var n,u,f,p,d,h=t.target,v=t.global,m=t.stat;if(n=v?r:m?r[h]||s(h,{}):(r[h]||{}).prototype)for(u in e){if(p=e[u],f=t.dontCallGetSet?(d=o(n,u))&&d.value:n[u],!c(v?u:h+(m?".":"#")+u,t.forced)&&void 0!==f){if(typeof p==typeof f)continue;l(p,f)}(t.sham||f&&f.sham)&&i(p,"sham",!0),a(n,u,p,t)}}},function(t,e,n){"use strict";var r=n(25),o=Function.prototype.call;t.exports=r?o.bind(o):function(){return o.apply(o,arguments)}},function(t,e,n){"use strict";var r=n(3);t.exports=!r((function(){var t=function(){}.bind();return"function"!=typeof t||t.hasOwnProperty("prototype")}))},function(t,e,n){"use strict";t.exports=function(t,e){return{enumerable:!(1&t),configurable:!(2&t),writable:!(4&t),value:e}}},function(t,e,n){"use strict";var r=n(46),o=n(47);t.exports=function(t){return r(o(t))}},function(t,e,n){"use strict";var r=n(0),o=n(1),i=function(t){return o(t)?t:void 0};t.exports=function(t,e){return arguments.length<2?i(r[t]):r[t]&&r[t][e]}},function(t,e,n){"use strict";var r=n(1),o=n(102),i=TypeError;t.exports=function(t){if(r(t))return t;throw new i(o(t)+" is not a function")}},function(t,e,n){"use strict";var r=n(0),o=n(55),i=n(8),a=n(57),s=n(53),l=n(52),c=r.Symbol,u=o("wks"),f=l?c.for||c:c&&c.withoutSetter||a;t.exports=function(t){return i(u,t)||(u[t]=s&&i(c,t)?c[t]:f("Symbol."+t)),u[t]}},function(t,e,n){"use strict";var r=n(0),o=n(32),i=r["__core-js_shared__"]||o("__core-js_shared__",{});t.exports=i},function(t,e,n){"use strict";var r=n(0),o=Object.defineProperty;t.exports=function(t,e){try{o(r,t,{value:e,configurable:!0,writable:!0})}catch(n){r[t]=e}return e}},function(t,e,n){"use strict";var r=n(47),o=Object;t.exports=function(t){return o(r(t))}},function(t,e,n){"use strict";var r=n(7),o=String,i=TypeError;t.exports=function(t){if(r(t))return t;throw new i(o(t)+" is not an object")}},function(t,e,n){"use strict";var r=n(117);t.exports=function(t){return r(t.length)}},function(t,e,n){var r=n(144),o=n(10),i=Object.prototype,a=i.hasOwnProperty,s=i.propertyIsEnumerable,l=r(function(){return arguments}())?r:function(t){return o(t)&&a.call(t,"callee")&&!s.call(t,"callee")};t.exports=l},function(t,e,n){var r=n(9)(n(6),"Map");t.exports=r},function(t,e){t.exports=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)}},function(t,e,n){var r=n(164),o=n(171),i=n(173),a=n(174),s=n(175);function l(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e-1&&t%1==0&&t<=9007199254740991}},function(t,e,n){var r=n(4),o=n(43),i=/\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/,a=/^\w*$/;t.exports=function(t,e){if(r(t))return!1;var n=typeof t;return!("number"!=n&&"symbol"!=n&&"boolean"!=n&&null!=t&&!o(t))||(a.test(t)||!i.test(t)||null!=e&&t in Object(e))}},function(t,e,n){var r=n(11),o=n(10);t.exports=function(t){return"symbol"==typeof t||o(t)&&"[object Symbol]"==r(t)}},function(t,e){t.exports=function(t){return t}},function(t,e,n){"use strict";var r=n(5),o=n(24),i=n(98),a=n(26),s=n(27),l=n(49),c=n(8),u=n(58),f=Object.getOwnPropertyDescriptor;e.f=r?f:function(t,e){if(t=s(t),e=l(e),u)try{return f(t,e)}catch(t){}if(c(t,e))return a(!o(i.f,t,e),t[e])}},function(t,e,n){"use strict";var r=n(2),o=n(3),i=n(16),a=Object,s=r("".split);t.exports=o((function(){return!a("z").propertyIsEnumerable(0)}))?function(t){return"String"===i(t)?s(t,""):a(t)}:a},function(t,e,n){"use strict";var r=n(48),o=TypeError;t.exports=function(t){if(r(t))throw new o("Can't call method on "+t);return t}},function(t,e,n){"use strict";t.exports=function(t){return null==t}},function(t,e,n){"use strict";var r=n(99),o=n(50);t.exports=function(t){var e=r(t,"string");return o(e)?e:e+""}},function(t,e,n){"use strict";var r=n(28),o=n(1),i=n(51),a=n(52),s=Object;t.exports=a?function(t){return"symbol"==typeof t}:function(t){var e=r("Symbol");return o(e)&&i(e.prototype,s(t))}},function(t,e,n){"use strict";var r=n(2);t.exports=r({}.isPrototypeOf)},function(t,e,n){"use strict";var r=n(53);t.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol.iterator},function(t,e,n){"use strict";var r=n(54),o=n(3),i=n(0).String;t.exports=!!Object.getOwnPropertySymbols&&!o((function(){var t=Symbol("symbol detection");return!i(t)||!(Object(t)instanceof Symbol)||!Symbol.sham&&r&&r<41}))},function(t,e,n){"use strict";var r,o,i=n(0),a=n(100),s=i.process,l=i.Deno,c=s&&s.versions||l&&l.version,u=c&&c.v8;u&&(o=(r=u.split("."))[0]>0&&r[0]<4?1:+(r[0]+r[1])),!o&&a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(o=+r[1]),t.exports=o},function(t,e,n){"use strict";var r=n(56),o=n(31);(t.exports=function(t,e){return o[t]||(o[t]=void 0!==e?e:{})})("versions",[]).push({version:"3.35.0",mode:r?"pure":"global",copyright:"© 2014-2023 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.35.0/LICENSE",source:"https://github.com/zloirock/core-js"})},function(t,e,n){"use strict";t.exports=!1},function(t,e,n){"use strict";var r=n(2),o=0,i=Math.random(),a=r(1..toString);t.exports=function(t){return"Symbol("+(void 0===t?"":t)+")_"+a(++o+i,36)}},function(t,e,n){"use strict";var r=n(5),o=n(3),i=n(104);t.exports=!r&&!o((function(){return 7!==Object.defineProperty(i("div"),"a",{get:function(){return 7}}).a}))},function(t,e,n){"use strict";t.exports={}},function(t,e,n){"use strict";var r=n(8),o=n(111),i=n(45),a=n(15);t.exports=function(t,e,n){for(var s=o(e),l=a.f,c=i.f,u=0;uu))return!1;var p=l.get(t),d=l.get(e);if(p&&d)return p==e&&d==t;var h=-1,v=!0,m=2&n?new r:void 0;for(l.set(t,e),l.set(e,t);++h-1&&t%1==0&&t=0&&Math.floor(e)===e&&isFinite(t)}function v(t){return a(t)&&"function"==typeof t.then&&"function"==typeof t.catch}function m(t){return null==t?"":Array.isArray(t)||p(t)&&t.toString===f?JSON.stringify(t,g,2):String(t)}function g(t,e){return e&&e.__v_isRef?e.value:e}function y(t){var e=parseFloat(t);return isNaN(e)?t:e}function b(t,e){for(var n=Object.create(null),r=t.split(","),o=0;o-1)return t.splice(r,1)}}var x=Object.prototype.hasOwnProperty;function S(t,e){return x.call(t,e)}function k(t){var e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}var O=/-(\w)/g,P=k((function(t){return t.replace(O,(function(t,e){return e?e.toUpperCase():""}))})),T=k((function(t){return t.charAt(0).toUpperCase()+t.slice(1)})),C=/\B([A-Z])/g,E=k((function(t){return t.replace(C,"-$1").toLowerCase()}));var j=Function.prototype.bind?function(t,e){return t.bind(e)}:function(t,e){function n(n){var r=arguments.length;return r?r>1?t.apply(e,arguments):t.call(e,n):t.call(e)}return n._length=t.length,n};function $(t,e){e=e||0;for(var n=t.length-e,r=new Array(n);n--;)r[n]=t[n+e];return r}function A(t,e){for(var n in e)t[n]=e[n];return t}function M(t){for(var e={},n=0;n0,Z=K&&K.indexOf("edge/")>0;K&&K.indexOf("android");var tt=K&&/iphone|ipad|ipod|ios/.test(K);K&&/chrome\/\d+/.test(K),K&&/phantomjs/.test(K);var et,nt=K&&K.match(/firefox\/(\d+)/),rt={}.watch,ot=!1;if(X)try{var it={};Object.defineProperty(it,"passive",{get:function(){ot=!0}}),window.addEventListener("test-passive",null,it)}catch(t){}var at=function(){return void 0===et&&(et=!X&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),et},st=X&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function lt(t){return"function"==typeof t&&/native code/.test(t.toString())}var ct,ut="undefined"!=typeof Symbol&<(Symbol)&&"undefined"!=typeof Reflect&<(Reflect.ownKeys);ct="undefined"!=typeof Set&<(Set)?Set:function(){function t(){this.set=Object.create(null)}return t.prototype.has=function(t){return!0===this.set[t]},t.prototype.add=function(t){this.set[t]=!0},t.prototype.clear=function(){this.set=Object.create(null)},t}();var ft=null;function pt(t){void 0===t&&(t=null),t||ft&&ft._scope.off(),ft=t,t&&t._scope.on()}var dt=function(){function t(t,e,n,r,o,i,a,s){this.tag=t,this.data=e,this.children=n,this.text=r,this.elm=o,this.ns=void 0,this.context=i,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=e&&e.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=s,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(t.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),t}(),ht=function(t){void 0===t&&(t="");var e=new dt;return e.text=t,e.isComment=!0,e};function vt(t){return new dt(void 0,void 0,void 0,String(t))}function mt(t){var e=new dt(t.tag,t.data,t.children&&t.children.slice(),t.text,t.elm,t.context,t.componentOptions,t.asyncFactory);return e.ns=t.ns,e.isStatic=t.isStatic,e.key=t.key,e.isComment=t.isComment,e.fnContext=t.fnContext,e.fnOptions=t.fnOptions,e.fnScopeId=t.fnScopeId,e.asyncMeta=t.asyncMeta,e.isCloned=!0,e}"function"==typeof SuppressedError&&SuppressedError;var gt=0,yt=[],bt=function(){function t(){this._pending=!1,this.id=gt++,this.subs=[]}return t.prototype.addSub=function(t){this.subs.push(t)},t.prototype.removeSub=function(t){this.subs[this.subs.indexOf(t)]=null,this._pending||(this._pending=!0,yt.push(this))},t.prototype.depend=function(e){t.target&&t.target.addDep(this)},t.prototype.notify=function(t){var e=this.subs.filter((function(t){return t}));for(var n=0,r=e.length;n0&&(Kt((c=t(c,"".concat(n||"","_").concat(r)))[0])&&Kt(f)&&(p[u]=vt(f.text+c[0].text),c.shift()),p.push.apply(p,c)):l(c)?Kt(f)?p[u]=vt(f.text+c):""!==c&&p.push(vt(c)):Kt(c)&&Kt(f)?p[u]=vt(f.text+c.text):(s(e._isVList)&&a(c.tag)&&i(c.key)&&a(n)&&(c.key="__vlist".concat(n,"_").concat(r,"__")),p.push(c)));return p}(t):void 0}function Kt(t){return a(t)&&a(t.text)&&!1===t.isComment}function Yt(t,e){var n,r,i,s,l=null;if(o(t)||"string"==typeof t)for(l=new Array(t.length),n=0,r=t.length;n0,s=e?!!e.$stable:!a,l=e&&e.$key;if(e){if(e._normalized)return e._normalized;if(s&&o&&o!==r&&l===o.$key&&!a&&!o.$hasNormal)return o;for(var c in i={},e)e[c]&&"$"!==c[0]&&(i[c]=me(t,n,c,e[c]))}else i={};for(var u in n)u in i||(i[u]=ge(n,u));return e&&Object.isExtensible(e)&&(e._normalized=i),W(i,"$stable",s),W(i,"$key",l),W(i,"$hasNormal",a),i}function me(t,e,n,r){var i=function(){var e=ft;pt(t);var n=arguments.length?r.apply(null,arguments):r({}),i=(n=n&&"object"==typeof n&&!o(n)?[n]:Xt(n))&&n[0];return pt(e),n&&(!i||1===n.length&&i.isComment&&!he(i))?void 0:n};return r.proxy&&Object.defineProperty(e,n,{get:i,enumerable:!0,configurable:!0}),i}function ge(t,e){return function(){return t[e]}}function ye(t){return{get attrs(){if(!t._attrsProxy){var e=t._attrsProxy={};W(e,"_v_attr_proxy",!0),be(e,t.$attrs,r,t,"$attrs")}return t._attrsProxy},get listeners(){t._listenersProxy||be(t._listenersProxy={},t.$listeners,r,t,"$listeners");return t._listenersProxy},get slots(){return function(t){t._slotsProxy||_e(t._slotsProxy={},t.$scopedSlots);return t._slotsProxy}(t)},emit:j(t.$emit,t),expose:function(e){e&&Object.keys(e).forEach((function(n){return Ft(t,e,n)}))}}}function be(t,e,n,r,o){var i=!1;for(var a in e)a in t?e[a]!==n[a]&&(i=!0):(i=!0,we(t,a,r,o));for(var a in t)a in e||(i=!0,delete t[a]);return i}function we(t,e,n,r){Object.defineProperty(t,e,{enumerable:!0,configurable:!0,get:function(){return n[r][e]}})}function _e(t,e){for(var n in e)t[n]=e[n];for(var n in t)n in e||delete t[n]}var xe=null;function Se(t,e){return(t.__esModule||ut&&"Module"===t[Symbol.toStringTag])&&(t=t.default),u(t)?e.extend(t):t}function ke(t){if(o(t))for(var e=0;edocument.createEvent("Event").timeStamp&&(cn=function(){return un.now()})}var fn=function(t,e){if(t.post){if(!e.post)return 1}else if(e.post)return-1;return t.id-e.id};function pn(){var t,e;for(ln=cn(),an=!0,en.sort(fn),sn=0;snsn&&en[n].id>t.id;)n--;en.splice(n+1,0,t)}else en.push(t);on||(on=!0,De(pn))}}function hn(t,e){if(t){for(var n=Object.create(null),r=ut?Reflect.ownKeys(t):Object.keys(t),o=0;o-1)if(i&&!S(o,"default"))a=!1;else if(""===a||a===E(t)){var l=Un(String,o.type);(l<0||s-1:"string"==typeof t?t.split(",").indexOf(e)>-1:!!d(t)&&t.test(e)}function Yn(t,e){var n=t.cache,r=t.keys,o=t._vnode,i=t.$vnode;for(var a in n){var s=n[a];if(s){var l=s.name;l&&!e(l)&&Jn(n,a,r,o)}}i.componentOptions.children=void 0}function Jn(t,e,n,r){var o=t[e];!o||r&&o.tag===r.tag||o.componentInstance.$destroy(),t[e]=null,_(n,e)}Qn.prototype._init=function(t){var e=this;e._uid=Vn++,e._isVue=!0,e.__v_skip=!0,e._scope=new Nt(!0),e._scope.parent=void 0,e._scope._vm=!0,t&&t._isComponent?function(t,e){var n=t.$options=Object.create(t.constructor.options),r=e._parentVnode;n.parent=e.parent,n._parentVnode=r;var o=r.componentOptions;n.propsData=o.propsData,n._parentListeners=o.listeners,n._renderChildren=o.children,n._componentTag=o.tag,e.render&&(n.render=e.render,n.staticRenderFns=e.staticRenderFns)}(e,t):e.$options=jn(Wn(e.constructor),t||{},e),e._renderProxy=e,e._self=e,function(t){var e=t.$options,n=e.parent;if(n&&!e.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(t)}t.$parent=n,t.$root=n?n.$root:t,t.$children=[],t.$refs={},t._provided=n?n._provided:Object.create(null),t._watcher=null,t._inactive=null,t._directInactive=!1,t._isMounted=!1,t._isDestroyed=!1,t._isBeingDestroyed=!1}(e),function(t){t._events=Object.create(null),t._hasHookEvent=!1;var e=t.$options._parentListeners;e&&Xe(t,e)}(e),function(t){t._vnode=null,t._staticTrees=null;var e=t.$options,n=t.$vnode=e._parentVnode,o=n&&n.context;t.$slots=pe(e._renderChildren,o),t.$scopedSlots=n?ve(t.$parent,n.data.scopedSlots,t.$slots):r,t._c=function(e,n,r,o){return Oe(t,e,n,r,o,!1)},t.$createElement=function(e,n,r,o){return Oe(t,e,n,r,o,!0)};var i=n&&n.data;At(t,"$attrs",i&&i.attrs||r,null,!0),At(t,"$listeners",e._parentListeners||r,null,!0)}(e),tn(e,"beforeCreate",void 0,!1),function(t){var e=hn(t.$options.inject,t);e&&(Ct(!1),Object.keys(e).forEach((function(n){At(t,n,e[n])})),Ct(!0))}(e),Dn(e),function(t){var e=t.$options.provide;if(e){var n=c(e)?e.call(t):e;if(!u(n))return;for(var r=Ht(t),o=ut?Reflect.ownKeys(n):Object.keys(n),i=0;i1?$(n):n;for(var r=$(arguments,1),o='event handler for "'.concat(t,'"'),i=0,a=n.length;iparseInt(this.max)&&Jn(t,e[0],e,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var t in this.cache)Jn(this.cache,t,this.keys)},mounted:function(){var t=this;this.cacheVNode(),this.$watch("include",(function(e){Yn(t,(function(t){return Kn(e,t)}))})),this.$watch("exclude",(function(e){Yn(t,(function(t){return!Kn(e,t)}))}))},updated:function(){this.cacheVNode()},render:function(){var t=this.$slots.default,e=ke(t),n=e&&e.componentOptions;if(n){var r=Xn(n),o=this.include,i=this.exclude;if(o&&(!r||!Kn(o,r))||i&&r&&Kn(i,r))return e;var a=this.cache,s=this.keys,l=null==e.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):e.key;a[l]?(e.componentInstance=a[l].componentInstance,_(s,l),s.push(l)):(this.vnodeToCache=e,this.keyToCache=l),e.data.keepAlive=!0}return e||t&&t[0]}}};!function(t){var e={get:function(){return H}};Object.defineProperty(t,"config",e),t.util={warn:Sn,extend:A,mergeOptions:jn,defineReactive:At},t.set=Mt,t.delete=Lt,t.nextTick=De,t.observable=function(t){return $t(t),t},t.options=Object.create(null),q.forEach((function(e){t.options[e+"s"]=Object.create(null)})),t.options._base=t,A(t.options.components,tr),function(t){t.use=function(t){var e=this._installedPlugins||(this._installedPlugins=[]);if(e.indexOf(t)>-1)return this;var n=$(arguments,1);return n.unshift(this),c(t.install)?t.install.apply(t,n):c(t)&&t.apply(null,n),e.push(t),this}}(t),function(t){t.mixin=function(t){return this.options=jn(this.options,t),this}}(t),Gn(t),function(t){q.forEach((function(e){t[e]=function(t,n){return n?("component"===e&&p(n)&&(n.name=n.name||t,n=this.options._base.extend(n)),"directive"===e&&c(n)&&(n={bind:n,update:n}),this.options[e+"s"][t]=n,n):this.options[e+"s"][t]}}))}(t)}(Qn),Object.defineProperty(Qn.prototype,"$isServer",{get:at}),Object.defineProperty(Qn.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(Qn,"FunctionalRenderContext",{value:vn}),Qn.version="2.7.16";var er=b("style,class"),nr=b("input,textarea,option,select,progress"),rr=b("contenteditable,draggable,spellcheck"),or=b("events,caret,typing,plaintext-only"),ir=b("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),ar="http://www.w3.org/1999/xlink",sr=function(t){return":"===t.charAt(5)&&"xlink"===t.slice(0,5)},lr=function(t){return sr(t)?t.slice(6,t.length):""},cr=function(t){return null==t||!1===t};function ur(t){for(var e=t.data,n=t,r=t;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(e=fr(r.data,e));for(;a(n=n.parent);)n&&n.data&&(e=fr(e,n.data));return function(t,e){if(a(t)||a(e))return pr(t,dr(e));return""}(e.staticClass,e.class)}function fr(t,e){return{staticClass:pr(t.staticClass,e.staticClass),class:a(t.class)?[t.class,e.class]:e.class}}function pr(t,e){return t?e?t+" "+e:t:e||""}function dr(t){return Array.isArray(t)?function(t){for(var e,n="",r=0,o=t.length;r-1?Ir(t,e,n):ir(e)?cr(n)?t.removeAttribute(e):(n="allowfullscreen"===e&&"EMBED"===t.tagName?"true":e,t.setAttribute(e,n)):rr(e)?t.setAttribute(e,function(t,e){return cr(e)||"false"===e?"false":"contenteditable"===t&&or(e)?e:"true"}(e,n)):sr(e)?cr(n)?t.removeAttributeNS(ar,lr(e)):t.setAttributeNS(ar,e,n):Ir(t,e,n)}function Ir(t,e,n){if(cr(n))t.removeAttribute(e);else{if(Y&&!J&&"TEXTAREA"===t.tagName&&"placeholder"===e&&""!==n&&!t.__ieph){var r=function(e){e.stopImmediatePropagation(),t.removeEventListener("input",r)};t.addEventListener("input",r),t.__ieph=!0}t.setAttribute(e,n)}}var Br={create:Rr,update:Rr};function Dr(t,e){var n=e.elm,r=e.data,o=t.data;if(!(i(r.staticClass)&&i(r.class)&&(i(o)||i(o.staticClass)&&i(o.class)))){var s=ur(e),l=n._transitionClasses;a(l)&&(s=pr(s,dr(l))),s!==n._prevClass&&(n.setAttribute("class",s),n._prevClass=s)}}var Fr,qr={create:Dr,update:Dr};function Nr(t,e,n){var r=Fr;return function o(){var i=e.apply(null,arguments);null!==i&&Vr(t,o,n,r)}}var Hr=$e&&!(nt&&Number(nt[1])<=53);function zr(t,e,n,r){if(Hr){var o=ln,i=e;e=i._wrapper=function(t){if(t.target===t.currentTarget||t.timeStamp>=o||t.timeStamp<=0||t.target.ownerDocument!==document)return i.apply(this,arguments)}}Fr.addEventListener(t,e,ot?{capture:n,passive:r}:n)}function Vr(t,e,n,r){(r||Fr).removeEventListener(t,e._wrapper||e,n)}function Wr(t,e){if(!i(t.data.on)||!i(e.data.on)){var n=e.data.on||{},r=t.data.on||{};Fr=e.elm||t.elm,function(t){if(a(t.__r)){var e=Y?"change":"input";t[e]=[].concat(t.__r,t[e]||[]),delete t.__r}a(t.__c)&&(t.change=[].concat(t.__c,t.change||[]),delete t.__c)}(n),Wt(n,r,zr,Vr,Nr,e.context),Fr=void 0}}var Qr,Gr={create:Wr,update:Wr,destroy:function(t){return Wr(t,kr)}};function Xr(t,e){if(!i(t.data.domProps)||!i(e.data.domProps)){var n,r,o=e.elm,l=t.data.domProps||{},c=e.data.domProps||{};for(n in(a(c.__ob__)||s(c._v_attr_proxy))&&(c=e.data.domProps=A({},c)),l)n in c||(o[n]="");for(n in c){if(r=c[n],"textContent"===n||"innerHTML"===n){if(e.children&&(e.children.length=0),r===l[n])continue;1===o.childNodes.length&&o.removeChild(o.childNodes[0])}if("value"===n&&"PROGRESS"!==o.tagName){o._value=r;var u=i(r)?"":String(r);Kr(o,u)&&(o.value=u)}else if("innerHTML"===n&&mr(o.tagName)&&i(o.innerHTML)){(Qr=Qr||document.createElement("div")).innerHTML="".concat(r,"");for(var f=Qr.firstChild;o.firstChild;)o.removeChild(o.firstChild);for(;f.firstChild;)o.appendChild(f.firstChild)}else if(r!==l[n])try{o[n]=r}catch(t){}}}}function Kr(t,e){return!t.composing&&("OPTION"===t.tagName||function(t,e){var n=!0;try{n=document.activeElement!==t}catch(t){}return n&&t.value!==e}(t,e)||function(t,e){var n=t.value,r=t._vModifiers;if(a(r)){if(r.number)return y(n)!==y(e);if(r.trim)return n.trim()!==e.trim()}return n!==e}(t,e))}var Yr={create:Xr,update:Xr},Jr=k((function(t){var e={},n=/:(.+)/;return t.split(/;(?![^(]*\))/g).forEach((function(t){if(t){var r=t.split(n);r.length>1&&(e[r[0].trim()]=r[1].trim())}})),e}));function Zr(t){var e=to(t.style);return t.staticStyle?A(t.staticStyle,e):e}function to(t){return Array.isArray(t)?M(t):"string"==typeof t?Jr(t):t}var eo,no=/^--/,ro=/\s*!important$/,oo=function(t,e,n){if(no.test(e))t.style.setProperty(e,n);else if(ro.test(n))t.style.setProperty(E(e),n.replace(ro,""),"important");else{var r=ao(e);if(Array.isArray(n))for(var o=0,i=n.length;o-1?e.split(co).forEach((function(e){return t.classList.add(e)})):t.classList.add(e);else{var n=" ".concat(t.getAttribute("class")||""," ");n.indexOf(" "+e+" ")<0&&t.setAttribute("class",(n+e).trim())}}function fo(t,e){if(e&&(e=e.trim()))if(t.classList)e.indexOf(" ")>-1?e.split(co).forEach((function(e){return t.classList.remove(e)})):t.classList.remove(e),t.classList.length||t.removeAttribute("class");else{for(var n=" ".concat(t.getAttribute("class")||""," "),r=" "+e+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?t.setAttribute("class",n):t.removeAttribute("class")}}function po(t){if(t){if("object"==typeof t){var e={};return!1!==t.css&&A(e,ho(t.name||"v")),A(e,t),e}return"string"==typeof t?ho(t):void 0}}var ho=k((function(t){return{enterClass:"".concat(t,"-enter"),enterToClass:"".concat(t,"-enter-to"),enterActiveClass:"".concat(t,"-enter-active"),leaveClass:"".concat(t,"-leave"),leaveToClass:"".concat(t,"-leave-to"),leaveActiveClass:"".concat(t,"-leave-active")}})),vo=X&&!J,mo="transition",go="transitionend",yo="animation",bo="animationend";vo&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(mo="WebkitTransition",go="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(yo="WebkitAnimation",bo="webkitAnimationEnd"));var wo=X?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(t){return t()};function _o(t){wo((function(){wo(t)}))}function xo(t,e){var n=t._transitionClasses||(t._transitionClasses=[]);n.indexOf(e)<0&&(n.push(e),uo(t,e))}function So(t,e){t._transitionClasses&&_(t._transitionClasses,e),fo(t,e)}function ko(t,e,n){var r=Po(t,e),o=r.type,i=r.timeout,a=r.propCount;if(!o)return n();var s="transition"===o?go:bo,l=0,c=function(){t.removeEventListener(s,u),n()},u=function(e){e.target===t&&++l>=a&&c()};setTimeout((function(){l0&&(n="transition",u=a,f=i.length):"animation"===e?c>0&&(n="animation",u=c,f=l.length):f=(n=(u=Math.max(a,c))>0?a>c?"transition":"animation":null)?"transition"===n?i.length:l.length:0,{type:n,timeout:u,propCount:f,hasTransform:"transition"===n&&Oo.test(r[mo+"Property"])}}function To(t,e){for(;t.length1}function Mo(t,e){!0!==e.data.show&&Eo(e)}var Lo=function(t){var e,n,r={},c=t.modules,u=t.nodeOps;for(e=0;eh?w(t,i(n[g+1])?null:n[g+1].elm,n,d,g,r):d>g&&x(e,f,h)}(f,v,g,n,c):a(g)?(a(t.text)&&u.setTextContent(f,""),w(f,null,g,0,g.length-1,n)):a(v)?x(v,0,v.length-1):a(t.text)&&u.setTextContent(f,""):t.text!==e.text&&u.setTextContent(f,e.text),a(h)&&a(d=h.hook)&&a(d=d.postpatch)&&d(t,e)}}}function P(t,e,n){if(s(n)&&a(t.parent))t.parent.data.pendingInsert=e;else for(var r=0;r-1,a.selected!==i&&(a.selected=i);else if(I(Do(a),r))return void(t.selectedIndex!==s&&(t.selectedIndex=s));o||(t.selectedIndex=-1)}}function Bo(t,e){return e.every((function(e){return!I(e,t)}))}function Do(t){return"_value"in t?t._value:t.value}function Fo(t){t.target.composing=!0}function qo(t){t.target.composing&&(t.target.composing=!1,No(t.target,"input"))}function No(t,e){var n=document.createEvent("HTMLEvents");n.initEvent(e,!0,!0),t.dispatchEvent(n)}function Ho(t){return!t.componentInstance||t.data&&t.data.transition?t:Ho(t.componentInstance._vnode)}var zo={model:Ro,show:{bind:function(t,e,n){var r=e.value,o=(n=Ho(n)).data&&n.data.transition,i=t.__vOriginalDisplay="none"===t.style.display?"":t.style.display;r&&o?(n.data.show=!0,Eo(n,(function(){t.style.display=i}))):t.style.display=r?i:"none"},update:function(t,e,n){var r=e.value;!r!=!e.oldValue&&((n=Ho(n)).data&&n.data.transition?(n.data.show=!0,r?Eo(n,(function(){t.style.display=t.__vOriginalDisplay})):jo(n,(function(){t.style.display="none"}))):t.style.display=r?t.__vOriginalDisplay:"none")},unbind:function(t,e,n,r,o){o||(t.style.display=t.__vOriginalDisplay)}}},Vo={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Wo(t){var e=t&&t.componentOptions;return e&&e.Ctor.options.abstract?Wo(ke(e.children)):t}function Qo(t){var e={},n=t.$options;for(var r in n.propsData)e[r]=t[r];var o=n._parentListeners;for(var r in o)e[P(r)]=o[r];return e}function Go(t,e){if(/\d-keep-alive$/.test(e.tag))return t("keep-alive",{props:e.componentOptions.propsData})}var Xo=function(t){return t.tag||he(t)},Ko=function(t){return"show"===t.name},Yo={name:"transition",props:Vo,abstract:!0,render:function(t){var e=this,n=this.$slots.default;if(n&&(n=n.filter(Xo)).length){0;var r=this.mode;0;var o=n[0];if(function(t){for(;t=t.parent;)if(t.data.transition)return!0}(this.$vnode))return o;var i=Wo(o);if(!i)return o;if(this._leaving)return Go(t,o);var a="__transition-".concat(this._uid,"-");i.key=null==i.key?i.isComment?a+"comment":a+i.tag:l(i.key)?0===String(i.key).indexOf(a)?i.key:a+i.key:i.key;var s=(i.data||(i.data={})).transition=Qo(this),c=this._vnode,u=Wo(c);if(i.data.directives&&i.data.directives.some(Ko)&&(i.data.show=!0),u&&u.data&&!function(t,e){return e.key===t.key&&e.tag===t.tag}(i,u)&&!he(u)&&(!u.componentInstance||!u.componentInstance._vnode.isComment)){var f=u.data.transition=A({},s);if("out-in"===r)return this._leaving=!0,Qt(f,"afterLeave",(function(){e._leaving=!1,e.$forceUpdate()})),Go(t,o);if("in-out"===r){if(he(i))return c;var p,d=function(){p()};Qt(s,"afterEnter",d),Qt(s,"enterCancelled",d),Qt(f,"delayLeave",(function(t){p=t}))}}return o}}},Jo=A({tag:String,moveClass:String},Vo);function Zo(t){t.elm._moveCb&&t.elm._moveCb(),t.elm._enterCb&&t.elm._enterCb()}function ti(t){t.data.newPos=t.elm.getBoundingClientRect()}function ei(t){var e=t.data.pos,n=t.data.newPos,r=e.left-n.left,o=e.top-n.top;if(r||o){t.data.moved=!0;var i=t.elm.style;i.transform=i.WebkitTransform="translate(".concat(r,"px,").concat(o,"px)"),i.transitionDuration="0s"}}delete Jo.mode;var ni={Transition:Yo,TransitionGroup:{props:Jo,beforeMount:function(){var t=this,e=this._update;this._update=function(n,r){var o=Ye(t);t.__patch__(t._vnode,t.kept,!1,!0),t._vnode=t.kept,o(),e.call(t,n,r)}},render:function(t){for(var e=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,o=this.$slots.default||[],i=this.children=[],a=Qo(this),s=0;s-1?yr[t]=e.constructor===window.HTMLUnknownElement||e.constructor===window.HTMLElement:yr[t]=/HTMLUnknownElement/.test(e.toString())},A(Qn.options.directives,zo),A(Qn.options.components,ni),Qn.prototype.__patch__=X?Lo:L,Qn.prototype.$mount=function(t,e){return function(t,e,n){var r;t.$el=e,t.$options.render||(t.$options.render=ht),tn(t,"beforeMount"),r=function(){t._update(t._render(),n)},new Ve(t,r,L,{before:function(){t._isMounted&&!t._isDestroyed&&tn(t,"beforeUpdate")}},!0),n=!1;var o=t._preWatchers;if(o)for(var i=0;i=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(o.path||""),c=e&&e.path||"/",u=l.path?Si(l.path,c,n||o.append):c,f=function(t,e,n){void 0===e&&(e={});var r,o=n||ui;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(ci):ci(a)}return r}(l.query,o.query,r&&r.options.parseQuery),p=o.hash||l.hash;return p&&"#"!==p.charAt(0)&&(p="#"+p),{_normalized:!0,path:u,query:f,hash:p}}var zi,Vi=function(){},Wi={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,o=n.resolve(this.to,r,this.append),i=o.location,a=o.route,s=o.href,l={},c=n.options.linkActiveClass,u=n.options.linkExactActiveClass,f=null==c?"router-link-active":c,p=null==u?"router-link-exact-active":u,d=null==this.activeClass?f:this.activeClass,h=null==this.exactActiveClass?p:this.exactActiveClass,v=a.redirectedFrom?di(null,Hi(a.redirectedFrom),null,n):a;l[h]=yi(r,v,this.exactPath),l[d]=this.exact||this.exactPath?l[h]:function(t,e){return 0===t.path.replace(pi,"/").indexOf(e.path.replace(pi,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,v);var m=l[h]?this.ariaCurrentValue:null,g=function(t){Qi(t)&&(e.replace?n.replace(i,Vi):n.push(i,Vi))},y={click:Qi};Array.isArray(this.event)?this.event.forEach((function(t){y[t]=g})):y[this.event]=g;var b={class:l},w=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:s,route:a,navigate:g,isActive:l[d],isExactActive:l[h]});if(w){if(1===w.length)return w[0];if(w.length>1||!w.length)return 0===w.length?t():t("span",{},w)}if("a"===this.tag)b.on=y,b.attrs={href:s,"aria-current":m};else{var _=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=Ni(u.path,s.params),l(u,s,a)}if(s.path){s.params={};for(var d=0;d-1}function ka(t,e){return Sa(t)&&t._isRouter&&(null==e||t.type===e)}function Oa(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function Pa(t){return function(e,n,r){var o=!1,i=0,a=null;Ta(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var l,c=ja((function(e){var o;((o=e).__esModule||Ea&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:zi.extend(e),n.components[s]=e,--i<=0&&r()})),u=ja((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=Sa(t)?t:new Error(e),r(a))}));try{l=t(c,u)}catch(t){u(t)}if(l)if("function"==typeof l.then)l.then(c,u);else{var f=l.component;f&&"function"==typeof f.then&&f.then(c,u)}}})),o||r()}}function Ta(t,e){return Ca(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function Ca(t){return Array.prototype.concat.apply([],t)}var Ea="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function ja(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var $a=function(t,e){this.router=t,this.base=function(t){if(!t)if(Gi){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=vi,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Aa(t,e,n,r){var o=Ta(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=zi.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return Ca(r?o.reverse():o)}function Ma(t,e){if(e)return function(){return t.apply(e,arguments)}}$a.prototype.listen=function(t){this.cb=t},$a.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},$a.prototype.onError=function(t){this.errorCbs.push(t)},$a.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(ka(t,ya.redirected)&&i===vi||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},$a.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!ka(t)&&Sa(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},l=t.matched.length-1,c=o.matched.length-1;if(yi(t,o)&&l===c&&t.matched[l]===o.matched[c])return this.ensureURL(),t.hash&&aa(this.router,o,t,!1),s(((a=_a(i=o,t,ya.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var u=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=va&&n;r&&this.listeners.push(ia());var o=function(){var n=t.current,o=Ra(t.base);t.current===vi&&o===t._startLocation||t.transitionTo(o,(function(t){r&&aa(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ma(ki(r.base+t.fullPath)),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ga(ki(r.base+t.fullPath)),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Ra(this.base)!==this.current.fullPath){var e=ki(this.base+this.current.fullPath);t?ma(e):ga(e)}},e.prototype.getCurrentLocation=function(){return Ra(this.base)},e}($a);function Ra(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(ki(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var Ua=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Ra(t);if(!/^\/#/.test(e))return window.location.replace(ki(t+"/#"+e)),!0}(this.base)||Ia()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=va&&e;n&&this.listeners.push(ia());var r=function(){var e=t.current;Ia()&&t.transitionTo(Ba(),(function(r){n&&aa(t.router,r,e,!0),va||qa(r.fullPath)}))},o=va?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Fa(t.fullPath),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){qa(t.fullPath),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Ba()!==e&&(t?Fa(e):qa(e))},e.prototype.getCurrentLocation=function(){return Ba()},e}($a);function Ia(){var t=Ba();return"/"===t.charAt(0)||(qa("/"+t),!1)}function Ba(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function Da(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function Fa(t){va?ma(Da(t)):window.location.hash=t}function qa(t){va?ga(Da(t)):window.location.replace(Da(t))}var Na=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){ka(t,ya.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}($a),Ha=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Yi(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!va&&!1!==t.fallback,this.fallback&&(e="hash"),Gi||(e="abstract"),this.mode=e,e){case"history":this.history=new La(this,t.base);break;case"hash":this.history=new Ua(this,t.base,this.fallback);break;case"abstract":this.history=new Na(this,t.base);break;default:0}},za={currentRoute:{configurable:!0}};Ha.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},za.currentRoute.get=function(){return this.history&&this.history.current},Ha.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof La||n instanceof Ua){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;va&&o&&"fullPath"in t&&aa(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ha.prototype.beforeEach=function(t){return Wa(this.beforeHooks,t)},Ha.prototype.beforeResolve=function(t){return Wa(this.resolveHooks,t)},Ha.prototype.afterEach=function(t){return Wa(this.afterHooks,t)},Ha.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ha.prototype.onError=function(t){this.history.onError(t)},Ha.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ha.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ha.prototype.go=function(t){this.history.go(t)},Ha.prototype.back=function(){this.go(-1)},Ha.prototype.forward=function(){this.go(1)},Ha.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ha.prototype.resolve=function(t,e,n){var r=Hi(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?ki(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ha.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ha.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==vi&&this.history.transitionTo(this.history.getCurrentLocation())},Ha.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==vi&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ha.prototype,za);var Va=Ha;function Wa(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ha.install=function t(e){if(!t.installed||zi!==e){t.installed=!0,zi=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",_i),e.component("RouterLink",Wi);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ha.version="3.6.5",Ha.isNavigationFailure=ka,Ha.NavigationFailureType=ya,Ha.START_LOCATION=vi,Gi&&window.Vue&&window.Vue.use(Ha);n(97);n(90),n(127);var Qa={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(19)]).then(n.bind(null,418)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(20)]).then(n.bind(null,256)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(31)]).then(n.bind(null,244)),"components/Home":()=>Promise.all([n.e(0),n.e(22)]).then(n.bind(null,285)),"components/NavLink":()=>n.e(41).then(n.bind(null,243)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(15)]).then(n.bind(null,268)),"components/Navbar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,415)),"components/Page":()=>Promise.all([n.e(0),n.e(14)]).then(n.bind(null,286)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,270)),"components/PageNav":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,271)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(11)]).then(n.bind(null,287)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(32)]).then(n.bind(null,288)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,269)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(25)]).then(n.bind(null,257)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,255)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,424)),"global-components/CodeBlock":()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,419)),"global-components/CodeGroup":()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,420)),"layouts/404":()=>n.e(7).then(n.bind(null,421)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,422)),NotFound:()=>n.e(7).then(n.bind(null,421)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,422))},Ga={"v-347fe277":()=>n.e(12).then(n.bind(null,425)),"v-96f26938":()=>n.e(48).then(n.bind(null,426)),"v-06f4d0aa":()=>n.e(16).then(n.bind(null,427)),"v-b936cd92":()=>n.e(10).then(n.bind(null,428)),"v-73cb197f":()=>n.e(17).then(n.bind(null,429)),"v-e115e73a":()=>n.e(49).then(n.bind(null,430)),"v-095f6301":()=>n.e(42).then(n.bind(null,431)),"v-2db1db37":()=>n.e(50).then(n.bind(null,432)),"v-117d8812":()=>n.e(51).then(n.bind(null,433)),"v-08357a02":()=>n.e(13).then(n.bind(null,434)),"v-f3fbff12":()=>n.e(52).then(n.bind(null,435)),"v-412f01af":()=>n.e(26).then(n.bind(null,436)),"v-56e06d4d":()=>n.e(54).then(n.bind(null,437)),"v-01bee537":()=>n.e(53).then(n.bind(null,438)),"v-204c7852":()=>n.e(24).then(n.bind(null,439)),"v-5e0eec87":()=>n.e(43).then(n.bind(null,440)),"v-29f81312":()=>n.e(55).then(n.bind(null,441)),"v-0c47cd52":()=>n.e(56).then(n.bind(null,442)),"v-cf2ed192":()=>n.e(33).then(n.bind(null,443)),"v-b5aec012":()=>n.e(44).then(n.bind(null,444)),"v-eab731fa":()=>n.e(34).then(n.bind(null,445)),"v-0d1e8e9e":()=>n.e(57).then(n.bind(null,446)),"v-aa1cc612":()=>n.e(58).then(n.bind(null,447)),"v-2fe62c26":()=>n.e(35).then(n.bind(null,448)),"v-255607ed":()=>n.e(36).then(n.bind(null,449)),"v-7df515d2":()=>n.e(37).then(n.bind(null,450)),"v-6e14dcd7":()=>n.e(27).then(n.bind(null,451)),"v-303bd052":()=>n.e(59).then(n.bind(null,452)),"v-2c32e617":()=>n.e(38).then(n.bind(null,453)),"v-27c660f7":()=>n.e(28).then(n.bind(null,454)),"v-246d3f77":()=>n.e(60).then(n.bind(null,455)),"v-0d819412":()=>n.e(62).then(n.bind(null,456)),"v-bbb970d2":()=>n.e(18).then(n.bind(null,457)),"v-3043a2b9":()=>n.e(39).then(n.bind(null,458)),"v-2b7b8f3b":()=>n.e(61).then(n.bind(null,459)),"v-288d7b9e":()=>n.e(63).then(n.bind(null,460)),"v-20c05837":()=>n.e(45).then(n.bind(null,461)),"v-a9ffe0fe":()=>n.e(46).then(n.bind(null,462)),"v-131b9357":()=>n.e(40).then(n.bind(null,463)),"v-749f316f":()=>n.e(29).then(n.bind(null,464)),"v-21b208b7":()=>n.e(64).then(n.bind(null,465)),"v-2494b4d7":()=>n.e(65).then(n.bind(null,466)),"v-947f362a":()=>n.e(30).then(n.bind(null,467)),"v-93d2a72a":()=>n.e(66).then(n.bind(null,468)),"v-2566e137":()=>n.e(67).then(n.bind(null,469))};function Xa(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const Ka=/-(\w)/g,Ya=Xa(t=>t.replace(Ka,(t,e)=>e?e.toUpperCase():"")),Ja=/\B([A-Z])/g,Za=Xa(t=>t.replace(Ja,"-$1").toLowerCase()),ts=Xa(t=>t.charAt(0).toUpperCase()+t.slice(1));function es(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ts(Ya(e))):t(ts(e))||t(Za(e))}const ns=Object.assign({},Qa,Ga),rs=t=>ns[t],os=t=>Ga[t],is=t=>Qa[t],as=t=>Qn.component(t);function ss(t){return es(os,t)}function ls(t){return es(is,t)}function cs(t){return es(rs,t)}function us(t){return es(as,t)}function fs(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!us(t)&&cs(t)){const e=await cs(t)();Qn.component(t,e.default)}}))}function ps(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var ds=n(86),hs=n.n(ds),vs=n(87),ms=n.n(vs),gs={created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${ms()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=bs(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=ws(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return hs()([{name:"description",content:this.$description}],t,this.siteMeta,_s)},updateCanonicalLink(){ys(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",bs(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){ws(null,this.currentMetaTags),ys()}};function ys(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function bs(t=""){return t?``:""}function ws(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function _s(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var xs=n(88),Ss={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(xs)()((function(){this.setActiveHash()}),300),setActiveHash(){const t=[].slice.call(document.querySelectorAll(".sidebar-link")),e=[].slice.call(document.querySelectorAll(".header-anchor")).filter(e=>t.some(t=>t.hash===e.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let t=0;t=i.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},ks=n(22),Os=n.n(ks),Ps={mounted(){Os.a.configure({showSpinner:!1}),this.$router.beforeEach((t,e,n)=>{t.path===e.path||Qn.component(t.name)||Os.a.start(),n()}),this.$router.afterEach(()=>{Os.a.done(),this.isSidebarOpen=!1})}},Ts=n(89),Cs=n.n(Ts),Es=[gs,Ss,Ps,{mounted(){Cs.a.polyfill()}}],js={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return ps("layout",t),Qn.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},$s=n(14),As=Object($s.a)(js,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(As,"mixins",Es);const Ms=[{name:"v-347fe277",path:"/integrate/aws_iot.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-347fe277").then(n)}},{name:"v-96f26938",path:"/",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-96f26938").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-06f4d0aa",path:"/integrate/home_assistant.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-06f4d0aa").then(n)}},{name:"v-b936cd92",path:"/integrate/jeedom.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-b936cd92").then(n)}},{name:"v-73cb197f",path:"/integrate/node_red.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-73cb197f").then(n)}},{name:"v-e115e73a",path:"/participate/adding-protocols.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-e115e73a").then(n)}},{name:"v-095f6301",path:"/integrate/openhab2.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-095f6301").then(n)}},{name:"v-2db1db37",path:"/participate/community.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2db1db37").then(n)}},{name:"v-117d8812",path:"/participate/development.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-117d8812").then(n)}},{name:"v-08357a02",path:"/integrate/openhab3.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-08357a02").then(n)}},{name:"v-f3fbff12",path:"/participate/support.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-f3fbff12").then(n)}},{name:"v-412f01af",path:"/prerequisites/M5.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-412f01af").then(n)}},{name:"v-56e06d4d",path:"/prerequisites/broker.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-56e06d4d").then(n)}},{name:"v-01bee537",path:"/prerequisites/board.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-01bee537").then(n)}},{name:"v-204c7852",path:"/prerequisites/devices.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-204c7852").then(n)}},{name:"v-5e0eec87",path:"/prerequisites/controller.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-5e0eec87").then(n)}},{name:"v-29f81312",path:"/prerequisites/parts.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-29f81312").then(n)}},{name:"v-0c47cd52",path:"/setitup/actuators.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0c47cd52").then(n)}},{name:"v-cf2ed192",path:"/setitup/ble.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-cf2ed192").then(n)}},{name:"v-b5aec012",path:"/setitup/gsm.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-b5aec012").then(n)}},{name:"v-eab731fa",path:"/setitup/ir.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-eab731fa").then(n)}},{name:"v-0d1e8e9e",path:"/setitup/lora.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0d1e8e9e").then(n)}},{name:"v-aa1cc612",path:"/setitup/sensors.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-aa1cc612").then(n)}},{name:"v-2fe62c26",path:"/setitup/rf.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2fe62c26").then(n)}},{name:"v-255607ed",path:"/setitup/serial.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-255607ed").then(n)}},{name:"v-7df515d2",path:"/upload/advanced-configuration.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-7df515d2").then(n)}},{name:"v-6e14dcd7",path:"/upload/binaries.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-6e14dcd7").then(n)}},{name:"v-303bd052",path:"/upload/builds.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-303bd052").then(n)}},{name:"v-2c32e617",path:"/upload/gitpod.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2c32e617").then(n)}},{name:"v-27c660f7",path:"/upload/portal.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-27c660f7").then(n)}},{name:"v-246d3f77",path:"/upload/troubleshoot.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-246d3f77").then(n)}},{name:"v-0d819412",path:"/use/actuators.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0d819412").then(n)}},{name:"v-bbb970d2",path:"/use/ble.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-bbb970d2").then(n)}},{name:"v-3043a2b9",path:"/use/boards.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-3043a2b9").then(n)}},{name:"v-2b7b8f3b",path:"/upload/web-install.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2b7b8f3b").then(n)}},{name:"v-288d7b9e",path:"/use/displays.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-288d7b9e").then(n)}},{name:"v-20c05837",path:"/use/gateway.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-20c05837").then(n)}},{name:"v-a9ffe0fe",path:"/use/ir.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-a9ffe0fe").then(n)}},{name:"v-131b9357",path:"/use/gsm.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-131b9357").then(n)}},{name:"v-749f316f",path:"/use/lora.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-749f316f").then(n)}},{name:"v-21b208b7",path:"/use/rfm69.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-21b208b7").then(n)}},{name:"v-2494b4d7",path:"/use/sensors.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2494b4d7").then(n)}},{name:"v-947f362a",path:"/use/rf.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-947f362a").then(n)}},{name:"v-93d2a72a",path:"/use/serial.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-93d2a72a").then(n)}},{name:"v-2566e137",path:"/use/webui.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2566e137").then(n)}},{path:"*",component:As}],Ls={title:"Theengs OpenMQTTGateway DEVELOPMENT SHA:326644 TEST ONLY",description:"One gateway, many technologies: MQTT gateway for ESP8266 or ESP32 with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, LoRa, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.",base:"/dev/",headTags:[["meta",{name:"viewport",content:"width=device-width, initial-scale=1"}],["link",{rel:"apple-touch-icon",sizes:"180x180",href:".apple-touch-icon.png"}],["link",{rel:"icon",type:"image/png",sizes:"32x32",href:"/dev/favicon-32x32.png"}],["link",{rel:"icon",type:"image/png",sizes:"16x16",href:"/dev/favicon-16x16.png"}],["link",{rel:"manifest",href:"/dev/manifest.json"}],["meta",{name:"theme-color",content:"#3eaf7c"}],["meta",{name:"apple-mobile-web-app-capable",content:"yes"}],["meta",{name:"apple-mobile-web-app-status-bar-style",content:"black"}],["link",{rel:"mask-icon",href:"/dev/icons/safari-pinned-tab.svg",color:"#3eaf7c"}],["meta",{name:"msapplication-TileImage",content:"/favicon-144x144.png"}],["meta",{name:"msapplication-TileColor",content:"#000000"}],["script",{type:"module",src:"https://unpkg.com/esp-web-tools@9.4.3/dist/web/install-button.js?module"}]],pages:[{title:"Integrate AWS IOT",frontmatter:{},regularPath:"/integrate/aws_iot.html",relativePath:"integrate/aws_iot.md",key:"v-347fe277",path:"/integrate/aws_iot.html",headers:[{level:2,title:"Create a thing",slug:"create-a-thing"},{level:2,title:"Create a policy",slug:"create-a-policy"},{level:2,title:"Create a certificate",slug:"create-a-certificate"},{level:2,title:"Attach Policy with certificate",slug:"attach-policy-with-certificate"},{level:2,title:"Activate certificate and attach it to Thing",slug:"activate-certificate-and-attach-it-to-thing"},{level:2,title:"Find AWS EndPoint",slug:"find-aws-endpoint"},{level:2,title:"Gather the information for OpenMQTTGateway configuration",slug:"gather-the-information-for-openmqttgateway-configuration"},{level:2,title:"Modify OpenMQTTGateway configuration",slug:"modify-openmqttgateway-configuration"},{level:2,title:"Build and upload",slug:"build-and-upload"},{level:2,title:"Connect to a WiFi Access point see portal",slug:"connect-to-a-wifi-access-point-see-portal"},{level:2,title:"Verify that you receive data in AWS",slug:"verify-that-you-receive-data-in-aws"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{frontmatter:{},regularPath:"/",relativePath:"README.md",key:"v-96f26938",path:"/",headers:[{level:2,title:"Using OpenMQTTGateway ?",slug:"using-openmqttgateway"},{level:2,title:"Products powered by OpenMQTTGateway",slug:"products-powered-by-openmqttgateway"},{level:3,title:"Theengs Bridge, BLE gateway with external antenna",slug:"theengs-bridge-ble-gateway-with-external-antenna"},{level:3,title:"Theengs Plug, BLE gateway and Smart Plug",slug:"theengs-plug-ble-gateway-and-smart-plug"},{level:2,title:"Media",slug:"media"},{level:3,title:"Theengs Plug",slug:"theengs-plug"},{level:3,title:"433Mhz and BLE",slug:"_433mhz-and-ble"},{level:3,title:"BLE",slug:"ble"},{level:3,title:"433Mhz",slug:"_433mhz"},{level:3,title:"LORA",slug:"lora"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate Home Assistant",frontmatter:{},regularPath:"/integrate/home_assistant.html",relativePath:"integrate/home_assistant.md",key:"v-06f4d0aa",path:"/integrate/home_assistant.html",headers:[{level:2,title:"Automatic integration with Auto discovery",slug:"automatic-integration-with-auto-discovery"},{level:3,title:"RTL_433 auto discovery specificity",slug:"rtl-433-auto-discovery-specificity"},{level:3,title:"RF (RCSwitch based gateway) Auto discovery specificity",slug:"rf-rcswitch-based-gateway-auto-discovery-specificity"},{level:2,title:"Manual integration",slug:"manual-integration"},{level:3,title:"Pir Sensor",slug:"pir-sensor"},{level:3,title:"Door sensor",slug:"door-sensor"},{level:3,title:"Motion sensor",slug:"motion-sensor"},{level:3,title:"Switches",slug:"switches"},{level:3,title:"RF gateway mode - Pilight, RF, kaku",slug:"rf-gateway-mode-pilight-rf-kaku"},{level:3,title:"Mijia Thermometer BLE",slug:"mijia-thermometer-ble"},{level:3,title:"Xiaomi Mi Scale V2 BLE (XMTZC05HM)",slug:"xiaomi-mi-scale-v2-ble-xmtzc05hm"},{level:3,title:"MQTT Room Presence",slug:"mqtt-room-presence"},{level:3,title:"Temperature sensor",slug:"temperature-sensor"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate Jeedom",frontmatter:{},regularPath:"/integrate/jeedom.html",relativePath:"integrate/jeedom.md",key:"v-b936cd92",path:"/integrate/jeedom.html",headers:[{level:2,title:"Installation of jMQTT",slug:"installation-of-jmqtt"},{level:2,title:"Configuration the Broker in jMQTT",slug:"configuration-the-broker-in-jmqtt"},{level:2,title:"Creation of the OMG device",slug:"creation-of-the-omg-device"},{level:3,title:"Creation of the Last Will and Testament command",slug:"creation-of-the-last-will-and-testament-command"},{level:3,title:"Creation of an action command to restart the OMG device",slug:"creation-of-an-action-command-to-restart-the-omg-device"},{level:2,title:'Creation of the equipment for the "Xiaomi Mi Jia" sensor',slug:"creation-of-the-equipment-for-the-xiaomi-mi-jia-sensor"},{level:3,title:"Creation of an unknown/unidentified BT device",slug:"creation-of-an-unknown-unidentified-bt-device"},{level:3,title:"Creation of a known/identified BT device",slug:"creation-of-a-known-identified-bt-device"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate Node-Red",frontmatter:{},regularPath:"/integrate/node_red.html",relativePath:"integrate/node_red.md",key:"v-73cb197f",path:"/integrate/node_red.html",headers:[{level:2,title:"Integrate BLE sensors, devices and display a dashboard",slug:"integrate-ble-sensors-devices-and-display-a-dashboard"},{level:3,title:"Broker connection",slug:"broker-connection"},{level:3,title:"Json message processing",slug:"json-message-processing"},{level:3,title:"Dashboard",slug:"dashboard"},{level:2,title:"Integrate RF",slug:"integrate-rf"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Adding protocols",frontmatter:{},regularPath:"/participate/adding-protocols.html",relativePath:"participate/adding-protocols.md",key:"v-e115e73a",path:"/participate/adding-protocols.html",headers:[{level:2,title:"RF or IR",slug:"rf-or-ir"},{level:2,title:"BLE",slug:"ble"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate OPENHAB2",frontmatter:{},regularPath:"/integrate/openhab2.html",relativePath:"integrate/openhab2.md",key:"v-095f6301",path:"/integrate/openhab2.html",headers:[{level:2,title:"Auto discovery through home assistant convention",slug:"auto-discovery-through-home-assistant-convention"},{level:2,title:"MQTT 2 manual setup >=Openhab2.4",slug:"mqtt-2-manual-setup-openhab2-4"},{level:2,title:"For a mi flora or mi jia temperature :",slug:"for-a-mi-flora-or-mi-jia-temperature"},{level:2,title:'For a switch channel, add a channel by choosing the type "On/Off switch"',slug:"for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Community participation",frontmatter:{},regularPath:"/participate/community.html",relativePath:"participate/community.md",key:"v-2db1db37",path:"/participate/community.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Development contributions",frontmatter:{},regularPath:"/participate/development.html",relativePath:"participate/development.md",key:"v-117d8812",path:"/participate/development.html",headers:[{level:2,title:"Nightly builds",slug:"nightly-builds"},{level:2,title:"Developer Certificate Of Origin",slug:"developer-certificate-of-origin"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate OPENHAB 3/4",frontmatter:{},regularPath:"/integrate/openhab3.html",relativePath:"integrate/openhab3.md",key:"v-08357a02",path:"/integrate/openhab3.html",headers:[{level:2,title:"Prerequisites",slug:"prerequisites"},{level:2,title:"IP address (if your broker is installed on the same server as OpenHAB)",slug:"ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"},{level:2,title:"Install the MQTT binding",slug:"install-the-mqtt-binding"},{level:2,title:"Install Jinja and JSONPath Transformations",slug:"install-jinja-and-jsonpath-transformations"},{level:2,title:"Upload OpenMQTTGateway to an ESP32",slug:"upload-openmqttgateway-to-an-esp32"},{level:2,title:"Configure OpenMQTTGateway from the web portal",slug:"configure-openmqttgateway-from-the-web-portal"},{level:2,title:"Adding the things",slug:"adding-the-things"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Supporting the project",frontmatter:{},regularPath:"/participate/support.html",relativePath:"participate/support.md",key:"v-f3fbff12",path:"/participate/support.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"M5 Boards",frontmatter:{},regularPath:"/prerequisites/M5.html",relativePath:"prerequisites/M5.md",key:"v-412f01af",path:"/prerequisites/M5.html",headers:[{level:2,title:"M5StickC and M5Stack",slug:"m5stickc-and-m5stack"},{level:3,title:"3 low power modes",slug:"_3-low-power-modes"},{level:3,title:"Start screen",slug:"start-screen"},{level:3,title:"Sleep screen",slug:"sleep-screen"},{level:3,title:"Log display in case of warning",slug:"log-display-in-case-of-warning"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Broker",frontmatter:{},regularPath:"/prerequisites/broker.html",relativePath:"prerequisites/broker.md",key:"v-56e06d4d",path:"/prerequisites/broker.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Boards",frontmatter:{},regularPath:"/prerequisites/board.html",relativePath:"prerequisites/board.md",key:"v-01bee537",path:"/prerequisites/board.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Devices",frontmatter:{},regularPath:"/prerequisites/devices.html",relativePath:"prerequisites/devices.md",key:"v-204c7852",path:"/prerequisites/devices.html",headers:[{level:2,title:"For radio frequency devices",slug:"for-radio-frequency-devices"},{level:2,title:"For BLE devices",slug:"for-ble-devices"},{level:2,title:"For infrared IR devices",slug:"for-infrared-ir-devices"},{level:2,title:"LORA",slug:"lora"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Controller",frontmatter:{},regularPath:"/prerequisites/controller.html",relativePath:"prerequisites/controller.md",key:"v-5e0eec87",path:"/prerequisites/controller.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Parts",frontmatter:{},regularPath:"/prerequisites/parts.html",relativePath:"prerequisites/parts.md",key:"v-29f81312",path:"/prerequisites/parts.html",headers:[{level:2,title:"Main parts",slug:"main-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Actuators",frontmatter:{},regularPath:"/setitup/actuators.html",relativePath:"setitup/actuators.md",key:"v-0c47cd52",path:"/setitup/actuators.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"Somfy RTS",slug:"somfy-rts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"BLE gateway",frontmatter:{},regularPath:"/setitup/ble.html",relativePath:"setitup/ble.md",key:"v-cf2ed192",path:"/setitup/ble.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"GSM 2G gateway",frontmatter:{},regularPath:"/setitup/gsm.html",relativePath:"setitup/gsm.md",key:"v-b5aec012",path:"/setitup/gsm.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Hardware setup",slug:"hardware-setup"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"IR gateway",frontmatter:{},regularPath:"/setitup/ir.html",relativePath:"setitup/ir.md",key:"v-eab731fa",path:"/setitup/ir.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"Credits",slug:"credits"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"LoRa gateway",frontmatter:{},regularPath:"/setitup/lora.html",relativePath:"setitup/lora.md",key:"v-0d1e8e9e",path:"/setitup/lora.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Sensors",frontmatter:{},regularPath:"/setitup/sensors.html",relativePath:"setitup/sensors.md",key:"v-aa1cc612",path:"/setitup/sensors.html",headers:[{level:2,title:"Compatible sensors",slug:"compatible-sensors"},{level:2,title:"Pinout",slug:"pinout"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RF gateway (433mhz/315mhz)",frontmatter:{},regularPath:"/setitup/rf.html",relativePath:"setitup/rf.md",key:"v-2fe62c26",path:"/setitup/rf.html",headers:[{level:2,title:"Protocols, modules and library",slug:"protocols-modules-and-library"},{level:2,title:"Assembly/soldering required parts",slug:"assembly-soldering-required-parts"},{level:3,title:"SRX STX Pinout",slug:"srx-stx-pinout"},{level:3,title:"CC1101 Pinout",slug:"cc1101-pinout"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"SONOFF RF Bridge Hardware setup",slug:"sonoff-rf-bridge-hardware-setup"},{level:2,title:"SONOFF RFR3 Hardware setup",slug:"sonoff-rfr3-hardware-setup"},{level:2,title:"WIFI RF GATEWAY Hardware setup",slug:"wifi-rf-gateway-hardware-setup"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Serial/RS232 gateway",frontmatter:{},regularPath:"/setitup/serial.html",relativePath:"setitup/serial.md",key:"v-255607ed",path:"/setitup/serial.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"Credits",slug:"credits"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Advanced configuration of the gateway",frontmatter:{},regularPath:"/upload/advanced-configuration.html",relativePath:"upload/advanced-configuration.md",key:"v-7df515d2",path:"/upload/advanced-configuration.html",headers:[{level:2,title:"Secure connection to the broker",slug:"secure-connection-to-the-broker"},{level:3,title:"Prerequisites",slug:"prerequisites"},{level:3,title:"Configure secure connection in the gateway",slug:"configure-secure-connection-in-the-gateway"},{level:2,title:'Add the received "value" at the end of the topic',slug:"add-the-received-value-at-the-end-of-the-topic"},{level:2,title:"Auto discovery",slug:"auto-discovery"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 2) Upload ready-to-go binaries",frontmatter:{},regularPath:"/upload/binaries.html",relativePath:"upload/binaries.md",key:"v-6e14dcd7",path:"/upload/binaries.html",headers:[{level:2,title:"ESP32",slug:"esp32"},{level:3,title:"Linux - esptool.py",slug:"linux-esptool-py"},{level:3,title:"Mac - esptool.py",slug:"mac-esptool-py"},{level:2,title:"ESP8266",slug:"esp8266"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 3) Upload your configurations",frontmatter:{},regularPath:"/upload/builds.html",relativePath:"upload/builds.md",key:"v-303bd052",path:"/upload/builds.html",headers:[{level:2,title:"Introduction",slug:"introduction"},{level:2,title:"Configure & Upload with PlatformIO",slug:"configure-upload-with-platformio"},{level:3,title:"(Option A) Creating a portable config file",slug:"option-a-creating-a-portable-config-file"},{level:3,title:"(Option B) Editing files directly",slug:"option-b-editing-files-directly"},{level:2,title:"API",slug:"api"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 4) Build from the web",frontmatter:{},regularPath:"/upload/gitpod.html",relativePath:"upload/gitpod.md",key:"v-2c32e617",path:"/upload/gitpod.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Wifi and MQTT configuration",frontmatter:{},regularPath:"/upload/portal.html",relativePath:"upload/portal.md",key:"v-27c660f7",path:"/upload/portal.html",headers:[{level:2,title:"Configuration portal",slug:"configuration-portal"},{level:2,title:"Build time configuration",slug:"build-time-configuration"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Troubleshooting",frontmatter:{},regularPath:"/upload/troubleshoot.html",relativePath:"upload/troubleshoot.md",key:"v-246d3f77",path:"/upload/troubleshoot.html",headers:[{level:2,title:"Compilation/build error",slug:"compilation-build-error"},{level:2,title:"ESP32 compilation errors related to WiFi",slug:"esp32-compilation-errors-related-to-wifi"},{level:2,title:"Not able to send or receive RF or IR",slug:"not-able-to-send-or-receive-rf-or-ir"},{level:2,title:"Repetitive MQTT disconnections or/and commands sent to the gateway not taken into account",slug:"repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"},{level:2,title:"OMG ignores messages sent to it via MQTT",slug:"omg-ignores-messages-sent-to-it-via-mqtt"},{level:2,title:"ESP Continuous restart or strange behaviour:",slug:"esp-continuous-restart-or-strange-behaviour"},{level:2,title:"ESP does not connect to broker with TLS enabled",slug:"esp-does-not-connect-to-broker-with-tls-enabled"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Actuators",frontmatter:{},regularPath:"/use/actuators.html",relativePath:"use/actuators.md",key:"v-0d819412",path:"/use/actuators.html",headers:[{level:2,title:"ON/OFF Functionality",slug:"on-off-functionality"},{level:3,title:"Standard ON/OFF control",slug:"standard-on-off-control"},{level:3,title:"Pulse control for short activations",slug:"pulse-control-for-short-activations"},{level:2,title:"FASTLED",slug:"fastled"},{level:3,title:"The FASTLED module support 2 different operation modes",slug:"the-fastled-module-support-2-different-operation-modes"},{level:3,title:"Hardware wiring",slug:"hardware-wiring"},{level:2,title:"PWM",slug:"pwm"},{level:3,title:"Configuration",slug:"configuration"},{level:3,title:"Usage",slug:"usage"},{level:2,title:"Somfy RTS",slug:"somfy-rts"},{level:3,title:"Setup",slug:"setup"},{level:3,title:"Commands",slug:"commands"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Bluetooth ESP32 gateway",frontmatter:{title:"Bluetooth ESP32 gateway",description:"Versatile Bluetooth gateway that scans and decodes data from various Bluetooth Low Energy (BLE) devices. It integrates seamlessly with MQTT brokers and controllers like Home Assistant and OpenHAB. Monitor temperature, humidity, pressure, and more for smarter control."},regularPath:"/use/ble.html",relativePath:"use/ble.md",key:"v-bbb970d2",path:"/use/ble.html",headers:[{level:2,title:"Products powered by OpenMQTTGateway",slug:"products-powered-by-openmqttgateway"},{level:3,title:"Theengs Bridge, BLE gateway with external antenna",slug:"theengs-bridge-ble-gateway-with-external-antenna"},{level:3,title:"Theengs Plug, BLE gateway and Smart Plug",slug:"theengs-plug-ble-gateway-and-smart-plug"},{level:2,title:"Disable or enable the BLE gateway (default: true, available with HA discovery)",slug:"disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"},{level:2,title:"Receiving signals from compatible BLE sensors to publish it to an MQTT broker.",slug:"receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"},{level:2,title:"Receiving signals from BLE devices for Device Tracker detection",slug:"receiving-signals-from-ble-devices-for-device-tracker-detection"},{level:2,title:"Receiving signals from BLE devices for Presence detection",slug:"receiving-signals-from-ble-devices-for-presence-detection"},{level:2,title:"Receiving signals from BLE devices with accelerometers for movement detection",slug:"receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"},{level:2,title:"Setting a white or black list",slug:"setting-a-white-or-black-list"},{level:2,title:"Setting the time between BLE scans and force a scan (available with HA discovery)",slug:"setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"},{level:2,title:"Setting the time between connection attempts (default: 60min, available with HA discovery)",slug:"setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publishes all the BLE devices scanned or only the detected sensors (default: false, available with HA discovery)",slug:"setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publishes known devices which randomly change their MAC address (default: false)",slug:"setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"},{level:2,title:"Setting if the gateway use adaptive scanning (default: true, available with HA discovery)",slug:"setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"},{level:2,title:"Setting the time between active scanning (available with HA discovery)",slug:"setting-the-time-between-active-scanning-available-with-ha-discovery"},{level:2,title:"Setting the duration of a scan (available with HA discovery)",slug:"setting-the-duration-of-a-scan-available-with-ha-discovery"},{level:2,title:"Setting if the gateway connects to BLE devices eligibles (default: true, available with HA discovery)",slug:"setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publish into Home Assistant Home presence topic (default: false, available with HA discovery)",slug:"setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"},{level:2,title:"Setting if the gateway uses iBeacon UUID as topic, instead of (random) MAC address (default: false)",slug:"setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"},{level:2,title:"Setting the minimum RSSI accepted to publish device data (default:-100)",slug:"setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"},{level:2,title:"Store BLE configuration into the gateway",slug:"store-ble-configuration-into-the-gateway"},{level:2,title:"Controlling devices",slug:"controlling-devices"},{level:2,title:"Read/write BLE characteristics over MQTT",slug:"read-write-ble-characteristics-over-mqtt"},{level:3,title:"Example write command",slug:"example-write-command"},{level:3,title:"Example read command",slug:"example-read-command"},{level:2,title:"SwitchBot Bot control (available with HA discovery)",slug:"switchbot-bot-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Bot state to ON:",slug:"set-the-switchbot-bot-state-to-on"},{level:3,title:"Set the SwitchBot Bot state to OFF:",slug:"set-the-switchbot-bot-state-to-off"},{level:3,title:"Set the SwitchBot Bot to PRESS:",slug:"set-the-switchbot-bot-to-press"},{level:3,title:"Set the SwitchBot Bot to go UP:",slug:"set-the-switchbot-bot-to-go-up"},{level:3,title:"Set the SwitchBot Bot to go DOWN:",slug:"set-the-switchbot-bot-to-go-down"},{level:2,title:"SwitchBot Blind Tilt control (available with HA discovery)",slug:"switchbot-blind-tilt-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Blind Tilt state to OPEN:",slug:"set-the-switchbot-blind-tilt-state-to-open"},{level:3,title:"Set the SwitchBot Blind Tilt state to CLOSE_DOWN:",slug:"set-the-switchbot-blind-tilt-state-to-close-down"},{level:3,title:"Set the SwitchBot Blind Tilt state to CLOSE_UP:",slug:"set-the-switchbot-blind-tilt-state-to-close-up"},{level:3,title:"Set the SwitchBot Blind Tilt state to a percentage (0-100):",slug:"set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"},{level:3,title:"Set the SwitchBot Blind Tilt to Stop:",slug:"set-the-switchbot-blind-tilt-to-stop"},{level:3,title:"Response (assuming success):",slug:"response-assuming-success"},{level:2,title:"SwitchBot Curtain (2/3) control (available with HA discovery)",slug:"switchbot-curtain-2-3-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Curtain state to OPEN:",slug:"set-the-switchbot-curtain-state-to-open"},{level:3,title:"Set the SwitchBot Curtain state to CLOSE:",slug:"set-the-switchbot-curtain-state-to-close"},{level:3,title:"Set the SwitchBot Curtain to a percentage (0-100):",slug:"set-the-switchbot-curtain-to-a-percentage-0-100"},{level:3,title:"Set the SwitchBot Curtain to Stop:",slug:"set-the-switchbot-curtain-to-stop"},{level:3,title:"Response (assuming success):",slug:"response-assuming-success-2"},{level:2,title:"ADVANCED: Setting up an external decoder",slug:"advanced-setting-up-an-external-decoder"},{level:2,title:"ADVANCED: Filtering out connectable devices (default: false)",slug:"advanced-filtering-out-connectable-devices-default-false"},{level:2,title:"ADVANCED: Advertisement and advanced data (default: false, available with HA discovery)",slug:"advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Boards",frontmatter:{},regularPath:"/use/boards.html",relativePath:"use/boards.md",key:"v-3043a2b9",path:"/use/boards.html",headers:[{level:2,title:"ESP",slug:"esp"},{level:3,title:"Erasing the flash",slug:"erasing-the-flash"},{level:3,title:"Wifi interference on sensors when using an ESP",slug:"wifi-interference-on-sensors-when-using-an-esp"},{level:3,title:"Low power mode for ESP32",slug:"low-power-mode-for-esp32"},{level:2,title:"M5StickC, M5StickC Plus or M5Stack",slug:"m5stickc-m5stickc-plus-or-m5stack"},{level:3,title:"Behaviour",slug:"behaviour"},{level:3,title:"Setting the log output",slug:"setting-the-log-output"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 1) Upload from the web",frontmatter:{pageClass:"table-generated-page"},regularPath:"/upload/web-install.html",relativePath:"upload/web-install.md",key:"v-2b7b8f3b",path:"/upload/web-install.html",headers:[{level:2,title:"Using OpenMQTTGateway ?",slug:"using-openmqttgateway"},{level:2,title:"Environments characteristics",slug:"environments-characteristics"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Displays",frontmatter:{},regularPath:"/use/displays.html",relativePath:"use/displays.md",key:"v-288d7b9e",path:"/use/displays.html",headers:[{level:2,title:"SSD1306 Display (Heltec SX127X, LILYGO® LoRa32 boards, generic SSD1306 displays)",slug:"ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"},{level:3,title:"Display ON/OFF",slug:"display-on-off"},{level:3,title:"Brightness",slug:"brightness"},{level:3,title:"Metric or Imperial property units",slug:"metric-or-imperial-property-units"},{level:3,title:"Rotating the display by 180 degrees",slug:"rotating-the-display-by-180-degrees"},{level:3,title:"Display idle Logo",slug:"display-idle-logo"},{level:3,title:"Setting the log output",slug:"setting-the-log-output"},{level:3,title:"Displaying Module json messages (default)",slug:"displaying-module-json-messages-default"},{level:3,title:"Store the current display configuration in the gateway",slug:"store-the-current-display-configuration-in-the-gateway"},{level:3,title:"Connecting a generic SSD1306 display to ESP32",slug:"connecting-a-generic-ssd1306-display-to-esp32"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"System commands (ESP only)",frontmatter:{},regularPath:"/use/gateway.html",relativePath:"use/gateway.md",key:"v-20c05837",path:"/use/gateway.html",headers:[{level:2,title:"Restart the ESP",slug:"restart-the-esp"},{level:2,title:"Erase the ESP settings",slug:"erase-the-esp-settings"},{level:2,title:"Retrieve current status of the ESP",slug:"retrieve-current-status-of-the-esp"},{level:2,title:"Auto discovery",slug:"auto-discovery"},{level:3,title:"Deactivate",slug:"deactivate"},{level:3,title:"Activate",slug:"activate"},{level:2,title:"Activate Offline mode",slug:"activate-offline-mode"},{level:2,title:"Change the WiFi credentials",slug:"change-the-wifi-credentials"},{level:2,title:"Change the gateway password",slug:"change-the-gateway-password"},{level:2,title:"Change the MQTT broker credentials",slug:"change-the-mqtt-broker-credentials"},{level:2,title:"Change the MQTT main topic, discovery prefix, and or gateway name",slug:"change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"},{level:2,title:"Switching brokers and using signed and client certificates",slug:"switching-brokers-and-using-signed-and-client-certificates"},{level:2,title:"Saving/Loading connection parameters/certificates at runtime",slug:"saving-loading-connection-parameters-certificates-at-runtime"},{level:3,title:"Storing and Loading Certificates",slug:"storing-and-loading-certificates"},{level:3,title:"Use Case: Changing a Group of Certificates",slug:"use-case-changing-a-group-of-certificates"},{level:2,title:"MQTT",slug:"mqtt"},{level:2,title:"Serial",slug:"serial"},{level:2,title:"Change the LED indicator brightness",slug:"change-the-led-indicator-brightness"},{level:2,title:"Understanding LED Indicators in OpenMQTTGateway",slug:"understanding-led-indicators-in-openmqttgateway"},{level:2,title:"LED Color Guide",slug:"led-color-guide"},{level:2,title:"Understanding Gateway States",slug:"understanding-gateway-states"},{level:3,title:"Power On",slug:"power-on"},{level:3,title:"Processing",slug:"processing"},{level:3,title:"Waiting for Onboarding",slug:"waiting-for-onboarding"},{level:3,title:"Onboarding in Progress",slug:"onboarding-in-progress"},{level:3,title:"Network Connected",slug:"network-connected"},{level:3,title:"Network Disconnected",slug:"network-disconnected"},{level:3,title:"MQTT Broker Connected",slug:"mqtt-broker-connected"},{level:3,title:"MQTT Broker Disconnected",slug:"mqtt-broker-disconnected"},{level:3,title:"Offline",slug:"offline"},{level:3,title:"Local OTA Update",slug:"local-ota-update"},{level:3,title:"Remote OTA Update",slug:"remote-ota-update"},{level:3,title:"Error",slug:"error"},{level:3,title:"Actuator On/Off",slug:"actuator-on-off"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Infrared gateway",frontmatter:{title:"Infrared gateway",description:"Unlock the potential of Infrared technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems abd controllers like Home Assistant and OpenHAB."},regularPath:"/use/ir.html",relativePath:"use/ir.md",key:"v-a9ffe0fe",path:"/use/ir.html",headers:[{level:2,title:"Receiving data from IR signal",slug:"receiving-data-from-ir-signal"},{level:2,title:"Send data by MQTT to convert it on IR signal",slug:"send-data-by-mqtt-to-convert-it-on-ir-signal"},{level:2,title:"Send data by MQTT from Global Caché database to convert it on IR signal",slug:"send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"},{level:2,title:"Send data by MQTT with advanced IR parameters",slug:"send-data-by-mqtt-with-advanced-ir-parameters"},{level:2,title:"Send raw IR data by MQTT",slug:"send-raw-ir-data-by-mqtt"},{level:2,title:"Repeat the IR signal OpenMQTTGateway receive",slug:"repeat-the-ir-signal-openmqttgateway-receive"},{level:2,title:"Raw IR signal forwarding",slug:"raw-ir-signal-forwarding"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"GSM 2G gateway",frontmatter:{},regularPath:"/use/gsm.html",relativePath:"use/gsm.md",key:"v-131b9357",path:"/use/gsm.html",headers:[{level:2,title:"Receiving SMS from 2G",slug:"receiving-sms-from-2g"},{level:2,title:"Send data by MQTT to send an SMS message with A6/7",slug:"send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"LoRa gateway",frontmatter:{title:"LoRa gateway",description:"Explore the LoRa MQTT gateway, designed for integration with devices utilizing LoRa technology, including the MakerFab soil and moisture sensor, devices from PricelessTookit. Unlock long range communication with the power of LoRa.."},regularPath:"/use/lora.html",relativePath:"use/lora.md",key:"v-749f316f",path:"/use/lora.html",headers:[{level:2,title:"What is a LoRa gateway",slug:"what-is-a-lora-gateway"},{level:2,title:"Configuring the LoRa gateway",slug:"configuring-the-lora-gateway"},{level:2,title:"Receiving data from LoRa signal",slug:"receiving-data-from-lora-signal"},{level:2,title:"Send data by MQTT to convert it on LoRa signal",slug:"send-data-by-mqtt-to-convert-it-on-lora-signal"},{level:2,title:"Send data by MQTT with advanced LoRa parameters",slug:"send-data-by-mqtt-with-advanced-lora-parameters"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RFM69 gateway",frontmatter:{},regularPath:"/use/rfm69.html",relativePath:"use/rfm69.md",key:"v-21b208b7",path:"/use/rfm69.html",headers:[{level:3,title:"Receiving data from RFM signal",slug:"receiving-data-from-rfm-signal"},{level:3,title:"Send data by MQTT to convert it on RFM69 signal",slug:"send-data-by-mqtt-to-convert-it-on-rfm69-signal"},{level:3,title:"Send data by MQTT with advanced RFM69 parameters",slug:"send-data-by-mqtt-with-advanced-rfm69-parameters"},{level:3,title:"RFM69 acknowledgment",slug:"rfm69-acknowledgment"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Sensors",frontmatter:{},regularPath:"/use/sensors.html",relativePath:"use/sensors.md",key:"v-2494b4d7",path:"/use/sensors.html",headers:[{level:3,title:"ADC",slug:"adc"},{level:3,title:"DHT",slug:"dht"},{level:3,title:"HTU21",slug:"htu21"},{level:3,title:"AHTx0 (AHT10 and AHT20)",slug:"ahtx0-aht10-and-aht20"},{level:3,title:"DS18x20",slug:"ds18x20"},{level:3,title:"HCSR501",slug:"hcsr501"},{level:3,title:"RN8209",slug:"rn8209"},{level:3,title:"Touch",slug:"touch"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RF gateways (RTL_433/RCSwitch/RF/RF2)",frontmatter:{title:"RF gateways (RTL_433/RCSwitch/RF/RF2)",description:"Unlock the potential of RF 433 MHz technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems and controllers like Home Assistant and OpenHAB."},regularPath:"/use/rf.html",relativePath:"use/rf.md",key:"v-947f362a",path:"/use/rf.html",headers:[{level:2,title:"What is an RF gateway",slug:"what-is-an-rf-gateway"},{level:2,title:"Common parameters accross modules",slug:"common-parameters-accross-modules"},{level:3,title:"Change default frequency (SX127X and CC1101)",slug:"change-default-frequency-sx127x-and-cc1101"},{level:3,title:"Changing Active Receiver Modules",slug:"changing-active-receiver-modules"},{level:2,title:"RTL_433 device decoders",slug:"rtl-433-device-decoders"},{level:3,title:"Supported hardware combinations",slug:"supported-hardware-combinations"},{level:3,title:"Supported Decoders",slug:"supported-decoders"},{level:3,title:"Change Signal RSSI Threshold Delta",slug:"change-signal-rssi-threshold-delta"},{level:3,title:"Retrieve current status of receiver",slug:"retrieve-current-status-of-receiver"},{level:2,title:"RCSwitch based gateway",slug:"rcswitch-based-gateway"},{level:3,title:"Handling RF signal over MQTT",slug:"handling-rf-signal-over-mqtt"},{level:3,title:"Send data by MQTT with advanced RF parameters",slug:"send-data-by-mqtt-with-advanced-rf-parameters"},{level:2,title:"Pilight gateway",slug:"pilight-gateway"},{level:3,title:"Receiving data from RF signal",slug:"receiving-data-from-rf-signal-2"},{level:3,title:"Limit Protocols",slug:"limit-protocols"},{level:3,title:"Send data by MQTT to transmit a RF signal",slug:"send-data-by-mqtt-to-transmit-a-rf-signal"},{level:2,title:"RF with SONOFF RF BRIDGE",slug:"rf-with-sonoff-rf-bridge"},{level:3,title:"Receiving data from RF signal",slug:"receiving-data-from-rf-signal-3"},{level:3,title:"Send data by MQTT to convert it on RF signal",slug:"send-data-by-mqtt-to-convert-it-on-rf-signal"},{level:3,title:"Send data by MQTT with advanced RF parameters",slug:"send-data-by-mqtt-with-advanced-rf-parameters-2"},{level:2,title:"RF2 gateway KAKU",slug:"rf2-gateway-kaku"},{level:3,title:"Receiving data from KAKU signal",slug:"receiving-data-from-kaku-signal"},{level:3,title:"Send data by MQTT to convert it on KAKU signal",slug:"send-data-by-mqtt-to-convert-it-on-kaku-signal"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RS232/Serial gateway",frontmatter:{},regularPath:"/use/serial.html",relativePath:"use/serial.md",key:"v-93d2a72a",path:"/use/serial.html",headers:[{level:2,title:"Sending an SERIAL message",slug:"sending-an-serial-message"},{level:2,title:"Receiving an SERIAL message",slug:"receiving-an-serial-message"},{level:3,title:"Single MQTT message mode (default)",slug:"single-mqtt-message-mode-default"},{level:3,title:"JSON mode",slug:"json-mode"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"WebUI",frontmatter:{},regularPath:"/use/webui.html",relativePath:"use/webui.md",key:"v-2566e137",path:"/use/webui.html",headers:[{level:2,title:"WiFi",slug:"wifi"},{level:2,title:"MQTT",slug:"mqtt"},{level:2,title:"WebUI",slug:"webui-2"},{level:2,title:"Bluetooth Low Energy - BLE",slug:"bluetooth-low-energy-ble"},{level:2,title:"Logging",slug:"logging"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3}],themeConfig:{repo:"1technophile/OpenMQTTGateway",docsDir:"docs",smoothScroll:!0,search:!1,docsBranch:"development",lastUpdated:"Last Updated",editLinks:!0,nav:[{text:"Home",link:"https://www.theengs.io",target:"_self",rel:""},{text:"Use cases",items:[{text:"Smart Home",link:"https://www.theengs.io/usecases/smarthome.html",target:"_self",rel:""},{text:"IoT",link:"https://www.theengs.io/usecases/iot.html",target:"_self",rel:""},{text:"Research",link:"https://www.theengs.io/usecases/research.html",target:"_self",rel:""}]},{text:"Solutions",items:[{text:"Hardware",items:[{text:"Theengs Plug",link:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_self",rel:""},{text:"Theengs Bridge",link:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_self",rel:""}]},{text:"Software",items:[{text:"Mobile App",link:"https://app.theengs.io",target:"_self",rel:""},{text:"OpenMQTTGateway",link:"https://docs.openmqttgateway.com",target:"_self",rel:""},{text:"Gateway",link:"https://gateway.theengs.io",target:"_self",rel:""}]},{text:"Core",items:[{text:"Decoder",link:"https://decoder.theengs.io",target:"_self",rel:""},{text:"Web Parser",link:"https://parser.theengs.io",target:"_self",rel:""}]}]},{text:"Compatible devices",link:"https://decoder.theengs.io/devices/devices.html",target:"_self",rel:""},{text:"Community",link:"https://community.openmqttgateway.com",target:"_self",rel:""},{text:"Shop",link:"https://shop.theengs.io/",target:"_self",rel:""},{text:"Sponsor 🤍",link:"https://github.com/sponsors/theengs",target:"_self",rel:""}],sidebar:[["/","0 - What is it for 🏠"],{title:"1 - Prerequisites🧭",sidebarDepth:1,children:["prerequisites/devices","prerequisites/board","prerequisites/parts","prerequisites/broker","prerequisites/controller"]},{title:"2 - Set it up 🔨",sidebarDepth:1,children:["setitup/rf","setitup/ble","setitup/ir","setitup/lora","setitup/gsm","setitup/serial","setitup/sensors","setitup/actuators"]},{title:"3 - Upload ➡️",sidebarDepth:1,children:["upload/web-install","upload/binaries","upload/builds","upload/gitpod","upload/portal","upload/advanced-configuration","upload/troubleshoot"]},{title:"4 - Use ✈️",sidebarDepth:1,children:["use/rf","use/ble","use/ir","use/lora","use/gsm","use/serial","use/rfm69","use/sensors","use/actuators","use/boards","use/displays","use/gateway","use/webui"]},{title:"5 - Integrate 🎉",sidebarDepth:1,children:["integrate/openhab2","integrate/openhab3","integrate/home_assistant","integrate/node_red","integrate/aws_iot","integrate/jeedom"]},{title:"6 - Participate 💻",sidebarDepth:1,children:["participate/support","participate/development","participate/adding-protocols","participate/community",["https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt","License"]]}]}};n(235);Qn.component("web-uploader",()=>n.e(47).then(n.bind(null,423))),Qn.component("Badge",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,424))),Qn.component("CodeBlock",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,419))),Qn.component("CodeGroup",()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,420)));n(236),n(237);function Rs(t){const e=document.documentElement.getBoundingClientRect(),n=t.getBoundingClientRect();return{x:n.left-e.left,y:n.top-e.top}}var Us=[{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},({Vue:t,router:e})=>{e.options.scrollBehavior=(e,n,r)=>{if(r)return window.scrollTo({top:r.y,behavior:"smooth"});if(e.hash){if(t.$vuepress.$get("disableScrollBehavior"))return!1;const n=document.querySelector(e.hash);return!!n&&window.scrollTo({top:Rs(n).y,behavior:"smooth"})}return window.scrollTo({top:0,behavior:"smooth"})}}],Is=[];class Bs extends class{constructor(){this.store=new Qn({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){Qn.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Bs.prototype,{getPageAsyncComponent:ss,getLayoutAsyncComponent:ls,getAsyncComponent:cs,getVueComponent:us});var Ds={install(t){const e=new Bs;t.$vuepress=e,t.prototype.$vuepress=e}};function Fs(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var qs={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return ps("pageKey",e),Qn.component(e)||Qn.component(e,ss(e)),Qn.component(e)?t(e):t("")}},Ns={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Hs={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},zs=(n(238),n(239),Object($s.a)(Hs,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[t("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),t("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Vs={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};Qn.config.productionTip=!1,Qn.use(Va),Qn.use(Ds),Qn.mixin(function(t,e,n=Qn){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const r=new(t(n.$vuepress.$get("siteData"))),o=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),i={};return Object.keys(o).reduce((t,e)=>(e.startsWith("$")&&(t[e]=o[e].get),t),i),{computed:i}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!Qn.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Fs(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Fs(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Fs(t,o)?r(o):Fs(t,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Us.filter(t=>"function"==typeof t).map(e=>e({Vue:Qn,options:r,router:n,siteData:Ls,isServer:t})))}catch(t){console.error(t)}return{app:new Qn(Object.assign(r,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Is.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file +var r=Object.freeze({}),o=Array.isArray;function i(t){return null==t}function a(t){return null!=t}function s(t){return!0===t}function l(t){return"string"==typeof t||"number"==typeof t||"symbol"==typeof t||"boolean"==typeof t}function c(t){return"function"==typeof t}function u(t){return null!==t&&"object"==typeof t}var f=Object.prototype.toString;function p(t){return"[object Object]"===f.call(t)}function d(t){return"[object RegExp]"===f.call(t)}function h(t){var e=parseFloat(String(t));return e>=0&&Math.floor(e)===e&&isFinite(t)}function v(t){return a(t)&&"function"==typeof t.then&&"function"==typeof t.catch}function m(t){return null==t?"":Array.isArray(t)||p(t)&&t.toString===f?JSON.stringify(t,g,2):String(t)}function g(t,e){return e&&e.__v_isRef?e.value:e}function y(t){var e=parseFloat(t);return isNaN(e)?t:e}function b(t,e){for(var n=Object.create(null),r=t.split(","),o=0;o-1)return t.splice(r,1)}}var x=Object.prototype.hasOwnProperty;function S(t,e){return x.call(t,e)}function k(t){var e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}var O=/-(\w)/g,P=k((function(t){return t.replace(O,(function(t,e){return e?e.toUpperCase():""}))})),T=k((function(t){return t.charAt(0).toUpperCase()+t.slice(1)})),C=/\B([A-Z])/g,E=k((function(t){return t.replace(C,"-$1").toLowerCase()}));var j=Function.prototype.bind?function(t,e){return t.bind(e)}:function(t,e){function n(n){var r=arguments.length;return r?r>1?t.apply(e,arguments):t.call(e,n):t.call(e)}return n._length=t.length,n};function $(t,e){e=e||0;for(var n=t.length-e,r=new Array(n);n--;)r[n]=t[n+e];return r}function A(t,e){for(var n in e)t[n]=e[n];return t}function M(t){for(var e={},n=0;n0,Z=K&&K.indexOf("edge/")>0;K&&K.indexOf("android");var tt=K&&/iphone|ipad|ipod|ios/.test(K);K&&/chrome\/\d+/.test(K),K&&/phantomjs/.test(K);var et,nt=K&&K.match(/firefox\/(\d+)/),rt={}.watch,ot=!1;if(X)try{var it={};Object.defineProperty(it,"passive",{get:function(){ot=!0}}),window.addEventListener("test-passive",null,it)}catch(t){}var at=function(){return void 0===et&&(et=!X&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),et},st=X&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function lt(t){return"function"==typeof t&&/native code/.test(t.toString())}var ct,ut="undefined"!=typeof Symbol&<(Symbol)&&"undefined"!=typeof Reflect&<(Reflect.ownKeys);ct="undefined"!=typeof Set&<(Set)?Set:function(){function t(){this.set=Object.create(null)}return t.prototype.has=function(t){return!0===this.set[t]},t.prototype.add=function(t){this.set[t]=!0},t.prototype.clear=function(){this.set=Object.create(null)},t}();var ft=null;function pt(t){void 0===t&&(t=null),t||ft&&ft._scope.off(),ft=t,t&&t._scope.on()}var dt=function(){function t(t,e,n,r,o,i,a,s){this.tag=t,this.data=e,this.children=n,this.text=r,this.elm=o,this.ns=void 0,this.context=i,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=e&&e.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=s,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(t.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),t}(),ht=function(t){void 0===t&&(t="");var e=new dt;return e.text=t,e.isComment=!0,e};function vt(t){return new dt(void 0,void 0,void 0,String(t))}function mt(t){var e=new dt(t.tag,t.data,t.children&&t.children.slice(),t.text,t.elm,t.context,t.componentOptions,t.asyncFactory);return e.ns=t.ns,e.isStatic=t.isStatic,e.key=t.key,e.isComment=t.isComment,e.fnContext=t.fnContext,e.fnOptions=t.fnOptions,e.fnScopeId=t.fnScopeId,e.asyncMeta=t.asyncMeta,e.isCloned=!0,e}"function"==typeof SuppressedError&&SuppressedError;var gt=0,yt=[],bt=function(){function t(){this._pending=!1,this.id=gt++,this.subs=[]}return t.prototype.addSub=function(t){this.subs.push(t)},t.prototype.removeSub=function(t){this.subs[this.subs.indexOf(t)]=null,this._pending||(this._pending=!0,yt.push(this))},t.prototype.depend=function(e){t.target&&t.target.addDep(this)},t.prototype.notify=function(t){var e=this.subs.filter((function(t){return t}));for(var n=0,r=e.length;n0&&(Kt((c=t(c,"".concat(n||"","_").concat(r)))[0])&&Kt(f)&&(p[u]=vt(f.text+c[0].text),c.shift()),p.push.apply(p,c)):l(c)?Kt(f)?p[u]=vt(f.text+c):""!==c&&p.push(vt(c)):Kt(c)&&Kt(f)?p[u]=vt(f.text+c.text):(s(e._isVList)&&a(c.tag)&&i(c.key)&&a(n)&&(c.key="__vlist".concat(n,"_").concat(r,"__")),p.push(c)));return p}(t):void 0}function Kt(t){return a(t)&&a(t.text)&&!1===t.isComment}function Yt(t,e){var n,r,i,s,l=null;if(o(t)||"string"==typeof t)for(l=new Array(t.length),n=0,r=t.length;n0,s=e?!!e.$stable:!a,l=e&&e.$key;if(e){if(e._normalized)return e._normalized;if(s&&o&&o!==r&&l===o.$key&&!a&&!o.$hasNormal)return o;for(var c in i={},e)e[c]&&"$"!==c[0]&&(i[c]=me(t,n,c,e[c]))}else i={};for(var u in n)u in i||(i[u]=ge(n,u));return e&&Object.isExtensible(e)&&(e._normalized=i),W(i,"$stable",s),W(i,"$key",l),W(i,"$hasNormal",a),i}function me(t,e,n,r){var i=function(){var e=ft;pt(t);var n=arguments.length?r.apply(null,arguments):r({}),i=(n=n&&"object"==typeof n&&!o(n)?[n]:Xt(n))&&n[0];return pt(e),n&&(!i||1===n.length&&i.isComment&&!he(i))?void 0:n};return r.proxy&&Object.defineProperty(e,n,{get:i,enumerable:!0,configurable:!0}),i}function ge(t,e){return function(){return t[e]}}function ye(t){return{get attrs(){if(!t._attrsProxy){var e=t._attrsProxy={};W(e,"_v_attr_proxy",!0),be(e,t.$attrs,r,t,"$attrs")}return t._attrsProxy},get listeners(){t._listenersProxy||be(t._listenersProxy={},t.$listeners,r,t,"$listeners");return t._listenersProxy},get slots(){return function(t){t._slotsProxy||_e(t._slotsProxy={},t.$scopedSlots);return t._slotsProxy}(t)},emit:j(t.$emit,t),expose:function(e){e&&Object.keys(e).forEach((function(n){return Ft(t,e,n)}))}}}function be(t,e,n,r,o){var i=!1;for(var a in e)a in t?e[a]!==n[a]&&(i=!0):(i=!0,we(t,a,r,o));for(var a in t)a in e||(i=!0,delete t[a]);return i}function we(t,e,n,r){Object.defineProperty(t,e,{enumerable:!0,configurable:!0,get:function(){return n[r][e]}})}function _e(t,e){for(var n in e)t[n]=e[n];for(var n in t)n in e||delete t[n]}var xe=null;function Se(t,e){return(t.__esModule||ut&&"Module"===t[Symbol.toStringTag])&&(t=t.default),u(t)?e.extend(t):t}function ke(t){if(o(t))for(var e=0;edocument.createEvent("Event").timeStamp&&(cn=function(){return un.now()})}var fn=function(t,e){if(t.post){if(!e.post)return 1}else if(e.post)return-1;return t.id-e.id};function pn(){var t,e;for(ln=cn(),an=!0,en.sort(fn),sn=0;snsn&&en[n].id>t.id;)n--;en.splice(n+1,0,t)}else en.push(t);on||(on=!0,De(pn))}}function hn(t,e){if(t){for(var n=Object.create(null),r=ut?Reflect.ownKeys(t):Object.keys(t),o=0;o-1)if(i&&!S(o,"default"))a=!1;else if(""===a||a===E(t)){var l=Un(String,o.type);(l<0||s-1:"string"==typeof t?t.split(",").indexOf(e)>-1:!!d(t)&&t.test(e)}function Yn(t,e){var n=t.cache,r=t.keys,o=t._vnode,i=t.$vnode;for(var a in n){var s=n[a];if(s){var l=s.name;l&&!e(l)&&Jn(n,a,r,o)}}i.componentOptions.children=void 0}function Jn(t,e,n,r){var o=t[e];!o||r&&o.tag===r.tag||o.componentInstance.$destroy(),t[e]=null,_(n,e)}Qn.prototype._init=function(t){var e=this;e._uid=Vn++,e._isVue=!0,e.__v_skip=!0,e._scope=new Nt(!0),e._scope.parent=void 0,e._scope._vm=!0,t&&t._isComponent?function(t,e){var n=t.$options=Object.create(t.constructor.options),r=e._parentVnode;n.parent=e.parent,n._parentVnode=r;var o=r.componentOptions;n.propsData=o.propsData,n._parentListeners=o.listeners,n._renderChildren=o.children,n._componentTag=o.tag,e.render&&(n.render=e.render,n.staticRenderFns=e.staticRenderFns)}(e,t):e.$options=jn(Wn(e.constructor),t||{},e),e._renderProxy=e,e._self=e,function(t){var e=t.$options,n=e.parent;if(n&&!e.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(t)}t.$parent=n,t.$root=n?n.$root:t,t.$children=[],t.$refs={},t._provided=n?n._provided:Object.create(null),t._watcher=null,t._inactive=null,t._directInactive=!1,t._isMounted=!1,t._isDestroyed=!1,t._isBeingDestroyed=!1}(e),function(t){t._events=Object.create(null),t._hasHookEvent=!1;var e=t.$options._parentListeners;e&&Xe(t,e)}(e),function(t){t._vnode=null,t._staticTrees=null;var e=t.$options,n=t.$vnode=e._parentVnode,o=n&&n.context;t.$slots=pe(e._renderChildren,o),t.$scopedSlots=n?ve(t.$parent,n.data.scopedSlots,t.$slots):r,t._c=function(e,n,r,o){return Oe(t,e,n,r,o,!1)},t.$createElement=function(e,n,r,o){return Oe(t,e,n,r,o,!0)};var i=n&&n.data;At(t,"$attrs",i&&i.attrs||r,null,!0),At(t,"$listeners",e._parentListeners||r,null,!0)}(e),tn(e,"beforeCreate",void 0,!1),function(t){var e=hn(t.$options.inject,t);e&&(Ct(!1),Object.keys(e).forEach((function(n){At(t,n,e[n])})),Ct(!0))}(e),Dn(e),function(t){var e=t.$options.provide;if(e){var n=c(e)?e.call(t):e;if(!u(n))return;for(var r=Ht(t),o=ut?Reflect.ownKeys(n):Object.keys(n),i=0;i1?$(n):n;for(var r=$(arguments,1),o='event handler for "'.concat(t,'"'),i=0,a=n.length;iparseInt(this.max)&&Jn(t,e[0],e,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var t in this.cache)Jn(this.cache,t,this.keys)},mounted:function(){var t=this;this.cacheVNode(),this.$watch("include",(function(e){Yn(t,(function(t){return Kn(e,t)}))})),this.$watch("exclude",(function(e){Yn(t,(function(t){return!Kn(e,t)}))}))},updated:function(){this.cacheVNode()},render:function(){var t=this.$slots.default,e=ke(t),n=e&&e.componentOptions;if(n){var r=Xn(n),o=this.include,i=this.exclude;if(o&&(!r||!Kn(o,r))||i&&r&&Kn(i,r))return e;var a=this.cache,s=this.keys,l=null==e.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):e.key;a[l]?(e.componentInstance=a[l].componentInstance,_(s,l),s.push(l)):(this.vnodeToCache=e,this.keyToCache=l),e.data.keepAlive=!0}return e||t&&t[0]}}};!function(t){var e={get:function(){return H}};Object.defineProperty(t,"config",e),t.util={warn:Sn,extend:A,mergeOptions:jn,defineReactive:At},t.set=Mt,t.delete=Lt,t.nextTick=De,t.observable=function(t){return $t(t),t},t.options=Object.create(null),q.forEach((function(e){t.options[e+"s"]=Object.create(null)})),t.options._base=t,A(t.options.components,tr),function(t){t.use=function(t){var e=this._installedPlugins||(this._installedPlugins=[]);if(e.indexOf(t)>-1)return this;var n=$(arguments,1);return n.unshift(this),c(t.install)?t.install.apply(t,n):c(t)&&t.apply(null,n),e.push(t),this}}(t),function(t){t.mixin=function(t){return this.options=jn(this.options,t),this}}(t),Gn(t),function(t){q.forEach((function(e){t[e]=function(t,n){return n?("component"===e&&p(n)&&(n.name=n.name||t,n=this.options._base.extend(n)),"directive"===e&&c(n)&&(n={bind:n,update:n}),this.options[e+"s"][t]=n,n):this.options[e+"s"][t]}}))}(t)}(Qn),Object.defineProperty(Qn.prototype,"$isServer",{get:at}),Object.defineProperty(Qn.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(Qn,"FunctionalRenderContext",{value:vn}),Qn.version="2.7.16";var er=b("style,class"),nr=b("input,textarea,option,select,progress"),rr=b("contenteditable,draggable,spellcheck"),or=b("events,caret,typing,plaintext-only"),ir=b("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),ar="http://www.w3.org/1999/xlink",sr=function(t){return":"===t.charAt(5)&&"xlink"===t.slice(0,5)},lr=function(t){return sr(t)?t.slice(6,t.length):""},cr=function(t){return null==t||!1===t};function ur(t){for(var e=t.data,n=t,r=t;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(e=fr(r.data,e));for(;a(n=n.parent);)n&&n.data&&(e=fr(e,n.data));return function(t,e){if(a(t)||a(e))return pr(t,dr(e));return""}(e.staticClass,e.class)}function fr(t,e){return{staticClass:pr(t.staticClass,e.staticClass),class:a(t.class)?[t.class,e.class]:e.class}}function pr(t,e){return t?e?t+" "+e:t:e||""}function dr(t){return Array.isArray(t)?function(t){for(var e,n="",r=0,o=t.length;r-1?Ir(t,e,n):ir(e)?cr(n)?t.removeAttribute(e):(n="allowfullscreen"===e&&"EMBED"===t.tagName?"true":e,t.setAttribute(e,n)):rr(e)?t.setAttribute(e,function(t,e){return cr(e)||"false"===e?"false":"contenteditable"===t&&or(e)?e:"true"}(e,n)):sr(e)?cr(n)?t.removeAttributeNS(ar,lr(e)):t.setAttributeNS(ar,e,n):Ir(t,e,n)}function Ir(t,e,n){if(cr(n))t.removeAttribute(e);else{if(Y&&!J&&"TEXTAREA"===t.tagName&&"placeholder"===e&&""!==n&&!t.__ieph){var r=function(e){e.stopImmediatePropagation(),t.removeEventListener("input",r)};t.addEventListener("input",r),t.__ieph=!0}t.setAttribute(e,n)}}var Br={create:Rr,update:Rr};function Dr(t,e){var n=e.elm,r=e.data,o=t.data;if(!(i(r.staticClass)&&i(r.class)&&(i(o)||i(o.staticClass)&&i(o.class)))){var s=ur(e),l=n._transitionClasses;a(l)&&(s=pr(s,dr(l))),s!==n._prevClass&&(n.setAttribute("class",s),n._prevClass=s)}}var Fr,qr={create:Dr,update:Dr};function Nr(t,e,n){var r=Fr;return function o(){var i=e.apply(null,arguments);null!==i&&Vr(t,o,n,r)}}var Hr=$e&&!(nt&&Number(nt[1])<=53);function zr(t,e,n,r){if(Hr){var o=ln,i=e;e=i._wrapper=function(t){if(t.target===t.currentTarget||t.timeStamp>=o||t.timeStamp<=0||t.target.ownerDocument!==document)return i.apply(this,arguments)}}Fr.addEventListener(t,e,ot?{capture:n,passive:r}:n)}function Vr(t,e,n,r){(r||Fr).removeEventListener(t,e._wrapper||e,n)}function Wr(t,e){if(!i(t.data.on)||!i(e.data.on)){var n=e.data.on||{},r=t.data.on||{};Fr=e.elm||t.elm,function(t){if(a(t.__r)){var e=Y?"change":"input";t[e]=[].concat(t.__r,t[e]||[]),delete t.__r}a(t.__c)&&(t.change=[].concat(t.__c,t.change||[]),delete t.__c)}(n),Wt(n,r,zr,Vr,Nr,e.context),Fr=void 0}}var Qr,Gr={create:Wr,update:Wr,destroy:function(t){return Wr(t,kr)}};function Xr(t,e){if(!i(t.data.domProps)||!i(e.data.domProps)){var n,r,o=e.elm,l=t.data.domProps||{},c=e.data.domProps||{};for(n in(a(c.__ob__)||s(c._v_attr_proxy))&&(c=e.data.domProps=A({},c)),l)n in c||(o[n]="");for(n in c){if(r=c[n],"textContent"===n||"innerHTML"===n){if(e.children&&(e.children.length=0),r===l[n])continue;1===o.childNodes.length&&o.removeChild(o.childNodes[0])}if("value"===n&&"PROGRESS"!==o.tagName){o._value=r;var u=i(r)?"":String(r);Kr(o,u)&&(o.value=u)}else if("innerHTML"===n&&mr(o.tagName)&&i(o.innerHTML)){(Qr=Qr||document.createElement("div")).innerHTML="".concat(r,"");for(var f=Qr.firstChild;o.firstChild;)o.removeChild(o.firstChild);for(;f.firstChild;)o.appendChild(f.firstChild)}else if(r!==l[n])try{o[n]=r}catch(t){}}}}function Kr(t,e){return!t.composing&&("OPTION"===t.tagName||function(t,e){var n=!0;try{n=document.activeElement!==t}catch(t){}return n&&t.value!==e}(t,e)||function(t,e){var n=t.value,r=t._vModifiers;if(a(r)){if(r.number)return y(n)!==y(e);if(r.trim)return n.trim()!==e.trim()}return n!==e}(t,e))}var Yr={create:Xr,update:Xr},Jr=k((function(t){var e={},n=/:(.+)/;return t.split(/;(?![^(]*\))/g).forEach((function(t){if(t){var r=t.split(n);r.length>1&&(e[r[0].trim()]=r[1].trim())}})),e}));function Zr(t){var e=to(t.style);return t.staticStyle?A(t.staticStyle,e):e}function to(t){return Array.isArray(t)?M(t):"string"==typeof t?Jr(t):t}var eo,no=/^--/,ro=/\s*!important$/,oo=function(t,e,n){if(no.test(e))t.style.setProperty(e,n);else if(ro.test(n))t.style.setProperty(E(e),n.replace(ro,""),"important");else{var r=ao(e);if(Array.isArray(n))for(var o=0,i=n.length;o-1?e.split(co).forEach((function(e){return t.classList.add(e)})):t.classList.add(e);else{var n=" ".concat(t.getAttribute("class")||""," ");n.indexOf(" "+e+" ")<0&&t.setAttribute("class",(n+e).trim())}}function fo(t,e){if(e&&(e=e.trim()))if(t.classList)e.indexOf(" ")>-1?e.split(co).forEach((function(e){return t.classList.remove(e)})):t.classList.remove(e),t.classList.length||t.removeAttribute("class");else{for(var n=" ".concat(t.getAttribute("class")||""," "),r=" "+e+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?t.setAttribute("class",n):t.removeAttribute("class")}}function po(t){if(t){if("object"==typeof t){var e={};return!1!==t.css&&A(e,ho(t.name||"v")),A(e,t),e}return"string"==typeof t?ho(t):void 0}}var ho=k((function(t){return{enterClass:"".concat(t,"-enter"),enterToClass:"".concat(t,"-enter-to"),enterActiveClass:"".concat(t,"-enter-active"),leaveClass:"".concat(t,"-leave"),leaveToClass:"".concat(t,"-leave-to"),leaveActiveClass:"".concat(t,"-leave-active")}})),vo=X&&!J,mo="transition",go="transitionend",yo="animation",bo="animationend";vo&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(mo="WebkitTransition",go="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(yo="WebkitAnimation",bo="webkitAnimationEnd"));var wo=X?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(t){return t()};function _o(t){wo((function(){wo(t)}))}function xo(t,e){var n=t._transitionClasses||(t._transitionClasses=[]);n.indexOf(e)<0&&(n.push(e),uo(t,e))}function So(t,e){t._transitionClasses&&_(t._transitionClasses,e),fo(t,e)}function ko(t,e,n){var r=Po(t,e),o=r.type,i=r.timeout,a=r.propCount;if(!o)return n();var s="transition"===o?go:bo,l=0,c=function(){t.removeEventListener(s,u),n()},u=function(e){e.target===t&&++l>=a&&c()};setTimeout((function(){l0&&(n="transition",u=a,f=i.length):"animation"===e?c>0&&(n="animation",u=c,f=l.length):f=(n=(u=Math.max(a,c))>0?a>c?"transition":"animation":null)?"transition"===n?i.length:l.length:0,{type:n,timeout:u,propCount:f,hasTransform:"transition"===n&&Oo.test(r[mo+"Property"])}}function To(t,e){for(;t.length1}function Mo(t,e){!0!==e.data.show&&Eo(e)}var Lo=function(t){var e,n,r={},c=t.modules,u=t.nodeOps;for(e=0;eh?w(t,i(n[g+1])?null:n[g+1].elm,n,d,g,r):d>g&&x(e,f,h)}(f,v,g,n,c):a(g)?(a(t.text)&&u.setTextContent(f,""),w(f,null,g,0,g.length-1,n)):a(v)?x(v,0,v.length-1):a(t.text)&&u.setTextContent(f,""):t.text!==e.text&&u.setTextContent(f,e.text),a(h)&&a(d=h.hook)&&a(d=d.postpatch)&&d(t,e)}}}function P(t,e,n){if(s(n)&&a(t.parent))t.parent.data.pendingInsert=e;else for(var r=0;r-1,a.selected!==i&&(a.selected=i);else if(I(Do(a),r))return void(t.selectedIndex!==s&&(t.selectedIndex=s));o||(t.selectedIndex=-1)}}function Bo(t,e){return e.every((function(e){return!I(e,t)}))}function Do(t){return"_value"in t?t._value:t.value}function Fo(t){t.target.composing=!0}function qo(t){t.target.composing&&(t.target.composing=!1,No(t.target,"input"))}function No(t,e){var n=document.createEvent("HTMLEvents");n.initEvent(e,!0,!0),t.dispatchEvent(n)}function Ho(t){return!t.componentInstance||t.data&&t.data.transition?t:Ho(t.componentInstance._vnode)}var zo={model:Ro,show:{bind:function(t,e,n){var r=e.value,o=(n=Ho(n)).data&&n.data.transition,i=t.__vOriginalDisplay="none"===t.style.display?"":t.style.display;r&&o?(n.data.show=!0,Eo(n,(function(){t.style.display=i}))):t.style.display=r?i:"none"},update:function(t,e,n){var r=e.value;!r!=!e.oldValue&&((n=Ho(n)).data&&n.data.transition?(n.data.show=!0,r?Eo(n,(function(){t.style.display=t.__vOriginalDisplay})):jo(n,(function(){t.style.display="none"}))):t.style.display=r?t.__vOriginalDisplay:"none")},unbind:function(t,e,n,r,o){o||(t.style.display=t.__vOriginalDisplay)}}},Vo={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Wo(t){var e=t&&t.componentOptions;return e&&e.Ctor.options.abstract?Wo(ke(e.children)):t}function Qo(t){var e={},n=t.$options;for(var r in n.propsData)e[r]=t[r];var o=n._parentListeners;for(var r in o)e[P(r)]=o[r];return e}function Go(t,e){if(/\d-keep-alive$/.test(e.tag))return t("keep-alive",{props:e.componentOptions.propsData})}var Xo=function(t){return t.tag||he(t)},Ko=function(t){return"show"===t.name},Yo={name:"transition",props:Vo,abstract:!0,render:function(t){var e=this,n=this.$slots.default;if(n&&(n=n.filter(Xo)).length){0;var r=this.mode;0;var o=n[0];if(function(t){for(;t=t.parent;)if(t.data.transition)return!0}(this.$vnode))return o;var i=Wo(o);if(!i)return o;if(this._leaving)return Go(t,o);var a="__transition-".concat(this._uid,"-");i.key=null==i.key?i.isComment?a+"comment":a+i.tag:l(i.key)?0===String(i.key).indexOf(a)?i.key:a+i.key:i.key;var s=(i.data||(i.data={})).transition=Qo(this),c=this._vnode,u=Wo(c);if(i.data.directives&&i.data.directives.some(Ko)&&(i.data.show=!0),u&&u.data&&!function(t,e){return e.key===t.key&&e.tag===t.tag}(i,u)&&!he(u)&&(!u.componentInstance||!u.componentInstance._vnode.isComment)){var f=u.data.transition=A({},s);if("out-in"===r)return this._leaving=!0,Qt(f,"afterLeave",(function(){e._leaving=!1,e.$forceUpdate()})),Go(t,o);if("in-out"===r){if(he(i))return c;var p,d=function(){p()};Qt(s,"afterEnter",d),Qt(s,"enterCancelled",d),Qt(f,"delayLeave",(function(t){p=t}))}}return o}}},Jo=A({tag:String,moveClass:String},Vo);function Zo(t){t.elm._moveCb&&t.elm._moveCb(),t.elm._enterCb&&t.elm._enterCb()}function ti(t){t.data.newPos=t.elm.getBoundingClientRect()}function ei(t){var e=t.data.pos,n=t.data.newPos,r=e.left-n.left,o=e.top-n.top;if(r||o){t.data.moved=!0;var i=t.elm.style;i.transform=i.WebkitTransform="translate(".concat(r,"px,").concat(o,"px)"),i.transitionDuration="0s"}}delete Jo.mode;var ni={Transition:Yo,TransitionGroup:{props:Jo,beforeMount:function(){var t=this,e=this._update;this._update=function(n,r){var o=Ye(t);t.__patch__(t._vnode,t.kept,!1,!0),t._vnode=t.kept,o(),e.call(t,n,r)}},render:function(t){for(var e=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,o=this.$slots.default||[],i=this.children=[],a=Qo(this),s=0;s-1?yr[t]=e.constructor===window.HTMLUnknownElement||e.constructor===window.HTMLElement:yr[t]=/HTMLUnknownElement/.test(e.toString())},A(Qn.options.directives,zo),A(Qn.options.components,ni),Qn.prototype.__patch__=X?Lo:L,Qn.prototype.$mount=function(t,e){return function(t,e,n){var r;t.$el=e,t.$options.render||(t.$options.render=ht),tn(t,"beforeMount"),r=function(){t._update(t._render(),n)},new Ve(t,r,L,{before:function(){t._isMounted&&!t._isDestroyed&&tn(t,"beforeUpdate")}},!0),n=!1;var o=t._preWatchers;if(o)for(var i=0;i=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(o.path||""),c=e&&e.path||"/",u=l.path?Si(l.path,c,n||o.append):c,f=function(t,e,n){void 0===e&&(e={});var r,o=n||ui;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(ci):ci(a)}return r}(l.query,o.query,r&&r.options.parseQuery),p=o.hash||l.hash;return p&&"#"!==p.charAt(0)&&(p="#"+p),{_normalized:!0,path:u,query:f,hash:p}}var zi,Vi=function(){},Wi={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,o=n.resolve(this.to,r,this.append),i=o.location,a=o.route,s=o.href,l={},c=n.options.linkActiveClass,u=n.options.linkExactActiveClass,f=null==c?"router-link-active":c,p=null==u?"router-link-exact-active":u,d=null==this.activeClass?f:this.activeClass,h=null==this.exactActiveClass?p:this.exactActiveClass,v=a.redirectedFrom?di(null,Hi(a.redirectedFrom),null,n):a;l[h]=yi(r,v,this.exactPath),l[d]=this.exact||this.exactPath?l[h]:function(t,e){return 0===t.path.replace(pi,"/").indexOf(e.path.replace(pi,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,v);var m=l[h]?this.ariaCurrentValue:null,g=function(t){Qi(t)&&(e.replace?n.replace(i,Vi):n.push(i,Vi))},y={click:Qi};Array.isArray(this.event)?this.event.forEach((function(t){y[t]=g})):y[this.event]=g;var b={class:l},w=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:s,route:a,navigate:g,isActive:l[d],isExactActive:l[h]});if(w){if(1===w.length)return w[0];if(w.length>1||!w.length)return 0===w.length?t():t("span",{},w)}if("a"===this.tag)b.on=y,b.attrs={href:s,"aria-current":m};else{var _=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=Ni(u.path,s.params),l(u,s,a)}if(s.path){s.params={};for(var d=0;d-1}function ka(t,e){return Sa(t)&&t._isRouter&&(null==e||t.type===e)}function Oa(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function Pa(t){return function(e,n,r){var o=!1,i=0,a=null;Ta(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var l,c=ja((function(e){var o;((o=e).__esModule||Ea&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:zi.extend(e),n.components[s]=e,--i<=0&&r()})),u=ja((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=Sa(t)?t:new Error(e),r(a))}));try{l=t(c,u)}catch(t){u(t)}if(l)if("function"==typeof l.then)l.then(c,u);else{var f=l.component;f&&"function"==typeof f.then&&f.then(c,u)}}})),o||r()}}function Ta(t,e){return Ca(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function Ca(t){return Array.prototype.concat.apply([],t)}var Ea="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function ja(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var $a=function(t,e){this.router=t,this.base=function(t){if(!t)if(Gi){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=vi,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Aa(t,e,n,r){var o=Ta(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=zi.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return Ca(r?o.reverse():o)}function Ma(t,e){if(e)return function(){return t.apply(e,arguments)}}$a.prototype.listen=function(t){this.cb=t},$a.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},$a.prototype.onError=function(t){this.errorCbs.push(t)},$a.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(ka(t,ya.redirected)&&i===vi||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},$a.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!ka(t)&&Sa(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},l=t.matched.length-1,c=o.matched.length-1;if(yi(t,o)&&l===c&&t.matched[l]===o.matched[c])return this.ensureURL(),t.hash&&aa(this.router,o,t,!1),s(((a=_a(i=o,t,ya.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var u=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=va&&n;r&&this.listeners.push(ia());var o=function(){var n=t.current,o=Ra(t.base);t.current===vi&&o===t._startLocation||t.transitionTo(o,(function(t){r&&aa(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ma(ki(r.base+t.fullPath)),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ga(ki(r.base+t.fullPath)),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Ra(this.base)!==this.current.fullPath){var e=ki(this.base+this.current.fullPath);t?ma(e):ga(e)}},e.prototype.getCurrentLocation=function(){return Ra(this.base)},e}($a);function Ra(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(ki(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var Ua=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Ra(t);if(!/^\/#/.test(e))return window.location.replace(ki(t+"/#"+e)),!0}(this.base)||Ia()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=va&&e;n&&this.listeners.push(ia());var r=function(){var e=t.current;Ia()&&t.transitionTo(Ba(),(function(r){n&&aa(t.router,r,e,!0),va||qa(r.fullPath)}))},o=va?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Fa(t.fullPath),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){qa(t.fullPath),aa(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Ba()!==e&&(t?Fa(e):qa(e))},e.prototype.getCurrentLocation=function(){return Ba()},e}($a);function Ia(){var t=Ba();return"/"===t.charAt(0)||(qa("/"+t),!1)}function Ba(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function Da(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function Fa(t){va?ma(Da(t)):window.location.hash=t}function qa(t){va?ga(Da(t)):window.location.replace(Da(t))}var Na=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){ka(t,ya.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}($a),Ha=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Yi(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!va&&!1!==t.fallback,this.fallback&&(e="hash"),Gi||(e="abstract"),this.mode=e,e){case"history":this.history=new La(this,t.base);break;case"hash":this.history=new Ua(this,t.base,this.fallback);break;case"abstract":this.history=new Na(this,t.base);break;default:0}},za={currentRoute:{configurable:!0}};Ha.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},za.currentRoute.get=function(){return this.history&&this.history.current},Ha.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof La||n instanceof Ua){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;va&&o&&"fullPath"in t&&aa(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ha.prototype.beforeEach=function(t){return Wa(this.beforeHooks,t)},Ha.prototype.beforeResolve=function(t){return Wa(this.resolveHooks,t)},Ha.prototype.afterEach=function(t){return Wa(this.afterHooks,t)},Ha.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ha.prototype.onError=function(t){this.history.onError(t)},Ha.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ha.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ha.prototype.go=function(t){this.history.go(t)},Ha.prototype.back=function(){this.go(-1)},Ha.prototype.forward=function(){this.go(1)},Ha.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ha.prototype.resolve=function(t,e,n){var r=Hi(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?ki(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ha.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ha.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==vi&&this.history.transitionTo(this.history.getCurrentLocation())},Ha.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==vi&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ha.prototype,za);var Va=Ha;function Wa(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ha.install=function t(e){if(!t.installed||zi!==e){t.installed=!0,zi=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",_i),e.component("RouterLink",Wi);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ha.version="3.6.5",Ha.isNavigationFailure=ka,Ha.NavigationFailureType=ya,Ha.START_LOCATION=vi,Gi&&window.Vue&&window.Vue.use(Ha);n(97);n(90),n(127);var Qa={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(19)]).then(n.bind(null,418)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(20)]).then(n.bind(null,256)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(31)]).then(n.bind(null,244)),"components/Home":()=>Promise.all([n.e(0),n.e(22)]).then(n.bind(null,285)),"components/NavLink":()=>n.e(41).then(n.bind(null,243)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(15)]).then(n.bind(null,268)),"components/Navbar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,415)),"components/Page":()=>Promise.all([n.e(0),n.e(14)]).then(n.bind(null,286)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,270)),"components/PageNav":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,271)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(11)]).then(n.bind(null,287)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(32)]).then(n.bind(null,288)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,269)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(25)]).then(n.bind(null,257)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,255)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,424)),"global-components/CodeBlock":()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,419)),"global-components/CodeGroup":()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,420)),"layouts/404":()=>n.e(7).then(n.bind(null,421)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,422)),NotFound:()=>n.e(7).then(n.bind(null,421)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,422))},Ga={"v-06f4d0aa":()=>n.e(16).then(n.bind(null,425)),"v-347fe277":()=>n.e(12).then(n.bind(null,426)),"v-96f26938":()=>n.e(48).then(n.bind(null,427)),"v-b936cd92":()=>n.e(10).then(n.bind(null,428)),"v-73cb197f":()=>n.e(17).then(n.bind(null,429)),"v-08357a02":()=>n.e(13).then(n.bind(null,430)),"v-095f6301":()=>n.e(42).then(n.bind(null,431)),"v-2db1db37":()=>n.e(50).then(n.bind(null,432)),"v-e115e73a":()=>n.e(49).then(n.bind(null,433)),"v-117d8812":()=>n.e(51).then(n.bind(null,434)),"v-f3fbff12":()=>n.e(52).then(n.bind(null,435)),"v-01bee537":()=>n.e(53).then(n.bind(null,436)),"v-56e06d4d":()=>n.e(54).then(n.bind(null,437)),"v-5e0eec87":()=>n.e(43).then(n.bind(null,438)),"v-204c7852":()=>n.e(24).then(n.bind(null,439)),"v-29f81312":()=>n.e(55).then(n.bind(null,440)),"v-0c47cd52":()=>n.e(56).then(n.bind(null,441)),"v-b5aec012":()=>n.e(44).then(n.bind(null,442)),"v-412f01af":()=>n.e(26).then(n.bind(null,443)),"v-cf2ed192":()=>n.e(33).then(n.bind(null,444)),"v-eab731fa":()=>n.e(34).then(n.bind(null,445)),"v-2fe62c26":()=>n.e(35).then(n.bind(null,446)),"v-aa1cc612":()=>n.e(58).then(n.bind(null,447)),"v-0d1e8e9e":()=>n.e(57).then(n.bind(null,448)),"v-255607ed":()=>n.e(36).then(n.bind(null,449)),"v-7df515d2":()=>n.e(37).then(n.bind(null,450)),"v-6e14dcd7":()=>n.e(27).then(n.bind(null,451)),"v-303bd052":()=>n.e(59).then(n.bind(null,452)),"v-2c32e617":()=>n.e(38).then(n.bind(null,453)),"v-246d3f77":()=>n.e(60).then(n.bind(null,454)),"v-2b7b8f3b":()=>n.e(61).then(n.bind(null,455)),"v-0d819412":()=>n.e(62).then(n.bind(null,456)),"v-3043a2b9":()=>n.e(39).then(n.bind(null,457)),"v-bbb970d2":()=>n.e(18).then(n.bind(null,458)),"v-27c660f7":()=>n.e(28).then(n.bind(null,459)),"v-20c05837":()=>n.e(45).then(n.bind(null,460)),"v-131b9357":()=>n.e(40).then(n.bind(null,461)),"v-288d7b9e":()=>n.e(63).then(n.bind(null,462)),"v-a9ffe0fe":()=>n.e(46).then(n.bind(null,463)),"v-749f316f":()=>n.e(29).then(n.bind(null,464)),"v-21b208b7":()=>n.e(64).then(n.bind(null,465)),"v-2494b4d7":()=>n.e(65).then(n.bind(null,466)),"v-93d2a72a":()=>n.e(66).then(n.bind(null,467)),"v-2566e137":()=>n.e(67).then(n.bind(null,468)),"v-947f362a":()=>n.e(30).then(n.bind(null,469))};function Xa(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const Ka=/-(\w)/g,Ya=Xa(t=>t.replace(Ka,(t,e)=>e?e.toUpperCase():"")),Ja=/\B([A-Z])/g,Za=Xa(t=>t.replace(Ja,"-$1").toLowerCase()),ts=Xa(t=>t.charAt(0).toUpperCase()+t.slice(1));function es(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ts(Ya(e))):t(ts(e))||t(Za(e))}const ns=Object.assign({},Qa,Ga),rs=t=>ns[t],os=t=>Ga[t],is=t=>Qa[t],as=t=>Qn.component(t);function ss(t){return es(os,t)}function ls(t){return es(is,t)}function cs(t){return es(rs,t)}function us(t){return es(as,t)}function fs(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!us(t)&&cs(t)){const e=await cs(t)();Qn.component(t,e.default)}}))}function ps(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var ds=n(86),hs=n.n(ds),vs=n(87),ms=n.n(vs),gs={created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${ms()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=bs(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=ws(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return hs()([{name:"description",content:this.$description}],t,this.siteMeta,_s)},updateCanonicalLink(){ys(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",bs(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){ws(null,this.currentMetaTags),ys()}};function ys(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function bs(t=""){return t?``:""}function ws(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function _s(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var xs=n(88),Ss={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(xs)()((function(){this.setActiveHash()}),300),setActiveHash(){const t=[].slice.call(document.querySelectorAll(".sidebar-link")),e=[].slice.call(document.querySelectorAll(".header-anchor")).filter(e=>t.some(t=>t.hash===e.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let t=0;t=i.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},ks=n(22),Os=n.n(ks),Ps={mounted(){Os.a.configure({showSpinner:!1}),this.$router.beforeEach((t,e,n)=>{t.path===e.path||Qn.component(t.name)||Os.a.start(),n()}),this.$router.afterEach(()=>{Os.a.done(),this.isSidebarOpen=!1})}},Ts=n(89),Cs=n.n(Ts),Es=[gs,Ss,Ps,{mounted(){Cs.a.polyfill()}}],js={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return ps("layout",t),Qn.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},$s=n(14),As=Object($s.a)(js,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(As,"mixins",Es);const Ms=[{name:"v-06f4d0aa",path:"/integrate/home_assistant.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-06f4d0aa").then(n)}},{name:"v-347fe277",path:"/integrate/aws_iot.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-347fe277").then(n)}},{name:"v-96f26938",path:"/",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-96f26938").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-b936cd92",path:"/integrate/jeedom.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-b936cd92").then(n)}},{name:"v-73cb197f",path:"/integrate/node_red.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-73cb197f").then(n)}},{name:"v-08357a02",path:"/integrate/openhab3.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-08357a02").then(n)}},{name:"v-095f6301",path:"/integrate/openhab2.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-095f6301").then(n)}},{name:"v-2db1db37",path:"/participate/community.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2db1db37").then(n)}},{name:"v-e115e73a",path:"/participate/adding-protocols.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-e115e73a").then(n)}},{name:"v-117d8812",path:"/participate/development.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-117d8812").then(n)}},{name:"v-f3fbff12",path:"/participate/support.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-f3fbff12").then(n)}},{name:"v-01bee537",path:"/prerequisites/board.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-01bee537").then(n)}},{name:"v-56e06d4d",path:"/prerequisites/broker.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-56e06d4d").then(n)}},{name:"v-5e0eec87",path:"/prerequisites/controller.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-5e0eec87").then(n)}},{name:"v-204c7852",path:"/prerequisites/devices.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-204c7852").then(n)}},{name:"v-29f81312",path:"/prerequisites/parts.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-29f81312").then(n)}},{name:"v-0c47cd52",path:"/setitup/actuators.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0c47cd52").then(n)}},{name:"v-b5aec012",path:"/setitup/gsm.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-b5aec012").then(n)}},{name:"v-412f01af",path:"/prerequisites/M5.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-412f01af").then(n)}},{name:"v-cf2ed192",path:"/setitup/ble.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-cf2ed192").then(n)}},{name:"v-eab731fa",path:"/setitup/ir.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-eab731fa").then(n)}},{name:"v-2fe62c26",path:"/setitup/rf.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2fe62c26").then(n)}},{name:"v-aa1cc612",path:"/setitup/sensors.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-aa1cc612").then(n)}},{name:"v-0d1e8e9e",path:"/setitup/lora.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0d1e8e9e").then(n)}},{name:"v-255607ed",path:"/setitup/serial.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-255607ed").then(n)}},{name:"v-7df515d2",path:"/upload/advanced-configuration.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-7df515d2").then(n)}},{name:"v-6e14dcd7",path:"/upload/binaries.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-6e14dcd7").then(n)}},{name:"v-303bd052",path:"/upload/builds.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-303bd052").then(n)}},{name:"v-2c32e617",path:"/upload/gitpod.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2c32e617").then(n)}},{name:"v-246d3f77",path:"/upload/troubleshoot.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-246d3f77").then(n)}},{name:"v-2b7b8f3b",path:"/upload/web-install.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2b7b8f3b").then(n)}},{name:"v-0d819412",path:"/use/actuators.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-0d819412").then(n)}},{name:"v-3043a2b9",path:"/use/boards.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-3043a2b9").then(n)}},{name:"v-bbb970d2",path:"/use/ble.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-bbb970d2").then(n)}},{name:"v-27c660f7",path:"/upload/portal.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-27c660f7").then(n)}},{name:"v-20c05837",path:"/use/gateway.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-20c05837").then(n)}},{name:"v-131b9357",path:"/use/gsm.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-131b9357").then(n)}},{name:"v-288d7b9e",path:"/use/displays.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-288d7b9e").then(n)}},{name:"v-a9ffe0fe",path:"/use/ir.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-a9ffe0fe").then(n)}},{name:"v-749f316f",path:"/use/lora.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-749f316f").then(n)}},{name:"v-21b208b7",path:"/use/rfm69.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-21b208b7").then(n)}},{name:"v-2494b4d7",path:"/use/sensors.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2494b4d7").then(n)}},{name:"v-93d2a72a",path:"/use/serial.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-93d2a72a").then(n)}},{name:"v-2566e137",path:"/use/webui.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-2566e137").then(n)}},{name:"v-947f362a",path:"/use/rf.html",component:As,beforeEnter:(t,e,n)=>{fs("Layout","v-947f362a").then(n)}},{path:"*",component:As}],Ls={title:"Theengs OpenMQTTGateway DEVELOPMENT SHA:326644 TEST ONLY",description:"One gateway, many technologies: MQTT gateway for ESP8266 or ESP32 with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, LoRa, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.",base:"/dev/",headTags:[["meta",{name:"viewport",content:"width=device-width, initial-scale=1"}],["link",{rel:"apple-touch-icon",sizes:"180x180",href:".apple-touch-icon.png"}],["link",{rel:"icon",type:"image/png",sizes:"32x32",href:"/dev/favicon-32x32.png"}],["link",{rel:"icon",type:"image/png",sizes:"16x16",href:"/dev/favicon-16x16.png"}],["link",{rel:"manifest",href:"/dev/manifest.json"}],["meta",{name:"theme-color",content:"#3eaf7c"}],["meta",{name:"apple-mobile-web-app-capable",content:"yes"}],["meta",{name:"apple-mobile-web-app-status-bar-style",content:"black"}],["link",{rel:"mask-icon",href:"/dev/icons/safari-pinned-tab.svg",color:"#3eaf7c"}],["meta",{name:"msapplication-TileImage",content:"/favicon-144x144.png"}],["meta",{name:"msapplication-TileColor",content:"#000000"}],["script",{type:"module",src:"https://unpkg.com/esp-web-tools@9.4.3/dist/web/install-button.js?module"}]],pages:[{title:"Integrate Home Assistant",frontmatter:{},regularPath:"/integrate/home_assistant.html",relativePath:"integrate/home_assistant.md",key:"v-06f4d0aa",path:"/integrate/home_assistant.html",headers:[{level:2,title:"Automatic integration with Auto discovery",slug:"automatic-integration-with-auto-discovery"},{level:3,title:"RTL_433 auto discovery specificity",slug:"rtl-433-auto-discovery-specificity"},{level:3,title:"RF (RCSwitch based gateway) Auto discovery specificity",slug:"rf-rcswitch-based-gateway-auto-discovery-specificity"},{level:2,title:"Manual integration",slug:"manual-integration"},{level:3,title:"Pir Sensor",slug:"pir-sensor"},{level:3,title:"Door sensor",slug:"door-sensor"},{level:3,title:"Motion sensor",slug:"motion-sensor"},{level:3,title:"Switches",slug:"switches"},{level:3,title:"RF gateway mode - Pilight, RF, kaku",slug:"rf-gateway-mode-pilight-rf-kaku"},{level:3,title:"Mijia Thermometer BLE",slug:"mijia-thermometer-ble"},{level:3,title:"Xiaomi Mi Scale V2 BLE (XMTZC05HM)",slug:"xiaomi-mi-scale-v2-ble-xmtzc05hm"},{level:3,title:"MQTT Room Presence",slug:"mqtt-room-presence"},{level:3,title:"Temperature sensor",slug:"temperature-sensor"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate AWS IOT",frontmatter:{},regularPath:"/integrate/aws_iot.html",relativePath:"integrate/aws_iot.md",key:"v-347fe277",path:"/integrate/aws_iot.html",headers:[{level:2,title:"Create a thing",slug:"create-a-thing"},{level:2,title:"Create a policy",slug:"create-a-policy"},{level:2,title:"Create a certificate",slug:"create-a-certificate"},{level:2,title:"Attach Policy with certificate",slug:"attach-policy-with-certificate"},{level:2,title:"Activate certificate and attach it to Thing",slug:"activate-certificate-and-attach-it-to-thing"},{level:2,title:"Find AWS EndPoint",slug:"find-aws-endpoint"},{level:2,title:"Gather the information for OpenMQTTGateway configuration",slug:"gather-the-information-for-openmqttgateway-configuration"},{level:2,title:"Modify OpenMQTTGateway configuration",slug:"modify-openmqttgateway-configuration"},{level:2,title:"Build and upload",slug:"build-and-upload"},{level:2,title:"Connect to a WiFi Access point see portal",slug:"connect-to-a-wifi-access-point-see-portal"},{level:2,title:"Verify that you receive data in AWS",slug:"verify-that-you-receive-data-in-aws"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{frontmatter:{},regularPath:"/",relativePath:"README.md",key:"v-96f26938",path:"/",headers:[{level:2,title:"Using OpenMQTTGateway ?",slug:"using-openmqttgateway"},{level:2,title:"Products powered by OpenMQTTGateway",slug:"products-powered-by-openmqttgateway"},{level:3,title:"Theengs Bridge, BLE gateway with external antenna",slug:"theengs-bridge-ble-gateway-with-external-antenna"},{level:3,title:"Theengs Plug, BLE gateway and Smart Plug",slug:"theengs-plug-ble-gateway-and-smart-plug"},{level:2,title:"Media",slug:"media"},{level:3,title:"Theengs Plug",slug:"theengs-plug"},{level:3,title:"433Mhz and BLE",slug:"_433mhz-and-ble"},{level:3,title:"BLE",slug:"ble"},{level:3,title:"433Mhz",slug:"_433mhz"},{level:3,title:"LORA",slug:"lora"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate Jeedom",frontmatter:{},regularPath:"/integrate/jeedom.html",relativePath:"integrate/jeedom.md",key:"v-b936cd92",path:"/integrate/jeedom.html",headers:[{level:2,title:"Installation of jMQTT",slug:"installation-of-jmqtt"},{level:2,title:"Configuration the Broker in jMQTT",slug:"configuration-the-broker-in-jmqtt"},{level:2,title:"Creation of the OMG device",slug:"creation-of-the-omg-device"},{level:3,title:"Creation of the Last Will and Testament command",slug:"creation-of-the-last-will-and-testament-command"},{level:3,title:"Creation of an action command to restart the OMG device",slug:"creation-of-an-action-command-to-restart-the-omg-device"},{level:2,title:'Creation of the equipment for the "Xiaomi Mi Jia" sensor',slug:"creation-of-the-equipment-for-the-xiaomi-mi-jia-sensor"},{level:3,title:"Creation of an unknown/unidentified BT device",slug:"creation-of-an-unknown-unidentified-bt-device"},{level:3,title:"Creation of a known/identified BT device",slug:"creation-of-a-known-identified-bt-device"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate Node-Red",frontmatter:{},regularPath:"/integrate/node_red.html",relativePath:"integrate/node_red.md",key:"v-73cb197f",path:"/integrate/node_red.html",headers:[{level:2,title:"Integrate BLE sensors, devices and display a dashboard",slug:"integrate-ble-sensors-devices-and-display-a-dashboard"},{level:3,title:"Broker connection",slug:"broker-connection"},{level:3,title:"Json message processing",slug:"json-message-processing"},{level:3,title:"Dashboard",slug:"dashboard"},{level:2,title:"Integrate RF",slug:"integrate-rf"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate OPENHAB 3/4",frontmatter:{},regularPath:"/integrate/openhab3.html",relativePath:"integrate/openhab3.md",key:"v-08357a02",path:"/integrate/openhab3.html",headers:[{level:2,title:"Prerequisites",slug:"prerequisites"},{level:2,title:"IP address (if your broker is installed on the same server as OpenHAB)",slug:"ip-address-if-your-broker-is-installed-on-the-same-server-as-openhab"},{level:2,title:"Install the MQTT binding",slug:"install-the-mqtt-binding"},{level:2,title:"Install Jinja and JSONPath Transformations",slug:"install-jinja-and-jsonpath-transformations"},{level:2,title:"Upload OpenMQTTGateway to an ESP32",slug:"upload-openmqttgateway-to-an-esp32"},{level:2,title:"Configure OpenMQTTGateway from the web portal",slug:"configure-openmqttgateway-from-the-web-portal"},{level:2,title:"Adding the things",slug:"adding-the-things"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Integrate OPENHAB2",frontmatter:{},regularPath:"/integrate/openhab2.html",relativePath:"integrate/openhab2.md",key:"v-095f6301",path:"/integrate/openhab2.html",headers:[{level:2,title:"Auto discovery through home assistant convention",slug:"auto-discovery-through-home-assistant-convention"},{level:2,title:"MQTT 2 manual setup >=Openhab2.4",slug:"mqtt-2-manual-setup-openhab2-4"},{level:2,title:"For a mi flora or mi jia temperature :",slug:"for-a-mi-flora-or-mi-jia-temperature"},{level:2,title:'For a switch channel, add a channel by choosing the type "On/Off switch"',slug:"for-a-switch-channel-add-a-channel-by-choosing-the-type-on-off-switch"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Community participation",frontmatter:{},regularPath:"/participate/community.html",relativePath:"participate/community.md",key:"v-2db1db37",path:"/participate/community.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Adding protocols",frontmatter:{},regularPath:"/participate/adding-protocols.html",relativePath:"participate/adding-protocols.md",key:"v-e115e73a",path:"/participate/adding-protocols.html",headers:[{level:2,title:"RF or IR",slug:"rf-or-ir"},{level:2,title:"BLE",slug:"ble"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Development contributions",frontmatter:{},regularPath:"/participate/development.html",relativePath:"participate/development.md",key:"v-117d8812",path:"/participate/development.html",headers:[{level:2,title:"Nightly builds",slug:"nightly-builds"},{level:2,title:"Developer Certificate Of Origin",slug:"developer-certificate-of-origin"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Supporting the project",frontmatter:{},regularPath:"/participate/support.html",relativePath:"participate/support.md",key:"v-f3fbff12",path:"/participate/support.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Boards",frontmatter:{},regularPath:"/prerequisites/board.html",relativePath:"prerequisites/board.md",key:"v-01bee537",path:"/prerequisites/board.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Broker",frontmatter:{},regularPath:"/prerequisites/broker.html",relativePath:"prerequisites/broker.md",key:"v-56e06d4d",path:"/prerequisites/broker.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Controller",frontmatter:{},regularPath:"/prerequisites/controller.html",relativePath:"prerequisites/controller.md",key:"v-5e0eec87",path:"/prerequisites/controller.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Devices",frontmatter:{},regularPath:"/prerequisites/devices.html",relativePath:"prerequisites/devices.md",key:"v-204c7852",path:"/prerequisites/devices.html",headers:[{level:2,title:"For radio frequency devices",slug:"for-radio-frequency-devices"},{level:2,title:"For BLE devices",slug:"for-ble-devices"},{level:2,title:"For infrared IR devices",slug:"for-infrared-ir-devices"},{level:2,title:"LORA",slug:"lora"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Parts",frontmatter:{},regularPath:"/prerequisites/parts.html",relativePath:"prerequisites/parts.md",key:"v-29f81312",path:"/prerequisites/parts.html",headers:[{level:2,title:"Main parts",slug:"main-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Actuators",frontmatter:{},regularPath:"/setitup/actuators.html",relativePath:"setitup/actuators.md",key:"v-0c47cd52",path:"/setitup/actuators.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"Somfy RTS",slug:"somfy-rts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"GSM 2G gateway",frontmatter:{},regularPath:"/setitup/gsm.html",relativePath:"setitup/gsm.md",key:"v-b5aec012",path:"/setitup/gsm.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Hardware setup",slug:"hardware-setup"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"M5 Boards",frontmatter:{},regularPath:"/prerequisites/M5.html",relativePath:"prerequisites/M5.md",key:"v-412f01af",path:"/prerequisites/M5.html",headers:[{level:2,title:"M5StickC and M5Stack",slug:"m5stickc-and-m5stack"},{level:3,title:"3 low power modes",slug:"_3-low-power-modes"},{level:3,title:"Start screen",slug:"start-screen"},{level:3,title:"Sleep screen",slug:"sleep-screen"},{level:3,title:"Log display in case of warning",slug:"log-display-in-case-of-warning"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"BLE gateway",frontmatter:{},regularPath:"/setitup/ble.html",relativePath:"setitup/ble.md",key:"v-cf2ed192",path:"/setitup/ble.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"IR gateway",frontmatter:{},regularPath:"/setitup/ir.html",relativePath:"setitup/ir.md",key:"v-eab731fa",path:"/setitup/ir.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"Credits",slug:"credits"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RF gateway (433mhz/315mhz)",frontmatter:{},regularPath:"/setitup/rf.html",relativePath:"setitup/rf.md",key:"v-2fe62c26",path:"/setitup/rf.html",headers:[{level:2,title:"Protocols, modules and library",slug:"protocols-modules-and-library"},{level:2,title:"Assembly/soldering required parts",slug:"assembly-soldering-required-parts"},{level:3,title:"SRX STX Pinout",slug:"srx-stx-pinout"},{level:3,title:"CC1101 Pinout",slug:"cc1101-pinout"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"SONOFF RF Bridge Hardware setup",slug:"sonoff-rf-bridge-hardware-setup"},{level:2,title:"SONOFF RFR3 Hardware setup",slug:"sonoff-rfr3-hardware-setup"},{level:2,title:"WIFI RF GATEWAY Hardware setup",slug:"wifi-rf-gateway-hardware-setup"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Sensors",frontmatter:{},regularPath:"/setitup/sensors.html",relativePath:"setitup/sensors.md",key:"v-aa1cc612",path:"/setitup/sensors.html",headers:[{level:2,title:"Compatible sensors",slug:"compatible-sensors"},{level:2,title:"Pinout",slug:"pinout"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"LoRa gateway",frontmatter:{},regularPath:"/setitup/lora.html",relativePath:"setitup/lora.md",key:"v-0d1e8e9e",path:"/setitup/lora.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Serial/RS232 gateway",frontmatter:{},regularPath:"/setitup/serial.html",relativePath:"setitup/serial.md",key:"v-255607ed",path:"/setitup/serial.html",headers:[{level:2,title:"Compatible parts",slug:"compatible-parts"},{level:2,title:"Pinout",slug:"pinout"},{level:2,title:"ESP8266 Hardware setup",slug:"esp8266-hardware-setup"},{level:2,title:"ESP32 Hardware setup",slug:"esp32-hardware-setup"},{level:2,title:"Credits",slug:"credits"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Advanced configuration of the gateway",frontmatter:{},regularPath:"/upload/advanced-configuration.html",relativePath:"upload/advanced-configuration.md",key:"v-7df515d2",path:"/upload/advanced-configuration.html",headers:[{level:2,title:"Secure connection to the broker",slug:"secure-connection-to-the-broker"},{level:3,title:"Prerequisites",slug:"prerequisites"},{level:3,title:"Configure secure connection in the gateway",slug:"configure-secure-connection-in-the-gateway"},{level:2,title:'Add the received "value" at the end of the topic',slug:"add-the-received-value-at-the-end-of-the-topic"},{level:2,title:"Auto discovery",slug:"auto-discovery"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 2) Upload ready-to-go binaries",frontmatter:{},regularPath:"/upload/binaries.html",relativePath:"upload/binaries.md",key:"v-6e14dcd7",path:"/upload/binaries.html",headers:[{level:2,title:"ESP32",slug:"esp32"},{level:3,title:"Linux - esptool.py",slug:"linux-esptool-py"},{level:3,title:"Mac - esptool.py",slug:"mac-esptool-py"},{level:2,title:"ESP8266",slug:"esp8266"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 3) Upload your configurations",frontmatter:{},regularPath:"/upload/builds.html",relativePath:"upload/builds.md",key:"v-303bd052",path:"/upload/builds.html",headers:[{level:2,title:"Introduction",slug:"introduction"},{level:2,title:"Configure & Upload with PlatformIO",slug:"configure-upload-with-platformio"},{level:3,title:"(Option A) Creating a portable config file",slug:"option-a-creating-a-portable-config-file"},{level:3,title:"(Option B) Editing files directly",slug:"option-b-editing-files-directly"},{level:2,title:"API",slug:"api"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 4) Build from the web",frontmatter:{},regularPath:"/upload/gitpod.html",relativePath:"upload/gitpod.md",key:"v-2c32e617",path:"/upload/gitpod.html",lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Troubleshooting",frontmatter:{},regularPath:"/upload/troubleshoot.html",relativePath:"upload/troubleshoot.md",key:"v-246d3f77",path:"/upload/troubleshoot.html",headers:[{level:2,title:"Compilation/build error",slug:"compilation-build-error"},{level:2,title:"ESP32 compilation errors related to WiFi",slug:"esp32-compilation-errors-related-to-wifi"},{level:2,title:"Not able to send or receive RF or IR",slug:"not-able-to-send-or-receive-rf-or-ir"},{level:2,title:"Repetitive MQTT disconnections or/and commands sent to the gateway not taken into account",slug:"repetitive-mqtt-disconnections-or-and-commands-sent-to-the-gateway-not-taken-into-account"},{level:2,title:"OMG ignores messages sent to it via MQTT",slug:"omg-ignores-messages-sent-to-it-via-mqtt"},{level:2,title:"ESP Continuous restart or strange behaviour:",slug:"esp-continuous-restart-or-strange-behaviour"},{level:2,title:"ESP does not connect to broker with TLS enabled",slug:"esp-does-not-connect-to-broker-with-tls-enabled"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"(Option 1) Upload from the web",frontmatter:{pageClass:"table-generated-page"},regularPath:"/upload/web-install.html",relativePath:"upload/web-install.md",key:"v-2b7b8f3b",path:"/upload/web-install.html",headers:[{level:2,title:"Using OpenMQTTGateway ?",slug:"using-openmqttgateway"},{level:2,title:"Environments characteristics",slug:"environments-characteristics"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Actuators",frontmatter:{},regularPath:"/use/actuators.html",relativePath:"use/actuators.md",key:"v-0d819412",path:"/use/actuators.html",headers:[{level:2,title:"ON/OFF Functionality",slug:"on-off-functionality"},{level:3,title:"Standard ON/OFF control",slug:"standard-on-off-control"},{level:3,title:"Pulse control for short activations",slug:"pulse-control-for-short-activations"},{level:2,title:"FASTLED",slug:"fastled"},{level:3,title:"The FASTLED module support 2 different operation modes",slug:"the-fastled-module-support-2-different-operation-modes"},{level:3,title:"Hardware wiring",slug:"hardware-wiring"},{level:2,title:"PWM",slug:"pwm"},{level:3,title:"Configuration",slug:"configuration"},{level:3,title:"Usage",slug:"usage"},{level:2,title:"Somfy RTS",slug:"somfy-rts"},{level:3,title:"Setup",slug:"setup"},{level:3,title:"Commands",slug:"commands"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Boards",frontmatter:{},regularPath:"/use/boards.html",relativePath:"use/boards.md",key:"v-3043a2b9",path:"/use/boards.html",headers:[{level:2,title:"ESP",slug:"esp"},{level:3,title:"Erasing the flash",slug:"erasing-the-flash"},{level:3,title:"Wifi interference on sensors when using an ESP",slug:"wifi-interference-on-sensors-when-using-an-esp"},{level:3,title:"Low power mode for ESP32",slug:"low-power-mode-for-esp32"},{level:2,title:"M5StickC, M5StickC Plus or M5Stack",slug:"m5stickc-m5stickc-plus-or-m5stack"},{level:3,title:"Behaviour",slug:"behaviour"},{level:3,title:"Setting the log output",slug:"setting-the-log-output"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Bluetooth ESP32 gateway",frontmatter:{title:"Bluetooth ESP32 gateway",description:"Versatile Bluetooth gateway that scans and decodes data from various Bluetooth Low Energy (BLE) devices. It integrates seamlessly with MQTT brokers and controllers like Home Assistant and OpenHAB. Monitor temperature, humidity, pressure, and more for smarter control."},regularPath:"/use/ble.html",relativePath:"use/ble.md",key:"v-bbb970d2",path:"/use/ble.html",headers:[{level:2,title:"Products powered by OpenMQTTGateway",slug:"products-powered-by-openmqttgateway"},{level:3,title:"Theengs Bridge, BLE gateway with external antenna",slug:"theengs-bridge-ble-gateway-with-external-antenna"},{level:3,title:"Theengs Plug, BLE gateway and Smart Plug",slug:"theengs-plug-ble-gateway-and-smart-plug"},{level:2,title:"Disable or enable the BLE gateway (default: true, available with HA discovery)",slug:"disable-or-enable-the-ble-gateway-default-true-available-with-ha-discovery"},{level:2,title:"Receiving signals from compatible BLE sensors to publish it to an MQTT broker.",slug:"receiving-signals-from-compatible-ble-sensors-to-publish-it-to-an-mqtt-broker"},{level:2,title:"Receiving signals from BLE devices for Device Tracker detection",slug:"receiving-signals-from-ble-devices-for-device-tracker-detection"},{level:2,title:"Receiving signals from BLE devices for Presence detection",slug:"receiving-signals-from-ble-devices-for-presence-detection"},{level:2,title:"Receiving signals from BLE devices with accelerometers for movement detection",slug:"receiving-signals-from-ble-devices-with-accelerometers-for-movement-detection"},{level:2,title:"Setting a white or black list",slug:"setting-a-white-or-black-list"},{level:2,title:"Setting the time between BLE scans and force a scan (available with HA discovery)",slug:"setting-the-time-between-ble-scans-and-force-a-scan-available-with-ha-discovery"},{level:2,title:"Setting the time between connection attempts (default: 60min, available with HA discovery)",slug:"setting-the-time-between-connection-attempts-default-60min-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publishes all the BLE devices scanned or only the detected sensors (default: false, available with HA discovery)",slug:"setting-if-the-gateway-publishes-all-the-ble-devices-scanned-or-only-the-detected-sensors-default-false-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publishes known devices which randomly change their MAC address (default: false)",slug:"setting-if-the-gateway-publishes-known-devices-which-randomly-change-their-mac-address-default-false"},{level:2,title:"Setting if the gateway use adaptive scanning (default: true, available with HA discovery)",slug:"setting-if-the-gateway-use-adaptive-scanning-default-true-available-with-ha-discovery"},{level:2,title:"Setting the time between active scanning (available with HA discovery)",slug:"setting-the-time-between-active-scanning-available-with-ha-discovery"},{level:2,title:"Setting the duration of a scan (available with HA discovery)",slug:"setting-the-duration-of-a-scan-available-with-ha-discovery"},{level:2,title:"Setting if the gateway connects to BLE devices eligibles (default: true, available with HA discovery)",slug:"setting-if-the-gateway-connects-to-ble-devices-eligibles-default-true-available-with-ha-discovery"},{level:2,title:"Setting if the gateway publish into Home Assistant Home presence topic (default: false, available with HA discovery)",slug:"setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery"},{level:2,title:"Setting if the gateway uses iBeacon UUID as topic, instead of (random) MAC address (default: false)",slug:"setting-if-the-gateway-uses-ibeacon-uuid-as-topic-instead-of-random-mac-address-default-false"},{level:2,title:"Setting the minimum RSSI accepted to publish device data (default:-100)",slug:"setting-the-minimum-rssi-accepted-to-publish-device-data-default-100"},{level:2,title:"Store BLE configuration into the gateway",slug:"store-ble-configuration-into-the-gateway"},{level:2,title:"Controlling devices",slug:"controlling-devices"},{level:2,title:"Read/write BLE characteristics over MQTT",slug:"read-write-ble-characteristics-over-mqtt"},{level:3,title:"Example write command",slug:"example-write-command"},{level:3,title:"Example read command",slug:"example-read-command"},{level:2,title:"SwitchBot Bot control (available with HA discovery)",slug:"switchbot-bot-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Bot state to ON:",slug:"set-the-switchbot-bot-state-to-on"},{level:3,title:"Set the SwitchBot Bot state to OFF:",slug:"set-the-switchbot-bot-state-to-off"},{level:3,title:"Set the SwitchBot Bot to PRESS:",slug:"set-the-switchbot-bot-to-press"},{level:3,title:"Set the SwitchBot Bot to go UP:",slug:"set-the-switchbot-bot-to-go-up"},{level:3,title:"Set the SwitchBot Bot to go DOWN:",slug:"set-the-switchbot-bot-to-go-down"},{level:2,title:"SwitchBot Blind Tilt control (available with HA discovery)",slug:"switchbot-blind-tilt-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Blind Tilt state to OPEN:",slug:"set-the-switchbot-blind-tilt-state-to-open"},{level:3,title:"Set the SwitchBot Blind Tilt state to CLOSE_DOWN:",slug:"set-the-switchbot-blind-tilt-state-to-close-down"},{level:3,title:"Set the SwitchBot Blind Tilt state to CLOSE_UP:",slug:"set-the-switchbot-blind-tilt-state-to-close-up"},{level:3,title:"Set the SwitchBot Blind Tilt state to a percentage (0-100):",slug:"set-the-switchbot-blind-tilt-state-to-a-percentage-0-100"},{level:3,title:"Set the SwitchBot Blind Tilt to Stop:",slug:"set-the-switchbot-blind-tilt-to-stop"},{level:3,title:"Response (assuming success):",slug:"response-assuming-success"},{level:2,title:"SwitchBot Curtain (2/3) control (available with HA discovery)",slug:"switchbot-curtain-2-3-control-available-with-ha-discovery"},{level:3,title:"Set the SwitchBot Curtain state to OPEN:",slug:"set-the-switchbot-curtain-state-to-open"},{level:3,title:"Set the SwitchBot Curtain state to CLOSE:",slug:"set-the-switchbot-curtain-state-to-close"},{level:3,title:"Set the SwitchBot Curtain to a percentage (0-100):",slug:"set-the-switchbot-curtain-to-a-percentage-0-100"},{level:3,title:"Set the SwitchBot Curtain to Stop:",slug:"set-the-switchbot-curtain-to-stop"},{level:3,title:"Response (assuming success):",slug:"response-assuming-success-2"},{level:2,title:"ADVANCED: Setting up an external decoder",slug:"advanced-setting-up-an-external-decoder"},{level:2,title:"ADVANCED: Filtering out connectable devices (default: false)",slug:"advanced-filtering-out-connectable-devices-default-false"},{level:2,title:"ADVANCED: Advertisement and advanced data (default: false, available with HA discovery)",slug:"advanced-advertisement-and-advanced-data-default-false-available-with-ha-discovery"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Wifi and MQTT configuration",frontmatter:{},regularPath:"/upload/portal.html",relativePath:"upload/portal.md",key:"v-27c660f7",path:"/upload/portal.html",headers:[{level:2,title:"Configuration portal",slug:"configuration-portal"},{level:2,title:"Build time configuration",slug:"build-time-configuration"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"System commands (ESP only)",frontmatter:{},regularPath:"/use/gateway.html",relativePath:"use/gateway.md",key:"v-20c05837",path:"/use/gateway.html",headers:[{level:2,title:"Restart the ESP",slug:"restart-the-esp"},{level:2,title:"Erase the ESP settings",slug:"erase-the-esp-settings"},{level:2,title:"Retrieve current status of the ESP",slug:"retrieve-current-status-of-the-esp"},{level:2,title:"Auto discovery",slug:"auto-discovery"},{level:3,title:"Deactivate",slug:"deactivate"},{level:3,title:"Activate",slug:"activate"},{level:2,title:"Activate Offline mode",slug:"activate-offline-mode"},{level:2,title:"Change the WiFi credentials",slug:"change-the-wifi-credentials"},{level:2,title:"Change the gateway password",slug:"change-the-gateway-password"},{level:2,title:"Change the MQTT broker credentials",slug:"change-the-mqtt-broker-credentials"},{level:2,title:"Change the MQTT main topic, discovery prefix, and or gateway name",slug:"change-the-mqtt-main-topic-discovery-prefix-and-or-gateway-name"},{level:2,title:"Switching brokers and using signed and client certificates",slug:"switching-brokers-and-using-signed-and-client-certificates"},{level:2,title:"Saving/Loading connection parameters/certificates at runtime",slug:"saving-loading-connection-parameters-certificates-at-runtime"},{level:3,title:"Storing and Loading Certificates",slug:"storing-and-loading-certificates"},{level:3,title:"Use Case: Changing a Group of Certificates",slug:"use-case-changing-a-group-of-certificates"},{level:2,title:"MQTT",slug:"mqtt"},{level:2,title:"Serial",slug:"serial"},{level:2,title:"Change the LED indicator brightness",slug:"change-the-led-indicator-brightness"},{level:2,title:"Understanding LED Indicators in OpenMQTTGateway",slug:"understanding-led-indicators-in-openmqttgateway"},{level:2,title:"LED Color Guide",slug:"led-color-guide"},{level:2,title:"Understanding Gateway States",slug:"understanding-gateway-states"},{level:3,title:"Power On",slug:"power-on"},{level:3,title:"Processing",slug:"processing"},{level:3,title:"Waiting for Onboarding",slug:"waiting-for-onboarding"},{level:3,title:"Onboarding in Progress",slug:"onboarding-in-progress"},{level:3,title:"Network Connected",slug:"network-connected"},{level:3,title:"Network Disconnected",slug:"network-disconnected"},{level:3,title:"MQTT Broker Connected",slug:"mqtt-broker-connected"},{level:3,title:"MQTT Broker Disconnected",slug:"mqtt-broker-disconnected"},{level:3,title:"Offline",slug:"offline"},{level:3,title:"Local OTA Update",slug:"local-ota-update"},{level:3,title:"Remote OTA Update",slug:"remote-ota-update"},{level:3,title:"Error",slug:"error"},{level:3,title:"Actuator On/Off",slug:"actuator-on-off"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"GSM 2G gateway",frontmatter:{},regularPath:"/use/gsm.html",relativePath:"use/gsm.md",key:"v-131b9357",path:"/use/gsm.html",headers:[{level:2,title:"Receiving SMS from 2G",slug:"receiving-sms-from-2g"},{level:2,title:"Send data by MQTT to send an SMS message with A6/7",slug:"send-data-by-mqtt-to-send-an-sms-message-with-a6-7"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Displays",frontmatter:{},regularPath:"/use/displays.html",relativePath:"use/displays.md",key:"v-288d7b9e",path:"/use/displays.html",headers:[{level:2,title:"SSD1306 Display (Heltec SX127X, LILYGO® LoRa32 boards, generic SSD1306 displays)",slug:"ssd1306-display-heltec-sx127x-lilygo®-lora32-boards-generic-ssd1306-displays"},{level:3,title:"Display ON/OFF",slug:"display-on-off"},{level:3,title:"Brightness",slug:"brightness"},{level:3,title:"Metric or Imperial property units",slug:"metric-or-imperial-property-units"},{level:3,title:"Rotating the display by 180 degrees",slug:"rotating-the-display-by-180-degrees"},{level:3,title:"Display idle Logo",slug:"display-idle-logo"},{level:3,title:"Setting the log output",slug:"setting-the-log-output"},{level:3,title:"Displaying Module json messages (default)",slug:"displaying-module-json-messages-default"},{level:3,title:"Store the current display configuration in the gateway",slug:"store-the-current-display-configuration-in-the-gateway"},{level:3,title:"Connecting a generic SSD1306 display to ESP32",slug:"connecting-a-generic-ssd1306-display-to-esp32"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Infrared gateway",frontmatter:{title:"Infrared gateway",description:"Unlock the potential of Infrared technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems abd controllers like Home Assistant and OpenHAB."},regularPath:"/use/ir.html",relativePath:"use/ir.md",key:"v-a9ffe0fe",path:"/use/ir.html",headers:[{level:2,title:"Receiving data from IR signal",slug:"receiving-data-from-ir-signal"},{level:2,title:"Send data by MQTT to convert it on IR signal",slug:"send-data-by-mqtt-to-convert-it-on-ir-signal"},{level:2,title:"Send data by MQTT from Global Caché database to convert it on IR signal",slug:"send-data-by-mqtt-from-global-cache-database-to-convert-it-on-ir-signal"},{level:2,title:"Send data by MQTT with advanced IR parameters",slug:"send-data-by-mqtt-with-advanced-ir-parameters"},{level:2,title:"Send raw IR data by MQTT",slug:"send-raw-ir-data-by-mqtt"},{level:2,title:"Repeat the IR signal OpenMQTTGateway receive",slug:"repeat-the-ir-signal-openmqttgateway-receive"},{level:2,title:"Raw IR signal forwarding",slug:"raw-ir-signal-forwarding"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"LoRa gateway",frontmatter:{title:"LoRa gateway",description:"Explore the LoRa MQTT gateway, designed for integration with devices utilizing LoRa technology, including the MakerFab soil and moisture sensor, devices from PricelessTookit. Unlock long range communication with the power of LoRa.."},regularPath:"/use/lora.html",relativePath:"use/lora.md",key:"v-749f316f",path:"/use/lora.html",headers:[{level:2,title:"What is a LoRa gateway",slug:"what-is-a-lora-gateway"},{level:2,title:"Configuring the LoRa gateway",slug:"configuring-the-lora-gateway"},{level:2,title:"Receiving data from LoRa signal",slug:"receiving-data-from-lora-signal"},{level:2,title:"Send data by MQTT to convert it on LoRa signal",slug:"send-data-by-mqtt-to-convert-it-on-lora-signal"},{level:2,title:"Send data by MQTT with advanced LoRa parameters",slug:"send-data-by-mqtt-with-advanced-lora-parameters"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RFM69 gateway",frontmatter:{},regularPath:"/use/rfm69.html",relativePath:"use/rfm69.md",key:"v-21b208b7",path:"/use/rfm69.html",headers:[{level:3,title:"Receiving data from RFM signal",slug:"receiving-data-from-rfm-signal"},{level:3,title:"Send data by MQTT to convert it on RFM69 signal",slug:"send-data-by-mqtt-to-convert-it-on-rfm69-signal"},{level:3,title:"Send data by MQTT with advanced RFM69 parameters",slug:"send-data-by-mqtt-with-advanced-rfm69-parameters"},{level:3,title:"RFM69 acknowledgment",slug:"rfm69-acknowledgment"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"Sensors",frontmatter:{},regularPath:"/use/sensors.html",relativePath:"use/sensors.md",key:"v-2494b4d7",path:"/use/sensors.html",headers:[{level:3,title:"ADC",slug:"adc"},{level:3,title:"DHT",slug:"dht"},{level:3,title:"HTU21",slug:"htu21"},{level:3,title:"AHTx0 (AHT10 and AHT20)",slug:"ahtx0-aht10-and-aht20"},{level:3,title:"DS18x20",slug:"ds18x20"},{level:3,title:"HCSR501",slug:"hcsr501"},{level:3,title:"RN8209",slug:"rn8209"},{level:3,title:"Touch",slug:"touch"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RS232/Serial gateway",frontmatter:{},regularPath:"/use/serial.html",relativePath:"use/serial.md",key:"v-93d2a72a",path:"/use/serial.html",headers:[{level:2,title:"Sending an SERIAL message",slug:"sending-an-serial-message"},{level:2,title:"Receiving an SERIAL message",slug:"receiving-an-serial-message"},{level:3,title:"Single MQTT message mode (default)",slug:"single-mqtt-message-mode-default"},{level:3,title:"JSON mode",slug:"json-mode"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"WebUI",frontmatter:{},regularPath:"/use/webui.html",relativePath:"use/webui.md",key:"v-2566e137",path:"/use/webui.html",headers:[{level:2,title:"WiFi",slug:"wifi"},{level:2,title:"MQTT",slug:"mqtt"},{level:2,title:"WebUI",slug:"webui-2"},{level:2,title:"Bluetooth Low Energy - BLE",slug:"bluetooth-low-energy-ble"},{level:2,title:"Logging",slug:"logging"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3},{title:"RF gateways (RTL_433/RCSwitch/RF/RF2)",frontmatter:{title:"RF gateways (RTL_433/RCSwitch/RF/RF2)",description:"Unlock the potential of RF 433 MHz technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems and controllers like Home Assistant and OpenHAB."},regularPath:"/use/rf.html",relativePath:"use/rf.md",key:"v-947f362a",path:"/use/rf.html",headers:[{level:2,title:"What is an RF gateway",slug:"what-is-an-rf-gateway"},{level:2,title:"Common parameters accross modules",slug:"common-parameters-accross-modules"},{level:3,title:"Change default frequency (SX127X and CC1101)",slug:"change-default-frequency-sx127x-and-cc1101"},{level:3,title:"Changing Active Receiver Modules",slug:"changing-active-receiver-modules"},{level:2,title:"RTL_433 device decoders",slug:"rtl-433-device-decoders"},{level:3,title:"Supported hardware combinations",slug:"supported-hardware-combinations"},{level:3,title:"Supported Decoders",slug:"supported-decoders"},{level:3,title:"Change Signal RSSI Threshold Delta",slug:"change-signal-rssi-threshold-delta"},{level:3,title:"Retrieve current status of receiver",slug:"retrieve-current-status-of-receiver"},{level:2,title:"RCSwitch based gateway",slug:"rcswitch-based-gateway"},{level:3,title:"Handling RF signal over MQTT",slug:"handling-rf-signal-over-mqtt"},{level:3,title:"Send data by MQTT with advanced RF parameters",slug:"send-data-by-mqtt-with-advanced-rf-parameters"},{level:2,title:"Pilight gateway",slug:"pilight-gateway"},{level:3,title:"Receiving data from RF signal",slug:"receiving-data-from-rf-signal-2"},{level:3,title:"Limit Protocols",slug:"limit-protocols"},{level:3,title:"Send data by MQTT to transmit a RF signal",slug:"send-data-by-mqtt-to-transmit-a-rf-signal"},{level:2,title:"RF with SONOFF RF BRIDGE",slug:"rf-with-sonoff-rf-bridge"},{level:3,title:"Receiving data from RF signal",slug:"receiving-data-from-rf-signal-3"},{level:3,title:"Send data by MQTT to convert it on RF signal",slug:"send-data-by-mqtt-to-convert-it-on-rf-signal"},{level:3,title:"Send data by MQTT with advanced RF parameters",slug:"send-data-by-mqtt-with-advanced-rf-parameters-2"},{level:2,title:"RF2 gateway KAKU",slug:"rf2-gateway-kaku"},{level:3,title:"Receiving data from KAKU signal",slug:"receiving-data-from-kaku-signal"},{level:3,title:"Send data by MQTT to convert it on KAKU signal",slug:"send-data-by-mqtt-to-convert-it-on-kaku-signal"}],lastUpdated:"1/10/2026, 5:59:41 PM",lastUpdatedTimestamp:1768067981e3}],themeConfig:{repo:"1technophile/OpenMQTTGateway",docsDir:"docs",smoothScroll:!0,search:!1,docsBranch:"development",lastUpdated:"Last Updated",editLinks:!0,nav:[{text:"Home",link:"https://www.theengs.io",target:"_self",rel:""},{text:"Use cases",items:[{text:"Smart Home",link:"https://www.theengs.io/usecases/smarthome.html",target:"_self",rel:""},{text:"IoT",link:"https://www.theengs.io/usecases/iot.html",target:"_self",rel:""},{text:"Research",link:"https://www.theengs.io/usecases/research.html",target:"_self",rel:""}]},{text:"Solutions",items:[{text:"Hardware",items:[{text:"Theengs Plug",link:"https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption",target:"_self",rel:""},{text:"Theengs Bridge",link:"https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna",target:"_self",rel:""}]},{text:"Software",items:[{text:"Mobile App",link:"https://app.theengs.io",target:"_self",rel:""},{text:"OpenMQTTGateway",link:"https://docs.openmqttgateway.com",target:"_self",rel:""},{text:"Gateway",link:"https://gateway.theengs.io",target:"_self",rel:""}]},{text:"Core",items:[{text:"Decoder",link:"https://decoder.theengs.io",target:"_self",rel:""},{text:"Web Parser",link:"https://parser.theengs.io",target:"_self",rel:""}]}]},{text:"Compatible devices",link:"https://decoder.theengs.io/devices/devices.html",target:"_self",rel:""},{text:"Community",link:"https://community.openmqttgateway.com",target:"_self",rel:""},{text:"Shop",link:"https://shop.theengs.io/",target:"_self",rel:""},{text:"Sponsor 🤍",link:"https://github.com/sponsors/theengs",target:"_self",rel:""}],sidebar:[["/","0 - What is it for 🏠"],{title:"1 - Prerequisites🧭",sidebarDepth:1,children:["prerequisites/devices","prerequisites/board","prerequisites/parts","prerequisites/broker","prerequisites/controller"]},{title:"2 - Set it up 🔨",sidebarDepth:1,children:["setitup/rf","setitup/ble","setitup/ir","setitup/lora","setitup/gsm","setitup/serial","setitup/sensors","setitup/actuators"]},{title:"3 - Upload ➡️",sidebarDepth:1,children:["upload/web-install","upload/binaries","upload/builds","upload/gitpod","upload/portal","upload/advanced-configuration","upload/troubleshoot"]},{title:"4 - Use ✈️",sidebarDepth:1,children:["use/rf","use/ble","use/ir","use/lora","use/gsm","use/serial","use/rfm69","use/sensors","use/actuators","use/boards","use/displays","use/gateway","use/webui"]},{title:"5 - Integrate 🎉",sidebarDepth:1,children:["integrate/openhab2","integrate/openhab3","integrate/home_assistant","integrate/node_red","integrate/aws_iot","integrate/jeedom"]},{title:"6 - Participate 💻",sidebarDepth:1,children:["participate/support","participate/development","participate/adding-protocols","participate/community",["https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt","License"]]}]}};n(235);Qn.component("web-uploader",()=>n.e(47).then(n.bind(null,423))),Qn.component("Badge",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,424))),Qn.component("CodeBlock",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,419))),Qn.component("CodeGroup",()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,420)));n(236),n(237);function Rs(t){const e=document.documentElement.getBoundingClientRect(),n=t.getBoundingClientRect();return{x:n.left-e.left,y:n.top-e.top}}var Us=[{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},({Vue:t,router:e})=>{e.options.scrollBehavior=(e,n,r)=>{if(r)return window.scrollTo({top:r.y,behavior:"smooth"});if(e.hash){if(t.$vuepress.$get("disableScrollBehavior"))return!1;const n=document.querySelector(e.hash);return!!n&&window.scrollTo({top:Rs(n).y,behavior:"smooth"})}return window.scrollTo({top:0,behavior:"smooth"})}}],Is=[];class Bs extends class{constructor(){this.store=new Qn({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){Qn.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Bs.prototype,{getPageAsyncComponent:ss,getLayoutAsyncComponent:ls,getAsyncComponent:cs,getVueComponent:us});var Ds={install(t){const e=new Bs;t.$vuepress=e,t.prototype.$vuepress=e}};function Fs(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var qs={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return ps("pageKey",e),Qn.component(e)||Qn.component(e,ss(e)),Qn.component(e)?t(e):t("")}},Ns={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Hs={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},zs=(n(238),n(239),Object($s.a)(Hs,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[t("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),t("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Vs={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};Qn.config.productionTip=!1,Qn.use(Va),Qn.use(Ds),Qn.mixin(function(t,e,n=Qn){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const r=new(t(n.$vuepress.$get("siteData"))),o=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),i={};return Object.keys(o).reduce((t,e)=>(e.startsWith("$")&&(t[e]=o[e].get),t),i),{computed:i}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!Qn.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Fs(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Fs(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Fs(t,o)?r(o):Fs(t,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Us.filter(t=>"function"==typeof t).map(e=>e({Vue:Qn,options:r,router:n,siteData:Ls,isServer:t})))}catch(t){console.error(t)}return{app:new Qn(Object.assign(r,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Is.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file diff --git a/dev/firmware_build/airm2m_core_esp32c3-firmware.bin b/dev/firmware_build/airm2m_core_esp32c3-firmware.bin index b9fde4e4..e0c5b33e 100644 Binary files a/dev/firmware_build/airm2m_core_esp32c3-firmware.bin and b/dev/firmware_build/airm2m_core_esp32c3-firmware.bin differ diff --git a/dev/firmware_build/esp32-lolin32lite-ble-firmware.bin b/dev/firmware_build/esp32-lolin32lite-ble-firmware.bin index 89fdea23..075bd06d 100644 Binary files a/dev/firmware_build/esp32-lolin32lite-ble-firmware.bin and b/dev/firmware_build/esp32-lolin32lite-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5atom-lite-firmware.bin b/dev/firmware_build/esp32-m5atom-lite-firmware.bin index cff500da..18823c04 100644 Binary files a/dev/firmware_build/esp32-m5atom-lite-firmware.bin and b/dev/firmware_build/esp32-m5atom-lite-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5atom-matrix-firmware.bin b/dev/firmware_build/esp32-m5atom-matrix-firmware.bin index 23be264b..4c08bd5e 100644 Binary files a/dev/firmware_build/esp32-m5atom-matrix-firmware.bin and b/dev/firmware_build/esp32-m5atom-matrix-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5stack-ble-firmware.bin b/dev/firmware_build/esp32-m5stack-ble-firmware.bin index 93dbd672..3b499d22 100644 Binary files a/dev/firmware_build/esp32-m5stack-ble-firmware.bin and b/dev/firmware_build/esp32-m5stack-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5stick-ble-firmware.bin b/dev/firmware_build/esp32-m5stick-ble-firmware.bin index 984ff055..f2e174c2 100644 Binary files a/dev/firmware_build/esp32-m5stick-ble-firmware.bin and b/dev/firmware_build/esp32-m5stick-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5stick-c-ble-firmware.bin b/dev/firmware_build/esp32-m5stick-c-ble-firmware.bin index cf04870b..1125bc72 100644 Binary files a/dev/firmware_build/esp32-m5stick-c-ble-firmware.bin and b/dev/firmware_build/esp32-m5stick-c-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5stick-cp-ble-firmware.bin b/dev/firmware_build/esp32-m5stick-cp-ble-firmware.bin index 1784e50d..8fca71a5 100644 Binary files a/dev/firmware_build/esp32-m5stick-cp-ble-firmware.bin and b/dev/firmware_build/esp32-m5stick-cp-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-m5tough-ble-firmware.bin b/dev/firmware_build/esp32-m5tough-ble-firmware.bin index 646d7b3c..dce5abf7 100644 Binary files a/dev/firmware_build/esp32-m5tough-ble-firmware.bin and b/dev/firmware_build/esp32-m5tough-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32-olimex-gtw-ble-eth-firmware.bin b/dev/firmware_build/esp32-olimex-gtw-ble-eth-firmware.bin index 68be3561..c4c31d53 100644 Binary files a/dev/firmware_build/esp32-olimex-gtw-ble-eth-firmware.bin and b/dev/firmware_build/esp32-olimex-gtw-ble-eth-firmware.bin differ diff --git a/dev/firmware_build/esp32-olimex-gtw-ble-poe-firmware.bin b/dev/firmware_build/esp32-olimex-gtw-ble-poe-firmware.bin index af760b04..1939e903 100644 Binary files a/dev/firmware_build/esp32-olimex-gtw-ble-poe-firmware.bin and b/dev/firmware_build/esp32-olimex-gtw-ble-poe-firmware.bin differ diff --git a/dev/firmware_build/esp32-olimex-gtw-ble-poe-iso-firmware.bin b/dev/firmware_build/esp32-olimex-gtw-ble-poe-iso-firmware.bin index d90b57ab..4105fd7a 100644 Binary files a/dev/firmware_build/esp32-olimex-gtw-ble-poe-iso-firmware.bin and b/dev/firmware_build/esp32-olimex-gtw-ble-poe-iso-firmware.bin differ diff --git a/dev/firmware_build/esp32-olimex-gtw-ble-wifi-firmware.bin b/dev/firmware_build/esp32-olimex-gtw-ble-wifi-firmware.bin index 9ef586b0..57b7a690 100644 Binary files a/dev/firmware_build/esp32-olimex-gtw-ble-wifi-firmware.bin and b/dev/firmware_build/esp32-olimex-gtw-ble-wifi-firmware.bin differ diff --git a/dev/firmware_build/esp32-wt32-eth01-ble-eth-firmware.bin b/dev/firmware_build/esp32-wt32-eth01-ble-eth-firmware.bin index d05c06c6..7569cbb3 100644 Binary files a/dev/firmware_build/esp32-wt32-eth01-ble-eth-firmware.bin and b/dev/firmware_build/esp32-wt32-eth01-ble-eth-firmware.bin differ diff --git a/dev/firmware_build/esp32c3-dev-c2-ble-firmware.bin b/dev/firmware_build/esp32c3-dev-c2-ble-firmware.bin index 964731ae..3a2c352e 100644 Binary files a/dev/firmware_build/esp32c3-dev-c2-ble-firmware.bin and b/dev/firmware_build/esp32c3-dev-c2-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32c3-dev-c2-ble-no-serial-firmware.bin b/dev/firmware_build/esp32c3-dev-c2-ble-no-serial-firmware.bin index 1a1733ea..0a869e71 100644 Binary files a/dev/firmware_build/esp32c3-dev-c2-ble-no-serial-firmware.bin and b/dev/firmware_build/esp32c3-dev-c2-ble-no-serial-firmware.bin differ diff --git a/dev/firmware_build/esp32c3-dev-m1-ble-firmware.bin b/dev/firmware_build/esp32c3-dev-m1-ble-firmware.bin index 4b88a581..6df27b4d 100644 Binary files a/dev/firmware_build/esp32c3-dev-m1-ble-firmware.bin and b/dev/firmware_build/esp32c3-dev-m1-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32c3-m5stamp-firmware.bin b/dev/firmware_build/esp32c3-m5stamp-firmware.bin index b58e0200..b461ed35 100644 Binary files a/dev/firmware_build/esp32c3-m5stamp-firmware.bin and b/dev/firmware_build/esp32c3-m5stamp-firmware.bin differ diff --git a/dev/firmware_build/esp32c3_lolin_mini-firmware.bin b/dev/firmware_build/esp32c3_lolin_mini-firmware.bin index f83df6ca..f98062af 100644 Binary files a/dev/firmware_build/esp32c3_lolin_mini-firmware.bin and b/dev/firmware_build/esp32c3_lolin_mini-firmware.bin differ diff --git a/dev/firmware_build/esp32c3_lolin_mini_with_serial-firmware.bin b/dev/firmware_build/esp32c3_lolin_mini_with_serial-firmware.bin index 69ac5ac3..86e2c727 100644 Binary files a/dev/firmware_build/esp32c3_lolin_mini_with_serial-firmware.bin and b/dev/firmware_build/esp32c3_lolin_mini_with_serial-firmware.bin differ diff --git a/dev/firmware_build/esp32c3u-m5stamp-firmware.bin b/dev/firmware_build/esp32c3u-m5stamp-firmware.bin index d37f66b5..7363c298 100644 Binary files a/dev/firmware_build/esp32c3u-m5stamp-firmware.bin and b/dev/firmware_build/esp32c3u-m5stamp-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-aws-firmware.bin b/dev/firmware_build/esp32dev-ble-aws-firmware.bin index d2bfe97d..73c02d1c 100644 Binary files a/dev/firmware_build/esp32dev-ble-aws-firmware.bin and b/dev/firmware_build/esp32dev-ble-aws-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-broker-firmware.bin b/dev/firmware_build/esp32dev-ble-broker-firmware.bin index b6754096..9972d191 100644 Binary files a/dev/firmware_build/esp32dev-ble-broker-firmware.bin and b/dev/firmware_build/esp32dev-ble-broker-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-datatest-firmware.bin b/dev/firmware_build/esp32dev-ble-datatest-firmware.bin index cce6f2a7..08be6259 100644 Binary files a/dev/firmware_build/esp32dev-ble-datatest-firmware.bin and b/dev/firmware_build/esp32dev-ble-datatest-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-firmware.bin b/dev/firmware_build/esp32dev-ble-firmware.bin index 7f453f88..881b2714 100644 Binary files a/dev/firmware_build/esp32dev-ble-firmware.bin and b/dev/firmware_build/esp32dev-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-idf-bootloader.bin b/dev/firmware_build/esp32dev-ble-idf-bootloader.bin index 2521a395..f9d4978f 100644 Binary files a/dev/firmware_build/esp32dev-ble-idf-bootloader.bin and b/dev/firmware_build/esp32dev-ble-idf-bootloader.bin differ diff --git a/dev/firmware_build/esp32dev-ble-idf-firmware.bin b/dev/firmware_build/esp32dev-ble-idf-firmware.bin index a132b3e6..6c289716 100644 Binary files a/dev/firmware_build/esp32dev-ble-idf-firmware.bin and b/dev/firmware_build/esp32dev-ble-idf-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ble-mqtt-undecoded-firmware.bin b/dev/firmware_build/esp32dev-ble-mqtt-undecoded-firmware.bin index bd53a4d6..71f8aef2 100644 Binary files a/dev/firmware_build/esp32dev-ble-mqtt-undecoded-firmware.bin and b/dev/firmware_build/esp32dev-ble-mqtt-undecoded-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-gf-sun-inverter-firmware.bin b/dev/firmware_build/esp32dev-gf-sun-inverter-firmware.bin index 0519b155..717d6807 100644 Binary files a/dev/firmware_build/esp32dev-gf-sun-inverter-firmware.bin and b/dev/firmware_build/esp32dev-gf-sun-inverter-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-ir-firmware.bin b/dev/firmware_build/esp32dev-ir-firmware.bin index d145ee21..e7581caf 100644 Binary files a/dev/firmware_build/esp32dev-ir-firmware.bin and b/dev/firmware_build/esp32dev-ir-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-multi_receiver-firmware.bin b/dev/firmware_build/esp32dev-multi_receiver-firmware.bin index b98a3585..515c4bf0 100644 Binary files a/dev/firmware_build/esp32dev-multi_receiver-firmware.bin and b/dev/firmware_build/esp32dev-multi_receiver-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-multi_receiver-pilight-firmware.bin b/dev/firmware_build/esp32dev-multi_receiver-pilight-firmware.bin index d8da2039..ecfa0a3d 100644 Binary files a/dev/firmware_build/esp32dev-multi_receiver-pilight-firmware.bin and b/dev/firmware_build/esp32dev-multi_receiver-pilight-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-pilight-cc1101-firmware.bin b/dev/firmware_build/esp32dev-pilight-cc1101-firmware.bin index 4d1f96af..e62de959 100644 Binary files a/dev/firmware_build/esp32dev-pilight-cc1101-firmware.bin and b/dev/firmware_build/esp32dev-pilight-cc1101-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-pilight-firmware.bin b/dev/firmware_build/esp32dev-pilight-firmware.bin index 5f7f3b62..f0f18bcb 100644 Binary files a/dev/firmware_build/esp32dev-pilight-firmware.bin and b/dev/firmware_build/esp32dev-pilight-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-pilight-somfy-cc1101-firmware.bin b/dev/firmware_build/esp32dev-pilight-somfy-cc1101-firmware.bin index 40243d7b..0114baa0 100644 Binary files a/dev/firmware_build/esp32dev-pilight-somfy-cc1101-firmware.bin and b/dev/firmware_build/esp32dev-pilight-somfy-cc1101-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-rf-firmware.bin b/dev/firmware_build/esp32dev-rf-firmware.bin index 986c93c7..89f1be6a 100644 Binary files a/dev/firmware_build/esp32dev-rf-firmware.bin and b/dev/firmware_build/esp32dev-rf-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-rtl_433-firmware.bin b/dev/firmware_build/esp32dev-rtl_433-firmware.bin index 07f6f137..e607615f 100644 Binary files a/dev/firmware_build/esp32dev-rtl_433-firmware.bin and b/dev/firmware_build/esp32dev-rtl_433-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-rtl_433-fsk-firmware.bin b/dev/firmware_build/esp32dev-rtl_433-fsk-firmware.bin index e9fd172f..8dda750a 100644 Binary files a/dev/firmware_build/esp32dev-rtl_433-fsk-firmware.bin and b/dev/firmware_build/esp32dev-rtl_433-fsk-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-somfy-cc1101-firmware.bin b/dev/firmware_build/esp32dev-somfy-cc1101-firmware.bin index 281b24d4..d485cca6 100644 Binary files a/dev/firmware_build/esp32dev-somfy-cc1101-firmware.bin and b/dev/firmware_build/esp32dev-somfy-cc1101-firmware.bin differ diff --git a/dev/firmware_build/esp32dev-weatherstation-firmware.bin b/dev/firmware_build/esp32dev-weatherstation-firmware.bin index e3d2c258..787822dc 100644 Binary files a/dev/firmware_build/esp32dev-weatherstation-firmware.bin and b/dev/firmware_build/esp32dev-weatherstation-firmware.bin differ diff --git a/dev/firmware_build/esp32doitv1-aithinker-r01-sx1278-firmware.bin b/dev/firmware_build/esp32doitv1-aithinker-r01-sx1278-firmware.bin index 3b2e0a5a..f87e441c 100644 Binary files a/dev/firmware_build/esp32doitv1-aithinker-r01-sx1278-firmware.bin and b/dev/firmware_build/esp32doitv1-aithinker-r01-sx1278-firmware.bin differ diff --git a/dev/firmware_build/esp32feather-ble-firmware.bin b/dev/firmware_build/esp32feather-ble-firmware.bin index cbba91d6..d0fcea4e 100644 Binary files a/dev/firmware_build/esp32feather-ble-firmware.bin and b/dev/firmware_build/esp32feather-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32s3-atomS3U-firmware.bin b/dev/firmware_build/esp32s3-atomS3U-firmware.bin index 50bc9e90..37c04e8e 100644 Binary files a/dev/firmware_build/esp32s3-atomS3U-firmware.bin and b/dev/firmware_build/esp32s3-atomS3U-firmware.bin differ diff --git a/dev/firmware_build/esp32s3-dev-c1-ble-firmware.bin b/dev/firmware_build/esp32s3-dev-c1-ble-firmware.bin index 0fa67d1e..23188696 100644 Binary files a/dev/firmware_build/esp32s3-dev-c1-ble-firmware.bin and b/dev/firmware_build/esp32s3-dev-c1-ble-firmware.bin differ diff --git a/dev/firmware_build/esp32s3-m5stack-stamps3-firmware.bin b/dev/firmware_build/esp32s3-m5stack-stamps3-firmware.bin index fbafbe16..72c03267 100644 Binary files a/dev/firmware_build/esp32s3-m5stack-stamps3-firmware.bin and b/dev/firmware_build/esp32s3-m5stack-stamps3-firmware.bin differ diff --git a/dev/firmware_build/heltec-ble-firmware.bin b/dev/firmware_build/heltec-ble-firmware.bin index 6c9e460f..31b4c172 100644 Binary files a/dev/firmware_build/heltec-ble-firmware.bin and b/dev/firmware_build/heltec-ble-firmware.bin differ diff --git a/dev/firmware_build/heltec-rtl_433-firmware.bin b/dev/firmware_build/heltec-rtl_433-firmware.bin index 9c08bfbe..c10937de 100644 Binary files a/dev/firmware_build/heltec-rtl_433-firmware.bin and b/dev/firmware_build/heltec-rtl_433-firmware.bin differ diff --git a/dev/firmware_build/heltec-rtl_433-fsk-firmware.bin b/dev/firmware_build/heltec-rtl_433-fsk-firmware.bin index 20bb4421..d0fef33a 100644 Binary files a/dev/firmware_build/heltec-rtl_433-fsk-firmware.bin and b/dev/firmware_build/heltec-rtl_433-fsk-firmware.bin differ diff --git a/dev/firmware_build/heltec-wifi-lora-32-firmware.bin b/dev/firmware_build/heltec-wifi-lora-32-firmware.bin index 74b856ee..391a9a14 100644 Binary files a/dev/firmware_build/heltec-wifi-lora-32-firmware.bin and b/dev/firmware_build/heltec-wifi-lora-32-firmware.bin differ diff --git a/dev/firmware_build/lilygo-ble-firmware.bin b/dev/firmware_build/lilygo-ble-firmware.bin index 19768523..be9fd631 100644 Binary files a/dev/firmware_build/lilygo-ble-firmware.bin and b/dev/firmware_build/lilygo-ble-firmware.bin differ diff --git a/dev/firmware_build/lilygo-rtl_433-firmware.bin b/dev/firmware_build/lilygo-rtl_433-firmware.bin index 9d9f3e2b..69a4b6f1 100644 Binary files a/dev/firmware_build/lilygo-rtl_433-firmware.bin and b/dev/firmware_build/lilygo-rtl_433-firmware.bin differ diff --git a/dev/firmware_build/lilygo-rtl_433-fsk-firmware.bin b/dev/firmware_build/lilygo-rtl_433-fsk-firmware.bin index b9474177..21d2aec0 100644 Binary files a/dev/firmware_build/lilygo-rtl_433-fsk-firmware.bin and b/dev/firmware_build/lilygo-rtl_433-fsk-firmware.bin differ diff --git a/dev/firmware_build/lilygo-t3-s3-rtl_433-firmware.bin b/dev/firmware_build/lilygo-t3-s3-rtl_433-firmware.bin index 591cd33c..4f66d6b8 100644 Binary files a/dev/firmware_build/lilygo-t3-s3-rtl_433-firmware.bin and b/dev/firmware_build/lilygo-t3-s3-rtl_433-firmware.bin differ diff --git a/dev/firmware_build/lilygo-t3-s3-rtl_433-fsk-firmware.bin b/dev/firmware_build/lilygo-t3-s3-rtl_433-fsk-firmware.bin index beea8245..26e2bfbe 100644 Binary files a/dev/firmware_build/lilygo-t3-s3-rtl_433-fsk-firmware.bin and b/dev/firmware_build/lilygo-t3-s3-rtl_433-fsk-firmware.bin differ diff --git a/dev/firmware_build/shelly-plus1-firmware.bin b/dev/firmware_build/shelly-plus1-firmware.bin index 87d493cd..23206b3b 100644 Binary files a/dev/firmware_build/shelly-plus1-firmware.bin and b/dev/firmware_build/shelly-plus1-firmware.bin differ diff --git a/dev/firmware_build/theengs-bridge-firmware.bin b/dev/firmware_build/theengs-bridge-firmware.bin index 723f27aa..b93e42e0 100644 Binary files a/dev/firmware_build/theengs-bridge-firmware.bin and b/dev/firmware_build/theengs-bridge-firmware.bin differ diff --git a/dev/firmware_build/theengs-bridge-v11-firmware.bin b/dev/firmware_build/theengs-bridge-v11-firmware.bin index fb6f9db4..98ebf635 100644 Binary files a/dev/firmware_build/theengs-bridge-v11-firmware.bin and b/dev/firmware_build/theengs-bridge-v11-firmware.bin differ diff --git a/dev/firmware_build/theengs-plug-firmware.bin b/dev/firmware_build/theengs-plug-firmware.bin index e13197be..c41d9001 100644 Binary files a/dev/firmware_build/theengs-plug-firmware.bin and b/dev/firmware_build/theengs-plug-firmware.bin differ diff --git a/dev/firmware_build/thingpulse-espgateway-firmware.bin b/dev/firmware_build/thingpulse-espgateway-firmware.bin index 34f6e58e..e763d093 100644 Binary files a/dev/firmware_build/thingpulse-espgateway-firmware.bin and b/dev/firmware_build/thingpulse-espgateway-firmware.bin differ diff --git a/dev/firmware_build/tinypico-ble-firmware.bin b/dev/firmware_build/tinypico-ble-firmware.bin index 0e1a2190..cd81229c 100644 Binary files a/dev/firmware_build/tinypico-ble-firmware.bin and b/dev/firmware_build/tinypico-ble-firmware.bin differ diff --git a/dev/firmware_build/ttgo-lora32-v1-firmware.bin b/dev/firmware_build/ttgo-lora32-v1-firmware.bin index bd607d38..8245b178 100644 Binary files a/dev/firmware_build/ttgo-lora32-v1-firmware.bin and b/dev/firmware_build/ttgo-lora32-v1-firmware.bin differ diff --git a/dev/firmware_build/ttgo-lora32-v21-firmware.bin b/dev/firmware_build/ttgo-lora32-v21-firmware.bin index d63e8989..f901c09b 100644 Binary files a/dev/firmware_build/ttgo-lora32-v21-firmware.bin and b/dev/firmware_build/ttgo-lora32-v21-firmware.bin differ diff --git a/dev/firmware_build/ttgo-t-beam-firmware.bin b/dev/firmware_build/ttgo-t-beam-firmware.bin index 399e8091..58c57b3b 100644 Binary files a/dev/firmware_build/ttgo-t-beam-firmware.bin and b/dev/firmware_build/ttgo-t-beam-firmware.bin differ diff --git a/dev/index.html b/dev/index.html index ee1b7ecb..31937ebf 100644 --- a/dev/index.html +++ b/dev/index.html @@ -19,7 +19,7 @@ - + @@ -106,6 +106,6 @@ BLE to MQTT gateway can also run on Raspberry Pi, Windows or Unix computers than →

- + diff --git a/dev/integrate/aws_iot.html b/dev/integrate/aws_iot.html index 0ccc5f77..a78b13e1 100644 --- a/dev/integrate/aws_iot.html +++ b/dev/integrate/aws_iot.html @@ -19,7 +19,7 @@ - + @@ -126,6 +126,6 @@ →

- + diff --git a/dev/integrate/home_assistant.html b/dev/integrate/home_assistant.html index 6e5b0dc2..bed4ab00 100644 --- a/dev/integrate/home_assistant.html +++ b/dev/integrate/home_assistant.html @@ -19,7 +19,7 @@ - + @@ -312,6 +312,6 @@ mqtt: !include homed-mqtt.yaml →

- + diff --git a/dev/integrate/jeedom.html b/dev/integrate/jeedom.html index 711ff973..dcb1442a 100644 --- a/dev/integrate/jeedom.html +++ b/dev/integrate/jeedom.html @@ -19,7 +19,7 @@ - + @@ -112,6 +112,6 @@ Creation of "uptime", "freemem", "frestack" and &q →

- + diff --git a/dev/integrate/node_red.html b/dev/integrate/node_red.html index 4789ec89..df7861fe 100644 --- a/dev/integrate/node_red.html +++ b/dev/integrate/node_red.html @@ -19,7 +19,7 @@ - + @@ -334,6 +334,6 @@ →

- + diff --git a/dev/integrate/openhab2.html b/dev/integrate/openhab2.html index 9c6df060..5cfc8d83 100644 --- a/dev/integrate/openhab2.html +++ b/dev/integrate/openhab2.html @@ -19,7 +19,7 @@ - + @@ -143,6 +143,6 @@ end →

- + diff --git a/dev/integrate/openhab3.html b/dev/integrate/openhab3.html index f74dac07..19ec544c 100644 --- a/dev/integrate/openhab3.html +++ b/dev/integrate/openhab3.html @@ -19,7 +19,7 @@ - + @@ -109,6 +109,6 @@ After this tutorial, you should see your Bluetooth Low Energy devices in OpenHAB →

- + diff --git a/dev/participate/adding-protocols.html b/dev/participate/adding-protocols.html index 937990f7..82fe2640 100644 --- a/dev/participate/adding-protocols.html +++ b/dev/participate/adding-protocols.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/participate/community.html b/dev/participate/community.html index c649fd92..9c0053b9 100644 --- a/dev/participate/community.html +++ b/dev/participate/community.html @@ -19,7 +19,7 @@ - + @@ -109,6 +109,6 @@ (opens new window) →

- + diff --git a/dev/participate/development.html b/dev/participate/development.html index cb707e6f..5241b6b4 100644 --- a/dev/participate/development.html +++ b/dev/participate/development.html @@ -19,7 +19,7 @@ - + @@ -133,6 +133,6 @@ They are generated from the development branch nightly or from a particular pull →

- + diff --git a/dev/participate/support.html b/dev/participate/support.html index f9148ae9..3409109b 100644 --- a/dev/participate/support.html +++ b/dev/participate/support.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/prerequisites/M5.html b/dev/prerequisites/M5.html index 06dcb8e1..f3e229b7 100644 --- a/dev/prerequisites/M5.html +++ b/dev/prerequisites/M5.html @@ -19,7 +19,7 @@ - + @@ -102,6 +102,6 @@ (opens new window)

# M5 Boards

M5 boards, manufactured by M5Stack (opens new window) are inexpensive, well featured boards based on ESP32.

# M5StickC and M5Stack

M5StickC and M5Stack are supported by OpenMQTTGateway and provide the following features:

# 3 low power modes

# Always ON display

The display is always ON but decrease its brightness when not processing.

# ON display when processing

The display is OFF when not processing and the ESP32 is put in low power mode.

# Always OFF display

The display is always OFF, if the board has a led, the led is used when processing.

To change the low power mode you can do it by MQTT or by pushing the middle button (btn B) of the M5Stack and the top button (btn B) of the M5Stick C

# Start screen

MStack core logo

# Sleep screen

The screen brightness is put to a minimum so as to reduce power consumption. M5Stack core brightness

# Log display in case of warning

If the gateway detects a warning or an error the sleep go out the sleep screen and show the message with a red (error) or orange (warning) background. M5 Stack core warning

The M5Stick support low power mode 2 but its display is not supported for the moment.

- + diff --git a/dev/prerequisites/board.html b/dev/prerequisites/board.html index 642f585a..ab679373 100644 --- a/dev/prerequisites/board.html +++ b/dev/prerequisites/board.html @@ -19,7 +19,7 @@ - + @@ -111,6 +111,6 @@ To have a good overview of the compatibilities per board you can refer to the co →

- + diff --git a/dev/prerequisites/broker.html b/dev/prerequisites/broker.html index c3c76c28..585a6d38 100644 --- a/dev/prerequisites/broker.html +++ b/dev/prerequisites/broker.html @@ -19,7 +19,7 @@ - + @@ -110,6 +110,6 @@ Here is also some - + diff --git a/dev/prerequisites/controller.html b/dev/prerequisites/controller.html index 078e624a..ad6c8b5b 100644 --- a/dev/prerequisites/controller.html +++ b/dev/prerequisites/controller.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/prerequisites/devices.html b/dev/prerequisites/devices.html index 01c1825c..de324144 100644 --- a/dev/prerequisites/devices.html +++ b/dev/prerequisites/devices.html @@ -19,7 +19,7 @@ - + @@ -110,6 +110,6 @@ Added to that it retrieves the measures from the devices mentioned and linked to →

- + diff --git a/dev/prerequisites/parts.html b/dev/prerequisites/parts.html index 680e5a18..68d265f3 100644 --- a/dev/prerequisites/parts.html +++ b/dev/prerequisites/parts.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/setitup/actuators.html b/dev/setitup/actuators.html index 9e34432b..daf585f8 100644 --- a/dev/setitup/actuators.html +++ b/dev/setitup/actuators.html @@ -19,7 +19,7 @@ - + @@ -112,6 +112,6 @@ The wiring of the hardware is described in the RF gateway.

< →

- + diff --git a/dev/setitup/ble.html b/dev/setitup/ble.html index 0fb694d7..110b82da 100644 --- a/dev/setitup/ble.html +++ b/dev/setitup/ble.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/setitup/gsm.html b/dev/setitup/gsm.html index e648a385..e316859b 100644 --- a/dev/setitup/gsm.html +++ b/dev/setitup/gsm.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/setitup/ir.html b/dev/setitup/ir.html index fb4aa40a..e6d78303 100644 --- a/dev/setitup/ir.html +++ b/dev/setitup/ir.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/setitup/lora.html b/dev/setitup/lora.html index df45ed09..7b8fda3b 100644 --- a/dev/setitup/lora.html +++ b/dev/setitup/lora.html @@ -19,7 +19,7 @@ - + @@ -109,6 +109,6 @@ Ideally a TTGO board with LoRa module included see - + diff --git a/dev/setitup/rf.html b/dev/setitup/rf.html index 8be3ef91..b4111374 100644 --- a/dev/setitup/rf.html +++ b/dev/setitup/rf.html @@ -19,7 +19,7 @@ - + @@ -110,6 +110,6 @@ The RF processing can be achieved after the modification by either RF, RF2 or Pi →

- + diff --git a/dev/setitup/sensors.html b/dev/setitup/sensors.html index b804e6c7..76dbc0e9 100644 --- a/dev/setitup/sensors.html +++ b/dev/setitup/sensors.html @@ -19,7 +19,7 @@ - + @@ -109,6 +109,6 @@ Ground pins of the board and the Module to the ground of the supply source.

< →

- + diff --git a/dev/setitup/serial.html b/dev/setitup/serial.html index 99c0d2f3..a7f970f5 100644 --- a/dev/setitup/serial.html +++ b/dev/setitup/serial.html @@ -19,7 +19,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/dev/sitemap.xml b/dev/sitemap.xml index ae1c1e76..8a402ab8 100644 --- a/dev/sitemap.xml +++ b/dev/sitemap.xml @@ -1 +1 @@ -https://decoder.theengs.io/devices/devices.htmlhttps://community.openmqttgateway.com/https://shop.theengs.io/https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumptionhttps://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antennahttps://app.theengs.io/https://gateway.theengs.io/https://decoder.theengs.io/https://parser.theengs.io/https://www.theengs.io/https://docs.openmqttgateway.com/dev/integrate/aws_iot.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/home_assistant.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/jeedom.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/node_red.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/adding-protocols.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/openhab2.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/community.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/development.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/openhab3.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/support.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/M5.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/broker.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/board.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/devices.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/controller.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/parts.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/actuators.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/ble.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/gsm.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/ir.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/lora.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/sensors.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/rf.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/serial.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/advanced-configuration.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/binaries.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/builds.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/gitpod.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/portal.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/troubleshoot.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/actuators.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/ble.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/boards.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/web-install.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/displays.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/gateway.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/ir.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/gsm.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/lora.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/rfm69.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/sensors.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/rf.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/serial.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/webui.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/404.htmldailyhttps://decoder.theengs.io/devices/devices.htmlhttps://community.openmqttgateway.com/https://shop.theengs.io/https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumptionhttps://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antennahttps://app.theengs.io/https://gateway.theengs.io/https://decoder.theengs.io/https://parser.theengs.io/https://www.theengs.io/ \ No newline at end of file +https://decoder.theengs.io/devices/devices.htmlhttps://community.openmqttgateway.com/https://shop.theengs.io/https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumptionhttps://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antennahttps://app.theengs.io/https://gateway.theengs.io/https://decoder.theengs.io/https://parser.theengs.io/https://www.theengs.io/https://docs.openmqttgateway.com/dev/integrate/home_assistant.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/aws_iot.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/jeedom.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/node_red.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/openhab3.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/integrate/openhab2.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/community.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/adding-protocols.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/development.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/participate/support.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/board.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/broker.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/controller.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/devices.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/parts.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/actuators.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/gsm.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/prerequisites/M5.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/ble.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/ir.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/rf.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/sensors.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/lora.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/setitup/serial.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/advanced-configuration.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/binaries.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/builds.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/gitpod.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/troubleshoot.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/web-install.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/actuators.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/boards.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/ble.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/upload/portal.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/gateway.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/gsm.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/displays.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/ir.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/lora.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/rfm69.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/sensors.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/serial.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/webui.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/use/rf.html2026-01-10T17:59:41.000Zdailyhttps://docs.openmqttgateway.com/dev/404.htmldailyhttps://decoder.theengs.io/devices/devices.htmlhttps://community.openmqttgateway.com/https://shop.theengs.io/https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumptionhttps://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antennahttps://app.theengs.io/https://gateway.theengs.io/https://decoder.theengs.io/https://parser.theengs.io/https://www.theengs.io/ \ No newline at end of file diff --git a/dev/upload/advanced-configuration.html b/dev/upload/advanced-configuration.html index eb8f8607..7fe20ae0 100644 --- a/dev/upload/advanced-configuration.html +++ b/dev/upload/advanced-configuration.html @@ -19,7 +19,7 @@ - + @@ -130,6 +130,6 @@ So as to activate this function you need to set valueAsATopic to tr →

- + diff --git a/dev/upload/binaries.html b/dev/upload/binaries.html index 6860fe97..4a8e6f98 100644 --- a/dev/upload/binaries.html +++ b/dev/upload/binaries.html @@ -19,7 +19,7 @@ - + @@ -151,6 +151,6 @@ The upload details appears.

With an ESP if you did not set your net →

- + diff --git a/dev/upload/builds.html b/dev/upload/builds.html index 980c5b5c..fa5df53d 100644 --- a/dev/upload/builds.html +++ b/dev/upload/builds.html @@ -19,7 +19,7 @@ - + @@ -237,6 +237,6 @@ Added to that auto discovery box should be selected into your Home Assistant MQT →

- + diff --git a/dev/upload/gitpod.html b/dev/upload/gitpod.html index 56a343d7..ce042be4 100644 --- a/dev/upload/gitpod.html +++ b/dev/upload/gitpod.html @@ -19,7 +19,7 @@ - + @@ -111,6 +111,6 @@ →

- + diff --git a/dev/upload/portal.html b/dev/upload/portal.html index 7ac7b404..e36ea9bb 100644 --- a/dev/upload/portal.html +++ b/dev/upload/portal.html @@ -19,7 +19,7 @@ - + @@ -132,6 +132,6 @@ If the board is connected by ethernet, the Wifi and password can be empty. If yo →

- + diff --git a/dev/upload/troubleshoot.html b/dev/upload/troubleshoot.html index f44d71b6..c8d3cb72 100644 --- a/dev/upload/troubleshoot.html +++ b/dev/upload/troubleshoot.html @@ -19,7 +19,7 @@ - + @@ -124,6 +124,6 @@ If you set the ntp server for the gateway and keep getting the errors you should →

- + diff --git a/dev/upload/web-install.html b/dev/upload/web-install.html index 0ba33e1e..36c7a1a6 100644 --- a/dev/upload/web-install.html +++ b/dev/upload/web-install.html @@ -19,7 +19,7 @@ - + @@ -294,6 +294,6 @@ The correct driver to then select in the popup of this web install is →

- + diff --git a/dev/use/actuators.html b/dev/use/actuators.html index 44219821..56b8b713 100644 --- a/dev/use/actuators.html +++ b/dev/use/actuators.html @@ -19,7 +19,7 @@ - + @@ -145,6 +145,6 @@ The json message must contain two properties: