xoxys.zigbee2mqtt_docker/index.md

6.1 KiB

title type
zigbee2mqtt docs

Source Code Build Status License: MIT

Setup zigbee2mqtt. Zigbee2mqtt allows you to use your Zigbee devices without the vendors bridge or gateway. It bridges events and allows you to control your Zigbee devices via MQTT.


Default Variables

zigbee2mqtt_base_dir

Default value

zigbee2mqtt_base_dir: /opt/zigbee2mqtt

zigbee2mqtt_cache_state

Default value

zigbee2mqtt_cache_state: true

zigbee2mqtt_channel

Default value

zigbee2mqtt_channel: 11

zigbee2mqtt_devices_ban

Default value

zigbee2mqtt_devices_ban: []

zigbee2mqtt_devices_whitelist

Default value

zigbee2mqtt_devices_whitelist: []

zigbee2mqtt_elapsed

Default value

zigbee2mqtt_elapsed: false

zigbee2mqtt_ext_pan_id

Default value

zigbee2mqtt_ext_pan_id: '[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]'

zigbee2mqtt_group

Default value

zigbee2mqtt_group: zigbee2mqtt

zigbee2mqtt_homeassistant_discovery_topic

Default value

zigbee2mqtt_homeassistant_discovery_topic: homeassistant

zigbee2mqtt_homeassistant_enabled

Default value

zigbee2mqtt_homeassistant_enabled: false

zigbee2mqtt_homeassistant_status_topic

Default value

zigbee2mqtt_homeassistant_status_topic: hass/status

zigbee2mqtt_last_seen

Default value

zigbee2mqtt_last_seen: disable

zigbee2mqtt_log_dir

Default value

zigbee2mqtt_log_dir: '{{ zigbee2mqtt_base_dir }}/log'

zigbee2mqtt_log_level

Default value

zigbee2mqtt_log_level: info

zigbee2mqtt_mqtt_base_topic

Default value

zigbee2mqtt_mqtt_base_topic: zigbee2mqtt

zigbee2mqtt_mqtt_client_id

Default value

zigbee2mqtt_mqtt_client_id: zigbee2mqtt

zigbee2mqtt_mqtt_include_device_information

Default value

zigbee2mqtt_mqtt_include_device_information: false

zigbee2mqtt_mqtt_password

Default value

zigbee2mqtt_mqtt_password: _unset_

zigbee2mqtt_mqtt_reject_unauthorized

Default value

zigbee2mqtt_mqtt_reject_unauthorized: false

zigbee2mqtt_mqtt_server

Default value

zigbee2mqtt_mqtt_server: mqtt://localhost:1883

zigbee2mqtt_mqtt_user

Default value

zigbee2mqtt_mqtt_user: _unset_

zigbee2mqtt_network_key

Default value

zigbee2mqtt_network_key: _unset_

Example usage

zigbee2mqtt_network_key: '[1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]'

zigbee2mqtt_pan_id

Default value

zigbee2mqtt_pan_id: '0x1a62'

zigbee2mqtt_permit_join

Default value

zigbee2mqtt_permit_join: true

zigbee2mqtt_report_enabled

Default value

zigbee2mqtt_report_enabled: false

zigbee2mqtt_secondary_groups

Default value

zigbee2mqtt_secondary_groups:
  - tty
  - dialout

zigbee2mqtt_serial_disable_led

Default value

zigbee2mqtt_serial_disable_led: false

zigbee2mqtt_serial_port

Default value

zigbee2mqtt_serial_port: _unset_

Example usage

zigbee2mqtt_serial_port: /dev/ttyACM0

zigbee2mqtt_service_restart_state

Default value

zigbee2mqtt_service_restart_state: restarted

zigbee2mqtt_service_state

Default value

zigbee2mqtt_service_state: started

zigbee2mqtt_user

Default value

zigbee2mqtt_user: zigbee2mqtt

zigbee2mqtt_version

Default value

zigbee2mqtt_version: 1.5.1

Dependencies

None.