fix(config): correct firmware warnings for Zooz controllers (#6433)

zwave-js · Oct 19, 2023 · f8bc7b8 · f8bc7b8
1 parent 5f18fa7
commit f8bc7b8
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 23 deletions.
diff --git a/maintenance/schemas/device-config.json b/maintenance/schemas/device-config.json
@@ -717,6 +717,7 @@
 				"$if": {
 					"$ref": "#/definitions/condition"
 				},
+				"$import": { "$ref": "#/definitions/import" },
 				"level": {
 					"type": "string",
 					"enum": ["info", "warning", "error"]
@@ -727,7 +728,14 @@
 				}
 			},
 			"additionalProperties": false,
-			"required": ["level", "text"]
+			"anyOf": [
+				{
+					"required": ["level", "text"]
+				},
+				{
+					"required": ["$import"]
+				}
+			]
 		}
 	}
 }
diff --git a/packages/config/config/devices/0x0000/700_series_controller.json b/packages/config/config/devices/0x0000/700_series_controller.json
@@ -16,6 +16,19 @@
 	},
 	"metadata": {
 		// 700/800 series firmware bugs that affect multiple controllers
-		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
+		"comments": [
+			{
+				"$if": "firmwareVersion < 7.17.2",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_pre_7_17_2"
+			},
+			{
+				"$if": "firmwareVersion === 7.19.1",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_1"
+			},
+			{
+				"$if": "firmwareVersion === 7.19.3",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_3"
+			}
+		]
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zac93.json b/packages/config/config/devices/0x027a/zac93.json
@@ -15,6 +15,16 @@
 	},
 	"metadata": {
 		// 700/800 series firmware bugs that affect multiple controllers
-		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
+		"comments": [
+			// https://www.support.getzooz.com/kb/article/1158-zooz-ota-firmware-files/
+			// These controllers started shipping with 7.18.1:
+			// 1.1 = 7.18.1
+			// (1.3 = 1.4 = 1.10) = 7.18.3
+			// 1.20 = 7.19.3
+			{
+				"$if": "firmwareVersion === 1.20",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_3"
+			}
+		]
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zst10_700.json b/packages/config/config/devices/0x027a/zst10_700.json
@@ -15,6 +15,19 @@
 	},
 	"metadata": {
 		// 700/800 series firmware bugs that affect multiple controllers
-		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
+		"comments": [
+			{
+				"$if": "firmwareVersion < 7.17.2",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_pre_7_17_2"
+			},
+			{
+				"$if": "firmwareVersion === 7.19.1",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_1"
+			},
+			{
+				"$if": "firmwareVersion === 7.19.3",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_3"
+			}
+		]
 	}
 }
diff --git a/packages/config/config/devices/0x027a/zst39lr.json b/packages/config/config/devices/0x027a/zst39lr.json
@@ -15,6 +15,16 @@
 	},
 	"metadata": {
 		// 700/800 series firmware bugs that affect multiple controllers
-		"$import": "~/templates/master_template.json#7xx_firmware_bugs"
+		"comments": [
+			// https://www.support.getzooz.com/kb/article/1352-zst39-800-long-range-z-wave-stick-change-log/
+			// These controllers started shipping with 7.18.1:
+			// 1.1 = 7.18.1
+			// (1.3 = 1.4 = 1.10) = 7.18.3
+			// 1.20 = 7.19.3
+			{
+				"$if": "firmwareVersion === 1.20",
+				"$import": "~/templates/master_template.json#7xx_firmware_bug_7_19_3"
+			}
+		]
 	}
 }
diff --git a/packages/config/config/devices/templates/master_template.json b/packages/config/config/devices/templates/master_template.json
@@ -657,24 +657,17 @@
 			}
 		]
 	},
-	"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."
-			}
-		]
+	"7xx_firmware_bug_pre_7_17_2": {
+		"level": "warning",
+		"text": "Early 700 series 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 SDK version 7.17.2.\nDirections for upgrading the firmware can be found at https://zwave-js.github.io/node-zwave-js/#/troubleshooting/otw-upgrade"
+	},
+	"7xx_firmware_bug_7_19_1": {
+		"level": "warning",
+		"text": "Controller firmwares based on Z-Wave SDK 7.19.1 have a bug that causes the controller to randomly restart. It is strongly recommended to update to a firmware based on version 7.19.2, but not later since those firmwares have another bug causing the controller to become unresponsive."
+	},
+	"7xx_firmware_bug_7_19_3": {
+		"level": "warning",
+		"text": "Controller firmwares based on Z-Wave SDK 7.19.3 have 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."
 	},
 	"500_series_controller_compat_flags": {
 		// It seems that all 500 series controllers have a firmware bug: