Skip to content

deCONZ command line parameters

Manuel Pietschmann edited this page Oct 20, 2022 · 11 revisions

General purpose parameters

dev=<Device>

This parameter can be used to tie a dedicated tty to deCONZ.

Example: /usr/bin/deCONZ --dev=/dev/ttyAMA0

dev-test-managed

This parameter can be used to start deCONZ in hybrid mode. Devices can be joined and their data processed based on DDFs, if available.

Example: /usr/bin/deCONZ --dev-test-managed=1

always-add-lights

New lights will always be added, regardless if joining is allowed or not.

Example: /usr/bin/deCONZ --always-add-lights=1

auto-connect

This parameter can be used to instruct deCONZ to automatically connect to a hardware device and start.

Example: /usr/bin/deCONZ --dev=/dev/ttyAMA0 --auto-connect=1

platform minimal

In case you want to start headless, use this parameter. In case you want to have access to deCONZ' GUI, just leave this parameter out. Note: This parameter has only one dash -.

Example: /usr/bin/deCONZ -platform minimal --auto-connect=1

http-listen=<listen interface IP>

Pin deCONZ to the network interface specified through the provided IP address. By default (so if not explicitly provided), this is set to 0.0.0.0 to listen on any interface. This applies for the webserver as well as the websocket notifications.

http-port=<Port>

This parameter explicitly specifies the HTTP port for deCONZ webserver to use.

Example: /usr/bin/deCONZ --http-port=8080

http-root

ws-port=<Port>

This parameter explicitly specifies the websocket port for deCONZ to use.

Example: /usr/bin/deCONZ --http-port=8080 --ws-port=8081

read-reg-interval

read-reg

baudrate

zdp-aps-ack

mgtmlqi-delay

appdata=<Config Folder>

Command line switch for alternate config location (e.g. to test a setup or two ConBee running on the same machine).

Example: /usr/bin/deCONZ --appdata=/home/deconz/

Available debug parameters

deCONZ can generate quite a lot of different debug output depending on the individual needs and requirements. This overview is intended to briefly explain what kind of information the individual switches provide and what available levels they have.

Note: Starting with v2.5.88 debug logs can be enabled and shown directly in the deCONZ UI via Help → Debug view on Windows and Linux.

Assuming you run a pure Raspbian with no middleware requiring or taking care of any deCONZ configuration, the switches can be used as follows:

/usr/bin/deCONZ --dbg-info=2

To write the output to a file, simply do:

/usr/bin/deCONZ --dbg-info=2 > debug.txt

You can add multiple switches, separated by a space. If you are using headless mode, don't forget to add -platform minimal to the command line.

dbg-info

Available levels: 1 or 2

This is the most comprehensive source of information for what is currently going on in deCONZ. It already provides lots of information on level 1, but sometimes in brevity and some data is spared out (node descriptor patching, full payloads, IAS enrollment, etc.). Therefore, if any debugging is required, it's always recommended to use level 2. The used level impacts the level of detail (the higher the level, the more information is provided).

Example: /usr/bin/deCONZ --dbg-info=2

dbg-error

Available levels: 1 or 2

This switch provides elaborate information when any errors are encountered while running deCONZ. The used level impacts the level of detail (the higher the level, the more information is provided).

Example: /usr/bin/deCONZ --dbg-error=2

dbg-ddf

Available levels: 1

This switch provides elaborate information on DDF usage and respective item processing via JS code.

Example: /usr/bin/deCONZ --dbg-ddf=1

dbg-dev

Available levels: 1

This switch provides elaborate information for general/basic zigbee activities for a device using a DDF (e.g. bindings, ZDP activities, reporting configuration).

Example: /usr/bin/deCONZ --dbg-dev=1

dbg-aps

Available levels: 1 or 2

This switch provides further insights on the APS packages received by deCONZ. It may help to gain a better understanding which clusters and commands are involved in communication.The used level impacts the level of detail (the higher the level, the more information is provided).

Example: /usr/bin/deCONZ --dbg-aps=2

dbg-ota

Available levels: 1

Use this switch to get any information regarding the STD OTAU plugin which is involved in updating device firmware.

Example: /usr/bin/deCONZ --dbg-ota=1

dbg-prot

Available levels: 1 or 2

This switch provides debug output of low level serial port communication. The used level impacts the level of detail (the higher the level, the more information is provided).

Example: /usr/bin/deCONZ --dbg-prot=1

dbg-wire

Available levels: 1

Example: /usr/bin/deCONZ --dbg-wire=1

dbg-zdp

Available levels: 1

This switch provides details for the ZDP layer commands, like discovering the mesh network neighbor tables, query node/simple descriptors and active endpoints.

Example: /usr/bin/deCONZ --dbg-zdp=1

dbg-zcl

Available levels: 1

Example: /usr/bin/deCONZ --dbg-zcl=1

dbg-zcldb

Available levels: 1

This switch allows debugging the processing of ZCLDB database, which is mainly represented by the general.xml file.

Example: /usr/bin/deCONZ --dbg-zcldb=1

dbg-http

Available levels: 1

This switch allows debugging the processing of http request.

Example: /usr/bin/deCONZ --dbg-http=1

dbg-tlink

Available levels: 1

This switch enabled debug output for the Touchlink feature. Currently, only supported by ConBee I and RaspBee I.

Example: /usr/bin/deCONZ --dbg-tlink=1

Clone this wiki locally