Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(config): clean up auto-import for Shelly Wave 1PM #6289

Merged
merged 24 commits into from
Sep 21, 2023
Merged

fix(config): clean up auto-import for Shelly Wave 1PM #6289

Changes from 5 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
884cf5b
Update qnsw-001x16.json
QubinoHelp Sep 18, 2023
aba8a4a
Update qnsw-001x16.json
QubinoHelp Sep 18, 2023
4c37506
Update qnsw-001x16.json
QubinoHelp Sep 18, 2023
2efc565
Rename qnsw-001x16.json to qnsw-001P16.json
QubinoHelp Sep 18, 2023
ce01641
Update qnsw-001P16.json
QubinoHelp Sep 18, 2023
c31d52f
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
e288e5c
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
e5eccea
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
a1c040f
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
eafec8f
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
05ab129
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
5b083bd
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
f4544bf
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
beb778c
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
47bb118
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
14c0669
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
b724e6b
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
e195e06
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
76d7059
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
5372d36
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
b29275d
Update packages/config/config/devices/0x0460/qnsw-001P16.json
QubinoHelp Sep 20, 2023
1232f3b
fix: formatting
AlCalzone Sep 21, 2023
31e6e70
fix: some labels
AlCalzone Sep 21, 2023
49f7e30
fix: descriptions, consistency
AlCalzone Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
212 changes: 178 additions & 34 deletions ...ig/config/devices/0x0460/qnsw-001x16.json → ...ig/config/devices/0x0460/qnsw-001P16.json
View file
Open in desktop
AlCalzone marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
// TODO: This file contains a placeholder for a productType, productID, or manufacturerId (0x9999) that must be corrected.
{
"manufacturer": "Shelly",
"manufacturerId": "0x0460",
"label": "QNSW-001X16",
"description": "Wave 1",
"label": "QNSW-001P16",
"description": "Wave 1PM",
"devices": [
{
"productType": "0x9999",
"productId": "0x0002",
"zwaveAllianceId": 4922
"productType": "0x0002",
"productId": "0x0084"
}
],
"firmwareVersion": {
Expand All @@ -29,31 +28,58 @@
"maxNodes": 9
}
},

