From 588e13c5a0956f8fa16879228e3e02b4168d00a9 Mon Sep 17 00:00:00 2001 From: Giorgio Ravera Date: Thu, 19 Jan 2023 01:49:04 +0100 Subject: [PATCH] Updated default configuration and aligned configuration.yaml to the new structure --- configuration.yaml | 209 ++++++++++++++++++------------------ configuration_default.yaml | 211 +++++++++++++++++++------------------ 2 files changed, 213 insertions(+), 207 deletions(-) diff --git a/configuration.yaml b/configuration.yaml index 669aa3b..5295abc 100644 --- a/configuration.yaml +++ b/configuration.yaml @@ -1,9 +1,3 @@ -# Optional: Home Assistant integration (MQTT discovery) (default: false) -homeassistant: true - -# Optional: allow new devices to join. -permit_join: false - # Required: serial settings serial: # Required: location of the adapter (e.g. CC2531). @@ -12,16 +6,20 @@ serial: port: 'tcp://pve.giorgioravera.it:20108' # Optional: disable LED of the adapter if supported (default: false) disable_led: true - # Optional: adapter type, not needed unless you are experiencing problems (default: shown below, options: zstack, deconz) + # Optional: adapter type, not needed unless you are experiencing problems (default: shown below, options: zstack, deconz, ezsp) #adapter: null + # Optional: Baud rate speed for serial port, this can be anything firmware support but default is 115200 for Z-Stack and EZSP, 38400 for Deconz, however note that some EZSP firmware need 57600. + #baudrate: 115200 + # Optional: RTS / CTS Hardware Flow Control for serial port (default: false) + #rtscts: false # Required: MQTT settings mqtt: - # Required: MQTT base topic for Zigbee2MQTT MQTT messages - base_topic: zigbee2mqtt # Required: MQTT server URL (use mqtts:// for SSL/TLS connection) server: 'mqtt://mqtt.giorgioravera.it' #server: 'mqtts://mqtt.giorgioravera.it:8883' + # Optional: MQTT base topic for Zigbee2MQTT MQTT messages + #base_topic: zigbee2mqtt # Optional: absolute path to SSL/TLS certificate of CA used to sign server and client certificates (default: nothing) #ca: '/etc/ssl/mqtt-ca.crt' # Optional: absolute paths to SSL/TLS key and certificate for client-authentication (default: nothing) @@ -47,34 +45,116 @@ mqtt: # Enabling will break the Home Assistant integration. (default: false) #force_disable_retain: false +# Optional: allow new devices to join. +permit_join: false + frontend: # Optional, default 8080 - port: 8080 + #port: 8080 # Optional, default 0.0.0.0 #host: 0.0.0.0 # Optional, enables authentication, disabled by default auth_token: '!secret auth_token' # Optional, url on which the frontend can be reached, currently only used for the Home Assistant device configuration page #url: 'https://zigbee2mqtt.myhouse.org' + # Optional, certificate file path for exposing HTTPS. The sibling property 'ssl_key' must be set for HTTPS to be activated + #ssl_cert: /config/etc/letsencrypt/live/mydomain.com/fullchain.pem + # Optional, private key file path for exposing HTTPS. The sibling property 'ssl_cert' must be set for HTTPS to be activated + #ssl_key: /config/etc/letsencrypt/live/mydomain.com/privkey.pem + +# Define default values which are applied to all devices +device_options: + retain: true + temperature_precision: 0 + humidity_precision: 0 + +# Define the files which contains the configs +devices: devices.yaml +groups: groups.yaml + +# Optional: Block devices from the network (by ieeeAddr) (default: empty) +#blocklist: +# - '0x000b57fffec6a5b2' + +# Optional: Allow only certain devices to join the network (by ieeeAddr) +# Note that all devices not on the passlist will be removed from the network! +# (default: empty) +#passlist: +# - '0x000b57fffec6a5b3' # Optional: OTA update settings # See https://www.zigbee2mqtt.io/guide/usage/ota_updates.html for more info #ota: + # Optional: use IKEA TRADFRI OTA test server, see OTA updates documentation (default: false) + #ikea_ota_use_test_url: false # Minimum time between OTA update checks #update_check_interval: 1440 # Disable automatic update checks #disable_automatic_update_check: false +# Optional: Enable the availability feature (default = false) +#availability: true + +# Note: all options are optional +#availability: + #active: + # Time after which an active device will be marked as offline in + # minutes (default = 10 minutes) + #timeout: 10 + #passive: + # Time after which a passive device will be marked as offline in + # minutes (default = 1500 minutes aka 25 hours) + #timeout: 1500 + +# Optional: Home Assistant integration (MQTT discovery) (default: false) +homeassistant: + # Optional: Home Assistant discovery topic (default: shown below) + #discovery_topic: 'homeassistant' + # Optional: Home Assistant status topic (default: shown below) + # Note: in addition to the `status_topic`, 'homeassistant/status' will also be used + #status_topic: 'hass/status' + # Optional: Home Assistant legacy entity attributes, (default: shown below), when enabled: + # Zigbee2MQTT will send additional states as attributes with each entity. For example, + # A temperature & humidity sensor will have 2 entities for the temperature and + # humidity, with this setting enabled both entities will also have + # an temperature and humidity attribute. + # Note: Disabling this option, requires a Home Assistant restart + legacy_entity_attributes: false + # Optional: Home Assistant legacy triggers (default: shown below), when enabled: + # - Zigbee2mqt will send an empty 'action' or 'click' after one has been send + # - A 'sensor_action' and 'sensor_click' will be discoverd + legacy_triggers: false + +# Optional: networkmap options +#map_options: + #graphviz: + # Optional: Colors to be used in the graphviz network map (default: shown below) + #colors: + #fill: + #enddevice: '#fff8ce' + #coordinator: '#e04e5d' + #router: '#4ea3e0' + #font: + #coordinator: '#ffffff' + #router: '#ffffff' + #enddevice: '#000000' + #line: + #active: '#009900' + #inactive: '#994444' + +# Optional, see 'External converters configuration' below +#external_converters: [] + # Optional: advanced settings advanced: - # Optional: Baud rate speed for serial port, this can be anything firmware support but default is 115200 for Z-Stack and EZSP, 38400 for Deconz, however note that some EZSP firmware need 57600. - #baudrate: 115200 - # Optional: RTS / CTS Hardware Flow Control for serial port (default: false) - #rtscts: false - # Optional: soft reset ZNP after timeout (in seconds); 0 is disabled (default: 0) - #soft_reset_timeout: 0 # Optional: configure adapter concurrency (e.g. 2 for CC2531 or 16 for CC26X2R1) (default: null, uses recommended value) #adapter_concurrent: null + # Optional: Transmit power setting in dBm (default: 5). + # This will set the transmit power for devices that bring an inbuilt amplifier. + # It can't go over the maximum of the respective hardware and might be limited + # by firmware (for example to migrate heat, or by using an unsupported firmware). + # For the CC2652R(B) this is 5 dBm, CC2652P/CC1352P-2 20 dBm. + #transmit_power: 5 # Optional: state caching, MQTT message payload will contain all attributes, not only changed ones. # Has to be true when integrating via Home Assistant (default: true) #cache_state: true @@ -92,6 +172,12 @@ advanced: #report: true # Optional: disables the legacy api (default: shown below) legacy_api: false + # Optional: MQTT output type: json, attribute or attribute_and_json (default: shown below) + # Examples when 'state' of a device is published + # json: topic: 'zigbee2mqtt/my_bulb' payload '{"state": "ON"}' + # attribute: topic 'zigbee2mqtt/my_bulb/state' payload 'ON" + # attribute_and_json: both json and attribute (see above) + #output: 'json' # Optional: ZigBee pan ID (default: shown below) # Setting pan_id: GENERATE will make Zigbee2MQTT generate a new panID on next startup pan_id: 0xbb41 @@ -132,90 +218,7 @@ advanced: # type: 5424 # The type of the syslog protocol to use (Default: BSD, also valid: 5424). # app_name: Zigbee2MQTT # The name of the application (Default: Zigbee2MQTT). # eol: '\n' # The end of line character to be added to the end of the message (Default: Message without modifications). - # Optional: use IKEA TRADFRI OTA test server, see OTA updates documentation (default: false) - #ikea_ota_use_test_url: false - # Optional: Home Assistant discovery topic (default: shown below) - #homeassistant_discovery_topic: 'homeassistant' - # Optional: Home Assistant status topic (default: shown below) - #homeassistant_status_topic: 'homeassistant/status' - # Optional: Home Assistant legacy entity attributes, (default: shown below), when enabled: - # Zigbee2MQTT will send additional states as attributes with each entity. For example, - # A temperature & humidity sensor will have 2 entities for the temperature and - # humidity, with this setting enabled both entities will also have - # an temperature and humidity attribute. - # Note: Disabling this option, requires a Home Assistant restart - homeassistant_legacy_entity_attributes: false - # Optional: Home Assistant legacy triggers (default: shown below), when enabled: - # - Zigbee2mqt will send an empty 'action' or 'click' after one has been send - # - A 'sensor_action' and 'sensor_click' will be discoverd - homeassistant_legacy_triggers: false - -# Optional: experimental options -#experimental: - # Optional: Transmit power setting in dBm (default: 5). - # This will set the transmit power for devices that bring an inbuilt amplifier. - # It can't go over the maximum of the respective hardware and might be limited - # by firmware (for example to migrate heat, or by using an unsupported firmware). - # For the CC2652R(B) this is 5 dBm, CC2652P/CC1352P-2 20 dBm. - #transmit_power: 5 - # Optional: MQTT output type: json, attribute or attribute_and_json (default: shown below) - # Examples when 'state' of a device is published - # json: topic: 'zigbee2mqtt/my_bulb' payload '{"state": "ON"}' - # attribute: topic 'zigbee2mqtt/my_bulb/state' payload 'ON" - # attribute_and_json: both json and attribute (see above) - #output: 'json' - -# Optional: Define default values which are applied to all devices -device_options: - retain: true - temperature_precision: 0 - humidity_precision: 0 - -# Optional: Define the files which contains the configs -devices: devices.yaml -groups: groups.yaml - -# Optional: Block devices from the network (by ieeeAddr) (default: empty) -# Previously called `ban` (which is deprecated) -#blocklist: -# - '0x000b57fffec6a5b2' - -# Optional: Allow only certain devices to join the network (by ieeeAddr) -# Note that all devices not on the passlist will be removed from the network! -# (default: empty) -# Previously called `whitelist` (which is deprecated) -#passlist: -# - '0x000b57fffec6a5b3' - -# Optional: Enable the availability feature (default = false) -#availability: true -# Note: all options are optional -#availability: - #active: - # Time after which an active device will be marked as offline in - # minutes (default = 10 minutes) - #timeout: 10 - #passive: - # Time after which a passive device will be marked as offline in - # minutes (default = 1500 minutes aka 25 hours) - #timeout: 1500 - -# Optional: networkmap options -#map_options: - #graphviz: - # Optional: Colors to be used in the graphviz network map (default: shown below) - #colors: - #fill: - #enddevice: '#fff8ce' - #coordinator: '#e04e5d' - #router: '#4ea3e0' - #font: - #coordinator: '#ffffff' - #router: '#ffffff' - #enddevice: '#000000' - #line: - #active: '#009900' - #inactive: '#994444' - -# Optional, see 'External converters configuration' below -#external_converters: [] + # Wether to use legacy mode for the availability message payload (default: true) + # true = online/offline + # false = {"state":"online"} / {"state":"offline"} + #legacy_availability_payload: true diff --git a/configuration_default.yaml b/configuration_default.yaml index 8d190f0..a151d2f 100644 --- a/configuration_default.yaml +++ b/configuration_default.yaml @@ -1,9 +1,3 @@ -# Optional: Home Assistant integration (MQTT discovery) (default: false) -homeassistant: true - -# Optional: allow new devices to join. -permit_join: true - # Required: serial settings serial: # Required: location of the adapter (e.g. CC2531). @@ -13,13 +7,17 @@ serial: disable_led: false # Optional: adapter type, not needed unless you are experiencing problems (default: shown below, options: zstack, deconz, ezsp) adapter: null + # Optional: Baud rate speed for serial port, this can be anything firmware support but default is 115200 for Z-Stack and EZSP, 38400 for Deconz, however note that some EZSP firmware need 57600. + baudrate: 115200 + # Optional: RTS / CTS Hardware Flow Control for serial port (default: false) + rtscts: false # Required: MQTT settings mqtt: - # Required: MQTT base topic for Zigbee2MQTT MQTT messages - base_topic: zigbee2mqtt # Required: MQTT server URL (use mqtts:// for SSL/TLS connection) server: 'mqtt://localhost:1883' + # Optional: MQTT base topic for Zigbee2MQTT MQTT messages (default: zigbee2mqtt) + base_topic: zigbee2mqtt # Optional: absolute path to SSL/TLS certificate of CA used to sign server and client certificates (default: nothing) ca: '/etc/ssl/mqtt-ca.crt' # Optional: absolute paths to SSL/TLS key and certificate for client-authentication (default: nothing) @@ -45,6 +43,9 @@ mqtt: # Enabling will break the Home Assistant integration. (default: false) force_disable_retain: false +# Optional: allow new devices to join. +permit_join: true + frontend: # Optional, default 8080 port: 8080 @@ -54,25 +55,106 @@ frontend: auth_token: your-secret-token # Optional, url on which the frontend can be reached, currently only used for the Home Assistant device configuration page url: 'https://zigbee2mqtt.myhouse.org' + # Optional, certificate file path for exposing HTTPS. The sibling property 'ssl_key' must be set for HTTPS to be activated + ssl_cert: /config/etc/letsencrypt/live/mydomain.com/fullchain.pem + # Optional, private key file path for exposing HTTPS. The sibling property 'ssl_cert' must be set for HTTPS to be activated + ssl_key: /config/etc/letsencrypt/live/mydomain.com/privkey.pem + +# Define default values which are applied to all devices +device_options: + retain: true + occupancy_timeout: 120 + no_occupancy_since: [ 10, 600 ] + +# Define the files which contains the configs +devices: devices.yaml +groups: groups.yaml + +# Optional: Block devices from the network (by ieeeAddr) (default: empty) +blocklist: + - '0x000b57fffec6a5b2' + +# Optional: Allow only certain devices to join the network (by ieeeAddr) +# Note that all devices not on the passlist will be removed from the network! +# (default: empty) +passlist: + - '0x000b57fffec6a5b3' # Optional: OTA update settings # See https://www.zigbee2mqtt.io/guide/usage/ota_updates.html for more info ota: + # Optional: use IKEA TRADFRI OTA test server, see OTA updates documentation (default: false) + ikea_ota_use_test_url: false # Minimum time between OTA update checks update_check_interval: 1440 # Disable automatic update checks disable_automatic_update_check: false +# Optional: Enable the availability feature (default = false) +availability: true + +# Note: all options are optional +availability: + active: + # Time after which an active device will be marked as offline in + # minutes (default = 10 minutes) + timeout: 10 + passive: + # Time after which a passive device will be marked as offline in + # minutes (default = 1500 minutes aka 25 hours) + timeout: 1500 + +# Optional: Home Assistant integration (MQTT discovery) (default: false) +homeassistant: + # Optional: Home Assistant discovery topic (default: shown below) + discovery_topic: 'homeassistant' + # Optional: Home Assistant status topic (default: shown below) + # Note: in addition to the `status_topic`, 'homeassistant/status' will also be used + status_topic: 'hass/status' + # Optional: Home Assistant legacy entity attributes, (default: shown below), when enabled: + # Zigbee2MQTT will send additional states as attributes with each entity. For example, + # A temperature & humidity sensor will have 2 entities for the temperature and + # humidity, with this setting enabled both entities will also have + # an temperature and humidity attribute. + # Note: Disabling this option, requires a Home Assistant restart + legacy_entity_attributes: true + # Optional: Home Assistant legacy triggers (default: shown below), when enabled: + # - Zigbee2mqt will send an empty 'action' or 'click' after one has been send + # - A 'sensor_action' and 'sensor_click' will be discoverd + legacy_triggers: true + +# Optional: networkmap options +map_options: + graphviz: + # Optional: Colors to be used in the graphviz network map (default: shown below) + colors: + fill: + enddevice: '#fff8ce' + coordinator: '#e04e5d' + router: '#4ea3e0' + font: + coordinator: '#ffffff' + router: '#ffffff' + enddevice: '#000000' + line: + active: '#009900' + inactive: '#994444' + +# Optional, see 'External converters configuration' below +external_converters: + - freepad_ext.js + - one-more-converter.js + # Optional: advanced settings advanced: - # Optional: Baud rate speed for serial port, this can be anything firmware support but default is 115200 for Z-Stack and EZSP, 38400 for Deconz, however note that some EZSP firmware need 57600. - baudrate: 115200 - # Optional: RTS / CTS Hardware Flow Control for serial port (default: false) - rtscts: false - # Optional: soft reset ZNP after timeout (in seconds); 0 is disabled (default: 0) - soft_reset_timeout: 0 # Optional: configure adapter concurrency (e.g. 2 for CC2531 or 16 for CC26X2R1) (default: null, uses recommended value) adapter_concurrent: null + # Optional: Transmit power setting in dBm (default: 5). + # This will set the transmit power for devices that bring an inbuilt amplifier. + # It can't go over the maximum of the respective hardware and might be limited + # by firmware (for example to migrate heat, or by using an unsupported firmware). + # For the CC2652R(B) this is 5 dBm, CC2652P/CC1352P-2 20 dBm. + transmit_power: 5 # Optional: state caching, MQTT message payload will contain all attributes, not only changed ones. # Has to be true when integrating via Home Assistant (default: true) cache_state: true @@ -90,6 +172,12 @@ advanced: report: true # Optional: disables the legacy api (default: shown below) legacy_api: true + # Optional: MQTT output type: json, attribute or attribute_and_json (default: shown below) + # Examples when 'state' of a device is published + # json: topic: 'zigbee2mqtt/my_bulb' payload '{"state": "ON"}' + # attribute: topic 'zigbee2mqtt/my_bulb/state' payload 'ON" + # attribute_and_json: both json and attribute (see above) + output: 'json' # Optional: ZigBee pan ID (default: shown below) # Setting pan_id: GENERATE will make Zigbee2MQTT generate a new panID on next startup pan_id: 0x1a62 @@ -98,7 +186,7 @@ advanced: # Optional: ZigBee channel, changing requires re-pairing of all devices. (Note: use a ZLL channel: 11, 15, 20, or 25 to avoid Problems) # (default: 11) channel: 11 - # Optional: network encryption key, will improve security + # Optional: network encryption key, will improve security # Note: changing requires repairing of all devices (default: shown below) network_key: [ 1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13 ] # Optional: Logging level, options: debug, info, warn, error (default: info) @@ -130,92 +218,7 @@ advanced: type: 5424 # The type of the syslog protocol to use (Default: BSD, also valid: 5424). app_name: Zigbee2MQTT # The name of the application (Default: Zigbee2MQTT). eol: '\n' # The end of line character to be added to the end of the message (Default: Message without modifications). - # Optional: use IKEA TRADFRI OTA test server, see OTA updates documentation (default: false) - ikea_ota_use_test_url: false - # Optional: Home Assistant discovery topic (default: shown below) - homeassistant_discovery_topic: 'homeassistant' - # Optional: Home Assistant status topic (default: shown below) - homeassistant_status_topic: 'homeassistant/status' - # Optional: Home Assistant legacy entity attributes, (default: shown below), when enabled: - # Zigbee2MQTT will send additional states as attributes with each entity. For example, - # A temperature & humidity sensor will have 2 entities for the temperature and - # humidity, with this setting enabled both entities will also have - # an temperature and humidity attribute. - # Note: Disabling this option, requires a Home Assistant restart - homeassistant_legacy_entity_attributes: true - # Optional: Home Assistant legacy triggers (default: shown below), when enabled: - # - Zigbee2mqt will send an empty 'action' or 'click' after one has been send - # - A 'sensor_action' and 'sensor_click' will be discoverd - homeassistant_legacy_triggers: true - -# Optional: experimental options -experimental: - # Optional: Transmit power setting in dBm (default: 5). - # This will set the transmit power for devices that bring an inbuilt amplifier. - # It can't go over the maximum of the respective hardware and might be limited - # by firmware (for example to migrate heat, or by using an unsupported firmware). - # For the CC2652R(B) this is 5 dBm, CC2652P/CC1352P-2 20 dBm. - transmit_power: 5 - # Optional: MQTT output type: json, attribute or attribute_and_json (default: shown below) - # Examples when 'state' of a device is published - # json: topic: 'zigbee2mqtt/my_bulb' payload '{"state": "ON"}' - # attribute: topic 'zigbee2mqtt/my_bulb/state' payload 'ON" - # attribute_and_json: both json and attribute (see above) - output: 'json' - -# Optional: Define default values which are applied to all devices -device_options: - retain: true - occupancy_timeout: 120 - no_occupancy_since: [ 10, 600 ] - -# Optional: Define the files which contains the configs -devices: devices.yaml -groups: groups.yaml - -# Optional: Block devices from the network (by ieeeAddr) (default: empty) -# Previously called `ban` (which is deprecated) -blocklist: - - '0x000b57fffec6a5b2' - -# Optional: Allow only certain devices to join the network (by ieeeAddr) -# Note that all devices not on the passlist will be removed from the network! -# (default: empty) -# Previously called `whitelist` (which is deprecated) -passlist: - - '0x000b57fffec6a5b3' - -# Optional: Enable the availability feature (default = false) -availability: true -# Note: all options are optional -availability: - active: - # Time after which an active device will be marked as offline in - # minutes (default = 10 minutes) - timeout: 10 - passive: - # Time after which a passive device will be marked as offline in - # minutes (default = 1500 minutes aka 25 hours) - timeout: 1500 - -# Optional: networkmap options -map_options: - graphviz: - # Optional: Colors to be used in the graphviz network map (default: shown below) - colors: - fill: - enddevice: '#fff8ce' - coordinator: '#e04e5d' - router: '#4ea3e0' - font: - coordinator: '#ffffff' - router: '#ffffff' - enddevice: '#000000' - line: - active: '#009900' - inactive: '#994444' - -# Optional, see 'External converters configuration' below -external_converters: - - freepad_ext.js - - one-more-converter.js + # Wether to use legacy mode for the availability message payload (default: true) + # true = online/offline + # false = {"state":"online"} / {"state":"offline"} + legacy_availability_payload: true \ No newline at end of file -- 2.47.3