From 0fe1e22c332a7e9f3f4d4565a86c3cbf19f5bdb4 Mon Sep 17 00:00:00 2001
From: Dominic Griesel <dominic.griesel@nabucasa.com>
Date: Wed, 20 Sep 2023 11:16:20 +0200
Subject: [PATCH] fix(config): add warnings about broken controller firmware
 versions

---
 maintenance/schemas/device-config.json        |  3 ++-
 .../devices/0x0000/700_series_controller.json |  9 ++-------
 .../config/config/devices/0x027a/zac93.json   |  4 ++++
 .../config/devices/0x027a/zst10_700.json      |  4 ++++
 .../config/config/devices/0x027a/zst39lr.json |  4 ++++
 .../devices/templates/master_template.json    | 19 +++++++++++++++++++
 6 files changed, 35 insertions(+), 8 deletions(-)

diff --git a/maintenance/schemas/device-config.json b/maintenance/schemas/device-config.json
index 5145a10ba07a..cc41d9a053e4 100644
--- a/maintenance/schemas/device-config.json
+++ b/maintenance/schemas/device-config.json
@@ -1,5 +1,5 @@
 {
-	"$schema": "http://json-schema.org/schema#",
+	"$schema": "https://json-schema.org/draft-07/schema",
 	"type": "object",
 	"properties": {
 		"$import": { "$ref": "#/definitions/import" },
@@ -99,6 +99,7 @@
 		"metadata": {
 			"type": "object",
 			"properties": {
+				"$import": { "$ref": "#/definitions/import" },
 				"wakeup": {
 					"$ref": "#/definitions/conditionalString",
 					"description": "How to wake up the device manually"
diff --git a/packages/config/config/devices/0x0000/700_series_controller.json b/packages/config/config/devices/0x0000/700_series_controller.json
index 6134c4fe4938..26c709f760c3 100644
--- a/packages/config/config/devices/0x0000/700_series_controller.json
+++ b/packages/config/config/devices/0x0000/700_series_controller.json
@@ -15,12 +15,7 @@
 		"max": "255.255"
 	},
 	"metadata": {
-		"comments": [
-			{
-				"$if": "firmwareVersion < 7.17.2",
-				"level": "warning",
-				"text": "Early firmware revisions had a bug that could cause the mesh to be flooded on some networks and the controller to become unresponsive. It appears that this bug is largely, if not completely, resolved as of firmware version 7.17.2.\nDirections for upgrading the firmware can be found at https://zwave-js.github.io/node-zwave-js/#/troubleshooting/otw-upgrade"
-			}
-		]
+		// 700/800 series firmware bugs that affect multiple controllers
+		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zac93.json b/packages/config/config/devices/0x027a/zac93.json
index c83a39df8f68..c1e4705a406f 100644
--- a/packages/config/config/devices/0x027a/zac93.json
+++ b/packages/config/config/devices/0x027a/zac93.json
@@ -12,5 +12,9 @@
 	"firmwareVersion": {
 		"min": "0.0",
 		"max": "255.255"
+	},
+	"metadata": {
+		// 700/800 series firmware bugs that affect multiple controllers
+		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zst10_700.json b/packages/config/config/devices/0x027a/zst10_700.json
index 29a607916ca7..1d4fdd54b3b6 100644
--- a/packages/config/config/devices/0x027a/zst10_700.json
+++ b/packages/config/config/devices/0x027a/zst10_700.json
@@ -12,5 +12,9 @@
 	"firmwareVersion": {
 		"min": "0.0",
 		"max": "255.255"
+	},
+	"metadata": {
+		// 700/800 series firmware bugs that affect multiple controllers
+		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zst39lr.json b/packages/config/config/devices/0x027a/zst39lr.json
index a0fa490032d5..c0f01f50cf66 100644
--- a/packages/config/config/devices/0x027a/zst39lr.json
+++ b/packages/config/config/devices/0x027a/zst39lr.json
@@ -12,5 +12,9 @@
 	"firmwareVersion": {
 		"min": "0.0",
 		"max": "255.255"
+	},
+	"metadata": {
+		// 700/800 series firmware bugs that affect multiple controllers
+		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
 	}
 }
diff --git a/packages/config/config/devices/templates/master_template.json b/packages/config/config/devices/templates/master_template.json
index 6e8dd9483aa5..178f0c7a487a 100644
--- a/packages/config/config/devices/templates/master_template.json
+++ b/packages/config/config/devices/templates/master_template.json
@@ -656,5 +656,24 @@
 				"value": 1
 			}
 		]
+	},
+	"7xx_firmware_bugs": {
+		"comments": [
+			{
+				"$if": "firmwareVersion < 7.17.2",
+				"level": "warning",
+				"text": "Early firmware revisions had a bug that could cause the mesh to be flooded on some networks and the controller to become unresponsive. It appears that this bug is largely, if not completely, resolved as of firmware version 7.17.2.\nDirections for upgrading the firmware can be found at https://zwave-js.github.io/node-zwave-js/#/troubleshooting/otw-upgrade"
+			},
+			{
+				"$if": "firmwareVersion == 7.19.1",
+				"level": "warning",
+				"text": "Firmware version 7.19.1 has a bug that causes the controller to randomly restart. It is strongly recommended to update to firmware 7.19.2, but not later since those firmwares have another bug causing the controller to become unresponsive."
+			},
+			{
+				"$if": "firmwareVersion == 7.19.3",
+				"level": "warning",
+				"text": "Firmware version 7.19.3 has a bug that causes the controller to randomly hang during transmission until it is restarted. It is currently unclear if this bug is fixed in a later firmware version."
+			}
+		]
 	}
 }