List not supported features of adapters (#2919)

* List not supported features of adapters * Add supported settings
Koenkk · Aug 3, 2024 · 14ad26d · 14ad26d
1 parent 152232c
commit 14ad26d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 4 deletions.
diff --git a/docs/guide/adapters/deconz.md b/docs/guide/adapters/deconz.md
@@ -1,13 +1,24 @@
 # deCONZ (Dresden Elektronik)
 
+::: warning ATTENTION
+Various features are not supported by this adapter, in case you depend on these features, consider a different adapter.
+
+-   [Changing the channel](../configuration/zigbee-network.md#changing-the-zigbee-channel), changing requires re-pairing all devices.
+-   Adding [install codes](../../guide/usage/mqtt_topics_and_messages.md#zigbee2mqttbridgerequestinstall_codeadd), which is required to pair some devices.
+-   [Backups](../../guide/usage/mqtt_topics_and_messages.md#zigbee2mqttbridgerequestbackup)
+-   Inter-PAN, which is required for [touchlink](../../guide/usage/touchlink.md)
+-   Changing the [transmit power](../../guide/configuration/adapter-settings.md)
+
+:::
+
 ### Configuration
 
 ```yaml
 serial:
     adapter: deconz
 ```
 
-[Other settings](../configuration/adapter-settings.md)
+Other supported settings are: `adapter_concurrent` and `adapter_delay` ([docs](../configuration/adapter-settings.md)).
 
 ## Hardware
 

diff --git a/docs/guide/adapters/emberznet.md b/docs/guide/adapters/emberznet.md
@@ -17,7 +17,7 @@ serial:
     adapter: ember
 ```
 
-[Other settings](../configuration/adapter-settings.md)
+Other supported settings are: `adapter_concurrent` and `transmit_power` ([docs](../configuration/adapter-settings.md)).
 
 ::: tip TIP
 If you are experiencing issues with your adapter and it has hardware flow control support (check list below), try to flash a [firmware with hardware flow control disabled](https://github.com/darkxst/silabs-firmware-builder/tree/ember-nohw/firmware_builds/) and use the following setting instead:

diff --git a/docs/guide/adapters/zigate.md b/docs/guide/adapters/zigate.md
@@ -2,6 +2,16 @@
 
 Initial development started on experimental (alpha stage) support for various ZigGate adapters. This includes all ZiGate compatible hardware adapters which are currently based on NXP Zigbee MCU chips like JN5168 and JN5169 with ZigGate 3.1d firmware or later.
 
+::: warning ATTENTION
+Various features are not supported by this adapter, in case you depend on these features, consider a different adapter.
+
+-   [Changing the channel](../configuration/zigbee-network.md#changing-the-zigbee-channel), changing requires re-pairing all devices.
+-   Adding [install codes](../../guide/usage/mqtt_topics_and_messages.md#zigbee2mqttbridgerequestinstall_codeadd), which is required to pair some devices.
+-   [Backups](../../guide/usage/mqtt_topics_and_messages.md#zigbee2mqttbridgerequestbackup)
+-   Inter-PAN, which is required for [touchlink](../../guide/usage/touchlink.md)
+
+:::
+
 ::: warning ATTENTION
 zigbee-herdsman is looking for maintainers for the ZiGate adapter. See [https://github.com/Koenkk/zigbee-herdsman/issues/1037](https://github.com/Koenkk/zigbee-herdsman/issues/1037)
 :::
@@ -13,7 +23,7 @@ serial:
     adapter: zigate
 ```
 
-[Other settings](../configuration/adapter-settings.md)
+Other supported settings are: `adapter_concurrent` and `transmit_power` ([docs](../configuration/adapter-settings.md)).
 
 ## Hardware
 

diff --git a/docs/guide/adapters/zstack.md b/docs/guide/adapters/zstack.md
@@ -7,7 +7,7 @@ serial:
     adapter: zstack
 ```
 
-[Other settings](../configuration/adapter-settings.md)
+Other supported settings are: `disable_led`, `adapter_concurrent` and `transmit_power` ([docs](../configuration/adapter-settings.md)).
 
 ### Firmware flashing
 

diff --git a/docs/guide/configuration/adapter-settings.md b/docs/guide/configuration/adapter-settings.md
@@ -4,6 +4,10 @@ sidebarDepth: 1
 
 # Adapter settings
 
+::: warning ATTENTION
+Not all features are supported for every adapter, to see what's supported, go to your [adapter page](../../guide/adapters/README.md).
+:::
+
 ## Configuration of the Zigbee adapter
 
 For USB apdaters you can use `dmesg` command on Linux hosts to find the mounted device. Where possible you should use the `/dev/serial/by-id/` path of the stick, instead of `/dev/tty*`. This is because the `/dev/tty*` path can change - for example `/dev/ttyACM0` may become `/dev/ttyACM1` and then later back to `/dev/ttyACM0`. The `/dev/serial/by-id/` path won't change.