"paramInformation": [
{
"#": "1",
"label": "Sw1 Switch Type",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "This parameter defines how the Device should treat the switch (which type) connected to the SW (SW1) terminal.",
"valueSize": 1,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We try to avoid parameter descriptions unless necessary for understanding what the parameter does, or to provide additional information like gaps in the allowed parameter range.
https://zwave-js.github.io/node-zwave-js/#/config-files/style-guide?id=parameter-descriptions

"minValue": 0,
"maxValue": 2,
"defaultValue": 2,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "mono-stable switch type (push button)",
"value": 0
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
},
{
"label": "toggle switch (contact closed - ON / contact opened - OFF)",
"value": 1
},
{
"label": "toggle switch (Device changes status when switch changes status)",
"value": 2
}
]
},
{
"#": "17",
"label": "Restore State of O1 After Power Failure",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "This parameter determines if the on/off status is saved and restored for the load connected to O (O1) after a power failure.",
"valueSize": 1,
"minValue": 0,
"maxValue": 1,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "Device saves last on/off status and restores it after a power failure",
"value": 0
},
{
"label": "Device does not save on/off status and does not restore it after a power failure, it remains off",
"value": 1
}
]
},
{
"#": "19",
"label": "Turn O1 Off Automatically With Timer",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "If the load O (O1) is ON, you can schedule it to turn OFF automatically after the period of time defined in this parameter. The timer resets to zero each time the Device receives an ON command",
"valueSize": 2,
"minValue": 0,
"maxValue": 32535,
Expand All @@ -63,7 +89,7 @@
{
"#": "20",
"label": "Turn O1 On Automatically With Timer",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "If the load O (O1) is OFF, you can schedule it to turn ON automatically after the period of time defined in this parameter. The timer resets to zero each time the Device receives an OFF command",
"valueSize": 2,
"minValue": 0,
"maxValue": 32535,
Expand All @@ -73,102 +99,220 @@
{
"#": "23",
"label": "O1 No/Nc",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "The set value determines the relay contact type for output O (O1). The relay contact type can be normally open (NO) or normally closed (NC).",
"valueSize": 1,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the updated label and the predefined options below, this description isn't necessary.

"minValue": 0,
"maxValue": 1,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "NO",
"value": 0
},
{
"label": "NC",
"value": 1
}
]
},
{
"#": "25",
"label": "Set Timer Units to Seconds Or Milliseconds For O1",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "Set the timer units to seconds or milliseconds. Choose if you want to set the timer in seconds or milliseconds in Parameters No. 19, 20.",
"valueSize": 1,
"minValue": 0,
"maxValue": 1,
"defaultValue": 0,
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "timer set in seconds",
"value": 0
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
},
{
"label": "timer set in milliseconds (scale 10ms)",
"value": 1
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
}
]
},
{
"#": "36",
"label": "O (O1) Power report on change - percentage",
"description": "This parameter determines the minimum change in consumed power that will result in sending a new report to the gateway.",
"unit": "%",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"valueSize": 1,
"minValue": 0,
"maxValue": 100,
"defaultValue": 50,
"unsigned": true
},
{
"#": "39",
"label": "Minimum time between reports (O) O1",
"description": "This parameter determines the minimum time that must elapse before a new power report on O (O1) is sent to the gateway.",
"unit": "seconds",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"valueSize": 1,
"minValue": 0,
"maxValue": 120,
"defaultValue": 30,
"unsigned": true
},
{
"#": "91",
"label": "Alarm Conf. - Water",
"description": "0",
"description": "This parameter determines which alarm frames the Device should respond to and how. The parameters consist of 4 bytes, the three most significant bytes are set according to the official Z-Wave protocol specification.",
"valueSize": 4,
"minValue": 0,
"maxValue": 2,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "no action",
"value": 0
},
{
"label": "open relay",
"value": 1
},
{
"label": "close relay",
"value": 2
}
]
},
{
"#": "92",
"label": "Alarm Conf. - Smoke",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "This parameter determines which alarm frames the Device should respond to and how. The parameters consist of 4 bytes, the three most significant bytes are set according to the official Z-Wave protocol specification.0",
"valueSize": 4,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm afraid this won't work as you intended. By predefining the options, only the values 0...2 can be set and the 3 most significant bytes will be zero.

Are those supposed to be changed by the user? If not, using a partial parameter could be used to let the user only edit the least siginificant byte.

"minValue": 0,
"maxValue": 2,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "no action",
"value": 0
},
{
"label": "open relay",
"value": 1
},
{
"label": "close relay",
"value": 2
}
]
},
{
"#": "93",
"label": "Alarm Conf. - Co",
"description": "0",
"description": "This parameter determines which alarm frames the Device should respond to and how. The parameters consist of 4 bytes, the three most significant bytes are set according to the official Z-Wave protocol specification.",
"valueSize": 4,
"minValue": 0,
"maxValue": 2,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "no action",
"value": 0
},
{
"label": "open relay",
"value": 1
},
{
"label": "close relay",
"value": 2
}
]
},
{
"#": "94",
"label": "Alarm Conf. - Heat",
"description": "0",
"description": "This parameter determines which alarm frames the Device should respond to and how. The parameters consist of 4 bytes, the three most significant bytes are set according to the official Z-Wave protocol specification.",
"valueSize": 4,
"minValue": 0,
"maxValue": 2,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "no action",
"value": 0
},
{
"label": "open relay",
"value": 1
},
{
"label": "close relay",
"value": 2
}
]
},
{
"#": "120",
"label": "Factory Reset",
"description": "0",
"description": "Reset to factory default settings and removed from the Z-Wave network.\nThe parameter is Advanced and may be hidden under the Advanced tag.",
"valueSize": 1,
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"minValue": 0,
"maxValue": 1,
"defaultValue": 0,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"options": [
{
"label": "Don’t do Factory reset",
"value": 0
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
},
{
"label": "Do the Factory reset",
"value": 1
}
]
},
{
"#": "201",
"label": "Serial Number 1",
"description": "0",
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
"description": "This parameter contains a part of device’s serial number.\nThe parameter is Read-Only and cannot be changed.\nThe parameter is Advanced and may be hidden under the Advanced tag.",
"valueSize": 4,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove the description. That it is read-only is already included in the definition. And the last sentence doesn't give any useful information to the end user.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for the next ones

"minValue": 0,
"maxValue": 2147483647,
"defaultValue": 2147483647,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"readOnly": true
QubinoHelp marked this conversation as resolved.
Show resolved Hide resolved
},
{
"#": "202",
"label": "Serial Number 2",
"description": "0",
"description": "This parameter contains a part of device’s serial number.\nThe parameter is Read-Only and cannot be changed.\nThe parameter is Advanced and may be hidden under the Advanced tag.",
"valueSize": 4,
"minValue": 0,
"maxValue": 2147483647,
"defaultValue": 2147483647,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"readOnly": true
},
{
"#": "203",
"label": "Serial Number 3",
"description": "0",
"description": "This parameter contains a part of device’s serial number\nThe parameter is Read-Only and cannot be changed.\nThe parameter is Advanced and may be hidden under the Advanced tag.",
"valueSize": 4,
"minValue": 0,
"maxValue": 2147483647,
"defaultValue": 2147483647,
"unsigned": true
"unsigned": true,
"allowManualEntry": false,
"readOnly": true
}
],
"metadata": {
Expand Down