[RELEASE] Z-Wave Universal Device Scanner

⚙️ Custom Apps and Drivers Custom Drivers
,
1

Z-Wave Universal Device Scanner - eventual goal is to bundle the features of the multiple utility drivers into one, plus additional features. Features to be included from the generic 'Device' driver, Basic Z-Wave Tool, and Z-Wave Tweaker.

If you are using this driver PLEASE like :heart: this post

Current Package Version: v0.4.0 - 2024-07-16

:point_right: Advanced features should work on ALL 800 series devices, and many 700 series.

:ballot_box_with_check: Features List:

  • Get Info - this mimics the output from the same command in the 'Device' driver. However this tool actually requests the make/model info from the device and updates the device data. Then prints the fingerprint in the logs.
  • Command Class Report - Similar output as the Basic Z-Wave Tool, but I have added a description for each command class making it easier to read.
  • Delete Child - Similar to command in 'Device' driver except you can specify only a single child to delete for more flexibility.
  • Query Device
    • Parameters: This fully scans the device using ConfigurationPropertiesGet (and optionally ConfigurationNameGet and ConfigurationInfoGet). Saves all the info returned to the device data, then generates a parameters list on the fly from it. An option in the preferences can disable the Name and Info scanning.
    • Associations: This scans the devices for supported associations and then syncs up any existing associations set on the device. Options to configure are presented in the settings.
    • Sync Only: Use to sync over the current settings, run if you have made changes outside of this driver before saving so you do not overwrite your current settings!
  • Remove Data - Similar to delete buttons in 'Device' driver except you can specify the exact entry to delete instead of deleting everything. BE CAREFUL deleting device data!
  • Set Lifeline Association - Useful after a firmware update if the device is no longer reporting back to the hub, try sending this command which might fix it without having to re-pair.
  • Set Wake Interval - This was added for battery devices so you can set the interval in which the device will wake up to receive commands from the hub. After clicking the command button, wake the device up manually so the command can be sent to it.

Please try this out on various devices, it may not work on older devices so don't be surprised if it says it is not supported.

:lady_beetle: Reporting Issues :beetle:
Please use GitHub to report any issues so each one can have its own conversation and tracking. Please provide as much info as you can including model, firmware and the "configVals" data string. Issues · jtp10181/Hubitat · GitHub

Known Issues

Known Issues:

  • Do not try to scan multiple devices at once

:eight_spoked_asterisk: Find on Hubitat Package Manager (HPM):
Package Name: :small_blue_diamond: Universal Z-Wave Drivers :small_blue_diamond:
HPM Install Docs: HPM Documentation

NOTE: The scanner driver is marked as required in the package so it is always installed no matter what other drivers you select to install with it (or select no other drivers to get just the scanner).

:eight_spoked_asterisk: OR Manual Download from GitHub
Full Repository Link: Hubitat/Drivers/universal at main · jtp10181/Hubitat · GitHub
Z-Wave Univeral Scanner [Raw File Import Link]

:beer: :coffee: Donations: ---->>>> PayPal.Me <<<<---- :money_with_wings: Never required, always appreciated!
:handshake: Support me by purchasing at TheSmartestHouse.com through my affiliate link!

32 Likes
2

Examples:

ZEN17 Example

Here is a sample of what I pulled off a ZEN17

image
image1139×692 36.8 KB

Here it is saved in the data, its really ugly, may change this to JSON but this was the quick way I already knew how to do.

image
image1203×394 68.5 KB

1 Like
3

UPDATE:

Moved over to GitHub and updated

[0.2.0] - 2021-08-06

Added

  • Get Info command to fetch device info and restore to data fields
  • Get Info command also prints fingerprint to logs same as the 'Device' driver
  • Set Lifeline Association command, useful after firmware updates if it gets cleared
  • Made scanning for Name and Info optional (some devices hang on these)

Fixed

  • Was unable to update settings if created as different type, fixed by removing before setting
  • Will handle signed or unsigned parameter values based on format specified in report
  • Other minor fixes merged from my other drivers
6 Likes
4

Hello
I've been trying to get my Ring Outdoor Siren (connected directly to Hubitat) to work using both the Siren and LED's. Although there is already a driver for this it is currently only able to turn the siren on and off and is unable to control the LED's within the device. I've been digging around with this for sometime and have managed to get the lights to turn on and off outside of Hubitat using the below information with z-wave js but it is not stable and I really want it to work in Hubitat. Is this something your scanner might be able to help with? I've pasted the results from the scan below.
Thanks

