Docs changes for "the big cleanup" pr

Koenkk · Oct 11, 2024 · a9acee5 · a9acee5
1 parent 2bbbe8a
commit a9acee5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 22 deletions.
diff --git a/docs/guide/configuration/device-availability.md b/docs/guide/configuration/device-availability.md
@@ -5,7 +5,7 @@ sidebarDepth: 1
 # Device-Availability
 
 The availability feature checks whether your devices are online. The availability state of a device is published
-to `zigbee2mqtt/[FRIENDLY_NAME]/availability` (this message is a retained MQTT message).
+to `zigbee2mqtt/[FRIENDLY_NAME]/availability` with payload `{"state":"online"}` or `{"state":"offline"}` (this message is a retained MQTT message).
 
 ```yaml
 # Optional: Enable the availability feature (default = false)
@@ -72,18 +72,6 @@ following attributes will be read: `state`, `brightness`, `color_temp` and `colo
 -   The pinging can be heavy on the coordinator, especially if you are using a CC2530 or CC2531 adapter.
 -   Higher `timeout` for active devices results in less pinging so less stress on the coordinator.
 
-## Availability payload
-
-By default the published availability payload is in legacy mode (`online`/`offline`). If the legacy mode is disabled the payload will be a JSON object (`{"state":"online"}`/`{"state":"offline"}`). Note that this changes the payload for `zigbee2mqtt/bridge/state` and `zigbee2mqtt/MY_DEVICE/availability`.
-
-```yaml
-advanced:
-    # Whether to use legacy mode for the availability message payload (default: true)
-    # true = online/offline
-    # false = {"state":"online"} / {"state":"offline"}
-    legacy_availability_payload: true
-```
-
 ## Groups
 
 When enabling device availability, availability will also be enabled for groups. A group is marked as available when at least one device in it is available.
diff --git a/docs/guide/configuration/mqtt.md b/docs/guide/configuration/mqtt.md
@@ -80,11 +80,6 @@ advanced:
     last_seen: 'disable'
     # Optional: Add an elapsed attribute to MQTT messages, contains milliseconds since the previous msg (default: false)
     elapsed: false
-    # Optional: Enables report feature, this feature is DEPRECATED since reporting is now setup by default
-    # when binding devices. Docs can still be found here: https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/information/report.md
-    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"}'

diff --git a/docs/guide/usage/mqtt_topics_and_messages.md b/docs/guide/usage/mqtt_topics_and_messages.md
@@ -117,10 +117,8 @@ Example payload:
 
 Contains the state of the bridge, this message is published as retained. Payloads are:
 
--   `online`: published when the bridge is running (on startup)
--   `offline`: published right before the bridge stops
-
-If `advanced.legacy_availability_payload` is set to `false` the payload will be a JSON object (`{"state":"online"}`/`{"state":"offline"}`).
+-   `{"state":"online"}`: published when the bridge is running (on startup)
+-   `{"state":"offline"}`: published right before the bridge stops
 
 ## zigbee2mqtt/bridge/logging