chore: add ESLint rule to enforce consistency in device config files …

…and prevent some common errors (#6345)
zwave-js · Oct 11, 2023 · 8fcdc40 · 8fcdc40
1 parent f54a9ac
commit 8fcdc40
Show file tree

Hide file tree

Showing 957 changed files with 9,239 additions and 12,140 deletions.
diff --git a/packages/config/config/.eslintrc.js b/packages/config/config/.eslintrc.js
@@ -8,9 +8,5 @@ module.exports = {
 	plugins: [
 		"@zwave-js",
 	],
-	rules: {
-		"@zwave-js/consistent-device-config-property-order": "error",
-		"@zwave-js/no-unnecessary-min-max-value": "error",
-		"@zwave-js/auto-unsigned": "error",
-	}
+	extends: "plugin:@zwave-js/config-files"
 };
diff --git a/packages/config/config/devices/0x0000/ps9ep.json b/packages/config/config/devices/0x0000/ps9ep.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Sigma Designs (Former Zensys)",
 	"manufacturerId": "0x0000",
 	"label": "PS9EP",
-	"description": "Z-wave 9 channel_module",
+	"description": "Z-Wave 9 Channel_module",
 	"devices": [
 		{
 			"productType": "0x0003",

diff --git a/packages/config/config/devices/0x0000/sm-pz701u.json b/packages/config/config/devices/0x0000/sm-pz701u.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Sigma Designs (Former Zensys)",
 	"manufacturerId": "0x0000",
 	"label": "SM-PZ701U",
-	"description": "Z-Wave power plug",
+	"description": "Z-Wave Power Plug",
 	"devices": [
 		{
 			"productType": "0x0003",

diff --git a/packages/config/config/devices/0x0000/yrl220.json b/packages/config/config/devices/0x0000/yrl220.json
@@ -46,7 +46,7 @@
 		},
 		{
 			"#": "2",
-			"label": "Auto Re-lock",
+			"label": "Auto Re-Lock",
 			"description": "When enabled, the unit will automatically re-lock",
 			"valueSize": 1,
 			"defaultValue": 0,
@@ -65,10 +65,10 @@
 		},
 		{
 			"#": "3",
-			"label": "Re-lock Time",
+			"label": "Re-Lock Time",
 			"description": "Time after unlocking that the device will lock",
 			"valueSize": 1,
-			"unit": "Seconds",
+			"unit": "seconds",
 			"minValue": 5,
 			"maxValue": 255,
 			"defaultValue": 30,
@@ -110,7 +110,7 @@
 			"label": "Shutdown Time",
 			"description": "Number of times the device is locked out after the invalid retries are exceeded",
 			"valueSize": 1,
-			"unit": "Seconds",
+			"unit": "seconds",
 			"minValue": 1,
 			"maxValue": 255,
 			"defaultValue": 30,
@@ -129,11 +129,11 @@
 					"value": 0
 				},
 				{
-					"label": "Vacation Mode",
+					"label": "Vacation mode",
 					"value": 1
 				},
 				{
-					"label": "Privacy Mode",
+					"label": "Privacy mode",
 					"value": 2
 				}
 			]

diff --git a/packages/config/config/devices/0x0001/zrm230.json b/packages/config/config/devices/0x0001/zrm230.json
@@ -2,7 +2,7 @@
 	"manufacturer": "HomePro",
 	"manufacturerId": "0x0001",
 	"label": "ZRM230",
-	"description": "Wall Switch/Transmitter (2-gang)",
+	"description": "Wall Switch/Transmitter (2-Gang)",
 	"devices": [
 		{
 			"productType": "0x524d",

diff --git a/packages/config/config/devices/0x0002/014g0210.json b/packages/config/config/devices/0x0002/014g0210.json
@@ -60,7 +60,7 @@
 		},
 		{
 			"#": "3",
-			"label": "PWM period",
+			"label": "PWM Period",
 			"description": "Pulse-width modulation period",
 			"valueSize": 1,
 			"defaultValue": 2,

diff --git a/packages/config/config/devices/0x0002/dthermz5.json b/packages/config/config/devices/0x0002/dthermz5.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Danfoss",
 	"manufacturerId": "0x0002",
 	"label": "DTHERMZ5",
-	"description": "Z-Wave room sensor",
+	"description": "Z-Wave Room Sensor",
 	"devices": [
 		{
 			"productType": "0x0248",
@@ -17,16 +17,16 @@
 	"paramInformation": [
 		{
 			"#": "1",
-			"label": "Temperature Report threshold",
+			"label": "Temperature Report Threshold",
 			"valueSize": 2,
 			"minValue": 1,
 			"maxValue": 100,
 			"defaultValue": 5
 		},
 		{
 			"#": "2",
-			"label": "Set-point display resolution",
-			"description": "range from 0.1 to 10°C 1=0.1°C 100=10°C",
+			"label": "Set-Point Display Resolution",
+			"description": "range from 0.1 to 10 °C 1=0.1 °C 100=10 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 1,
@@ -35,8 +35,8 @@
 		},
 		{
 			"#": "3",
-			"label": "Min Set-point and override limit",
-			"description": "from min 0°C to max setpoint override limit 0=0°C 40=40°C",
+			"label": "Min Set-Point and Override Limit",
+			"description": "from min 0 °C to max setpoint override limit 0=0 °C 40=40 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 0,
@@ -45,8 +45,8 @@
 		},
 		{
 			"#": "4",
-			"label": "Max Set-point and override limit",
-			"description": "from min setpoint override limit to max 40°C 0=0°C 40=40°C",
+			"label": "Max Set-Point and Override Limit",
+			"description": "from min setpoint override limit to max 40 °C 0=0 °C 40=40 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 0,
@@ -55,7 +55,7 @@
 		},
 		{
 			"#": "5",
-			"label": "LED Flash period",
+			"label": "LED Flash Period",
 			"description": "0 to 65535 seconds",
 			"valueSize": 4,
 			"unit": "seconds",
@@ -65,46 +65,19 @@
 		},
 		{
 			"#": "6",
-			"label": "Set-point control function",
-			"description": "0=Disabled 1=Enabled",
-			"valueSize": 1,
-			"unit": "int",
-			"defaultValue": 1,
-			"allowManualEntry": false,
-			"options": [
-				{
-					"label": "disabled",
-					"value": 0
-				},
-				{
-					"label": "enabled",
-					"value": 1
-				}
-			]
+			"$import": "~/templates/master_template.json#base_enable_disable",
+			"label": "Set-Point Control Function",
+			"defaultValue": 1
 		},
 		{
 			"#": "7",
-			"label": "Temporarily override scheduler",
-			"description": "0=Disabled 1=Enabled",
-			"valueSize": 1,
-			"unit": "int",
-			"defaultValue": 1,
-			"allowManualEntry": false,
-			"options": [
-				{
-					"label": "disabled",
-					"value": 0
-				},
-				{
-					"label": "enabled",
-					"value": 1
-				}
-			]
+			"$import": "~/templates/master_template.json#base_enable_disable",
+			"label": "Temporarily Override Scheduler",
+			"defaultValue": 1
 		},
 		{
 			"#": "8",
-			"label": "Set-point type in Thermostat_Setpoint_Reports",
-			"description": "1=Heating 2=Cooling 10=Auto Changeover",
+			"label": "Set-Point Type in Thermostat_Setpoint_Reports",
 			"valueSize": 1,
 			"defaultValue": 1,
 			"allowManualEntry": false,
@@ -125,7 +98,7 @@
 		},
 		{
 			"#": "9",
-			"label": "LED on time",
+			"label": "LED On Time",
 			"description": "1=100ms 5=500ms",
 			"valueSize": 2,
 			"minValue": 1,
@@ -134,7 +107,7 @@
 		},
 		{
 			"#": "10",
-			"label": "Number of LED flashes (duration)",
+			"label": "Number of LED Flashes (Duration)",
 			"description": "0 to 255",
 			"valueSize": 1,
 			"minValue": 0,
@@ -144,7 +117,7 @@
 		},
 		{
 			"#": "11",
-			"label": "LED color",
+			"label": "LED Color",
 			"description": "1=Green 2=Red",
 			"valueSize": 1,
 			"defaultValue": 1,

diff --git a/packages/config/config/devices/0x0002/keemple_smart_radiator.json b/packages/config/config/devices/0x0002/keemple_smart_radiator.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Danfoss",
 	"manufacturerId": "0x0002",
 	"label": "Keemple smart radiator",
-	"description": "Electronic radiator thermostat, intended for use with water based room radiators.",
+	"description": "Electronic Radiator Thermostat, Intended for Use with Water Based Room Radiators.",
 	"devices": [
 		{
 			"productType": "0x5fff",

diff --git a/packages/config/config/devices/0x0002/mt_2649.json b/packages/config/config/devices/0x0002/mt_2649.json
@@ -24,16 +24,16 @@
 	"paramInformation": [
 		{
 			"#": "1",
-			"label": "Temperature Report threshold",
+			"label": "Temperature Report Threshold",
 			"valueSize": 2,
 			"minValue": 1,
 			"maxValue": 100,
 			"defaultValue": 5
 		},
 		{
 			"#": "2",
-			"label": "Set-point display resolution",
-			"description": "range from 0.1 to 10°C 1=0.1°C 100=10°C",
+			"label": "Set-Point Display Resolution",
+			"description": "range from 0.1 to 10 °C 1=0.1 °C 100=10 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 1,
@@ -42,8 +42,8 @@
 		},
 		{
 			"#": "3",
-			"label": "Min Set-point and override limit",
-			"description": "from min 0°C to max setpoint override limit 0=0°C 40=40°C",
+			"label": "Min Set-Point and Override Limit",
+			"description": "from min 0 °C to max setpoint override limit 0=0 °C 40=40 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 0,
@@ -52,8 +52,8 @@
 		},
 		{
 			"#": "4",
-			"label": "Max Set-point and override limit",
-			"description": "from min setpoint override limit to max 40°C 0=0°C 40=40°C",
+			"label": "Max Set-Point and Override Limit",
+			"description": "from min setpoint override limit to max 40 °C 0=0 °C 40=40 °C",
 			"valueSize": 2,
 			"unit": "°C",
 			"minValue": 0,
@@ -62,7 +62,7 @@
 		},
 		{
 			"#": "5",
-			"label": "LED Flash period",
+			"label": "LED Flash Period",
 			"description": "0 to 65535 seconds",
 			"valueSize": 4,
 			"unit": "seconds",
@@ -72,44 +72,19 @@
 		},
 		{
 			"#": "6",
-			"label": "Set-point control function",
-			"description": "0=Disabled 1=Enabled",
-			"valueSize": 1,
-			"defaultValue": 1,
-			"allowManualEntry": false,
-			"options": [
-				{
-					"label": "disabled",
-					"value": 0
-				},
-				{
-					"label": "enabled",
-					"value": 1
-				}
-			]
+			"$import": "~/templates/master_template.json#base_enable_disable",
+			"label": "Set-Point Control Function",
+			"defaultValue": 1
 		},
 		{
 			"#": "7",
-			"label": "Temporarily override scheduler",
-			"description": "0=Disabled 1=Enabled",
-			"valueSize": 1,
-			"defaultValue": 1,
-			"allowManualEntry": false,
-			"options": [
-				{
-					"label": "disabled",
-					"value": 0
-				},
-				{
-					"label": "enabled",
-					"value": 1
-				}
-			]
+			"$import": "~/templates/master_template.json#base_enable_disable",
+			"label": "Temporarily Override Scheduler",
+			"defaultValue": 1
 		},
 		{
 			"#": "8",
-			"label": "Set-point type in Thermostat_Setpoint_Reports",
-			"description": "1=Heating 2=Cooling 10=Auto Changeover",
+			"label": "Set-Point Type in Thermostat_Setpoint_Reports",
 			"valueSize": 1,
 			"defaultValue": 1,
 			"allowManualEntry": false,
@@ -130,7 +105,7 @@
 		},
 		{
 			"#": "9",
-			"label": "LED on time",
+			"label": "LED On Time",
 			"description": "1=100ms 5=500ms",
 			"valueSize": 2,
 			"minValue": 1,
@@ -139,7 +114,7 @@
 		},
 		{
 			"#": "10",
-			"label": "Number of LED flashes (duration)",
+			"label": "Number of LED Flashes (Duration)",
 			"description": "0 to 255",
 			"valueSize": 1,
 			"minValue": 0,
@@ -149,7 +124,7 @@
 		},
 		{
 			"#": "11",
-			"label": "LED color",
+			"label": "LED Color",
 			"description": "1=Green 2=Red",
 			"valueSize": 1,
 			"defaultValue": 1,

diff --git a/packages/config/config/devices/0x0002/rxz.json b/packages/config/config/devices/0x0002/rxz.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Danfoss",
 	"manufacturerId": "0x0002",
 	"label": "RXZ",
-	"description": "RF Relay switching unit",
+	"description": "RF Relay Switching Unit",
 	"devices": [
 		{
 			"productType": "0x8004",

diff --git a/packages/config/config/devices/0x0005/ha05.json b/packages/config/config/devices/0x0005/ha05.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Intermatic",
 	"manufacturerId": "0x0005",
 	"label": "HA05",
-	"description": "Screw in lamp module",
+	"description": "Screw in Lamp Module",
 	"devices": [
 		{
 			"productType": "0x0005",

diff --git a/packages/config/config/devices/0x0005/ha18.json b/packages/config/config/devices/0x0005/ha18.json
@@ -2,7 +2,7 @@
 	"manufacturer": "Intermatic",
 	"manufacturerId": "0x0005",
 	"label": "HA18",
-	"description": "15-amp Wall Switch",
+	"description": "15-Amp Wall Switch",
 	"devices": [
 		{
 			"productType": "0x4841",