How to Enable Debug Logging in Z-Wave JS UI

Modified on Mon, 20 Jul at 11:05 AM

Overview


Debug logs are useful when troubleshooting Z-Wave devices, communication issues, failed commands, missing reports, or unexpected device behavior.


In most cases, for Z-Wave device troubleshooting, the important logs are the Driver Logs. These logs show communication between the Z-Wave controller and the Z-Wave devices.


Application logs can also be enabled, but they are mainly used for troubleshooting the Z-Wave JS UI interface, not the Z-Wave devices.


1. Enable Driver Logs for Z-Wave troubleshooting

Use this option when the issue is related to:

  • Device inclusion or exclusion

  • Device interview

  • Missing reports

  • Commands not working

  • Routing problems

  • Z-Wave communication errors

  • Device not reacting correctly

  • Battery device wake-up issues

  • Sensor or relay events not shown correctly

Steps

  1. Open Z-Wave JS UI.

  2. Go to Settings.

  3. Open the Z-Wave section.

  4. Find the logging settings.

  5. Set Log Level to Debug.

  6. Turn Log enabled ON.

  7. Turn Log to file ON.

  8. Click Save.

This enables detailed Z-Wave driver logging and saves the logs to a file.


2. Optional: Enable Application Logs for UI troubleshooting

Application logs are normally not required for device troubleshooting.

Use them only if the problem is related to the Z-Wave JS UI interface itself, for example:

  • Z-Wave JS UI page not loading correctly

  • Buttons not working in the interface

  • Settings page errors

  • UI crashes or freezes

  • Add-on interface problems

Steps

  1. Open Z-Wave JS UI.

  2. Go to Settings.

  3. Open the General section.

  4. Set Log Level to Silly for full detail.

  5. Turn Log enabled ON.

  6. Turn Log to file ON if you need to save these logs.

  7. Click Save.

Note: For normal device troubleshooting, Driver Logs in the Z-Wave section are usually enough.


3. Restart the Z-Wave JS UI add-on

After enabling logging, restart the add-on.

Steps

  1. Open Home Assistant.

  2. Go to Settings.

  3. Open Add-ons.

  4. Select Z-Wave JS UI.

  5. Click Restart.

After restart, wait 1–2 minutes for the Z-Wave network to stabilize.

This helps make sure the log captures the issue clearly and not only startup traffic.


4. Reproduce the issue

After the add-on has restarted and the network is stable, reproduce the problem.

Examples:

  • Operate the wall switch

  • Turn the relay ON or OFF

  • Trigger the sensor

  • Open or close the door/window sensor

  • Wake up the battery device

  • Start inclusion or exclusion

  • Send the command that fails

  • Wait for the report that is missing

After the issue happens, wait about 1 minute before downloading the logs.

This gives the system enough time to write all related events to the log file.


5. Export the logs from Z-Wave JS UI

To download the generated log file:

  1. Open Z-Wave JS UI.

  2. Go to Settings.

  3. Open Logs.

  4. Download the generated log file.

The log file is usually named similar to:

zwavejs_*.log

Send this file to us for analysis.


Recommended logging flow

For best troubleshooting results, follow this order:

  1. Enable Driver Logs.

  2. Set Driver Log Level to Debug.

  3. Enable Log to file.

  4. Save the settings.

  5. Restart the Z-Wave JS UI add-on.

  6. Wait 1–2 minutes.

  7. Reproduce the issue.

  8. Wait another 1 minute.

  9. Download the log file from Settings > Logs.

  10. Send the log file to support.


Important notes

  • Do not leave debug logging enabled for a long time.

  • Debug logs can become large.

  • After troubleshooting, set the log level back to a normal level.

  • Driver Logs are used for Z-Wave device and network issues.

  • Application Logs are mainly used for Z-Wave JS UI interface issues.

  • Always reproduce the issue after debug logging is enabled.


Summary

To troubleshoot Z-Wave device issues, enable Driver Logs in the Z-Wave section of Z-Wave JS UI.


Set the log level to Debug, enable Log enabled, enable Log to file, restart the add-on, reproduce the issue, and download the log file from Settings > Logs.


For UI-related issues, Application Logs in the General section can also be enabled, but they are usually not required for device troubleshooting.