Z-Wave controllers: rename to adapter #39806
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR renames references from “Z-Wave controllers” to “Z-Wave adapters” in the documentation, updating titles, headings, and content to reflect the new terminology.
- Updated the frontmatter title and main headings to use “adapters” instead of “controllers”
- Replaced all inline mentions of “controllers” with “adapters” in lists and paragraphs
- Adjusted the “Stick alternatives” section header to “Stick or module alternatives” and the “Controller notes” section to “Adapter notes”
Comments suppressed due to low confidence (2)
source/_docs/z-wave/controllers.markdown:76
- This line was converted from a list item to a paragraph when renaming controllers to adapters. Consider restoring the leading "- " so it remains part of the bullet list.
If you are just starting out, we recommend that you purchase a 700 series adapter or a Raspberry Pi module. The 700 series adapters are the more recent version (when compared to the 500 series). The 700 series adapters support SmartStart, which allows you to add a device by scanning a QR code.
source/_docs/z-wave/controllers.markdown:1
- Since the document now refers to "adapters" throughout, consider renaming the file from
controllers.markdowntoadapters.markdownfor consistency.
---
📝 Walkthrough""" WalkthroughThe documentation for Z-Wave hardware was updated to consistently use the term "adapter" instead of "controller" or "stick." This includes changes to titles, section headers, warnings, notes, and device lists. The recommended starting hardware was updated to emphasize 800-series adapters with firmware version 7.23.2 or higher. No technical instructions, upgrade procedures, or device lists beyond terminology and recommendations were changed. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation terminology updates. 📜 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)
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_docs/z-wave/controllers.markdown (4)
3-3: Fix grammatical issue in the description sentence
“Extended instructions how to setup Z-Wave.” is ungrammatical. Use “Extended instructions on how to set up Z-Wave.”-description: "Extended instructions how to setup Z-Wave." +description: "Extended instructions on how to set up Z-Wave."
15-16: Use uncountable noun “firmware”
“Firmwares” is not standard English; “firmware versions” or just “firmware” is preferred.-The firmwares of 700 and 800 series Z-Wave adapters have several bugs +The firmware of 700 and 800-series Z-Wave adapters has several bugs
35-36: Minor wording tweak for clarity
Consider inserting “to” for smoother reading.-You should upgrade the firmware on all 700 and 800 series adapters to a recommended version. +You should upgrade the firmware on all 700 and 800-series adapters to a recommended version.
84-85: Reduce repetition of “support(s)”
The sentence repeats “support(s)” twice.-The alternative to a stick or module is a hub that supports Z-Wave. Home Assistant supports the following hubs with Z-Wave support: +Instead of a stick or module, you can use a hub with built-in Z-Wave. Home Assistant supports the following hubs:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/z-wave/controllers.markdown(4 hunks)
⏰ 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
| @@ -73,32 +73,32 @@ Firmware can be upgraded using the below directions: | |||
| - Z-Wave.Me Razberry 2 (500 series) | |||
| - Z-Wave.Me Razberry 1 (300 series) | |||
|
|
|||
| If you are just starting out, we recommend that you purchase a 700 series controller or a Raspberry Pi module. The 700 series controllers are the more recent version (when compared to the 500 series). The 700 series controllers support SmartStart, which allows you to add a device by scanning a QR code. | |||
| If you are just starting out, we recommend that you purchase a 700 series adapter or a Raspberry Pi module. The 700 series adapters are the more recent version (when compared to the 500 series). The 700 series adapters support SmartStart, which allows you to add a device by scanning a QR code. | |||
There was a problem hiding this comment.
Actually, I think this entire sentence needs to be reworked:
- We recommend starting with 800 series now, especially in EU because of the upcoming Long Range support
- 700 series only supports Long Range in US (with one exception)
- 700 and 800 series (and some recent 500 series firmwares) support SmartStart
But this is too complex to explain here, so we should just say that 800 series is the most future proof and has the best RF performance.
|
|
||
| ### 800 Series Controllers | ||
| ### 800 Series Adapters | ||
|
|
||
| Z-Wave JS does not support Z-Wave Long Range yet. |
There was a problem hiding this comment.
Thank you for the catch. Removed!
Co-authored-by: AlCalzone <dominic.griesel@nabucasa.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_docs/z-wave/controllers.markdown (1)
82-86: Minor style polish for hub paragraph (optional)
Flow reads more naturally with the adverbial clause at the end.-For best experience, it is recommended to use an adapter directly with Home Assistant. If this doesn't work for you, you can use a hub that supports Z-Wave. +For the best experience, use an adapter directly with Home Assistant. If that is not possible, you can fall back to a hub that supports Z-Wave.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/z-wave/controllers.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/z-wave/controllers.markdown
[misspelling] ~76-~76: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ing out, we recommend that you purchase a 800-series controller (with firmware up...
(EN_A_VS_AN)
[misspelling] ~76-~76: This word is normally spelled with a hyphen.
Context: ...). The 800-series adapters are the most future proof and have the best RF performance. {% t...
(EN_COMPOUNDS_FUTURE_PROOF)
🔇 Additional comments (1)
source/_docs/z-wave/controllers.markdown (1)
74-78: Reviewcontrollers.markdownfor remaining “controller” & “stick” references
Our grep on source/_docs/z-wave/controllers.markdown found additional occurrences:• The original purchase recommendation (lines 74–78) still uses “controller”
• A generic USB “stick” reference
• Numerous product names (e.g. “Z-Stick”, “USB Stick”)—verify which should stay as branded namesSuggested updates for the generic lines:
--- source/_docs/z-wave/controllers.markdown @@ -74,4 +74,4 @@ -If you are just starting out, we recommend that you purchase a 800-series controller (with firmware updated to >=7.23.2). The 800-series adapters are the most future proof and have the best RF performance. +If you are just starting out, we recommend that you purchase an 800-series adapter (with firmware updated to ≥ 7.23.2). The 800-series adapters are the most future-proof and offer the best RF performance. -It's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through. +It's recommended to use a USB adapter, not a module. Passing a module through Docker is more complicated than passing a USB adapter through.Please audit the remaining branded “Stick” product names and remove or update any other generic “controller”/“stick” references as needed.
|
good point. In that case, "modules": are they always hats/shields? would they then be shield adapters? |
|
I've seen 3 form factors so far:
I would ignore the latter. |
thx! I called it hat adapter, to have the form factor in the title. WDYT? |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_docs/z-wave/controllers.markdown (1)
47-75: Minor consistency polish for list headings
The bullet labels mix “USB adapters” with “hat adapters”, and “hat” is usually capitalised as the trademark “HAT”. Consider tightening the wording for uniformity:-800 series USB adapters -700 series USB adapters -500 series USB adapters -Raspberry Pi hat adapters +800-series USB adapters +700-series USB adapters +500-series USB adapters +Raspberry Pi HAT adaptersThis keeps the form-factor qualifier last and uses hyphens consistently in the series designations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/z-wave/controllers.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/z-wave/controllers.markdown
[misspelling] ~76-~76: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ing out, we recommend that you purchase a 800-series controller (with firmware up...
(EN_A_VS_AN)
[misspelling] ~76-~76: This word is normally spelled with a hyphen.
Context: ...). The 800-series adapters are the most future proof and have the best RF performance. {% t...
(EN_COMPOUNDS_FUTURE_PROOF)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_docs/z-wave/controllers.markdown (5)
15-16: Prefer “firmware versions” over plural “firmwares”“Firmware” is normally treated as an uncountable noun; “firmware versions” reads more naturally and avoids style debates.
-The firmwares of 700 and 800 series Z-Wave adapters have several bugs which impact the stability of the mesh and can cause the adapter to become unresponsive. Because there is no known firmware version that is completely fixed, it is recommended to choose a firmware based on the following criteria: +The firmware versions for 700- and 800-series Z-Wave adapters have several bugs that affect mesh stability and can cause the adapter to become unresponsive. Because no version is completely bug-free, choose a version based on the following criteria:
47-59: Hyphenate “800-series”, “700-series”, “500-series” for consistencyElsewhere (line 76) you use the hyphenated form “800-series adapter”. Keeping the adjectival compound consistently hyphenated improves readability.
-800 series USB adapters +800-series USB adapters … -700 series USB adapters +700-series USB adapters … -500 series USB adapters +500-series USB adapters
69-75: Capitalize “HAT” in Raspberry Pi HAT adapters“HAT” is the official Raspberry Pi term; capitalizing avoids ambiguity with the common noun “hat”.
-Raspberry Pi hat adapters +Raspberry Pi HAT adapters
76-79: Use ASCII “>=” and tighten wordingUnicode ≥ can render inconsistently in some terminals; ASCII “>=” is safer. Minor wording tweaks drop an extra article and keep the sentence tight.
-If you are just starting out, we recommend that you purchase an 800-series adapter (with firmware updated to ≥ 7.23.2). The 800-series adapters are the most future-proof and offer the best RF performance. +If you are just starting out, we recommend purchasing an 800-series adapter (with firmware updated to >= 7.23.2). 800-series adapters are the most future-proof and offer the best RF performance.
81-84: Add missing article “the”Standard English calls for “the best experience”.
-For best experience, it is recommended to use an adapter directly with Home Assistant. +For the best experience, use an adapter directly with Home Assistant.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/z-wave/controllers.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/z-wave/controllers.markdown
[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ... {% endtip %} ## Third-party hubs For best experience, it is recommended to use an...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ 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
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit