Using Python plugins - Revision history

Walter vl: /* Installing Python for Windows */

2026-01-03T16:21:39Z

Installing Python for Windows

← Older revision		Revision as of 16:21, 3 January 2026
Line 57:		Line 57:

	*If you are using the precompiled x86 version of Domoticz from https://www.domoticz.com/downloads/ , install the 32 bit Python version even if your Windows is 64 bit.		*If you are using the precompiled x86 version of Domoticz from https://www.domoticz.com/downloads/ , install the 32 bit Python version even if your Windows is 64 bit.
	*Currently Python 3.7 to 3.11 is supported~~. Python 3.12 still under test (but seems to work)~~.		*Currently Python 3.7 to 3.13 is supported.
	*Do not install Python 3.8.0 as this will stop the plugin framework. Install 3.8.1 or higher!		*Do not install Python 3.8.0 as this will stop the plugin framework. Install 3.8.1 or higher!

Walter vl: /* Setting up a Python Virtual Environment (venv) for module install */

2026-01-03T15:56:23Z

Setting up a Python Virtual Environment (venv) for module install

← Older revision		Revision as of 15:56, 3 January 2026
Line 98:		Line 98:
	When you close the terminal session the Python venv is deactivated for module installation. So when you need to install Python modules for eg another plugin you have to enable it again in the new terminal session with command:		When you close the terminal session the Python venv is deactivated for module installation. So when you need to install Python modules for eg another plugin you have to enable it again in the new terminal session with command:

	<code>/home/pi/Domoticz_Python_Environment/bin/activate</code>Then you can install the extra modules again with <code>pip install</code>		<code>/home/pi/Domoticz_Python_Environment/bin/activate</code>


			Then you can install the extra modules again with <code>pip install</code>

	===Example plugin install for Raspberry Pi with Raspbian (without Python venv)===		===Example plugin install for Raspberry Pi with Raspbian (without Python venv)===

Walter vl: /* Setting up a Python Virtual Environment (venv) for module install */

2026-01-03T15:55:40Z

Setting up a Python Virtual Environment (venv) for module install

← Older revision		Revision as of 15:55, 3 January 2026
Line 96:		Line 96:
	Install the python modules with <code>pip install</code> as needed when the venv is still active		Install the python modules with <code>pip install</code> as needed when the venv is still active

	When you close the terminal session the Python venv is deactivated for module installation. So when you need to install Python modules for eg another plugin you have to enable it again with command:		When you close the terminal session the Python venv is deactivated for module installation. So when you need to install Python modules for eg another plugin you have to enable it again in the new terminal session with command:

	<code>/home/pi/Domoticz_Python_Environment/bin/activate</code>Then you can install the extra modules again with <code>pip install</code>		<code>/home/pi/Domoticz_Python_Environment/bin/activate</code>Then you can install the extra modules again with <code>pip install</code>

Walter vl: /* Setting up a Python Virtual Environment (venv) for module install */

2026-01-03T15:54:19Z

Setting up a Python Virtual Environment (venv) for module install

← Older revision		Revision as of 15:54, 3 January 2026
Line 81:		Line 81:

	=== Setting up a Python Virtual Environment (venv) for module install ===		=== Setting up a Python Virtual Environment (venv) for module install ===
			Newer Linux distros adheres to PEP 668, which marks the system Python environment as "externally managed," making it difficult to install packages system-wide using <code>pip</code> without potential conflicts or breaking system utilities. So we need to setup a Python venv when extra Python modules are needed by the plugin (see the plugin install instructions to check if extra modules are needed)
	* Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands in a terminal session:		* Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands in a terminal session:
	*# <code>cd /home/pi</code> (change your username accordingly)		*# <code>cd /home/pi</code> (change your username accordingly)

Walter vl: /* Installing a plugin */ Python Venv

2026-01-03T15:49:24Z

Installing a plugin: Python Venv

Walter vl: /* Installing a plugin */

2026-01-03T11:44:08Z

Installing a plugin

