home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Mention another Zigbee limitation in ZHA docs

Open Hedda opened this issue 1 year ago • 2 comments

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).
  • [x] 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

  • [x] 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.
  • [x] 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.

Hedda avatar Jun 26 '24 07:06 Hedda

📝 Walkthrough
📝 Walkthrough
📝 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.

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

coderabbitai[bot] avatar Jun 26 '24 07:06 coderabbitai[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit f04b8281d2dee174a345a4a51b6f4ccac165d6d3
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6718e8b5f43a300008def6f6
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.

netlify[bot] avatar Jun 26 '24 07:06 netlify[bot]

I don't think listing limitations like this is useful. There are many limitations, too many to list, and further expanding the one page of documentation isn't good.

puddly avatar Jul 05 '24 19:07 puddly

I don't think listing limitations like this is useful.

I disagree in the use case when new users ask in the Home Assistant community forum why something is not working it is easy to simply refer to ZHA integration documentation by just giving them a link to that section, as then they usually accept that as fact.

Alternative is having to explain to each and every new users asking the same thing, and even then they might not accept that answer because it is not documented.

Example is now a lot of new users now asking to use a network-attatched Zigbee Coordinator either to connect Zigbee devices over VPN to a other site or over LAN from a other area if flash as Zigbee Router. For those asking about that there is now always a long dialogue explaing why it is a bad idea or why it is not will not work.

Note that some makers of those even added Wireguard VPN to them which makes new users think it is a good idea to use it -> https://smlight.tech/manual/slzb-06/guide/remote-vpn-conn/

Another example is Zigbee Green Power which is documented as a limitation, here we can simply point them to the documentation and they accept that.

Reference:

  • https://community.home-assistant.io/t/connecting-zigbee-devices-over-the-internet/741245

  • https://community.home-assistant.io/t/how-to-connect-zigbee-lan-coordinator-and-zha-via-wireguard-vpn/719057

  • https://community.home-assistant.io/t/uzg-01-vs-sonoff-more-then-1-mqtt-or-use-uzg-as-router/743332/

Hedda avatar Jul 06 '24 09:07 Hedda

The documentation isn't a FAQ and doesn't need to hold the answers to every question someone asks. We can invest in setting up a FAQ independent of the documentation in the future but for now, I do not think this is a beneficial change.

puddly avatar Jul 08 '24 18:07 puddly

The documentation isn't a FAQ and doesn't need to hold the answers to every question someone asks. We can invest in setting up a FAQ independent of the documentation in the future but for now, I do not think this is a beneficial change.

Resubmitting this. Think there is of benefit to having n ZHA documentation, at least until can be moved to an independent FAQ.

Hedda avatar Oct 01 '24 11:10 Hedda

Closing for the aforementioned reason.

puddly avatar Oct 25 '24 22:10 puddly

Sad as there is still no seperate FAQ for Zigbee or ZHA, nor has anyone annonced plans to create webpages for such FAQs.

Hedda avatar Oct 26 '24 08:10 Hedda