Z-Wave: update steps on changing log levels to reflect current SW #39468
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for enabling Z-Wave JS logging in Home Assistant was expanded and reorganized. The update replaces a brief two-step instruction with a detailed, step-by-step guide for setting log levels and enabling debug logging. An additional link to related Z-Wave controller documentation was also introduced. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant_UI
User->>HomeAssistant_UI: Navigate to Settings > Devices & services > Z-Wave
User->>HomeAssistant_UI: Select Configure
User->>HomeAssistant_UI: Open Logs tab and set log level
User->>HomeAssistant_UI: Return to Z-Wave integration panel
User->>HomeAssistant_UI: Enable debug logging
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
|
||
| The log level will be set to `debug` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs. | ||
| 1. Define the log level: | ||
| - By default, it is set to `info` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs. |
There was a problem hiding this comment.
This sentence doesn't make sense now. Before your change we described what happened when the log was set to debug. We should retain that.
| - By default, it is set to `info` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs. | ||
| - Go to the {% my integration domain="zwave_js" title="**Settings** > **Devices & services** > **Z-Wave**" %} and select **Configure**. | ||
| - On the Z-Wave configuration page, open the **Logs** tab. | ||
| - Choose your log level. |
There was a problem hiding this comment.
This isn't needed to just set the log level to debug. It's enough to do step 2 and 3.
If we want to expand on the logging feature I think it should be a separate paragraph that explains that you can customize the logging level of the driver. This is what's done from the logging panel in the config panel of the Z-Wave integration.
If the user just wants to capture debug logs for troubleshooting (the most common case) it's enough to follow the previous description.
| @@ -959,10 +962,13 @@ Many users have reported issues with interference when the USB stick was directl | |||
|
|
|||
| ##### Enable Z-Wave JS logging | |||
There was a problem hiding this comment.
I'd add "debug" here so that it becomes "Enable Z-Wave JS debug logging".
Proposed change
adjust steps to include Log tab on configuration page
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit