deCONZ Docker Image
This Docker image containerizes the deCONZ software from Dresden Elektronik, which controls a ZigBee network using a Conbee USB or RaspBee GPIO serial interface. This image runs deCONZ in "minimal" mode, for control of the ZigBee network via the WebUIs ("Wireless Light Control" and "Phoscon") and over the REST API and Websockets, and optionally runs a VNC server for viewing and interacting with the ZigBee mesh through the deCONZ UI.
Conbee is supported on
arm64(i.e. RaspberryPi 2/3B/3B+, and other arm64 boards) architectures; RaspBee is supported on
arm64(and see the "Configuring Raspbian for RaspBee" section below for instructions to configure Raspbian to allow access to the RaspBee serial hardware).
Builds of this image are available on (and should be pulled from) Docker Hub, with the following tags:
|Tag|Description| |---|-----------| |marthoc/deconz:latest|Latest release of deCONZ, stable or beta| |marthoc/deconz:stable|Stable releases of deCONZ only| |marthoc/deconz:version|Specific versions of deCONZ, use only if you wish to pin your version of deCONZ| |marthoc/deconz:arch-test|Test builds of this image, not for use by end users, only for developer testing!|
The "latest", "stable", and "version" tags have multiarch support for amd64, armv7, and arm64, so specifying any of these tags will pull the correct version for your architecture.
Please consult Docker Hub for the latest available versions of this image.
Before running the command that creates the deconz Docker container, you may need to add your Linux user to the
dialoutgroup, which allows the user access to serial devices (i.e. Conbee/Conbee II/RaspBee/RaspBeeII):
sudo usermod -a -G dialout $USER
For a RaspBee/Raspbee 2 installation on a Raspberry PI 4B : Make sure to have Wiring Pi updated to the latest version!
sudo apt install wiringpi
docker run -d \ --name=deconz \ --net=host \ --restart=always \ -v /etc/localtime:/etc/localtime:ro \ -v /opt/deconz:/root/.local/share/dresden-elektronik/deCONZ \ --device=/dev/ttyUSB0 \ marthoc/deconz
|Parameter|Description| |---------|-----------| |
--name=deconz|Names the container "deconz".| |
--net=host|Uses host networking mode for proper uPNP functionality; by default, the web UIs and REST API listen on port 80 and the websockets service listens on port 443. If these ports conflict with other services on your host, you can change them through the environment variables DECONZWEBPORT and DECONZWSPORT described below.| |
--restart=always|Start the container when Docker starts (i.e. on boot/reboot).| |
-v /etc/localtime:/etc/localtime:ro|Ensure the container has the correct local time (alternatively, use the TZ environment variable, see below).| |
-v /opt/deconz:/root/.local/share/dresden-elektronik/deCONZ|Bind mount /opt/deconz (or the directory of your choice) into the container for persistent storage.| |
--device=/dev/ttyUSB0|Pass the serial device at ttyUSB0 into the container for use by deCONZ (you may need to investigate which device name is assigned to your device depending on if you are also using other usb serial devices; by default ConBee = /dev/ttyUSB0, Conbee II = /dev/ttyACM0, RaspBee = /dev/ttyAMA0 or /dev/ttyS0).| |
marthoc/deconz|This image uses a manifest list for multiarch support; specifying marthoc/deconz:latest or marthoc/deconz:stable will pull the correct version for your arch.|
Use these environment variables to change the default behaviour of the container.
|Parameter|Description| |---------|-----------| |
-e DECONZ_WEB_PORT=8080|By default, the web UIs ("Wireless Light Control" and "Phoscon") and the REST API listen on port 80; only set this environment variable if you wish to change the listen port.| |
-e DECONZ_WS_PORT=8443|By default, the websockets service listens on port 443; only set this environment variable if you wish to change the listen port.| |
-e DEBUG_INFO=1|Sets the level of the deCONZ command-line flag --dbg-info (default 1).| |
-e DEBUG_APS=0|Sets the level of the deCONZ command-line flag --dbg-aps (default 0).| |
-e DEBUG_ZCL=0|Sets the level of the deCONZ command-line flag --dbg-zcl (default 0).| |
-e DEBUG_ZDP=0|Sets the level of the deCONZ command-line flag --dbg-zdp (default 0).| |
-e DEBUG_OTAU=0|Sets the level of the deCONZ command-line flag --dbg-otau (default 0).| |
-e DECONZ_DEVICE=/dev/ttyUSB1|By default, deCONZ searches for RaspBee at /dev/ttyAMA0 and Conbee at /dev/ttyUSB0; when using other USB devices (e.g. a Z-Wave stick) deCONZ may not find RaspBee/Conbee properly. Set this environment variable to the same string passed to --device to force deCONZ to use the specific USB device.| |
-e TZ=America/Toronto|Set the local time zone so deCONZ has the correct time.| |
-e DECONZ_VNC_MODE=1|Set this option to enable VNC access to the container to view the deCONZ ZigBee mesh| |
-e DECONZ_VNC_PORT=5900|Default port for VNC mode is 5900; this option can be used to change this port| |
-e DECONZ_VNC_PASSWORD=changeme|Default password for VNC mode is 'changeme'; this option can (should) be used to change the default password| |
-e DECONZ_VNC_PASSWORD_FILE=/var/secrets/my_secret|Per default this is disabled and DECONZVNCPASSWORD is used. Details on creating secrets for use with Docker containers can be found in the corresponding section from the official documentation | |
-e DECONZ_NOVNC_PORT=6080|Default port for noVNC is 6080; this option can be used to change this port; setting the port to
0will disable the noVNC functionality| |
-e DECONZ_UPNP=0|Set this option to 0 to disable uPNP, see: https://github.com/dresden-elektronik/deconz-rest-plugin/issues/274|
A docker-compose.yml file is provided in the root of this image's GitHub repo. You may also copy/paste the following into your existing docker-compose.yml, modifying the options as required (omit the
serviceslines as your docker-compose.yml will already contain these).
version: "2" services: deconz: image: marthoc/deconz container_name: deconz network_mode: host restart: always volumes: - /opt/deconz:/root/.local/share/dresden-elektronik/deCONZ devices: - /dev/ttyUSB0 environment: - DECONZ_WEB_PORT=80 - DECONZ_WS_PORT=443 - DEBUG_INFO=1 - DEBUG_APS=0 - DEBUG_ZCL=0 - DEBUG_ZDP=0 - DEBUG_OTAU=0
Then, you can do
docker-compose pullto pull the latest marthoc/deconz image,
docker-compose up -dto start the deconz container service, and
docker-compose downto stop the deconz service and delete the container. Note that these commands will also pull, start, and stop any other services defined in docker-compose.yml.
--net=hostoption is not yet supported on Mac/Windows. To run this container on those platforms, explicitly specify the ports in the run command and omit
docker run -d \ --name=deconz \ -p 80:80 \ -p 443:443 \ --restart=always \ -v /opt/deconz:/root/.local/share/dresden-elektronik/deCONZ \ --device=/dev/ttyUSB0 \ -e DECONZ_WEB_PORT=80 \ -e DECONZ_WS_PORT=443 \ marthoc/deconz
Raspbian defaults Bluetooth to /dev/ttyAMA0 and configures a login shell over serial (tty). You must disable the tty login shell and enable the serial port hardware, and swap Bluetooth to /dev/S0, to allow RaspBee to work properly under Docker.
To disable the login shell over serial and enable the serial port hardware:
To swap Bluetooth to /dev/S0 (moving RaspBee to /dev/ttyAMA0), run the following command and then reboot:
`echo 'dtoverlay=pi3-miniuart-bt' | sudo tee -a /boot/config.txt`
After running the above command and rebooting, RaspBee should be available at /dev/ttyAMA0.
Firmware updates from the web UI will fail silently. Instead, an interactive utility script is provided as part of this Docker image that you can use to flash your device's firmware. The script has been tested and verified to work for Conbee on amd64 Debian linux and armhf Raspbian Stretch and RaspBee on armhf Raspbian Stretch.
Note, however, that this way of flashing the firmware is not guaranteed to work. If it does it will speed up the whole process. If it doesn't you just have to update the firmware manually as described here:
This could involve that you have to plug your device into another system where the deCONZ software runs without docker (i.e. windows).
The script calls the flashing tool
GCFFlasher_internalwhich will output any failures. In some situations the flasher runs successfully but deCONZ couldn't be started afterwards:
disconnected device. In all these cases you may start the process some more times and/or play with the parameters for
To use the script for updating the firmware, follow the below instructions:
docker logs [container name], and look for lines near the beginning of the log that look like this, noting the
.GCFfile name listed (you'll need this later):
GW update firmware found: /usr/share/deCONZ/firmware/deCONZ_Rpi_0x261e0500.bin.GCF GW firmware version: 0x261c0500 GW firmware version shall be updated to: 0x261e0500
docker stop [container name]
bash docker-compose down
docker run -it --rm --entrypoint "/firmware-update.sh" --privileged --cap-add=ALL -v /dev:/dev -v /lib/modules:/lib/modules -v /sys:/sys marthoc/deconz
If you have multiple usb devices, you can map the
/dev/...volume corresponding to your Conbee/Raspbee to avoid wrong path mapping.
docker run -it --rm --entrypoint "/firmware-update.sh" --privileged --cap-add=ALL -v /dev/serial/by-id/usb-dresden_elektronik_ingenieurtechnik_GmbH_ConBee_II_DExxxxxxx-if00:/dev/ttyACM0 -v /lib/modules:/lib/modules -v /sys:/sys marthoc/deconz
You could also put additional options to the end of this call:
bash docker run ... marthoc/deconz [option1] [value1] [option2] [value2] ...If these are valid options for the flashing tool they will be added to the call: |Option|Description|Default (if any)| |------|-----------|----------------| |
-f [firmware]|flash firmware file|| |
-d [device]|device number or path to use, e.g. 0, /dev/ttyUSB0 or RaspBee|The value of DECONZ_DEVICE| |
-t [timeout]|retry until timeout (seconds) is reached|60| |
-R [retries]|max. retries|| |
-x [loglevel]|debug log level 0, 1, 3||
Please note that the values for device and firmware-file are still asked by the script but your options are taken as default.
/dev/ttyUSB0) that corresponds to your device in the listing.
docker start [container name]
bash docker-compose up
Q: Why does the script give an error about not being able to unload modules ftdi_sio and usbserial, or that the device couldn't be rest?
A: In order to flash the device, no other program or device on the system can be using these kernel modules or the device. Stop any program/container that could be using the modules or device (likely deCONZ) and then invoke the script again. If the error persists, you may need to temporarily remove other USB serial devices from the system in order allow the script to completely unload the kernel modules.
Q: Why does a flash run fail after some seconds even if I specified a timeout much longer?
A: By setting a timeout you allowed the flashing tool to start as many runs as will fit into this period. The timeout of a single run can not be changed by parameters.
Setting the environment variable DECONZVNCMODE to 1 enables a VNC server in the container; connect to this VNC server with a VNC client to view the deCONZ ZigBee mesh. The environment variable DECONZVNCPORT allows you to control the port the VNC server listens on (default 5900); environment variable DECONZVNCPASSWORD allows you to set the password for the VNC server (default is 'changeme' and should be changed!).
Note that if you are not using --host networking, you will need to add a -p directive for the DECONZVNCPORT (i.e.
If VNC does not work and you see an error like the following in the container logs, you can resolve by incrementing the DECONZVNCPORT variable (i.e. to 5901 or 5902).
tigervncserver: /usr/bin/Xtigervnc did not start up, please look into '/root/.vnc/debian:0.log' to determine the reason! -2 Invalid MIT-MAGIC-COOKIE-1 keyqt.qpa.screen: QXcbConnection: Could not connect to display :0 Could not connect to any X display.
By enabling VNC, per default, you also enabled noVNC which allows you to connect using a browser. Per default the port is been set to 6080 and if you are not using "--host" networking you need to open the port using the -p directive. Access is through https://hostname:6080/vnc.html, this is a self signed SSL certificate so you need to accept it before you can access the page. If you do not want to enable noVNC, you can disable it using the environment variable
NoVNC acts as a proxy for the VNC server, meaning that if you disable VNC functionality, noVNC will not be available either.
The minimum port for DECONZVNCPORT must be 5900 or higher and the minimum port for DECONZNOVNCPORT must be 6080 or higher.
Firmware updates from the web UI will fail silently and the Conbee/RaspBee device will stay at its current firmware level. See "Updating Conbee/RaspBee Firmware" above for instructions to update your device's firmware when a new version is available.
If you are NOT using host networking (i.e.
--net=host), and wish to change the websocket port, make sure that both "ends" of the port directive (i.e.
-p) are changed to match the port specified in the
DECONZ_WS_PORTenvironment variable (otherwise, the websocket will not connect resulting in possibly no updating of lights, switches and sensors). For example, if you wish to change the websocket port to 4443, you must specify BOTH
-p 4443:4443in your
Over-the-air update functionality is currently untested.
Please raise any issues with this container at its GitHub repo: https://github.com/marthoc/docker-deconz. Please check the "Gotchas / Known Issues" section above before raising an Issue on GitHub in case the issue is already known.
To contribute, please fork the GitHub repo, create a feature branch, and raise a Pull Request; for simple changes/fixes, it may be more effective to raise an Issue instead.
marthoc/deconzfrom Docker Hub is the recommended way to obtain this image. However, you can build this image locally by:
git clone https://github.com/marthoc/docker-deconz.git cd docker-deconz docker build --build-arg VERSION=`[BUILD_VERSION]` --build-arg CHANNEL=`[BUILD_CHANNEL]` -t "[your-user/]deconz[:local]" ./[arch]
|Parameter|Description| |---------|-----------| |
[BUILD_VERSION]|The version of deCONZ you wish to build.| |
[BUILD_CHANNEL]|The channel (i.e. stable or beta) that corresponds to the deCONZ version you wish to build.| |
[your-user/]|Your username (optional).| |
deconz|The name you want the built Docker image to have on your system (default: deconz).| |
[local]|Adds the tag
:localto the image (to help differentiate between this image and your locally built image) (optional).| |
[arch]|The architecture you want to build for (currently supported options:
Note: VERSION and CHANNEL are required arguments and the image will fail to build if they are not specified.
Dresden Elektronik for making deCONZ and the Conbee and RaspBee hardware.
https://github.com/multiarch/qemu-user-static for making multi-arch builds on Travis CI possible.