From Z-wave JS:
Ring LOGO LED
command class: 135
property: 48
property key: 1
value: 0-100

Red Strobe LED
command class: 135
property: 13
property key: 1
value: 0-100

image
image1447×1226 93.3 KB

5

No, this tool is mostly for viewing info about the device and also setting parameters. From the sounds of it you need to send commands to the device. That is indicator command class commands which I am slightly familiar with. I could easily make a command in a custom driver to trigger that but the problem is the custom driver would need all the code to support all the device features. @bcopeland any chance you could add the indicator commands to the built in driver?

5 Likes
6

@bcopeland any chance of either getting the code for the ring outdoor siren or the ability to manage the led via the inbuilt driver?

thanks in advance.

Dagaz

7

@jtp10181 - This is really cool, thank you for writing this tool.

1 Like
8

@jtp10181
Jeff, can you link the GitHub repo so it can be found more easily?

Edit, sorry, found it in the posts below, i will be trying this out on some of my zwave devices and report back

[Repository Link] -- [Raw File Import Link]

1 Like
9

Just sent you a little "treat"....

1 Like
10

UPDATE

Total overhaul and upgrade to bring current with changes for the Universal Dimmer/Switch.
Added to HPM, if you have it installed already run a Match Up, then update.

Breaking Change - settings will need to be re-scanned if you used this tool on a device prior to this update due to a change in how the data is stored (now in JSON string format).

Version [0.3.0] - 2024-06-28

  • Pushing some older changes up in prep for more updates
  • Added ability to set multichannel lifeline
  • Added Set Wake Interval command
  • Added Set Parameter command (to manually set parameters)
  • Added Command Class Report
  • Added command to remove states and data entries from device
  • Fixed range expansion issue with Hub Mesh (can cause java.lang.OutOfMemoryError)

Version [0.4.0] - 2024-07-16

  • Refactor code to get ready for library merges
  • Merge library and universal switch code improvements
  • Settings stored data changed to JSON string
  • Added friendly names to CC Report
  • Added Basic On/Off commands to test most devices
  • Parameter query will now sync settings from device automatically
  • Added full associations detection and support
  • Configure will run any scans that are missing
3 Likes
11

Hi Jeff, I download the package from HPM and only have the Universal Switch and Dimmer listed as choices. Was the scanner subsumed into them or is it missing?

12

The scanner comes along in either the swich or dimmer download, but it's not available as a standalone download.

13

Thanks for the clarification

14

Actually it is a separate driver as well, if you get all 3 items from the package you should have these 3 in the drivers list. The scanner has a slightly different name, kept the original name and decided on a slightly different order for the specialized drivers. The switch/dimmer are optional, you can remove them from the hub using the Modify section in HPM if you dont want them.

image

1 Like
15

Thanks, got it. What confused me was when I brought up the package in HPM, I got:
image.
I expected to see the scanner as an option here and didn't realize I could pick either one and get the scanner as part of the package.

1 Like
16

Oh yeah I did not realize how that would present. I made the scanner required, so you could have selected neither driver and the scanner would install! I will make a note in the main post.

2 Likes
17

To be fair, somewhere on that screen I believe it uses the word "optional" but I'll admit it confused me too. I thought it was just the 2 options and it was "optional" because I could choose one or the other, or both, or none. I didn't realize until I went to change the driver that it installed a 3rd one.

image
image1356×283 21.6 KB

1 Like
18

Thank you again Jeff for another great contribution here. I had the same issue with 4 Zen32 scene controllers seemingly not doing anything on a button push after updating the firmware. Your lifeline association button fixed things.

Quick question, should I have used the multichannel association over the single channel. I am not sure what the difference is.

Thanks again,

Jason

1 Like
19

Single channel for sure on the ZEN32.

Some multi-endpoint devices (like a double relay) will work better with the multi channel association.

1 Like
20

@jtp10181 Hello, on the newest platform version 2.4.1.154 I get stuff like that in the driver when, for example, scanning parameters, etc.

errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.

Here's log in a longer context.

