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

Enabling Long Range protocol in the SmartStart entry is being allowed for nodes that don't support LR #3735

Closed
3 tasks done
kpine opened this issue May 31, 2024 · 0 comments
Closed
3 tasks done

Enabling Long Range protocol in the SmartStart entry is being allowed for nodes that don't support LR #3735

kpine opened this issue May 31, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@kpine
Copy link
Contributor

kpine commented May 31, 2024

Checklist

  • I am not using Home Assistant. Or: a developer has told me to come here.
  • I have checked the troubleshooting section and my problem is not described there.
  • I have read the changelog and my problem is not mentioned there.

Deploy method

Docker

Z-Wave JS UI version

9.13.1.b613753

ZwaveJS version

12.9.1

Describe the bug

When editing a provisioning entry for a normal node, I am allowed to change the protocol from Z-Wave to Z-Wave Long Range (ZWLR). At least with this device, it causes the inclusion to fail and it will repeat this continuously. There is no indication in the UI that this is happening, so it just appears like the node never joins. It's only visible with driver logs.

To Reproduce

  1. Add a QR code for a normal ZW device
  2. Edit the QR entry and notice you can switch to ZWLR. Switch it to LR and save.
  3. Notice the node never includes, see errors in driver logs.

Expected behavior

I would expect that a device that does not claim to support ZWLR should not be allowed to be configured with ZWLR protocol. E.g. the menu option should not be visible for these nodes.

And/or the driver should provide some feedback that a node is joining with the wrong protocol?

But, I don't know if there are LR devices that are missing the supported protocol information. Should some kind of force override be allowed in that case? What if a vendor adds LR support in a firmware update (per DrZwave you can OTA devices in the field to add ZWLR)? Are they required to generate a new QR code for you? The existing QR code would be missing the protocol info.

Additional context

I ran driver code to decode the QR code:

const { logger, require } = this
const { parseQRCodeString } = require('zwave-js/Utils')

const qr = "900100737003583776180447150097942807440802365951664200100179303078022000634286725734500286";
const qrEntry = parseQRCodeString(qr);
logger.info(JSON.stringify(qrEntry, null, 2));

The output is:

2024-05-30 22:31:53.984 INFO Z-WAVE: {
  "version": 1,
  "requestedSecurityClasses": [
    0,
    1
  ],
  "securityClasses": [
    0,
    1
  ],
  "dsk": "58377-61804-47150-09794-28074-40802-36595-16642",
  "genericDeviceClass": 7,
  "specificDeviceClass": 1,
  "installerIconType": 3078,
  "manufacturerId": 634,
  "productType": 28672,
  "productId": 57345,
  "applicationVersion": "1.30"
}

So you can see there is no supportedProtocols field that lists Long Range as available, it's simply omitted. I would presume this means LR is not supported, otherwise it would indicate so.

I added the QR code, and you can see the same in the debug logs, no support for LR:

2024-05-30 22:40:19.675 INFO Z-WAVE: Success zwave api call getProvisioningEntries [
  {
    dsk: '58377-61804-47150-09794-28074-40802-36595-16642',
    securityClasses: [ 0, 1, [length]: 2 ],
    version: 1,
    requestedSecurityClasses: [ 0, 1, [length]: 2 ],
    genericDeviceClass: 7,
    specificDeviceClass: 1,
    installerIconType: 3078,
    manufacturerId: 634,
    productType: 28672,
    productId: 57345,
    applicationVersion: '1.30',
    manufacturer: 'Zooz',
    label: 'ZSE41',
    description: 'Open/Close XS Sensor'
  },
  [length]: 1
]

But then edit the entry and am allowed to change it:

image

The logs confirm the change was made, now protocol is LR.

2024-05-30 22:41:22.731 INFO Z-WAVE: Success zwave api call getProvisioningEntries [
  {
    dsk: '58377-61804-47150-09794-28074-40802-36595-16642',
    securityClasses: [ 1, [length]: 1 ],
    version: 1,
    requestedSecurityClasses: [ 1, 0, [length]: 2 ],
    genericDeviceClass: 7,
    specificDeviceClass: 1,
    installerIconType: 3078,
    manufacturerId: 634,
    productType: 28672,
    productId: 57345,
    applicationVersion: '1.30',
    manufacturer: 'Zooz',
    label: 'ZSE41',
    description: 'Open/Close XS Sensor',
    status: 0,
    protocol: 1
  },
  [length]: 1
]

Now I power on the node and can see it attempts to join, but the driver ignores it. This particular device will continue this non-stop.

2024-05-31T05:42:34.317Z SERIAL « 0x012100498500001aedaa9f62120407015e858e595586725a73809f71873070846 (35 bytes)
                                  c7a1d
