Z-Wave: set radio frequency region #39499
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new informational section was added to the Z-Wave JS integration documentation. This section details how to set or change the radio frequency region of the Z-Wave controller, explains regional compliance, and provides step-by-step instructions for updating the frequency region in the Z-Wave JS add-on settings. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Home Assistant UI
participant Z-Wave JS Add-on
User->>Home Assistant UI: Open Z-Wave JS Add-on configuration
User->>Home Assistant UI: Select desired radio frequency region
User->>Home Assistant UI: Save configuration changes
Home Assistant UI->>Z-Wave JS Add-on: Apply new frequency region setting
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (2)
source/_integrations/zwave_js.markdown (2)
189-192: Improve grammar and clarity
A few sentences could be tightened for grammar and consistency. For example:-The frequency used for Z-Wave depends on your region. For each country or region, the Z-Wave products has to apply the standard Z-Wave frequency used and approved in that region. +Z-Wave operates on different frequencies depending on the region. Z-Wave products must comply with the frequency approved for their region. -During onboarding of your controller, the region of your Home Assistant is used to determine the region in the Z-Wave JS add-on. If needed, you can change this radio frequency region for your controller. However, the region of the device cannot be changed. It only works in the frequency region it was specified for. +When onboarding your controller, Home Assistant’s region is used to set the initial frequency in the Z-Wave JS add-on. You can later change your controller’s frequency region, but individual devices cannot be reprogrammed and only operate in the region they were manufactured for.
193-200: Align instruction heading and list style
Existing sections use gerund-based subheadings rather than “To …”. Please update the step heading and ensure the note under step 4 isn’t mistaken for a nested list:-### To change the radio frequency region of your Z-Wave controller +### Changing the radio frequency region of your Z-Wave controllerAnd consider formatting the final bullet as a standalone note:
4. To apply your changes, select **Save**. > Your Z-Wave controller is now ready to communicate with devices approved for that region.
📜 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/_integrations/zwave_js.markdown(1 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
🔇 Additional comments (1)
source/_integrations/zwave_js.markdown (1)
187-188: Heading Level and Placement
The new section is well-positioned immediately after the migration steps and correctly uses a level-2 heading to match other top-level sections.
Co-authored-by: AlCalzone <[email protected]>
Co-authored-by: Martin Hjelmare <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
192-193: Clarify possessive phrasing.
Change "the country of your Home Assistant" to "Home Assistant's country" for readability:- If you are using the Z-Wave JS add-on, the country of your Home Assistant is used to determine the radio frequency region. + If you are using the Z-Wave JS add-on, Home Assistant's country is used to determine the radio frequency region.
🧹 Nitpick comments (3)
source/_integrations/zwave_js.markdown (3)
187-188: Remove extra blank line.
There are two consecutive blank lines before the new section; reduce to a single blank line to satisfy markdown linting (MD012).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
188-190: Simplify the heading.
Consider shortening to "Setting the radio frequency region in the Z-Wave JS add-on" to avoid redundant wording ("of the controller" is implied).
196-198: Use consistent terminology for device approval.
Replace "specified for that region" with "approved for that region" to match earlier phrasing:- All your Z-Wave devices must be specified for that region + All your Z-Wave devices must be approved for that region
📜 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/_integrations/zwave_js.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
187-187: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ 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
🔇 Additional comments (1)
source/_integrations/zwave_js.markdown (1)
202-205: Verify UI label accuracy.
Please confirm in the Z-Wave JS add-on UI that the setting is exactly labeled "Radio Frequency Region". If it differs (e.g., "RF Region"), update the docs accordingly.
| The frequency used by Z-Wave devices depends on your region. For each country or region, the Z-Wave product has to apply the standard Z-Wave frequency approved for that region. This means that when you buy a Z-Wave product, you need to make sure it is approved for your region. | ||
|
|
||
| If you are using the Z-Wave JS add-on, the country of your Home Assistant is used to determine the radio frequency region. If needed, you can change the radio frequency region for your controller. However, the region of end devices cannot be changed. They only work in the frequency region they were specified for. |
There was a problem hiding this comment.
Something about these two paragraph bugs me a bit. How about something in this direction?
| The frequency used by Z-Wave devices depends on your region. For each country or region, the Z-Wave product has to apply the standard Z-Wave frequency approved for that region. This means that when you buy a Z-Wave product, you need to make sure it is approved for your region. | |
| If you are using the Z-Wave JS add-on, the country of your Home Assistant is used to determine the radio frequency region. If needed, you can change the radio frequency region for your controller. However, the region of end devices cannot be changed. They only work in the frequency region they were specified for. | |
| The frequency used by Z-Wave devices depends on your region. For 700 and 800 series controllers, this frequency can be changed. The frequency of end devices cannot, so you need to make sure to buy devices specific to your region. | |
| If you are using the Z-Wave JS add-on, Home Assistant automatically changes the radio frequency region to match the region/country you're in. If needed, you can override this setting. |
|
|
||
| 1. Go to {% my supervisor_addon addon="core_zwave_js" title="**Settings** > **Add-ons** > **Z-Wave JS**" %}. | ||
| 2. Open the **Configuration** tab. | ||
| 3. In the **Options** section, select the **Radio Frequency Region**. |
There was a problem hiding this comment.
AFAIK we have an "Automatic" option, which is the default. Should we mention this here?
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit