ZigBeeForDomoticZ plugin Wiki
Frequently Asked Questions
- Q1. Where can I get support ?
- Q2. Where are the logs ?
- Q3. Can I debug myself ?
- Q4. Where can I find the list of supported Coordinators and Devices ?
- Q5. Where can I find the coordinator firmwares ?
- Q6. Can I use several coordinators in the same DomoticZ ?
- Q7. Can I fixe the USB Port number ?
- Q8. My device is not updated in DomoticZ when interacting via a remote control or manually
- Q9. The plugin menu’s link is not showed in DomoticZ
Troubleshooting
- T1. My coordinator is not working
- T2. My object can not be paired
- T3. My object doesn’t work as expected
Errors
- E1. Log error :
No transport, write directive to XXX.XXX.XXX.XXX:8080' ignored
- E2. Log error :
Decode8000
- E3. Log error :
Error: <plugin's name> Communication error when transmitting a previous command to XXXX ieee XXXXXXXXXXXXXXXX
- E4. Log Error :
Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter
- E5. Missing module Error
- E6. Error :
Error: <plugin's name> : You need to setup the URL Base to access the Domoticz JSON/API
- E7. Error when updating python modules
- E8. Error :
pkg_resources.VersionConflict: (dnspython 2.3.0 (/usr/local/lib/python3.10/site-packages), Requirement.parse('dnspython==2.2.1'))
- E9. Error :
ImportError: PyO3 modules may only be initialized once per interpreter process
- E10. Error :
[WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command!
- E11. Error on installation under Debian 12 :
This environment is externally managed. To install Python packages system-wide, try apt install python3-xyz...
- E12. Error :
Error: <plugin's name> : ModuleNotFoundError: No module named 'cchardet'
- E13-Error-AttributeError-module-lib-has-no-attribute-OpenSSL_add_all_algorithms-`
- E14. AttributeError: module ‘lib’ has no attribute ‘X509_V_FLAG_CB_ISSUER_CHECK
- E15. error: externally-managed-environment
Q1. Where can I get support ?
The first source of support is the Wiki :
- English Wiki
- French Wiki
- Dutch Wiki ( Unfortunately outdated. Please contact us if you are willing to contribute in the update of this wiki)
You can also get support and ask questions :
- The English Forum
- The French Forum
- The Keybase English channel
- The Keybase French channel
Q2. Where are the logs ?
Since Stable6, the logs are saved in a file : domoticz/plugins/Domoticz-Zigbee/Logs/PluginZigbee-XX.log
The folder Domoticz-Zigbee can also be Domoticz-Zigate if you have installed the plugin before April 2022.
Q3. Can I debug myself ?
Please refer to Troubleshooting pairing or connection
Q4. Where can I find the list of supported Coordinators and Devices ?
Please refer to Zigbee Device Compatibility Repository
Q5. Where can I find the coordinator firmwares ?
- For Texas Instrument, we recommend to use the Z-Stack firmware from @Koenkk available here. We do not recommend to use develop branch and rely on the master.
- For ZiGate, the firmwares are available here for Zigate V1 or here for ZiGate+ V2
- For EZNP (Silicon Labs), we recommend to follow the zigpy recommendations
Q6. Can I use several coordinators in the same DomoticZ ?
We have currently a limitation of the number of instances using Zigpy layer, which prevent having several instances of zigpy based communication.
If you use ZiGate hardware, you can run as many plugin instances ( one instance per ZiGate ) as you wish.
If you use non-ZiGate hardware, like TI CCxxxx or Silicon Labs, you can run only one instance of those 2, but still can mix with as many ZiGate as you want. For more information you can see the progress of that issue on #1117
Q7. Can I fixe the USB Port number ?
Some times, when you reboot your system, the USB Port (like dev/ttyUSB0) can change its number which cases a communication error with the coordinator. This is more an OS issue, but there are few hints :
Q8. My device is not updated in DomoticZ when interacting via a remote control or manually
For example : If you power off an Ikea bulb (with the physical switch) and then switch it on again, the status of the bulb is not updated in DomoticZ. And having the same issue with a remote controller which also doesn’t update it’s current state to DomoticZ.
If you encounter problems like the above example, it is most likely the automatic reporting is not configured correctly from the device end. Please follow below steps to fix this issue:
- Go to the settings page on the WebUI
- Activate the advanced settings
- Please check if the parameter AllowRebindingClusters.
- Switch off the Ikea bulb with the physical switch, wait for 10 seconds, then turn it on again.
The rebinding process will start itself, the status problems should now be fixed.
Q9. The plugin menu’s link is not showed in DomoticZ
Check that the Custom Tab is activated :
- Before DomoticZ 2022.2, go to Configuration / Parameters / System tab and check that the Custom Tab is activated at the bottom.
- From DomoticZ 2023.1, go to Configuration / Users and check that the Custom Tab is activated for each user needed.
T1. My coordinator is not working
I can see in the log file some messages like that
INFO : [ MainThread] Zigate plugin beta6-6.0.114 started
INFO : [ MainThread] Plugin Database: DeviceList-2.txt
INFO : [ MainThread] DeviceConf loaded - 23 confs loaded
INFO : [ MainThread] DeviceConf loaded - 329 confs loaded
INFO : [ MainThread] load ListOfDevice
INFO : [ MainThread] Transport mode: ZigpyZNP
ERROR : [ MainThread] [ 61] I have hard time to get Coordinator Version. Mostlikly there is a communication issue
ERROR : [ MainThread] [ ] Stop the plugin and check the Coordinator connectivity.
This indicate a miss communication between the plugin and the coordinator. You need to cross-check the following pieces in the DomoticZ Hardware menu :
- If this is the first time you are using the Coordinator (no device paired yet), you have to initialize it, set the Initialize Coordinator: True in the Domoticz Hardware menu when starting the plugin. Once the first startup is ok, then disable this parameter to prevent erasing all paired devices at the next restart.
- Ensure that the serial port is the right one.
- Ensure that the Coordinator Model matchs your dongle (in that case it must be Texas Instrument ZNP (via zigpy))
- Ensure that there is not an other process running on the port
- If the coordinator is connected on a PI, make sure that you use USB2 (and not the USB3 from the PI4)
- If you have connected the coordinator on an USB HUB, try to plug it directly to the server
If it still don’t work, you can try to test the coordinator with making Real time topology. This test will be done without Domoticz and the plugin. It is only working with TI CCxxx.
T2. My object can not be paired
- If the coordinator is plugged directly into a USB port on the server, try deporting it using a USB extension cord (don’t use an USB HUB). This will keep it away from interference, especially from SSD disks, wifi chips, etc…
Please refer to Dealing with none certified device
T3. My object doesn’t work as expected
Please refer to Dealing with none certified device
E1. Log error : No transport, write directive to XXX.XXX.XXX.XXX:8080' ignored
Time to time I see the following error message. Is that a big issue ? How can I get rid of it ?
Error: ZigBee: No transport, write directive to 'XXX.XXX.XXX.XXX:8080' ignored.
This error is coming from DomoticZ and is related to the fact that you had the WebUI page opened and which timeout, at the time you tried to refresh this page, Domoticz detected that they were no transport/communication anymore.
You shouldn’t worry much of this message.
E2. Log error : Decode8000
if you see error logs like here after, this is most-likely an issue with the ZiGate hardware.
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 22 Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 4d Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 51 Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 52 Status: [ZigBee Error Code Unknown code : 80]
- Make sure that you don’t have the old blue USB-TTL module (it must be a red one )
- Try to power off the ZiGate by stopping the plugin, removing ZiGate, wait for 1 minute, plug-in back and restart the plugin
E3. Log error : Error: <plugin's name> Communication error when transmitting a previous command to XXXX ieee XXXXXXXXXXXXXXXX
Here after is an exemple of errors found in the log file.
Error: (Zigate) Communication error when transmiting a previous command to 9d58 ieee 90fd9ffffe31f150
Error: (Zigate) Decode8702 - SQN: bc AddrMode: 02 DestAddr: 9d58 SrcEP: 01 DestEP: 01 Status: d4 - Unicast frame does not have a route available but it is buffered for automatic resend
This indicates that device 90fd9ffffe31f150is not reachable or - Zigate get a communication problem with it -
E4. Log Error : Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter
Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter.
This error appears when stopping the plugin. Ignore it.
E5. Missing module error
Make sure that you have correctly installed the plugin
from the plugin home directory Domoticz-Zigbee or Domoticz-Zigate do the following command
ls -l external/dnspython/
if the response is
total 0
you need to run
git config --add submodule.recurse true
git submodule update --init --recursive
Make sure that all dependencies have been installed
sudo pip3 install -r requirements.txt
ATTENTION:
- On windows system, it is a must that the pip3 install command is run from a CMD Administrator window, and it must be the first time. If you have run once already without Administrator windows, you must start removing all already installed modules.
E6. Error : Error: <plugin's name> : You need to setup the URL Base to access the Domoticz JSON/API
This error appears when the DomoticZ parameter API base url is not correctly filled. More infos on step 2 Plugin settings.
E7. Error when updating python module: Building wheel for cryptography (PEP 517) ... error
When doing the command pip3 install -r requirements.txt or python3 -m pip install -r requirements.txt --upgrade you get this error.
ERROR: Failed building wheel for cryptography
Failed to build cryptography
ERROR: Could not build wheels for cryptography which use PEP 517 and cannot be installed directly
-
upgrade or install the python module wheel
sudo python3 -m pip install wheel --upgrade
- make sure your /tmp is large enough
- make sure you have enough swap, if requires , add some filesystem swap
E8. Error : pkg_resources.VersionConflict: (dnspython 2.3.0 (/usr/local/lib/python3.10/site-packages), Requirement.parse('dnspython==2.2.1'))
This error may appear when you change branch from develop to stable6 : the dnspython module level is not the same.
- Do the following command from the plugin home directory
sudo python3 -m pip install -r requirements.txt --upgrade
E9. Error : ImportError: PyO3 modules may only be initialized once per interpreter process
Status: Zigpy-Elelabs: Transport mode: ZigpyEZSP
Error: Zigpy-Elelabs: Call to function 'onStart' failed, exception details:
Error: Zigpy-Elelabs: Traceback (most recent call last):
Error: Zigpy-Elelabs: File "/var/lib/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 1537, in onStart
Error: Zigpy-Elelabs: _plugin.onStart()
Error: Zigpy-Elelabs: File "/var/lib/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 602, in onStart
Error: Zigpy-Elelabs: from zigpy.config import (CONF_DEVICE, CONF_DEVICE_PATH,
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/config/init.py", line 32, in <module>
Error: Zigpy-Elelabs: from zigpy.config.validators import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/config/validators.py", line 9, in <module>
Error: Zigpy-Elelabs: import zigpy.zdo.types as zdo_t
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/zdo/init.py", line 10, in <module>
Error: Zigpy-Elelabs: import zigpy.util
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/util.py", line 14, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.primitives.ciphers import Cipher
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/hazmat/primitives/ciphers/init.py", line 11, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.primitives.ciphers.base import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/hazmat/primitives/ciphers/base.py", line 10, in <module>
Error: Zigpy-Elelabs: from cryptography.exceptions import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/exceptions.py", line 9, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.bindings.rust import exceptions as rustexceptions
Error: Zigpy-Elelabs: ImportError: PyO3 modules may only be initialized once per interpreter process
This is related to the fact that you are using a recent cryptography module.
you can solve this issue by downgrading the cryptography module
sudo python3 -m pip install cryptography==40.0.2 --upgrade`
E10. Error : [WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command!
This error comes with the API modification of DomoticZ 2023.2
You need to update to the plugin version 7 following the instructions.
E11. Error on installation under Debian 12 : This environment is externally managed. To install Python packages system-wide, try apt install python3-xyz...
The full error is :
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install python3-xyz, where xyz is the package you are trying to install.
If you wish to install a non-Debian-packaged Python package, create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make sure you have python3-full installed.
Operation under Debian 12 Bookworm needs to modify the installation command line by default by adding –break-system-packages at the end :
sudo pip3 install -r requirements.txt --break-system-packages
Reminder : This command line is only valid on Debian 12 Bookworm systems.
E12. Error : Error: <plugin's name> : ModuleNotFoundError: No module named 'cchardet'
This error appears when you have multiple plugin’s sessions and there is not the good charset-normalizer dependency version. It should be 2.0.12.
Check you version with the commande :
pip show charset-normalizer
or if you still using python2
pip3 show charset-normalizer
If the answer is not 2.0.12 then :
pip install --force-reinstall --upgrade charset-normalizer==2.0.12
or if you still using python2
pip3 install --force-reinstall --upgrade charset-normalizer==2.0.12
E13. Error : AttributeError: module 'lib' has no attribute 'OpenSSL_add_all_algorithms'
2024-04-16 18:31:06.519 Error: zig: (Zigate) failed to load 'plugin.py', Python Path used was '/home/ben/domoticz/plugins/Domoticz-Zigbee/:/usr/lib/python310.zip:/usr/lib/python3.10:/usr/lib/python3.10/lib-dynload:/usr/local/lib/python3.10/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.10/dist-packages'.
2024-04-16 18:31:06.523 Error: zig: Traceback (most recent call last):
2024-04-16 18:31:06.523 Error: zig: File "/home/ben/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 122, in <module>
2024-04-16 18:31:06.523 Error: zig: from Modules.checkingUpdate import (checkFirmwareUpdate, checkPluginUpdate,
2024-04-16 18:31:06.523 Error: zig: File "/home/ben/domoticz/plugins/Domoticz-Zigbee/Modules/checkingUpdate.py", line 14, in <module>
2024-04-16 18:31:06.523 Error: zig: import dns.resolver
2024-04-16 18:31:06.523 Error: zig: File "/usr/local/lib/python3.10/dist-packages/dns/resolver.py", line 39, in <module>
2024-04-16 18:31:06.523 Error: zig: import dns.query
2024-04-16 18:31:06.523 Error: zig: File "/usr/local/lib/python3.10/dist-packages/dns/query.py", line 48, in <module>
2024-04-16 18:31:06.523 Error: zig: from requests_toolbelt.adapters.source import SourceAddressAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/init.py", line 12, in <module>
2024-04-16 18:31:06.523 Error: zig: from .adapters import SSLAdapter, SourceAddressAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/init.py", line 12, in <module>
2024-04-16 18:31:06.523 Error: zig: from .ssl import SSLAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/ssl.py", line 16, in <module>
2024-04-16 18:31:06.523 Error: zig: from .._compat import poolmanager
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/_compat.py", line 56, in <module>
2024-04-16 18:31:06.523 Error: zig: from requests.packages.urllib3.contrib.pyopenssl \
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/urllib3/contrib/pyopenssl.py", line 50, in <module>
2024-04-16 18:31:06.523 Error: zig: import OpenSSL.SSL
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/OpenSSL/init.py", line 8, in <module>
2024-04-16 18:31:06.523 Error: zig: from OpenSSL import crypto, SSL
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 3279, in <module>
2024-04-16 18:31:06.523 Error: zig: lib.OpenSSLadd_all_algorithms()
2024-04-16 18:31:06.523 Error: zig: AttributeError: module 'lib' has no attribute 'OpenSSL_add_all_algorithms'
2024-04-16 18:32:14.294 Error: zig hardware (35) thread seems to have ended unexpectedly
it seems that the root cause is the conflicts between pyOpenSSL and Cryptography ref
sudo python3 -m pip install cryptography==38.0.4 --upgrade
E14. AttributeError: module ‘lib’ has no attribute ‘X509_V_FLAG_CB_ISSUER_CHECK
2024-04-24 12:29:41.998 Error: Zigbee: (Zigate) failed to load 'plugin.py', Python Path used was '/home/pi/domoticz/plugins/Domoticz-Zigbee/:/usr/lib/python39.zip:/usr/lib/python3.9:/usr/lib/python3.9/lib-dynload:/usr/local/lib/python3.9/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.9/dist-packages'.
2024-04-24 12:29:42.005 Error: Zigbee: Traceback (most recent call last):
2024-04-24 12:29:42.005 Error: Zigbee: File "/home/pi/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 131, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from Modules.checkingUpdate import (checkFirmwareUpdate, checkPluginUpdate,
2024-04-24 12:29:42.005 Error: Zigbee: File "/home/pi/domoticz/plugins/Domoticz-Zigbee/Modules/checkingUpdate.py", line 14, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import dns.resolver
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/local/lib/python3.9/dist-packages/dns/resolver.py", line 39, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import dns.query
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/local/lib/python3.9/dist-packages/dns/query.py", line 48, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from requests_toolbelt.adapters.source import SourceAddressAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/init.py", line 12, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .adapters import SSLAdapter, SourceAddressAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/init.py", line 12, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .ssl import SSLAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/ssl.py", line 16, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .._compat import poolmanager
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/_compat.py", line 56, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from requests.packages.urllib3.contrib.pyopenssl \
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/urllib3/contrib/pyopenssl.py", line 50, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import OpenSSL.SSL
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/init.py", line 8, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from OpenSSL import crypto, SSL
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 1556, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: class X509StoreFlags(object):
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 1577, in X509StoreFlags
2024-04-24 12:29:42.005 Error: Zigbee: CB_ISSUER_CHECK = lib.X509V_FLAG_CB_ISSUER_CHECK
2024-04-24 12:29:42.005 Error: Zigbee: AttributeError: module 'lib' has no attribute 'X509_V_FLAG_CB_ISSUER_CHECK'
It could be related to mix between python module and installed library
sudo apt remove -y python3-openssl
E15. error: externally-managed-environment
error: externally-managed-environment
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.
For more information visit http://rptl.io/venv
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
The best is to use the Python virtual environment as described in Using Python Virtual Environment
Frequently Asked Questions
- Q1. Where can I get support ?
- Q2. Where are the logs ?
- Q3. Can I debug myself ?
- Q4. Where can I find the list of supported Coordinators and Devices ?
- Q5. Where can I find the coordinator firmwares ?
- Q6. Can I use several coordinators in the same DomoticZ ?
- Q7. Can I fixe the USB Port number ?
- Q8. My device is not updated in DomoticZ when interacting via a remote control or manually
- Q9. The plugin menu’s link is not showed in DomoticZ
Troubleshooting
- T1. My coordinator is not working
- T2. My object can not be paired
- T3. My object doesn’t work as expected
Errors
- E1. Log error :
No transport, write directive to XXX.XXX.XXX.XXX:8080' ignored - E2. Log error :
Decode8000 - E3. Log error :
Error: <plugin's name> Communication error when transmitting a previous command to XXXX ieee XXXXXXXXXXXXXXXX - E4. Log Error :
Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter - E5. Missing module Error
- E6. Error :
Error: <plugin's name> : You need to setup the URL Base to access the Domoticz JSON/API - E7. Error when updating python modules
- E8. Error :
pkg_resources.VersionConflict: (dnspython 2.3.0 (/usr/local/lib/python3.10/site-packages), Requirement.parse('dnspython==2.2.1')) - E9. Error :
ImportError: PyO3 modules may only be initialized once per interpreter process - E10. Error :
[WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command! - E11. Error on installation under Debian 12 :
This environment is externally managed. To install Python packages system-wide, try apt install python3-xyz... - E12. Error :
Error: <plugin's name> : ModuleNotFoundError: No module named 'cchardet' - E13-Error-AttributeError-module-lib-has-no-attribute-OpenSSL_add_all_algorithms-`
- E14. AttributeError: module ‘lib’ has no attribute ‘X509_V_FLAG_CB_ISSUER_CHECK
- E15. error: externally-managed-environment
Q1. Where can I get support ?
The first source of support is the Wiki :
- English Wiki
- French Wiki
- Dutch Wiki ( Unfortunately outdated. Please contact us if you are willing to contribute in the update of this wiki)
You can also get support and ask questions :
- The English Forum
- The French Forum
- The Keybase English channel
- The Keybase French channel
Q2. Where are the logs ?
Since Stable6, the logs are saved in a file : domoticz/plugins/Domoticz-Zigbee/Logs/PluginZigbee-XX.log
The folder Domoticz-Zigbee can also be Domoticz-Zigate if you have installed the plugin before April 2022.
Q3. Can I debug myself ?
Please refer to Troubleshooting pairing or connection
Q4. Where can I find the list of supported Coordinators and Devices ?
Please refer to Zigbee Device Compatibility Repository
Q5. Where can I find the coordinator firmwares ?
- For Texas Instrument, we recommend to use the Z-Stack firmware from @Koenkk available here. We do not recommend to use develop branch and rely on the master.
- For ZiGate, the firmwares are available here for Zigate V1 or here for ZiGate+ V2
- For EZNP (Silicon Labs), we recommend to follow the zigpy recommendations
Q6. Can I use several coordinators in the same DomoticZ ?
We have currently a limitation of the number of instances using Zigpy layer, which prevent having several instances of zigpy based communication.
If you use ZiGate hardware, you can run as many plugin instances ( one instance per ZiGate ) as you wish. If you use non-ZiGate hardware, like TI CCxxxx or Silicon Labs, you can run only one instance of those 2, but still can mix with as many ZiGate as you want. For more information you can see the progress of that issue on #1117
Q7. Can I fixe the USB Port number ?
Some times, when you reboot your system, the USB Port (like dev/ttyUSB0) can change its number which cases a communication error with the coordinator. This is more an OS issue, but there are few hints :
Q8. My device is not updated in DomoticZ when interacting via a remote control or manually
For example : If you power off an Ikea bulb (with the physical switch) and then switch it on again, the status of the bulb is not updated in DomoticZ. And having the same issue with a remote controller which also doesn’t update it’s current state to DomoticZ.
If you encounter problems like the above example, it is most likely the automatic reporting is not configured correctly from the device end. Please follow below steps to fix this issue:
- Go to the settings page on the WebUI
- Activate the advanced settings
- Please check if the parameter AllowRebindingClusters.
- Switch off the Ikea bulb with the physical switch, wait for 10 seconds, then turn it on again. The rebinding process will start itself, the status problems should now be fixed.
Q9. The plugin menu’s link is not showed in DomoticZ
Check that the Custom Tab is activated :
- Before DomoticZ 2022.2, go to Configuration / Parameters / System tab and check that the Custom Tab is activated at the bottom.
- From DomoticZ 2023.1, go to Configuration / Users and check that the Custom Tab is activated for each user needed.
T1. My coordinator is not working
I can see in the log file some messages like that
INFO : [ MainThread] Zigate plugin beta6-6.0.114 started
INFO : [ MainThread] Plugin Database: DeviceList-2.txt
INFO : [ MainThread] DeviceConf loaded - 23 confs loaded
INFO : [ MainThread] DeviceConf loaded - 329 confs loaded
INFO : [ MainThread] load ListOfDevice
INFO : [ MainThread] Transport mode: ZigpyZNP
ERROR : [ MainThread] [ 61] I have hard time to get Coordinator Version. Mostlikly there is a communication issue
ERROR : [ MainThread] [ ] Stop the plugin and check the Coordinator connectivity.
This indicate a miss communication between the plugin and the coordinator. You need to cross-check the following pieces in the DomoticZ Hardware menu :
- If this is the first time you are using the Coordinator (no device paired yet), you have to initialize it, set the Initialize Coordinator: True in the Domoticz Hardware menu when starting the plugin. Once the first startup is ok, then disable this parameter to prevent erasing all paired devices at the next restart.
- Ensure that the serial port is the right one.
- Ensure that the Coordinator Model matchs your dongle (in that case it must be Texas Instrument ZNP (via zigpy))
- Ensure that there is not an other process running on the port
- If the coordinator is connected on a PI, make sure that you use USB2 (and not the USB3 from the PI4)
- If you have connected the coordinator on an USB HUB, try to plug it directly to the server
If it still don’t work, you can try to test the coordinator with making Real time topology. This test will be done without Domoticz and the plugin. It is only working with TI CCxxx.
T2. My object can not be paired
- If the coordinator is plugged directly into a USB port on the server, try deporting it using a USB extension cord (don’t use an USB HUB). This will keep it away from interference, especially from SSD disks, wifi chips, etc…
Please refer to Dealing with none certified device
T3. My object doesn’t work as expected
Please refer to Dealing with none certified device
E1. Log error : No transport, write directive to XXX.XXX.XXX.XXX:8080' ignored
Time to time I see the following error message. Is that a big issue ? How can I get rid of it ?
Error: ZigBee: No transport, write directive to 'XXX.XXX.XXX.XXX:8080' ignored.
This error is coming from DomoticZ and is related to the fact that you had the WebUI page opened and which timeout, at the time you tried to refresh this page, Domoticz detected that they were no transport/communication anymore. You shouldn’t worry much of this message.
E2. Log error : Decode8000
if you see error logs like here after, this is most-likely an issue with the ZiGate hardware.
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 22 Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 4d Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 51 Status: [ZigBee Error Code Unknown code : 80]
Error: ZiGate: Decode8000 - PacketType: 0030 TypeSqn: 02 sqn_app: 00 sqn_aps: 52 Status: [ZigBee Error Code Unknown code : 80]
- Make sure that you don’t have the old blue USB-TTL module (it must be a red one )
- Try to power off the ZiGate by stopping the plugin, removing ZiGate, wait for 1 minute, plug-in back and restart the plugin
E3. Log error : Error: <plugin's name> Communication error when transmitting a previous command to XXXX ieee XXXXXXXXXXXXXXXX
Here after is an exemple of errors found in the log file.
Error: (Zigate) Communication error when transmiting a previous command to 9d58 ieee 90fd9ffffe31f150
Error: (Zigate) Decode8702 - SQN: bc AddrMode: 02 DestAddr: 9d58 SrcEP: 01 DestEP: 01 Status: d4 - Unicast frame does not have a route available but it is buffered for automatic resend
This indicates that device 90fd9ffffe31f150is not reachable or - Zigate get a communication problem with it -
E4. Log Error : Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter
Error: (FindModule) Domoticz/DomoticzEx modules not found in interpreter.
This error appears when stopping the plugin. Ignore it.
E5. Missing module error
Make sure that you have correctly installed the plugin
from the plugin home directory Domoticz-Zigbee or Domoticz-Zigate do the following command
ls -l external/dnspython/
if the response is
total 0
you need to run
git config --add submodule.recurse true
git submodule update --init --recursive
Make sure that all dependencies have been installed
sudo pip3 install -r requirements.txt
ATTENTION:
- On windows system, it is a must that the pip3 install command is run from a CMD Administrator window, and it must be the first time. If you have run once already without Administrator windows, you must start removing all already installed modules.
E6. Error : Error: <plugin's name> : You need to setup the URL Base to access the Domoticz JSON/API
This error appears when the DomoticZ parameter API base url is not correctly filled. More infos on step 2 Plugin settings.
E7. Error when updating python module: Building wheel for cryptography (PEP 517) ... error
When doing the command pip3 install -r requirements.txt or python3 -m pip install -r requirements.txt --upgrade you get this error.
ERROR: Failed building wheel for cryptography
Failed to build cryptography
ERROR: Could not build wheels for cryptography which use PEP 517 and cannot be installed directly
-
upgrade or install the python module wheel
sudo python3 -m pip install wheel --upgrade - make sure your /tmp is large enough
- make sure you have enough swap, if requires , add some filesystem swap
E8. Error : pkg_resources.VersionConflict: (dnspython 2.3.0 (/usr/local/lib/python3.10/site-packages), Requirement.parse('dnspython==2.2.1'))
This error may appear when you change branch from develop to stable6 : the dnspython module level is not the same.
- Do the following command from the plugin home directory
sudo python3 -m pip install -r requirements.txt --upgrade
E9. Error : ImportError: PyO3 modules may only be initialized once per interpreter process
Status: Zigpy-Elelabs: Transport mode: ZigpyEZSP
Error: Zigpy-Elelabs: Call to function 'onStart' failed, exception details:
Error: Zigpy-Elelabs: Traceback (most recent call last):
Error: Zigpy-Elelabs: File "/var/lib/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 1537, in onStart
Error: Zigpy-Elelabs: _plugin.onStart()
Error: Zigpy-Elelabs: File "/var/lib/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 602, in onStart
Error: Zigpy-Elelabs: from zigpy.config import (CONF_DEVICE, CONF_DEVICE_PATH,
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/config/init.py", line 32, in <module>
Error: Zigpy-Elelabs: from zigpy.config.validators import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/config/validators.py", line 9, in <module>
Error: Zigpy-Elelabs: import zigpy.zdo.types as zdo_t
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/zdo/init.py", line 10, in <module>
Error: Zigpy-Elelabs: import zigpy.util
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/zigpy/util.py", line 14, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.primitives.ciphers import Cipher
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/hazmat/primitives/ciphers/init.py", line 11, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.primitives.ciphers.base import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/hazmat/primitives/ciphers/base.py", line 10, in <module>
Error: Zigpy-Elelabs: from cryptography.exceptions import (
Error: Zigpy-Elelabs: File "/usr/local/lib/python3.10/site-packages/cryptography/exceptions.py", line 9, in <module>
Error: Zigpy-Elelabs: from cryptography.hazmat.bindings.rust import exceptions as rustexceptions
Error: Zigpy-Elelabs: ImportError: PyO3 modules may only be initialized once per interpreter process
This is related to the fact that you are using a recent cryptography module. you can solve this issue by downgrading the cryptography module
sudo python3 -m pip install cryptography==40.0.2 --upgrade`
E10. Error : [WebServer] Deprecated RType (devices) for API request. Handled via fallback (getdevices), please use correct API Command!
This error comes with the API modification of DomoticZ 2023.2
You need to update to the plugin version 7 following the instructions.
E11. Error on installation under Debian 12 : This environment is externally managed. To install Python packages system-wide, try apt install python3-xyz...
The full error is :
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install python3-xyz, where xyz is the package you are trying to install.
If you wish to install a non-Debian-packaged Python package, create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make sure you have python3-full installed.
Operation under Debian 12 Bookworm needs to modify the installation command line by default by adding –break-system-packages at the end :
sudo pip3 install -r requirements.txt --break-system-packages
Reminder : This command line is only valid on Debian 12 Bookworm systems.
E12. Error : Error: <plugin's name> : ModuleNotFoundError: No module named 'cchardet'
This error appears when you have multiple plugin’s sessions and there is not the good charset-normalizer dependency version. It should be 2.0.12.
Check you version with the commande :
pip show charset-normalizer
or if you still using python2
pip3 show charset-normalizer
If the answer is not 2.0.12 then :
pip install --force-reinstall --upgrade charset-normalizer==2.0.12
or if you still using python2
pip3 install --force-reinstall --upgrade charset-normalizer==2.0.12
E13. Error : AttributeError: module 'lib' has no attribute 'OpenSSL_add_all_algorithms'
2024-04-16 18:31:06.519 Error: zig: (Zigate) failed to load 'plugin.py', Python Path used was '/home/ben/domoticz/plugins/Domoticz-Zigbee/:/usr/lib/python310.zip:/usr/lib/python3.10:/usr/lib/python3.10/lib-dynload:/usr/local/lib/python3.10/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.10/dist-packages'.
2024-04-16 18:31:06.523 Error: zig: Traceback (most recent call last):
2024-04-16 18:31:06.523 Error: zig: File "/home/ben/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 122, in <module>
2024-04-16 18:31:06.523 Error: zig: from Modules.checkingUpdate import (checkFirmwareUpdate, checkPluginUpdate,
2024-04-16 18:31:06.523 Error: zig: File "/home/ben/domoticz/plugins/Domoticz-Zigbee/Modules/checkingUpdate.py", line 14, in <module>
2024-04-16 18:31:06.523 Error: zig: import dns.resolver
2024-04-16 18:31:06.523 Error: zig: File "/usr/local/lib/python3.10/dist-packages/dns/resolver.py", line 39, in <module>
2024-04-16 18:31:06.523 Error: zig: import dns.query
2024-04-16 18:31:06.523 Error: zig: File "/usr/local/lib/python3.10/dist-packages/dns/query.py", line 48, in <module>
2024-04-16 18:31:06.523 Error: zig: from requests_toolbelt.adapters.source import SourceAddressAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/init.py", line 12, in <module>
2024-04-16 18:31:06.523 Error: zig: from .adapters import SSLAdapter, SourceAddressAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/init.py", line 12, in <module>
2024-04-16 18:31:06.523 Error: zig: from .ssl import SSLAdapter
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/ssl.py", line 16, in <module>
2024-04-16 18:31:06.523 Error: zig: from .._compat import poolmanager
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/requests_toolbelt/_compat.py", line 56, in <module>
2024-04-16 18:31:06.523 Error: zig: from requests.packages.urllib3.contrib.pyopenssl \
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/urllib3/contrib/pyopenssl.py", line 50, in <module>
2024-04-16 18:31:06.523 Error: zig: import OpenSSL.SSL
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/OpenSSL/init.py", line 8, in <module>
2024-04-16 18:31:06.523 Error: zig: from OpenSSL import crypto, SSL
2024-04-16 18:31:06.523 Error: zig: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 3279, in <module>
2024-04-16 18:31:06.523 Error: zig: lib.OpenSSLadd_all_algorithms()
2024-04-16 18:31:06.523 Error: zig: AttributeError: module 'lib' has no attribute 'OpenSSL_add_all_algorithms'
2024-04-16 18:32:14.294 Error: zig hardware (35) thread seems to have ended unexpectedly
it seems that the root cause is the conflicts between pyOpenSSL and Cryptography ref
sudo python3 -m pip install cryptography==38.0.4 --upgrade
E14. AttributeError: module ‘lib’ has no attribute ‘X509_V_FLAG_CB_ISSUER_CHECK
2024-04-24 12:29:41.998 Error: Zigbee: (Zigate) failed to load 'plugin.py', Python Path used was '/home/pi/domoticz/plugins/Domoticz-Zigbee/:/usr/lib/python39.zip:/usr/lib/python3.9:/usr/lib/python3.9/lib-dynload:/usr/local/lib/python3.9/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.9/dist-packages'.
2024-04-24 12:29:42.005 Error: Zigbee: Traceback (most recent call last):
2024-04-24 12:29:42.005 Error: Zigbee: File "/home/pi/domoticz/plugins/Domoticz-Zigbee/plugin.py", line 131, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from Modules.checkingUpdate import (checkFirmwareUpdate, checkPluginUpdate,
2024-04-24 12:29:42.005 Error: Zigbee: File "/home/pi/domoticz/plugins/Domoticz-Zigbee/Modules/checkingUpdate.py", line 14, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import dns.resolver
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/local/lib/python3.9/dist-packages/dns/resolver.py", line 39, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import dns.query
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/local/lib/python3.9/dist-packages/dns/query.py", line 48, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from requests_toolbelt.adapters.source import SourceAddressAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/init.py", line 12, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .adapters import SSLAdapter, SourceAddressAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/init.py", line 12, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .ssl import SSLAdapter
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/adapters/ssl.py", line 16, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from .._compat import poolmanager
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/requests_toolbelt/_compat.py", line 56, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from requests.packages.urllib3.contrib.pyopenssl \
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/urllib3/contrib/pyopenssl.py", line 50, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: import OpenSSL.SSL
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/init.py", line 8, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: from OpenSSL import crypto, SSL
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 1556, in <module>
2024-04-24 12:29:42.005 Error: Zigbee: class X509StoreFlags(object):
2024-04-24 12:29:42.005 Error: Zigbee: File "/usr/lib/python3/dist-packages/OpenSSL/crypto.py", line 1577, in X509StoreFlags
2024-04-24 12:29:42.005 Error: Zigbee: CB_ISSUER_CHECK = lib.X509V_FLAG_CB_ISSUER_CHECK
2024-04-24 12:29:42.005 Error: Zigbee: AttributeError: module 'lib' has no attribute 'X509_V_FLAG_CB_ISSUER_CHECK'
It could be related to mix between python module and installed library
sudo apt remove -y python3-openssl
E15. error: externally-managed-environment
error: externally-managed-environment
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.
For more information visit http://rptl.io/venv
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
The best is to use the Python virtual environment as described in Using Python Virtual Environment