Z-Wave: add required documentation on identify command #37512
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes introduce a new section titled "Identification via Z-Wave" to the Z-Wave JS integration documentation. This section outlines how Z-Wave devices can prompt a Home Assistant instance to identify itself using a specific Changes
Sequence Diagram(s)sequenceDiagram
participant ZWD as Z-Wave Device
participant HA as Home Assistant
participant NS as Notification Sidebar
ZWD->>HA: Sends Indicator Set command (hexadecimal with variable bytes)
HA->>NS: Triggers display of notification with node ID
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/zwave_js.markdown (1)
1006-1017: Enhance Code Block Formatting for the New "Identification via Z-Wave" SectionThe new section is clear in explaining the role of the
Indicator Setcommand for device identification. However, the fenced code block on lines 1009–1012 does not have a language specified and is not preceded and followed by a blank line, which causes markdownlint warnings (MD031, MD040). Consider reformatting the block as follows:-1009~``` -1010~87010003500308500403500506 -1011~ ~~ ~~ ~~ -1012~``` +1010~```bash +1011~87010003500308500403500506 +1012~ ~~ ~~ ~~ +1013~```This ensures the code block is surrounded by blank lines and specifies the language (e.g.
bash), improving both readability and compliance with markdown guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1009-1009: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
1009-1009: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1012-1012: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
🪛 GitHub Actions: home-assistant.io Test
[warning] 1009-1012: Unexpected missing fenced code language flag in info string, expected keyword fenced-code-flag
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/zwave_js.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
1009-1009: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
1009-1009: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1012-1012: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/zwave_js.markdown
[warning] 1009-1012: Unexpected missing fenced code language flag in info string, expected keyword fenced-code-flag
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/zwave_js.markdown (1)
1006-1017: New "Identification via Z-Wave" Section ReviewThe new section clearly explains how Home Assistant can be instructed to identify itself via an
Indicator SetZ-Wave command. The content aligns with the PR objective of including required certification documentation regarding device identification. However, static analysis (MD031) flags that fenced code blocks should be surrounded by blank lines. In this case, the code fence starting at line 1010 and ending at line 1012 should have an empty line before the opening and after the closing fence to improve markdown readability and comply with markdownlint guidelines.To address this, consider applying the following diff:
-```txt -1010~ -87010003500308500403500506 -1011~ - ~~ ~~ ~~ -1012~ -``` + +```txt +87010003500308500403500506 + ~~ ~~ ~~ +``` +This change ensures that there is a blank line before and after the fenced code block.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1009-1009: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
1012-1012: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/zwave_js.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
1009-1009: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
1012-1012: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Proposed change
Z-Wave certification requires the following documentation:
This PR adds this info in the certification-related section at the bottom of the integration documentation.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit