mirror of
https://github.com/1technophile/OpenMQTTGateway.git
synced 2026-02-20 00:32:04 +01:00
318 lines
73 KiB
HTML
318 lines
73 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Integrate Home Assistant | Theengs OpenMQTTGateway DEVELOPMENT SHA:fd433c TEST ONLY</title>
|
|
<meta name="generator" content="VuePress 1.9.10">
|
|
<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">
|
|
<link rel="mask-icon" href="/dev/icons/safari-pinned-tab.svg" color="#3eaf7c">
|
|
<script type="module" src="https://unpkg.com/esp-web-tools@9.4.3/dist/web/install-button.js?module"></script>
|
|
<meta name="description" content="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.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<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">
|
|
<meta name="msapplication-TileImage" content="/favicon-144x144.png">
|
|
<meta name="msapplication-TileColor" content="#000000">
|
|
|
|
<link rel="preload" href="/dev/assets/css/0.styles.0f5b7756.css" as="style"><link rel="preload" href="/dev/assets/js/app.4019ba7f.js" as="script"><link rel="preload" href="/dev/assets/js/2.f90febc1.js" as="script"><link rel="preload" href="/dev/assets/js/1.848070c7.js" as="script"><link rel="preload" href="/dev/assets/js/16.0eeaf94f.js" as="script"><link rel="prefetch" href="/dev/assets/js/10.da69edf3.js"><link rel="prefetch" href="/dev/assets/js/11.6556d787.js"><link rel="prefetch" href="/dev/assets/js/12.1e6cb39c.js"><link rel="prefetch" href="/dev/assets/js/13.8a594cea.js"><link rel="prefetch" href="/dev/assets/js/14.286ec29b.js"><link rel="prefetch" href="/dev/assets/js/15.91304de5.js"><link rel="prefetch" href="/dev/assets/js/17.3917abd4.js"><link rel="prefetch" href="/dev/assets/js/18.972dca58.js"><link rel="prefetch" href="/dev/assets/js/19.71e6901b.js"><link rel="prefetch" href="/dev/assets/js/20.fbef6fa1.js"><link rel="prefetch" href="/dev/assets/js/21.0e500e6c.js"><link rel="prefetch" href="/dev/assets/js/22.1fa11360.js"><link rel="prefetch" href="/dev/assets/js/23.d5ff69ee.js"><link rel="prefetch" href="/dev/assets/js/24.23aa6c36.js"><link rel="prefetch" href="/dev/assets/js/25.3cdd6711.js"><link rel="prefetch" href="/dev/assets/js/26.6afe7a72.js"><link rel="prefetch" href="/dev/assets/js/27.f4bc0108.js"><link rel="prefetch" href="/dev/assets/js/28.afe597be.js"><link rel="prefetch" href="/dev/assets/js/29.a6f3d105.js"><link rel="prefetch" href="/dev/assets/js/3.2fb8cc22.js"><link rel="prefetch" href="/dev/assets/js/30.a5f4568a.js"><link rel="prefetch" href="/dev/assets/js/31.7ec0b927.js"><link rel="prefetch" href="/dev/assets/js/32.bf6ed2d3.js"><link rel="prefetch" href="/dev/assets/js/33.d1f71bc6.js"><link rel="prefetch" href="/dev/assets/js/34.1144d4cf.js"><link rel="prefetch" href="/dev/assets/js/35.de5ccc4f.js"><link rel="prefetch" href="/dev/assets/js/36.adfdf2f5.js"><link rel="prefetch" href="/dev/assets/js/37.8a3f6ff9.js"><link rel="prefetch" href="/dev/assets/js/38.25b199b2.js"><link rel="prefetch" href="/dev/assets/js/39.3c2b16b3.js"><link rel="prefetch" href="/dev/assets/js/4.ee469e2f.js"><link rel="prefetch" href="/dev/assets/js/40.eb26a150.js"><link rel="prefetch" href="/dev/assets/js/41.c56bed06.js"><link rel="prefetch" href="/dev/assets/js/42.d266f92e.js"><link rel="prefetch" href="/dev/assets/js/43.73d8f4d8.js"><link rel="prefetch" href="/dev/assets/js/44.790d8d70.js"><link rel="prefetch" href="/dev/assets/js/45.421db05c.js"><link rel="prefetch" href="/dev/assets/js/46.a3d8b6f4.js"><link rel="prefetch" href="/dev/assets/js/47.39d975c4.js"><link rel="prefetch" href="/dev/assets/js/48.da7eba11.js"><link rel="prefetch" href="/dev/assets/js/49.c03deaf6.js"><link rel="prefetch" href="/dev/assets/js/5.45a12acb.js"><link rel="prefetch" href="/dev/assets/js/50.1767f2fa.js"><link rel="prefetch" href="/dev/assets/js/51.8c9d8fa9.js"><link rel="prefetch" href="/dev/assets/js/52.33ace286.js"><link rel="prefetch" href="/dev/assets/js/53.52d6801a.js"><link rel="prefetch" href="/dev/assets/js/54.0bae6b28.js"><link rel="prefetch" href="/dev/assets/js/55.6e9ddc55.js"><link rel="prefetch" href="/dev/assets/js/56.1fe4be81.js"><link rel="prefetch" href="/dev/assets/js/57.bbcbc292.js"><link rel="prefetch" href="/dev/assets/js/58.4d098c0a.js"><link rel="prefetch" href="/dev/assets/js/59.31bcc9c8.js"><link rel="prefetch" href="/dev/assets/js/6.88e76e8e.js"><link rel="prefetch" href="/dev/assets/js/60.7e3979c2.js"><link rel="prefetch" href="/dev/assets/js/61.f40d9370.js"><link rel="prefetch" href="/dev/assets/js/62.b4395a3f.js"><link rel="prefetch" href="/dev/assets/js/63.118c24b3.js"><link rel="prefetch" href="/dev/assets/js/64.71e20be8.js"><link rel="prefetch" href="/dev/assets/js/65.bd30a68b.js"><link rel="prefetch" href="/dev/assets/js/66.6b3e6794.js"><link rel="prefetch" href="/dev/assets/js/67.0d566ba2.js"><link rel="prefetch" href="/dev/assets/js/7.747393f7.js"><link rel="prefetch" href="/dev/assets/js/vendors~docsearch.9de5652f.js">
|
|
<link rel="stylesheet" href="/dev/assets/css/0.styles.0f5b7756.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/dev/" class="home-link router-link-active"><!----> <span class="site-name">Theengs OpenMQTTGateway DEVELOPMENT SHA:fd433c TEST ONLY</span></a> <div class="links"><!----> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://www.theengs.io" target="_self" class="nav-link external">
|
|
Home
|
|
<!----></a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Use cases" class="dropdown-title"><span class="title">Use cases</span> <span class="arrow down"></span></button> <button type="button" aria-label="Use cases" class="mobile-dropdown-title"><span class="title">Use cases</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/smarthome.html" target="_self" class="nav-link external">
|
|
Smart Home
|
|
<!----></a></li><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/iot.html" target="_self" class="nav-link external">
|
|
IoT
|
|
<!----></a></li><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/research.html" target="_self" class="nav-link external">
|
|
Research
|
|
<!----></a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Solutions" class="dropdown-title"><span class="title">Solutions</span> <span class="arrow down"></span></button> <button type="button" aria-label="Solutions" class="mobile-dropdown-title"><span class="title">Solutions</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>
|
|
Hardware
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption" target="_self" class="nav-link external">
|
|
Theengs Plug
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna" target="_self" class="nav-link external">
|
|
Theengs Bridge
|
|
<!----></a></li></ul></li><li class="dropdown-item"><h4>
|
|
Software
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://app.theengs.io" target="_self" class="nav-link external">
|
|
Mobile App
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://docs.openmqttgateway.com" target="_self" class="nav-link external">
|
|
OpenMQTTGateway
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://gateway.theengs.io" target="_self" class="nav-link external">
|
|
Gateway
|
|
<!----></a></li></ul></li><li class="dropdown-item"><h4>
|
|
Core
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://decoder.theengs.io" target="_self" class="nav-link external">
|
|
Decoder
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://parser.theengs.io" target="_self" class="nav-link external">
|
|
Web Parser
|
|
<!----></a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://decoder.theengs.io/devices/devices.html" target="_self" class="nav-link external">
|
|
Compatible devices
|
|
<!----></a></div><div class="nav-item"><a href="https://community.openmqttgateway.com" target="_self" class="nav-link external">
|
|
Community
|
|
<!----></a></div><div class="nav-item"><a href="https://shop.theengs.io/" target="_self" class="nav-link external">
|
|
Shop
|
|
<!----></a></div><div class="nav-item"><a href="https://github.com/sponsors/theengs" target="_self" class="nav-link external">
|
|
Sponsor 🤍
|
|
<!----></a></div> <a href="https://github.com/1technophile/OpenMQTTGateway" target="_blank" rel="noopener noreferrer" class="repo-link">
|
|
GitHub
|
|
<span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://www.theengs.io" target="_self" class="nav-link external">
|
|
Home
|
|
<!----></a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Use cases" class="dropdown-title"><span class="title">Use cases</span> <span class="arrow down"></span></button> <button type="button" aria-label="Use cases" class="mobile-dropdown-title"><span class="title">Use cases</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/smarthome.html" target="_self" class="nav-link external">
|
|
Smart Home
|
|
<!----></a></li><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/iot.html" target="_self" class="nav-link external">
|
|
IoT
|
|
<!----></a></li><li class="dropdown-item"><!----> <a href="https://www.theengs.io/usecases/research.html" target="_self" class="nav-link external">
|
|
Research
|
|
<!----></a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Solutions" class="dropdown-title"><span class="title">Solutions</span> <span class="arrow down"></span></button> <button type="button" aria-label="Solutions" class="mobile-dropdown-title"><span class="title">Solutions</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>
|
|
Hardware
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption" target="_self" class="nav-link external">
|
|
Theengs Plug
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna" target="_self" class="nav-link external">
|
|
Theengs Bridge
|
|
<!----></a></li></ul></li><li class="dropdown-item"><h4>
|
|
Software
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://app.theengs.io" target="_self" class="nav-link external">
|
|
Mobile App
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://docs.openmqttgateway.com" target="_self" class="nav-link external">
|
|
OpenMQTTGateway
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://gateway.theengs.io" target="_self" class="nav-link external">
|
|
Gateway
|
|
<!----></a></li></ul></li><li class="dropdown-item"><h4>
|
|
Core
|
|
</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="https://decoder.theengs.io" target="_self" class="nav-link external">
|
|
Decoder
|
|
<!----></a></li><li class="dropdown-subitem"><a href="https://parser.theengs.io" target="_self" class="nav-link external">
|
|
Web Parser
|
|
<!----></a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://decoder.theengs.io/devices/devices.html" target="_self" class="nav-link external">
|
|
Compatible devices
|
|
<!----></a></div><div class="nav-item"><a href="https://community.openmqttgateway.com" target="_self" class="nav-link external">
|
|
Community
|
|
<!----></a></div><div class="nav-item"><a href="https://shop.theengs.io/" target="_self" class="nav-link external">
|
|
Shop
|
|
<!----></a></div><div class="nav-item"><a href="https://github.com/sponsors/theengs" target="_self" class="nav-link external">
|
|
Sponsor 🤍
|
|
<!----></a></div> <a href="https://github.com/1technophile/OpenMQTTGateway" target="_blank" rel="noopener noreferrer" class="repo-link">
|
|
GitHub
|
|
<span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <ul class="sidebar-links"><li><a href="/dev/" aria-current="page" class="sidebar-link">0 - What is it for 🏠</a></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>1 - Prerequisites🧭</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>2 - Set it up 🔨</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>3 - Upload ➡️</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>4 - Use ✈️</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading open"><span>5 - Integrate 🎉</span> <span class="arrow down"></span></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/dev/integrate/openhab2.html" class="sidebar-link">Integrate OPENHAB2</a></li><li><a href="/dev/integrate/openhab3.html" class="sidebar-link">Integrate OPENHAB 3/4</a></li><li><a href="/dev/integrate/home_assistant.html" aria-current="page" class="active sidebar-link">Integrate Home Assistant</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/dev/integrate/home_assistant.html#automatic-integration-with-auto-discovery" class="sidebar-link">Automatic integration with Auto discovery</a></li><li class="sidebar-sub-header"><a href="/dev/integrate/home_assistant.html#manual-integration" class="sidebar-link">Manual integration</a></li></ul></li><li><a href="/dev/integrate/node_red.html" class="sidebar-link">Integrate Node-Red</a></li><li><a href="/dev/integrate/aws_iot.html" class="sidebar-link">Integrate AWS IOT</a></li><li><a href="/dev/integrate/jeedom.html" class="sidebar-link">Integrate Jeedom</a></li></ul></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>6 - Participate 💻</span> <span class="arrow right"></span></p> <!----></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="integrate-home-assistant"><a href="#integrate-home-assistant" class="header-anchor">#</a> Integrate Home Assistant</h1> <p>Home Assistant provide the <a href="https://www.home-assistant.io/integrations/mqtt/" target="_blank" rel="noopener noreferrer">MQTT integration<span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> and through this integration it is possible to exploit and manage the messages published by OpenMQTTGateway.</p> <p>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.</p> <h2 id="automatic-integration-with-auto-discovery"><a href="#automatic-integration-with-auto-discovery" class="header-anchor">#</a> Automatic integration with Auto discovery</h2> <p>From Home Assistant site</p> <blockquote><p>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.</p></blockquote> <p>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.</p> <p>Enable discovery on your MQTT integration in HASS (activated per default).</p> <p><img src="/dev/assets/img/OpenMQTTGateway-Configuration-Home-Assistant-Discovery-Integration.15338e07.png" alt="Home Assistant Auto Discovery"></p> <p>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.</p> <p><img src="/dev/assets/img/OpenMQTTGateway-Configuration-Home-Assistant.531a7826.png" alt="Home Assistant Auto Discovery"></p> <div class="custom-block warning"><p class="custom-block-title">Note</p> <p>The max size of the username and password is 64 characters.</p></div> <p>OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automatically.</p> <p><img src="/dev/assets/img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.79982abd.gif" alt="Home Assistant Auto Discovery"></p> <p><img src="/dev/assets/img/OpenMQTTGateway_auto_discovery_BLE_Sensor_Home_Assistant.ad3bc9c2.gif" alt="Home Assistant Auto Discovery"></p> <p><img src="/dev/assets/img/OpenMQTTGateway_Home_Assistant_MQTT_discovery.8980f020.png" alt="Home Assistant Auto Discovery"></p> <div class="custom-block tip"><p class="custom-block-title">INFO</p> <p>The Bluetooth and the RTL_433 gateway will automatically create devices and entities, the RF gateway will create DeviceTrigger.
|
|
The 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.</p> <p>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/<gatewayname>/commands/MQTTtoSYS/config topic.
|
|
30 minutes after its activation the auto discovery will be automatically deactivated, you can reactivate it from the gateway controls.
|
|
Some devices may require a button push or motion/contact event to trigger a message and generate the auto discovery.</gatewayname></p></div> <h3 id="rtl-433-auto-discovery-specificity"><a href="#rtl-433-auto-discovery-specificity" class="header-anchor">#</a> RTL_433 auto discovery specificity</h3> <p>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.
|
|
Example:</p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"+/+/RTL_433toMQTT/WS2032/+"</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>instead of</p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"+/+/RTL_433toMQTT/WS2032/47998"</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>Note also that the sensor may leverage channels, types or subtypes, they can be used in the filtering
|
|
Example:
|
|
In the example below 9 is the <code>subtype</code> and 1 is the <code>channel</code></p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"+/+/RTL_433toMQTT/Prologue-TH/9/1/+"</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>instead of</p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"+/+/RTL_433toMQTT/Prologue-TH/9/1/215"</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>Alternatively the rssi signal could be used also.</p> <h3 id="rf-rcswitch-based-gateway-auto-discovery-specificity"><a href="#rf-rcswitch-based-gateway-auto-discovery-specificity" class="header-anchor">#</a> RF (RCSwitch based gateway) Auto discovery specificity</h3> <p>With OpenMQTTGateway <a href="/dev/setitup/rf.html">configured to receive RF signals</a> messages are transmitted accordingly.</p> <p>As indicated in the <a href="/dev/use/rf.html#rcswitch-based-gateway">RCSwitch based gateway</a>, 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:</p> <ol><li>An <a href="https://www.home-assistant.io/integrations/device_trigger.mqtt/" target="_blank" rel="noopener noreferrer">MQTT Device Trigger<span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> which allows actions to be triggered when a specific RF signal is received.</li> <li>An <a href="https://www.home-assistant.io/integrations/sensor.mqtt/" target="_blank" rel="noopener noreferrer">MQTT Sensor<span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>
|
|
which stores the received RF data as a sensor value.</li></ol> <p>Below are some examples of both configurations.</p> <h4 id="example-a-rf-as-mqtt-device-trigger"><a href="#example-a-rf-as-mqtt-device-trigger" class="header-anchor">#</a> Example A - RF as MQTT Device Trigger</h4> <p>If the following parameters are enabled in OpenMQTTGateway:</p> <ul><li>ZgatewayRF="RF"</li> <li>valueAsATopic=true</li> <li>HADiscovery=true</li> <li>RF_on_HAS_as_DeviceTrigger=true</li> <li>RF_on_HAS_as_MQTTSensor=false</li></ul> <p>Then, each time an RF signal is received by OpenMQTTGateway, two messages are sent to the MQTT broker:</p> <ol><li>A device trigger announcement (used by Home Assistant to recognize the trigger).</li> <li>The RF signal data on the corresponding MQTT topic.</li></ol> <div class="language- line-numbers-mode"><pre class="language-text"><code>...
|
|
N: [ 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"}
|
|
T: Dequeue JSON
|
|
N: [ 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"}
|
|
...
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><p>These messages allow Home Assistant to recognize and integrate the RF signal as a device trigger.
|
|
<img src="/dev/assets/img/HASS-RF-DeviceTrigger.8d14f498.png" alt="MQTTExplorer Show Topic"> <em>Example of a detected RF device trigger in Home Assistant: Green shows the real message, Yellow shows the device trigger configuration</em></p> <p>Once this process is completed, Home Assistant detects a new trigger associated with the OpenMQTTGateway device and linked to the received RF signal value.
|
|
This means that Home Assistant can now react to the received RF signal as an automation trigger.</p> <p>Example of a detected RF trigger in Home Assistant:</p> <p><img src="/dev/assets/img/HASS-RF-Trigger-example.6dd53087.png" alt="MQTTExplorer Show Topic"> <em>Example of a detected RF trigger in Home Assistant</em></p> <h4 id="example-b-rf-as-mqtt-sensor"><a href="#example-b-rf-as-mqtt-sensor" class="header-anchor">#</a> Example B - RF As MQTT Sensor</h4> <p>If the following parameters are enabled in OpenMQTTGateway:</p> <ul><li>ZgatewayRF="RF"</li> <li>HADiscovery=true</li> <li>RF_on_HAS_as_DeviceTrigger=false</li> <li>RF_on_HAS_as_MQTTSensor=true</li></ul> <p>During any discovery round, a SYS message is sent, setting the MQTT Sensor as a sensor of the OpenMQTTGateway device.</p> <div class="language- line-numbers-mode"><pre class="language-text"><code>...
|
|
N: [ 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"}}
|
|
T: Dequeue JSON
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>Then, each time an RF signal is received by OpenMQTTGateway, the content of messages are sent to the MQTT broker on classic topic:</p> <div class="language- line-numbers-mode"><pre class="language-text"><code>T: Dequeue JSON
|
|
N: [ 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"}
|
|
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br></div></div><p>These messages enable Home Assistant to recognize and integrate the RF signal as a sensor.</p> <p><img src="/dev/assets/img/HASS-RF-MQTTSensor.62ca0325.png" alt="MQTTExplorer Show Topic"> <em>Example of a detected RF sensor in Home Assistant: Yellow the configuration of sensor, Green the real message</em></p> <p>Once this process is completed, Home Assistant detects a device with the new sensor and linked to the received RF signal value.
|
|
This means that Home Assistant can now react to the received RF signal as an sensor event.</p> <p>Example of a detected RF trigger in Home Assistant:</p> <p><img src="/dev/assets/img/HASS-RF-Sensor-example.2909340e.png" alt="MQTTExplorer Show Topic"> <em>Example of a detected RF sensor in Home Assistant: Yellow the real message</em></p> <h2 id="manual-integration"><a href="#manual-integration" class="header-anchor">#</a> Manual integration</h2> <p>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.</p> <p>From @123, @finity, @denniz03, @jrockstad, @anarchking, @dkluivingh, @Odyno</p> <h3 id="pir-sensor"><a href="#pir-sensor" class="header-anchor">#</a> Pir Sensor</h3> <p>This is an example of how to configure a PIR (Passive Infrared) sensor in Home Assistant using MQTT.</p> <p><img src="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" alt="Pir Sensor"></p> <p>The configuration below sets up a binary sensor that detects motion and sends the state to Home Assistant.</p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">binary_sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">unique_id</span><span class="token punctuation">:</span> pir.15484294
|
|
<span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"Pir.Mansarda"</span>
|
|
<span class="token key atrule">device_class</span><span class="token punctuation">:</span> motion
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/+/433toMQTT/15484294"</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">"{{ value_json.value }}"</span>
|
|
<span class="token key atrule">payload_on</span><span class="token punctuation">:</span> <span class="token string">"15484294"</span>
|
|
<span class="token key atrule">off_delay</span><span class="token punctuation">:</span> <span class="token number">3</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br></div></div><h3 id="door-sensor"><a href="#door-sensor" class="header-anchor">#</a> Door sensor</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">binary_sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"test"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/433toMQTT"</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token punctuation">-</span>
|
|
<span class="token punctuation">{</span>% if value_json.value == '7821834' %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token string">'ON'</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% elif value_json.value == '7821838' %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token string">'OFF'</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% else %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span>states('binary_sensor.test') <span class="token punctuation">|</span> upper<span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% endif %<span class="token punctuation">}</span>
|
|
<span class="token key atrule">qos</span><span class="token punctuation">:</span> <span class="token number">0</span>
|
|
<span class="token key atrule">device_class</span><span class="token punctuation">:</span> opening
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br></div></div><div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">binary_sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> doorbell
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/SRFBtoMQTT'</span>
|
|
<span class="token comment">#value_template: "{{ value_json.raw }}"</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token punctuation">-</span>
|
|
<span class="token punctuation">{</span>% if value_json.value == '14163857' %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token string">'ON'</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% else %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span>states('binary_sensor.doorbell') <span class="token punctuation">|</span> upper<span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% endif %<span class="token punctuation">}</span>
|
|
<span class="token key atrule">off_delay</span><span class="token punctuation">:</span> <span class="token number">30</span>
|
|
<span class="token key atrule">device_class</span><span class="token punctuation">:</span> <span class="token string">'sound'</span>
|
|
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> light_back_sensor
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/SRFBtoMQTT'</span>
|
|
<span class="token comment">#value_template: '{{ value_jason.value }}'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token punctuation">-</span>
|
|
<span class="token punctuation">{</span>% if value_json.value == '1213858' %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token string">'ON'</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% else %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span>states('binary_sensor.light_back_sensor') <span class="token punctuation">|</span> upper<span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% endif %<span class="token punctuation">}</span>
|
|
<span class="token key atrule">off_delay</span><span class="token punctuation">:</span> <span class="token number">5</span>
|
|
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> rf_outlet_sensor
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/SRFBtoMQTT'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token punctuation">-</span>
|
|
<span class="token punctuation">{</span>% if value_json.value == '16766303' %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token string">'ON'</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% else %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span>states('binary_sensor.rf_outlet_sensor') <span class="token punctuation">|</span> upper<span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span>% endif %<span class="token punctuation">}</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br><span class="line-number">21</span><br><span class="line-number">22</span><br><span class="line-number">23</span><br><span class="line-number">24</span><br><span class="line-number">25</span><br><span class="line-number">26</span><br><span class="line-number">27</span><br><span class="line-number">28</span><br><span class="line-number">29</span><br><span class="line-number">30</span><br><span class="line-number">31</span><br><span class="line-number">32</span><br><span class="line-number">33</span><br></div></div><h3 id="motion-sensor"><a href="#motion-sensor" class="header-anchor">#</a> Motion sensor</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">binary_sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"Bewegung_Schlafzimmer"</span>
|
|
<span class="token comment">#device_class: motion</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway1/HCSR501toMQTT"</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json["presence"] }}'</span>
|
|
<span class="token key atrule">payload_on</span><span class="token punctuation">:</span> <span class="token string">"true"</span>
|
|
<span class="token key atrule">payload_off</span><span class="token punctuation">:</span> <span class="token string">"false"</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br></div></div><h3 id="switches"><a href="#switches" class="header-anchor">#</a> Switches</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token comment">#switches</span>
|
|
<span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">switch</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> Plug1
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/SRFBtoMQTT"</span>
|
|
<span class="token key atrule">command_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/commands/MQTTtoSRFB"</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">"{{ value_json.value }}"</span>
|
|
<span class="token key atrule">payload_on</span><span class="token punctuation">:</span> <span class="token string">'{"value":4546575}'</span>
|
|
<span class="token key atrule">payload_off</span><span class="token punctuation">:</span> <span class="token string">'{"value":4546572}'</span>
|
|
<span class="token key atrule">state_on</span><span class="token punctuation">:</span> <span class="token number">4546575</span>
|
|
<span class="token key atrule">state_off</span><span class="token punctuation">:</span> <span class="token number">4546572</span>
|
|
<span class="token key atrule">qos</span><span class="token punctuation">:</span> <span class="token string">"0"</span>
|
|
<span class="token key atrule">retain</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br></div></div><h3 id="rf-gateway-mode-pilight-rf-kaku"><a href="#rf-gateway-mode-pilight-rf-kaku" class="header-anchor">#</a> RF gateway mode - Pilight, RF, kaku</h3> <p>insert an include statement in HA configuration.yaml</p> <div class="language-bash line-numbers-mode"><pre class="language-bash"><code><span class="token function">grep</span> homed ./configuration.yaml
|
|
mqtt: <span class="token operator">!</span>include homed-mqtt.yaml
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br></div></div><p>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,</p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">select</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">'RF: Mode receive'</span>
|
|
<span class="token key atrule">unique_id</span><span class="token punctuation">:</span> espdevcho<span class="token punctuation">-</span>rf<span class="token punctuation">-</span>mode
|
|
<span class="token comment">#platform: mqtt</span>
|
|
<span class="token key atrule">availability_topic</span><span class="token punctuation">:</span> home/espdevcho/LWT <span class="token comment"># espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway</span>
|
|
<span class="token key atrule">payload_available</span><span class="token punctuation">:</span> online
|
|
<span class="token key atrule">payload_not_available</span><span class="token punctuation">:</span> offline
|
|
<span class="token key atrule">options</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token string">"Pilight"</span>
|
|
<span class="token punctuation">-</span> <span class="token string">"RF classic"</span>
|
|
<span class="token punctuation">-</span> <span class="token string">"RF2 kaku"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> home/espdevcho/RFtoMQTT <span class="token comment"># espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token scalar string">
|
|
{% if value_json.active == 1 %} Pilight
|
|
{% elif value_json.active == 2 %} RF classic
|
|
{% elif value_json.active == 4 %} RF2 kaku
|
|
{% endif %}</span>
|
|
<span class="token comment">#unit_of_measurement: s</span>
|
|
<span class="token key atrule">command_topic</span><span class="token punctuation">:</span> home/espdevcho/commands/MQTTtoRF/config <span class="token comment"># espdevcho is a particular name of the gateway, instead of the default OpenMQTTGateway</span>
|
|
<span class="token key atrule">command_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token scalar string">
|
|
{% set value_map = {
|
|
"Pilight": 1,
|
|
"RF classic": 2,
|
|
"RF2 kaku": 4,
|
|
}
|
|
%}
|
|
{"active":{{ value_map[value] }}}</span>
|
|
<span class="token key atrule">device</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">configuration_url</span><span class="token punctuation">:</span> http<span class="token punctuation">:</span>//192.168.1.11/ <span class="token comment"># device section is optional. It is almost ommited in this example. Values here will update the corresponding device, if it already exist</span>
|
|
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br><span class="line-number">21</span><br><span class="line-number">22</span><br><span class="line-number">23</span><br><span class="line-number">24</span><br><span class="line-number">25</span><br><span class="line-number">26</span><br><span class="line-number">27</span><br><span class="line-number">28</span><br><span class="line-number">29</span><br><span class="line-number">30</span><br></div></div><h3 id="mijia-thermometer-ble"><a href="#mijia-thermometer-ble" class="header-anchor">#</a> Mijia Thermometer BLE</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"mijia_thermometer_temperature"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'</span> <span class="token comment"># MQTT topic, check MQTT messages; replace AA... with id (BLE MAC) of your device</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">'°C'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json.tem | is_defined }}'</span>
|
|
<span class="token key atrule">expire_after</span><span class="token punctuation">:</span> <span class="token number">21600</span> <span class="token comment"># 6 hours</span>
|
|
<span class="token key atrule">force_update</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"mijia_thermometer_humidity"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">'%'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json.hum | is_defined }}'</span>
|
|
<span class="token key atrule">expire_after</span><span class="token punctuation">:</span> <span class="token number">21600</span> <span class="token comment"># 6 hours</span>
|
|
<span class="token key atrule">force_update</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"mijia_thermometer_battery"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">'home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA'</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">'%'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json.batt | is_defined }}'</span>
|
|
<span class="token key atrule">expire_after</span><span class="token punctuation">:</span> <span class="token number">21600</span> <span class="token comment"># 6 hours</span>
|
|
<span class="token key atrule">force_update</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br></div></div><h3 id="xiaomi-mi-scale-v2-ble-xmtzc05hm"><a href="#xiaomi-mi-scale-v2-ble-xmtzc05hm" class="header-anchor">#</a> Xiaomi Mi Scale V2 BLE (XMTZC05HM)</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"Weight"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"</span> <span class="token comment"># replace your MQTT topic here</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json["weight"] }}'</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">"kg"</span>
|
|
<span class="token key atrule">icon</span><span class="token punctuation">:</span> mdi<span class="token punctuation">:</span>weight<span class="token punctuation">-</span>kilogram
|
|
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">"Impedance"</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/BTtoMQTT/AAAAAAAAAAAA"</span> <span class="token comment"># replace your MQTT topic here also</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token string">'{{ value_json["impedance"] }}'</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">"Ohm"</span>
|
|
<span class="token key atrule">icon</span><span class="token punctuation">:</span> mdi<span class="token punctuation">:</span>omega
|
|
|
|
<span class="token key atrule">template</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token key atrule">body_mass_index</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">friendly_name</span><span class="token punctuation">:</span> <span class="token string">'Body Mass Index'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token punctuation">-</span>
|
|
<span class="token punctuation">{</span>% set HEIGHT = (1.76)<span class="token punctuation">|</span>float %<span class="token punctuation">}</span> <span class="token comment"># replace your height in meters</span>
|
|
<span class="token punctuation">{</span>% set WEIGHT = states('sensor.xmtzc05hm_weight')<span class="token punctuation">|</span>float %<span class="token punctuation">}</span>
|
|
<span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token punctuation">-</span> (WEIGHT/(HEIGHT<span class="token important">*HEIGHT))|float|round(1)</span> <span class="token punctuation">-</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
|
|
<span class="token key atrule">icon_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token scalar string">
|
|
{{ 'mdi:human' }}</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br><span class="line-number">21</span><br><span class="line-number">22</span><br><span class="line-number">23</span><br><span class="line-number">24</span><br></div></div><h3 id="mqtt-room-presence"><a href="#mqtt-room-presence" class="header-anchor">#</a> MQTT Room Presence</h3> <p>For the publication into the presence topic the following needs to be activated - <a href="/dev/use/ble.html#setting-if-the-gateway-publish-into-home-assistant-home-presence-topic-default-false-available-with-ha-discovery">here is the command</a></p> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">platform</span><span class="token punctuation">:</span> mqtt_room
|
|
<span class="token key atrule">device_id</span><span class="token punctuation">:</span> XX<span class="token punctuation">:</span>XX<span class="token punctuation">:</span>XX<span class="token punctuation">:</span>XX<span class="token punctuation">:</span>XX<span class="token punctuation">:</span>XX <span class="token comment">#Mac Address of device wanting to track</span>
|
|
<span class="token key atrule">name</span><span class="token punctuation">:</span> you_are_in <span class="token comment"># home assistant will show a sensor named (you are in) with its value being the name you gave the gateway</span>
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/presence"</span>
|
|
<span class="token comment">#timeout:</span>
|
|
<span class="token comment">#away_timeout:</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br></div></div><h3 id="temperature-sensor"><a href="#temperature-sensor" class="header-anchor">#</a> Temperature sensor</h3> <div class="language-yaml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">mqtt</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">sensor</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> outdoor temp
|
|
<span class="token key atrule">state_topic</span><span class="token punctuation">:</span> <span class="token string">"home/OpenMQTTGateway/433toMQTT"</span>
|
|
<span class="token key atrule">unit_of_measurement</span><span class="token punctuation">:</span> <span class="token string">'°C'</span>
|
|
<span class="token key atrule">value_template</span><span class="token punctuation">:</span> <span class="token punctuation">></span><span class="token scalar string">
|
|
{% if value_json is defined and value_json.sensor == 125 %}
|
|
{{ value_json.tempc }}
|
|
{% else %}
|
|
{{ states('sensor.outdoor_temp') }}
|
|
{% endif %}</span>
|
|
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br></div></div></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/1technophile/OpenMQTTGateway/edit/development/docs/integrate/home_assistant.md" target="_blank" rel="noopener noreferrer">Edit this page</a> <span><svg 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" class="icon outbound"><path 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"></path> <polygon 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"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">1/24/2026, 11:16:03 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
|
|
←
|
|
<a href="/dev/integrate/openhab3.html" class="prev">
|
|
Integrate OPENHAB 3/4
|
|
</a></span> <span class="next"><a href="/dev/integrate/node_red.html">
|
|
Integrate Node-Red
|
|
</a>
|
|
→
|
|
</span></p></div> </main></div><div class="global-ui"></div></div>
|
|
<script src="/dev/assets/js/app.4019ba7f.js" defer></script><script src="/dev/assets/js/2.f90febc1.js" defer></script><script src="/dev/assets/js/1.848070c7.js" defer></script><script src="/dev/assets/js/16.0eeaf94f.js" defer></script>
|
|
</body>
|
|
</html>
|