dev:362025-04-05 15:57:57.918traceSensor wąskiego korytarza: parse: {"cc":128,"cmd":3,"ep":0,"values":[{"commandClass":128,"commandClassName":"Battery","endpoint":0,"newValue":35,"prevValue":30,"property":"level","propertyName":"level","ts":1743861477911}]} --PARSED-- BatteryReport(batteryLevel:35)
dev:362025-04-05 15:57:57.763debugSensor wąskiego korytarza: Unhandled zwaveEvent: BatteryReport(batteryLevel:30) (ep 0) [hubitat.zwave.commands.batteryv1.BatteryReport]
dev:362025-04-05 15:57:57.760traceSensor wąskiego korytarza: parse: {"cc":128,"cmd":3,"ep":0,"values":[{"commandClass":128,"commandClassName":"Battery","endpoint":0,"newValue":30,"prevValue":80,"property":"level","propertyName":"level","ts":1743861477754}]} --PARSED-- BatteryReport(batteryLevel:30)
dev:362025-04-05 15:57:57.197debugSensor wąskiego korytarza: getConfigureCmds...
dev:362025-04-05 15:57:57.195debugSensor wąskiego korytarza: WakeUp Notification Received
dev:362025-04-05 15:57:57.194traceSensor wąskiego korytarza: WakeUpNotification() (ep 0)
dev:362025-04-05 15:57:57.193traceSensor wąskiego korytarza: parse: {"cc":132,"cmd":7,"ep":0,"values":[]} --PARSED-- WakeUpNotification()
dev:362025-04-05 15:57:51.862debugSensor wąskiego korytarza: processAssocScan Completed
dev:362025-04-05 15:57:49.886errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:49.807traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 7, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:49.805traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[7],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected290","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 7, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:49.145errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:49.123traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 6, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:49.120traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[6],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected289","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 6, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:48.456errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:48.433traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 5, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:48.431traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[5],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected288","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 5, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:47.765errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:47.703traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 4, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:47.700traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[4],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected287","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 4, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:47.039errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:47.016traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 3, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:47.014traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[3],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected286","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 3, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:46.347errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:46.324traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 2, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:46.321traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[2],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected285","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[]}}]} --PARSED-- AssociationReport(groupingIdentifier: 2, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [])
dev:362025-04-05 15:57:45.825debugSensor wąskiego korytarza: Multi-Channel Association Groups Report found 7 groups
dev:362025-04-05 15:57:45.824traceSensor wąskiego korytarza: MultiChannelAssociationGroupingsReport(supportedGroupings:7)
dev:362025-04-05 15:57:45.822traceSensor wąskiego korytarza: parse: {"cc":142,"cmd":6,"ep":0,"values":[{"request":{"args":[],"command":"endpoint.invoke_cc_api","commandClass":142,"endpoint":0,"messageId":"expected284","methodName":"getGroupCount","nodeId":40},"response":7}]} --PARSED-- MultiChannelAssociationGroupingsReport(supportedGroupings:7)
dev:362025-04-05 15:57:45.625errorgroovy.lang.GroovyRuntimeException: Ambiguous method overloading for method com.hubitat.hub.executor.DeviceExecutor#zwaveSecureEncap.
dev:362025-04-05 15:57:45.605traceSensor wąskiego korytarza: AssociationReport(groupingIdentifier: 1, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [1])
dev:362025-04-05 15:57:45.602traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":3,"ep":0,"values":[{"request":{"args":[1],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected283","methodName":"getGroup","nodeId":40},"response":{"maxNodes":5,"nodeIds":[1]}}]} --PARSED-- AssociationReport(groupingIdentifier: 1, maxNodesSupported: 5, reportsToFollow: 0, nodeId: [1])
dev:362025-04-05 15:57:45.428debugSensor wąskiego korytarza: Association Groups Report found 7 groups
dev:362025-04-05 15:57:45.427traceSensor wąskiego korytarza: AssociationGroupingsReport(supportedGroupings: 7)
dev:362025-04-05 15:57:45.425traceSensor wąskiego korytarza: parse: {"cc":133,"cmd":6,"ep":0,"values":[{"request":{"args":[],"command":"endpoint.invoke_cc_api","commandClass":133,"endpoint":0,"messageId":"expected282","methodName":"getGroupCount","nodeId":40},"response":7}]} --PARSED-- AssociationGroupingsReport(supportedGroupings: 7)
dev:362025-04-05 15:57:45.092debugSensor wąskiego korytarza: scanAssociations probing for number of association groups
dev:362025-04-05 15:57:35.364debugSensor wąskiego korytarza: Unhandled zwaveEvent: BatteryReport(batteryLevel:80) (ep 0) [hubitat.zwave.commands.batteryv1.BatteryReport]
dev:362025-04-05 15:57:35.361traceSensor wąskiego korytarza: parse: {"cc":128,"cmd":3,"ep":0,"values":[{"commandClass":128,"commandClassName":"Battery","endpoint":0,"newValue":80,"prevValue":35,"property":"level","propertyName":"level","ts":1743861455354}]} --PARSED-- BatteryReport(batteryLevel:80)
dev:362025-04-05 15:57:25.067traceSensor wąskiego korytarza: ConfigurationNameReport(parameterNumber: 3, reportsToFollow: 0, name: Motion Untrigger Time)
dev:362025-04-05 15:57:25.062traceSensor wąskiego korytarza: parse: {"cc":112,"cmd":11,"ep":0,"values":[{"request":{"args":[3],"command":"endpoint.invoke_cc_api","commandClass":112,"endpoint":0,"messageId":"expected278","methodName":"getName","nodeId":40},"response":"Motion Untrigger Time"}]} --PARSED-- ConfigurationNameReport(parameterNumber: 3, reportsToFollow: 0, name: Motion Untrigger Time)
dev:362025-04-05 15:57:24.492debugSensor wąskiego korytarza: Received Param 3 (saved), next is #4
dev:362025-04-05 15:57:24.472traceSensor wąskiego korytarza: ConfigurationPropertiesReport(parameterNumber: 3, format: 1, size: 2, minValue: 30, maxValue: 3600, defaultValue: 60, nextParameterNumber: 4)
dev:362025-04-05 15:57:24.467traceSensor wąskiego korytarza: parse: {"cc":112,"cmd":15,"ep":0,"values":[{"request":{"args":[3],"command":"endpoint.invoke_cc_api","commandClass":112,"endpoint":0,"messageId":"expected277","methodName":"getProperties","nodeId":40},"response":{"altersCapabilities":false,"defaultValue":60,"isAdvanced":false,"isReadonly":false,"maxValue":3600,"minValue":30,"nextParameter":4,"noBulkSupport":true,"valueFormat":1,"valueSize":2}}]} --PARSED-- ConfigurationPropertiesReport(parameterNumber: 3, format: 1, size: 2, minValue: 30, maxValue: 3600, defaultValue: 60, nextParameterNumber: 4)
dev:362025-04-05 15:57:22.672debugSensor wąskiego korytarza: Received Param 1 (invalid), next is #3
dev:362025-04-05 15:57:22.670traceSensor wąskiego korytarza: ConfigurationPropertiesReport(parameterNumber: 1, format: 0, size: 0, minValue: 0, maxValue: 0, defaultValue: 0, nextParameterNumber: 3)
dev:362025-04-05 15:57:22.664traceSensor wąskiego korytarza: parse: {"cc":112,"cmd":15,"ep":0,"values":[{"request":{"args":[1],"command":"endpoint.invoke_cc_api","commandClass":112,"endpoint":0,"messageId":"expected276","methodName":"getProperties","nodeId":40},"response":{"altersCapabilities":false,"isAdvanced":false,"isReadonly":false,"nextParameter":3,"noBulkSupport":true,"valueFormat":0,"valueSize":0}}]} --PARSED-- ConfigurationPropertiesReport(parameterNumber: 1, format: 0, size: 0, minValue: 0, maxValue: 0, defaultValue: 0, nextParameterNumber: 3)
dev:362025-04-05 15:57:22.440debugSensor wąskiego korytarza: scanParameters: Starting with #1
dev:362025-04-05 15:57:22.337debugSensor wąskiego korytarza: Unhandled zwaveEvent: BatteryReport(batteryLevel:35) (ep 0) [hubitat.zwave.commands.batteryv1.BatteryReport]
dev:362025-04-05 15:57:22.334traceSensor wąskiego korytarza: parse: {"cc":128,"cmd":3,"ep":0,"values":

Apparently new platform version brings some BC breaks. I had to adjust my driver to work as well.