2024-05-31T05:42:34.319Z SERIAL » [ACK]                                                                   (0x06)
2024-05-31T05:42:34.322Z DRIVER « [REQ] [ApplicationUpdateRequest]
                                    type:                  SmartStart_HomeId_Received
                                    remote node ID:        0
                                    NWI home ID:           0xedaa9f62
                                    basic device class:    4
                                    generic device class:  7
                                    specific device class: 1
                                    supported CCs:
                                    · Z-Wave Plus Info
                                    · Association
                                    · Multi Channel Association
                                    · Association Group Information
                                    · Transport Service
                                    · Version
                                    · Manufacturer Specific
                                    · Device Reset Locally
                                    · Powerlevel
                                    · Battery
                                    · Security 2
                                    · Notification
                                    · Indicator
                                    · Binary Sensor
                                    · Configuration
                                    · Wake Up
                                    · Supervision
                                    · Firmware Update Meta Data
2024-05-31T05:42:34.323Z CNTRLR   Received Smart Start inclusion request
2024-05-31T05:42:34.323Z CNTRLR   NWI Home ID not found in provisioning list, ignoring request...

I go back and edit the provisioning entry to switch back the protocol to ZW, and it includes successfully.

2024-05-30 22:45:12.777 INFO Z-WAVE: Success zwave api call getProvisioningEntries [
  {
    dsk: '58377-61804-47150-09794-28074-40802-36595-16642',
    securityClasses: [ 1, [length]: 1 ],
    version: 1,
    requestedSecurityClasses: [ 1, 0, [length]: 2 ],
    genericDeviceClass: 7,
    specificDeviceClass: 1,
    installerIconType: 3078,
    manufacturerId: 634,
    productType: 28672,
    productId: 57345,
    applicationVersion: '1.30',
    manufacturer: 'Zooz',
    label: 'ZSE41',
    description: 'Open/Close XS Sensor',
    status: 0,
    protocol: 0
  },
  [length]: 1
]
2024-05-31T05:45:24.597Z DRIVER   all queues busy
2024-05-31T05:45:24.599Z SERIAL » 0x0103003bc7                                                         (5 bytes)
2024-05-31T05:45:24.600Z DRIVER » [REQ] [GetBackgroundRSSI]
2024-05-31T05:45:24.606Z SERIAL « [ACK]                                                                   (0x06)
2024-05-31T05:45:24.606Z SERIAL « 0x0107013b9596969ec9                                                 (9 bytes)
2024-05-31T05:45:24.607Z SERIAL » [ACK]                                                                   (0x06)
2024-05-31T05:45:24.607Z DRIVER « [RES] [GetBackgroundRSSI]
                                    channel 0: -107 dBm
                                    channel 1: -106 dBm
                                    channel 2: -106 dBm
                                    channel 3: -98 dBm
2024-05-31T05:45:24.609Z DRIVER   all queues idle
2024-05-31T05:45:25.064Z SERIAL « 0x012100498500001aedaa9f62120407015e858e595586725a73809f71873070846 (35 bytes)
                                  c7a1d
2024-05-31T05:45:25.065Z SERIAL » [ACK]                                                                   (0x06)
2024-05-31T05:45:25.067Z DRIVER « [REQ] [ApplicationUpdateRequest]
                                    type:                  SmartStart_HomeId_Received
                                    remote node ID:        0
                                    NWI home ID:           0xedaa9f62
                                    basic device class:    4
                                    generic device class:  7
                                    specific device class: 1
                                    supported CCs:
                                    · Z-Wave Plus Info
                                    · Association
                                    · Multi Channel Association
                                    · Association Group Information
                                    · Transport Service
                                    · Version
                                    · Manufacturer Specific
                                    · Device Reset Locally
                                    · Powerlevel
                                    · Battery
                                    · Security 2
                                    · Notification
                                    · Indicator
                                    · Binary Sensor
                                    · Configuration
                                    · Wake Up
                                    · Supervision
                                    · Firmware Update Meta Data
2024-05-31T05:45:25.068Z CNTRLR   Received Smart Start inclusion request
2024-05-31T05:45:25.068Z CNTRLR   NWI Home ID found in provisioning list, including node...
2024-05-31T05:45:25.069Z CNTRLR   Including SmartStart node with DSK 58377-61804-47150-09794-28074-40802-36595-1
                                  6642
2024-05-31T05:45:25.070Z DRIVER   all queues busy
2024-05-31T05:45:25.071Z SERIAL » 0x010d004ac801edaa9f620ef3410374                                    (15 bytes)
2024-05-31T05:45:25.072Z DRIVER » [REQ] [AddNodeToNetwork]
                                    action:       Add Smart Start node
                                    NWI Home ID:  0xedaa9f62
                                    high power:   true
                                    network wide: true
                                    protocol:     Z-Wave Classic
                                    callback id:  1
2024-05-31T05:45:25.077Z SERIAL « [ACK]                                                                   (0x06)
2024-05-30 22:45:25.078 INFO Z-WAVE: Controller status: Secure inclusion started

Attached is a fully log of the above activities.

zwave.log
@kpine kpine added the bug Something isn't working label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kpine