← Older revision		Revision as of 11:44, 3 January 2026
Line 65:		Line 65:

	==Installing a plugin==		==Installing a plugin==

			'''NOTE:''' On newer linux distros like Bookworm, Trixie, Ubuntu 24 , Debian 12, -13 etc, you have to setup a Python Virtual Environment (venv) when extra python modules are needed by the plugin. See for instructions below

	Generally installing a plugin takes a few steps:		Generally installing a plugin takes a few steps:

	'''NOTE:''' On newer linux distros like Bookworm, Trixie, Ubuntu 24 , Debian 12, -13 etc, you have to setup a Python Virtual Environment (venv) when extra python modules are needed by the plugin. See for instructions (written for the Zigbee4Domoticz but could be used for any plugin):

	~~https://zigbeefordomoticz.github.io/wiki/en-eng/HowTo_PythonVirtualEnv.html~~

	*Download the plugin and copy its folder into the ''domoticz/plugins'' directory. Each plugin at the very least consists of a ''plugin.py'' file. Downloading is normally done with a <code>git clone</code> command from the plugin repository.		*Download the plugin and copy its folder into the ''domoticz/plugins'' directory. Each plugin at the very least consists of a ''plugin.py'' file. Downloading is normally done with a <code>git clone</code> command from the plugin repository.

Walter vl: /* Installing a plugin */

2026-01-03T11:41:58Z

Installing a plugin

← Older revision		Revision as of 11:41, 3 January 2026
Line 84:		Line 84:
	=== Setting up a Python Virtual Environment (venv) ===		=== Setting up a Python Virtual Environment (venv) ===

	# Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands:		* Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands:
	## <code>cd /home/pi</code>		*# <code>cd /home/pi</code> (change your username accordingly)
	## <code>mkdir Domoticz_Python_Environment</code>		*# <code>mkdir Domoticz_Python_Environment</code>
	## <code>python3 -m venv Domoticz_Python_Environment source Domoticz_Python_Environment/bin/activate</code>		*# <code>python3 -m venv Domoticz_Python_Environment source Domoticz_Python_Environment/bin/activate</code>
	## <code>pip install --upgrade pip</code>		*# <code>pip install --upgrade pip</code>
	# Make Domoticz start with the Python Environment:		*# Make Domoticz start with the Python Environment:
	## If you are ~~in Option 1~~ , you can simply edit the <code>/etc/init.d/domoticz.sh</code> file and add an extra line ~~such~~		*## If you are running Domoticz as a service with the init.d feature, you can simply edit the <code>/etc/init.d/domoticz.sh</code> file and add an extra line: <code>export PYTHONPATH=/home/pi/Domoticz_Python_Environment:$PYTHONPATH</code>
	~~###~~ <code>export PYTHONPATH=/home/pi/Domoticz_Python_Environment:$PYTHONPATH</code>		*## If you run Domoticz with systemd, If you want to set some specific environment variable for the execution of the domoticz daemon, you can use the filename specified in the EnvironmentFile clause to do so. Here for example, we are setting the PYTHONPATH to use a local python environment:
	## If ~~your are in Option 2 Systemd Alternative (preferred)~~, you can ~~simply add~~ the EnvironmentFile ~~statement as described in~~ the ~~wiki and set~~ PYTHONPATH ~~accordingly in the corresponding file~~.		## <code>vi /home/pi/domoticz.env</code>
	## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>		## <code>PYTHONPATH="/home/pi/Domoticz_Python_Environment/:$PYTHONPATH"</code>
			*## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>

Walter vl: /* Installing a plugin */

2026-01-03T11:31:31Z

Installing a plugin

← Older revision		Revision as of 11:31, 3 January 2026
Line 91:		Line 91:
	# Make Domoticz start with the Python Environment:		# Make Domoticz start with the Python Environment:
	## If you are in Option 1 , you can simply edit the <code>/etc/init.d/domoticz.sh</code> file and add an extra line such		## If you are in Option 1 , you can simply edit the <code>/etc/init.d/domoticz.sh</code> file and add an extra line such
	### export PYTHONPATH=/home/pi/Domoticz_Python_Environment:$PYTHONPATH		### <code>export PYTHONPATH=/home/pi/Domoticz_Python_Environment:$PYTHONPATH</code>
	## If your are in Option 2 Systemd Alternative (preferred), you can simply add the EnvironmentFile statement as described in the wiki and set PYTHONPATH accordingly in the corresponding file.		## If your are in Option 2 Systemd Alternative (preferred), you can simply add the EnvironmentFile statement as described in the wiki and set PYTHONPATH accordingly in the corresponding file.
	## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>		## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>


			===Example plugin install for Raspberry Pi with Raspbian (without Python venv)===

	===Example for Raspberry Pi with Raspbian===

	Let's run through an example installation.		Let's run through an example installation.

Walter vl: /* Installing a plugin */

2026-01-03T11:30:01Z

Installing a plugin

← Older revision		Revision as of 11:30, 3 January 2026
Line 82:		Line 82:
	Optionally, you may have to install extra software like drivers. Check the plugin documentation to find out.		Optionally, you may have to install extra software like drivers. Check the plugin documentation to find out.

			=== Setting up a Python Virtual Environment (venv) ===

			# Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands:
			## <code>cd /home/pi</code>
			## <code>mkdir Domoticz_Python_Environment</code>
			## <code>python3 -m venv Domoticz_Python_Environment source Domoticz_Python_Environment/bin/activate</code>
			## <code>pip install --upgrade pip</code>
			# Make Domoticz start with the Python Environment:
			## If you are in Option 1 , you can simply edit the <code>/etc/init.d/domoticz.sh</code> file and add an extra line such
			### export PYTHONPATH=/home/pi/Domoticz_Python_Environment:$PYTHONPATH
			## If your are in Option 2 Systemd Alternative (preferred), you can simply add the EnvironmentFile statement as described in the wiki and set PYTHONPATH accordingly in the corresponding file.
			## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>

Walter vl: /* Installing a plugin */

2026-01-03T11:20:14Z

Installing a plugin

← Older revision		Revision as of 11:20, 3 January 2026
Line 68:		Line 68:
	Generally installing a plugin takes a few steps:		Generally installing a plugin takes a few steps:

	'''NOTE:''' On newer linux distros you have to setup a Python Virtual Environment (venv) when extra python modules are needed by the plugin. See for instructions (written for the Zigbee4Domoticz but could be used for any plugin):		'''NOTE:''' On newer linux distros like Bookworm, Trixie, Ubuntu 24 , Debian 12, -13 etc, you have to setup a Python Virtual Environment (venv) when extra python modules are needed by the plugin. See for instructions (written for the Zigbee4Domoticz but could be used for any plugin):

	https://zigbeefordomoticz.github.io/wiki/en-eng/HowTo_PythonVirtualEnv.html		https://zigbeefordomoticz.github.io/wiki/en-eng/HowTo_PythonVirtualEnv.html

← Older revision		Revision as of 15:49, 3 January 2026
Line 80:		Line 80:
	Optionally, you may have to install extra software like drivers. Check the plugin documentation to find out.		Optionally, you may have to install extra software like drivers. Check the plugin documentation to find out.

	=== Setting up a Python Virtual Environment (venv) ===		=== Setting up a Python Virtual Environment (venv) for module install ===

	* Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands:		* Create a folder in your home eg <code>/home/pi/Domoticz_Python_Environment</code> and make it a Pytrhon venv by running the following commands in a terminal session:
	*# <code>cd /home/pi</code> (change your username accordingly)		*# <code>cd /home/pi</code> (change your username accordingly)
	*# <code>mkdir Domoticz_Python_Environment</code>		*# <code>mkdir Domoticz_Python_Environment</code> (this can be any name)
	*# <code>python3 -m venv Domoticz_Python_Environment source Domoticz_Python_Environment/bin/activate</code>		*# <code>python3 -m venv Domoticz_Python_Environment source Domoticz_Python_Environment/bin/activate</code>
	*# <code>pip install --upgrade pip</code>		*# <code>pip install --upgrade pip</code>
Line 94:		Line 94:
	*## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>		*## As you are changing a startup script, in both options you have to run <code>systemctl daemon-reload</code>

			Install the python modules with <code>pip install</code> as needed when the venv is still active

			When you close the terminal session the Python venv is deactivated for module installation. So when you need to install Python modules for eg another plugin you have to enable it again with command:

			<code>/home/pi/Domoticz_Python_Environment/bin/activate</code>Then you can install the extra modules again with <code>pip install</code>

	===Example plugin install for Raspberry Pi with Raspbian (without Python venv)===		===Example plugin install for Raspberry Pi with Raspbian (without Python venv)===