Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention another Zigbee limitation in ZHA docs #33417

Open
wants to merge 2 commits into
base: current
Choose a base branch
from

Conversation

Hedda
Copy link
Contributor

@Hedda Hedda commented Jun 26, 2024

Proposed change

Mention another Zigbee limitation in the ZHA integration docs, (and also tried to further clarify an already described limitation).

The limitation of not being able to extend a Zigbee network using some kind of "Zigbee over IP" or "Zigbee over LAN/WAN" has become a frequently asked question in the Home community forum as network-attached Zigbee adapters are becoming more common and many people seem to assume that they can use one or more of those as a remote Zigbee Router device to extend their existing Zigbee network to multiple locations by converting and tunneling the Zigbee Router traffic over LAN and/or WAN.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Clarified limitations of Zigbee device functionality, including:
      • Single Zigbee Coordinator constraint.
      • Requirement to factory reset devices to switch networks.
      • Lack of support for "Zigbee over IP."
      • Inability to extend Zigbee networks over LAN/WAN.

Mention another Zigbee limitation in ZHA docs
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jun 26, 2024
Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

Walkthrough

The changes clarify the limitations of Zigbee networking within the documentation, emphasizing the necessity of a single Zigbee Coordinator, the requirement of factory resetting devices to switch networks, the absence of "Zigbee over IP" support, and the impossibility of extending Zigbee networks over LAN/WAN. These updates aim to eliminate any ambiguity related to Zigbee device networking and interconnectivity.

Changes

Files Change Summary
source/_integrations/zha.markdown Clarified limitations regarding Zigbee device connections, emphasizing the single Coordinator constraint and network limits.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 0d26fc2 and 74df48c.

Files selected for processing (1)
  • source/_integrations/zha.markdown (1 hunks)
Additional context used
Markdownlint
source/_integrations/zha.markdown

340-340: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


341-341: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


342-342: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


343-343: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


533-533: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


534-534: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


545-545: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


546-546: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


551-551: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


553-553: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


637-637: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


402-402: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


472-472: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


494-494: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


521-521: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


530-530: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


532-532: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


533-533: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


534-534: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


536-536: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


582-582: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


594-594: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


522-522: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


531-531: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


532-532: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


533-533: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


636-636: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


637-637: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


137-137: Element: div
Inline HTML

(MD033, no-inline-html)


231-231: Element: div
Inline HTML

(MD033, no-inline-html)


337-337: Element: div
Inline HTML

(MD033, no-inline-html)


428-428: Element: div
Inline HTML

(MD033, no-inline-html)


279-279: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


279-279: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


279-279: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


279-279: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


390-390: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


390-390: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


390-390: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


390-390: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


72-72: null
Link fragments should be valid

(MD051, link-fragments)

Additional comments not posted (2)
source/_integrations/zha.markdown (2)

498-498: Clarification of Zigbee network limitations

The added explanation clearly outlines the limitation regarding the inability of Zigbee devices to be paired with more than one Zigbee network. This is a crucial clarification for users looking to understand the fundamental constraints of Zigbee technology.


500-500: Detailed explanation on the impossibility of extending Zigbee networks over LAN/WAN

This addition effectively addresses a common misconception about Zigbee networks. It's important for users to understand that Zigbee networks cannot be extended over LAN/WAN due to the limitations of the protocol itself. The explanation is technically accurate and aligns with the Zigbee specifications.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 74df48c
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/667e62f3908d45000836737a
😎 Deploy Preview https://deploy-preview-33417--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Removed the line "**This also makes the Zigbee Coordinator a SPOF (Single-Point-Of-Failure) in your Zigbee network, so it needs to be available for your Zigbee devices to stay connected.**" after received feedback that some devices can sometimes still be controlled directly even if Zigbee Coordinator is down if and when a Zigbee binding is configured.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant