MQTT - Revision history

Walter vl: /* MQTT Autodiscovery way of working explained */

2026-01-06T22:26:53Z

MQTT Autodiscovery way of working explained

← Older revision		Revision as of 22:26, 6 January 2026
Line 226:		Line 226:
	The application (like Zigbee2MQTT or Zwave-JS-UI) should be configured to send discovery topics (config) additional to the normally already available state and optional command topics.		The application (like Zigbee2MQTT or Zwave-JS-UI) should be configured to send discovery topics (config) additional to the normally already available state and optional command topics.

	* The config topic describes the type of device (sensor, switch etc) with additional ~~paramaets~~ like where to find the state topic.		* The config topic describes the type of device (sensor, switch, light, blind etc) with additional parameters like where to find the state topic.
	* The state topic describes the state (eg temperature value or on/off) of the device		* The state topic describes the state (eg temperature value or on/off) of the device
	* Optional there is also a command (set) topic to send commands like on/off to devices.		* Optional there is also a command (set) topic to send commands like on/off to devices.

Walter vl: /* MQTT Autodiscovery way of working */

2026-01-06T22:25:39Z

MQTT Autodiscovery way of working

← Older revision		Revision as of 22:25, 6 January 2026
Line 210:		Line 210:

	Zwave JS UI (former Zwavejs2mqtt), Zigbee2mqtt, ESPHome, ecowitt2mqtt, EsPurna, IOTLink, MiFlora MQTT Daemon, OpenMQTTGateway, Teleinfo MQTT, Wyzesense2MQTT, Arduino HAMqttDevice, [[EMS-bus-Gateway]] etc		Zwave JS UI (former Zwavejs2mqtt), Zigbee2mqtt, ESPHome, ecowitt2mqtt, EsPurna, IOTLink, MiFlora MQTT Daemon, OpenMQTTGateway, Teleinfo MQTT, Wyzesense2MQTT, Arduino HAMqttDevice, [[EMS-bus-Gateway]] etc

	~~If you are a developer who wants to use this MQTT payload definition go to https://www.home-assistant.io/docs/mqtt/discovery/~~

	===MQTT Autodiscovery Setup===		===MQTT Autodiscovery Setup===
Line 223:		Line 221:
	[[File:MQTT-AD-Setup.png]]		[[File:MQTT-AD-Setup.png]]

	=== MQTT Autodiscovery way of working ===		=== MQTT Autodiscovery way of working explained ===
	Autodiscovery allows domoticz to receive device definition and configuration information which is used to automatically create corresponding devices in domoticz and send/receive messages for these devices to the controlling system.		Autodiscovery allows domoticz to receive device definition and configuration information which is used to automatically create corresponding devices in domoticz and send/receive messages for these devices to the controlling system.

Line 230:		Line 228:
	* The config topic describes the type of device (sensor, switch etc) with additional paramaets like where to find the state topic.		* The config topic describes the type of device (sensor, switch etc) with additional paramaets like where to find the state topic.
	* The state topic describes the state (eg temperature value or on/off) of the device		* The state topic describes the state (eg temperature value or on/off) of the device
	* Optional there is also a command topic to send commands like on/off to devices.		* Optional there is also a command (set) topic to send commands like on/off to devices.

	The device announces its configuration to MQTT in the '''auto discovery topic''' when configured in the host software, this is default set to '''homeassistant'''		The device announces its configuration to MQTT in the '''auto discovery topic''' when configured in the host software, this is default set to '''homeassistant'''
Line 238:		Line 236:
	It is important not to combine state topics with the config topic as that triggers a scan for new devices on every state update. With a lot of devices this is a big load on Domoticz.		It is important not to combine state topics with the config topic as that triggers a scan for new devices on every state update. With a lot of devices this is a big load on Domoticz.

			If you are a developer who wants to use this MQTT payload definition go to https://www.home-assistant.io/docs/mqtt/discovery/ for more background information.

	Below an example from MQTT Explorer where Zigbee2MQTT and Zwav-JS-UI are publishing MQTT config topics in folder homeassistant and the state topics in respectively zigbee2mqtt and zwave.		Below an example from MQTT Explorer where Zigbee2MQTT and Zwav-JS-UI are publishing MQTT config topics in folder homeassistant and the state topics in respectively zigbee2mqtt and zwave.

Walter vl: /* MQTT Autodiscovery way of working */

2026-01-06T22:19:55Z

MQTT Autodiscovery way of working

← Older revision		Revision as of 22:19, 6 January 2026
Line 226:		Line 226:
	Autodiscovery allows domoticz to receive device definition and configuration information which is used to automatically create corresponding devices in domoticz and send/receive messages for these devices to the controlling system.		Autodiscovery allows domoticz to receive device definition and configuration information which is used to automatically create corresponding devices in domoticz and send/receive messages for these devices to the controlling system.

	The application (like Zigbee2MQTT or Zwave-JS-UI) should be configured to send discovery topics (config).		The application (like Zigbee2MQTT or Zwave-JS-UI) should be configured to send discovery topics (config) additional to the normally already available state and optional command topics.

	~~Each device has a Configuration object (config)~~ and ~~a status object (state)~~.

	* The config topic describes the type of device (sensor, switch etc) with additional paramaets like where to find the state topic.		* The config topic describes the type of device (sensor, switch etc) with additional paramaets like where to find the state topic.
Line 239:		Line 237:

	It is important not to combine state topics with the config topic as that triggers a scan for new devices on every state update. With a lot of devices this is a big load on Domoticz.		It is important not to combine state topics with the config topic as that triggers a scan for new devices on every state update. With a lot of devices this is a big load on Domoticz.

Walter vl: /* MQTT Autodiscovery Setup */

2026-01-06T22:17:08Z

MQTT Autodiscovery Setup

← Older revision		Revision as of 22:17, 6 January 2026
Line 223:		Line 223:
	[[File:MQTT-AD-Setup.png]]		[[File:MQTT-AD-Setup.png]]

			=== MQTT Autodiscovery way of working ===
			Autodiscovery allows domoticz to receive device definition and configuration information which is used to automatically create corresponding devices in domoticz and send/receive messages for these devices to the controlling system.

			The application (like Zigbee2MQTT or Zwave-JS-UI) should be configured to send discovery topics (config).

			Each device has a Configuration object (config) and a status object (state).

			* The config topic describes the type of device (sensor, switch etc) with additional paramaets like where to find the state topic.
			* The state topic describes the state (eg temperature value or on/off) of the device
			* Optional there is also a command topic to send commands like on/off to devices.

			The device announces its configuration to MQTT in the '''auto discovery topic''' when configured in the host software, this is default set to '''homeassistant'''

			Domoticz will scan the config topic for new announce devices and when in the state topic with state value is published in MQTT it will create the device in Domoticz.

			It is important not to combine state topics with the config topic as that triggers a scan for new devices on every state update. With a lot of devices this is a big load on Domoticz.


			Below an example from MQTT Explorer where Zigbee2MQTT and Zwav-JS-UI are publishing MQTT config topics in folder homeassistant and the state topics in respectively zigbee2mqtt and zwave.

			[[File:MQTTADTopics.png]]

	==Domoticz MQTT communication==		==Domoticz MQTT communication==

Gizmocuz: /* Filter devices to send to Topic Out */

2025-08-04T07:20:51Z

Filter devices to send to Topic Out

← Older revision		Revision as of 07:20, 4 August 2025
Line 157:		Line 157:

	To filter the devices go to menu Setup - Hardware and click on the Setup button of the MQTT Client gateway. A new dialog page will be shown were you can select the devices.		To filter the devices go to menu Setup - Hardware and click on the Setup button of the MQTT Client gateway. A new dialog page will be shown were you can select the devices.
	<br />
			'''Also note that devices that are not 'used' (added to the system from the devices overview), are not published !'''<br />

	==Add hardware "MQTT Auto Discovery Client Gateway"==		==Add hardware "MQTT Auto Discovery Client Gateway"==

Walter vl: /* NodeJS */

2025-06-24T09:07:37Z

NodeJS

← Older revision		Revision as of 09:07, 24 June 2025
Line 425:		Line 425:

	==NodeJS==		==NodeJS==
			NodeJS Module for communication with Domoticz via MQTT Interface

	<code>sudo npm install node-domoticz-mqtt</code>		<code>sudo npm install node-domoticz-mqtt</code>

	See: https://www.domoticz.com/forum/viewtopic.php?f=21&t=10190		See: [https://forum.domoticz.com/viewtopic.php?f=21&t=10190 https://www.domoticz.com/forum/viewtopic.php?f=21&t=10190]

	==Python==		==Python==

Walter vl at 08:59, 24 June 2025

2025-06-24T08:59:50Z

@@ Line 17: / Line 17: @@
 If the hardware MQTT is not supporting the [[MQTT#Domoticz MQTT protocol|Domoticz MQTT protocol]] or [[MQTT#Add hardware .22MQTT Auto Discovery Client Gateway.22|Home Assistant Autodiscover protocol]] then you have to write your own transformation.
-This can be done with [[Plugins|Python Plugins]] like [[MQTT#MQTTMapper plugin|MQTTMapper]], scripting with [[DzVents: next generation Lua scripting|DzVents]] (with OpenURL to mosquitto_pub) or Node-Red
+This can be done with [[Plugins|Python Plugins]] like [[MQTT#MQTTMapper plugin|MQTTMapper]], scripting with [[DzVents: next generation Lua scripting|DzVents]] (with OpenURL to mosquitto_pub) or [[Node Red and Flows|Node Red]]
 ==Installing software==
@@ Line 100: / Line 88: @@
 [[MQTT Push|Add MQTT Push]] When you only want to push Domoticz data to MQTT
 ==Add hardware "MQTT Client Gateway"==
@@ Line 447: / Line 415: @@
 ==More information & useful links==
 *[http://www.domoticz.com/forum/viewtopic.php?f=5&t=838 MQTT Forum Topic] (note: the topic also includes discussions/solutions when Domoticz did not yet have a native MQTT interface so ignore those)
 *[https://play.google.com/store/apps/details?id=at.tripwire.mqtt.client MyMQTT for Android] usefull for reading the MQTT messages during testing.

Walter vl: /* Architecture */

2025-06-24T08:39:42Z

Architecture

← Older revision		Revision as of 08:39, 24 June 2025
Line 8:		Line 8:

	Domoticz supports a number of hardware devices natively (rfxtrx433, zwave, smartmeter etc.). There are zillions of other devices out there, with a lot of interfaces. Using it's native MQTT interface Domoticz can publish events from inside to the outside world. Domoticz can also respond to actions requested by anyone (and passed on by the MQTT-broker). Now something has to take care of creating and interpreting these messages.		Domoticz supports a number of hardware devices natively (rfxtrx433, zwave, smartmeter etc.). There are zillions of other devices out there, with a lot of interfaces. Using it's native MQTT interface Domoticz can publish events from inside to the outside world. Domoticz can also respond to actions requested by anyone (and passed on by the MQTT-broker). Now something has to take care of creating and interpreting these messages.

	The Node-RED tool provides an alternative way to creating little programs (flows) to interface with anything you want. But maybe your application can create MQTT-messages on it's own that can be understood by Domoticz. Or maybe you like to create programs in Node.js itself. So using Node-RED is not mandatory, it does however provide a fun and attractive way to handle messages.

	*Node-RED [http://nodered.org] is a tool running in the Node.js platform providing a browser-based flow editor that makes it easy to wire together "flows". Flows can be then deployed to the runtime in a single-click.
	*Node.js [http://nodejs.org/] is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications.

	====You'll need====		====You'll need====
Line 20:		Line 15:
	*Add hardware gateway to Domoticz: "Create a MQTT Client Gateway with LAN interface" or "MQTT Auto Discovery Client Gateway" (on localhost)		*Add hardware gateway to Domoticz: "Create a MQTT Client Gateway with LAN interface" or "MQTT Auto Discovery Client Gateway" (on localhost)

	If the hardware MQTT is not supporting [[MQTT#Domoticz MQTT protocol\|Domoticz MQTT protocol]] or [[MQTT#Add hardware .22MQTT Auto Discovery Client Gateway.22\|Home Assistant Autodiscover protocol]] then you have to write your own transformation.		If the hardware MQTT is not supporting the [[MQTT#Domoticz MQTT protocol\|Domoticz MQTT protocol]] or [[MQTT#Add hardware .22MQTT Auto Discovery Client Gateway.22\|Home Assistant Autodiscover protocol]] then you have to write your own transformation.

	This can be done with [[Plugins\|Python Plugins]] like [[MQTT#MQTTMapper plugin\|MQTTMapper]], scripting with [[DzVents: next generation Lua scripting\|DzVents]] (with OpenURL to mosquitto_pub) or Node-Red		This can be done with [[Plugins\|Python Plugins]] like [[MQTT#MQTTMapper plugin\|MQTTMapper]], scripting with [[DzVents: next generation Lua scripting\|DzVents]] (with OpenURL to mosquitto_pub) or Node-Red

			'''Node Red (optional)'''

			The Node-RED tool provides an alternative way to creating little programs (flows) to interface with anything you want. But maybe your application can create MQTT-messages on it's own that can be understood by Domoticz. Or maybe you like to create programs in Node.js itself. So using Node-RED is not mandatory, it does however provide a fun and attractive way to handle messages.
			*Node-RED [http://nodered.org] is a tool running in the Node.js platform providing a browser-based flow editor that makes it easy to wire together "flows". Flows can be then deployed to the runtime in a single-click.
			*Node.js [http://nodejs.org/] is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications.

	If you want to use Node-Red for writing your own interface you will need some extra software installed:		If you want to use Node-Red for writing your own interface you will need some extra software installed:
Line 39:		Line 40:
	- Install both '''[https://docs.docker.com/get-docker/ Docker Engine]''' and '''[https://docs.docker.com/compose/install/ Docker Compose]'''.		- Install both '''[https://docs.docker.com/get-docker/ Docker Engine]''' and '''[https://docs.docker.com/compose/install/ Docker Compose]'''.

	- Install Mosquitto using docker (compose) (from https://github.com/vvatelot/mosquitto-docker-compose)		- Install Mosquitto (v2.x) using docker (compose) (from https://github.com/vvatelot/mosquitto-docker-compose)
	<br />		<br />
	sudo su -		sudo su -
Line 60:		Line 61:
	docker compose down		docker compose down
	docker compose up -d		docker compose up -d
	MQTT should now be available on port '''1883.''' You can also use an application like 'MQTT Explorer' to connect to your new broker		MQTT should now be available on port '''1883.''' You can also use an application like [[MQTT#Debugging MQTT\|'MQTT Explorer]]' to connect to your new broker

	=====Legacy installation method- on Linux=====		=====Legacy installation method- on Linux=====
Line 71:		Line 72:

	====='''General''' '''Warning config change for v2.0 and up'''=====		====='''General''' '''Warning config change for v2.0 and up'''=====
	From Mosquitto v2.0.x you need extra configuration, else no connection is made with Domoticz see also https://www.domoticz.com/forum/viewtopic.php?f=28&t=35706		From Mosquitto v2.0.x you need extra configuration, else no connection is made with Domoticz see also [https://forum.domoticz.com/viewtopic.php?f=28&t=35706 https://www.domoticz.com/forum/viewtopic.php?f=28&t=35706]

	To see your installed version:		To see your installed version:
Line 91:		Line 92:


	If only a MQTT Broker is needed (for example Zigbee2MQTT) then continue with
			If only a MQTT Broker is needed (for example Zigbee2MQTT) then continue with adding the hardware gateway:

	[[MQTT#Add hardware "MQTT Client Gateway"\|Add hardware "MQTT Client Gateway"]] for general MQTT hardware or		[[MQTT#Add hardware "MQTT Client Gateway"\|Add hardware "MQTT Client Gateway"]] for general MQTT hardware or

	[[MQTT#Add hardware "MQTT Client Gateway"\|Add hardware "MQTT Auto Discovery Client Gateway"]] for Hardware that supports HA Autodiscover protocol		[[MQTT#Add hardware "MQTT Client Gateway"\|Add hardware "MQTT Auto Discovery Client Gateway"]] for Hardware that supports HA Autodiscover protocol

			[[MQTT Push\|Add MQTT Push]] When you only want to push Domoticz data to MQTT

	====When Using Node-RED for writing your own interface====		====When Using Node-RED for writing your own interface====

Walter vl: /* You'll need */

2025-04-16T14:29:15Z

You'll need

← Older revision		Revision as of 14:29, 16 April 2025
Line 22:		Line 22:
	If the hardware MQTT is not supporting [[MQTT#Domoticz MQTT protocol\|Domoticz MQTT protocol]] or [[MQTT#Add hardware .22MQTT Auto Discovery Client Gateway.22\|Home Assistant Autodiscover protocol]] then you have to write your own transformation.		If the hardware MQTT is not supporting [[MQTT#Domoticz MQTT protocol\|Domoticz MQTT protocol]] or [[MQTT#Add hardware .22MQTT Auto Discovery Client Gateway.22\|Home Assistant Autodiscover protocol]] then you have to write your own transformation.

	This can be done with [[Plugins\|Python Plugins]], [[DzVents: next generation Lua scripting\|DzVents]] (with OpenURL to mosquitto_pub) or Node-Red		This can be done with [[Plugins\|Python Plugins]] like [[MQTT#MQTTMapper plugin\|MQTTMapper]], scripting with [[DzVents: next generation Lua scripting\|DzVents]] (with OpenURL to mosquitto_pub) or Node-Red

	If you want to use Node-Red for writing your own interface you will need some extra software installed:		If you want to use Node-Red for writing your own interface you will need some extra software installed:

Walter vl: /* General Warning config change for v2.0 and up */

2025-04-14T21:23:04Z

General Warning config change for v2.0 and up

← Older revision		Revision as of 21:23, 14 April 2025
Line 84:		Line 84:


	Note that his will give access to the mqtt broker for all devices on your network		Note that his will give access to the mqtt broker for all devices on your network without using an account. Check the mosquitto documentation to make the connection more secure if needed.

	Eclipse has produced a document to support users to migrate from version 1.x to 2.0.		Eclipse has produced a document to support users to migrate from version 1.x to 2.0.