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

Zigbee FAQ about missing links in ZHA visualization

Open Hedda opened this issue 1 year ago • 2 comments

Proposed change

ZHA visualization UI related Zigbee FAQ about missing links showing under Zigbee network topology in ZHA visualization UI.

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
    • Added explanations for missing links in Zigbee network topology maps, particularly for Zigbee End Devices.
    • Provided guidance on interpreting RSSI and LQI values for troubleshooting Zigbee messages.

Hedda avatar Jun 26 '24 09:06 Hedda

Walkthrough

Walkthrough

The recent updates enhance the explanation of missing links in Zigbee network topology maps, specifically for Zigbee End Devices. The added content clarifies that the absence of links, especially for battery-powered devices, is typical and does not necessarily indicate connectivity issues. Additionally, it provides insights into the behavior of "sleepy" Zigbee End Devices, such as Xiaomi door sensors, and offers guidance on interpreting RSSI and LQI values for troubleshooting Zigbee messages.

Changes

Files Change Summary
source/_integrations/zha.markdown Expanded explanations on missing links in Zigbee network topology maps for battery-powered End Devices. Included a detailed discussion on the behavior of "sleepy" Zigbee End Devices in relation to child ageing by Zigbee Routers and how communication can occur despite missing links. Provided guidance on interpreting RSSI and LQI values for troubleshooting Zigbee messages.

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 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 09:06 coderabbitai[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit b367175ca37ca3a4f9f4f1ad49b8cf2b342e3a4d
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/668542fad99fd900088831fc
Deploy Preview https://deploy-preview-33419--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 09:06 netlify[bot]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar Jul 03 '24 05:07 home-assistant[bot]

I realize end and router devices are sometimes capitalized elsewhere on this page, but I think they should be lower-case.

@c0ffeeca7 I changed as requested as I do not not want that to be showstopper but IMHO they really should be capitilized because they are in the official Zigbee specification from the CSA (Zigbee Alliance). Also note that the official abbriviation for Zigbee Router is ZR, and abbriviatiob for Zigbee End Device is ZED. Since it is the name for something and not just a function it be like writing ”Connectivity standards alliance” instead of ”Connectivity Standards Alliance”, or writing ”Iot” instead of ”IoT” as abbriviation for ”Internet of Things”

Hedda avatar Jul 03 '24 12:07 Hedda

I realize end and router devices are sometimes capitalized elsewhere on this page, but I think they should be lower-case.

@c0ffeeca7 I changed as requested as I do not not want that to be showstopper but IMHO they really should be capitilized because they are in the official Zigbee specification from the CSA (Zigbee Alliance). Also note that the official abbriviation for Zigbee Router is ZR, and abbriviatiob for Zigbee End Device is ZED. Since it is the name for something and not just a function it be like writing ”Connectivity standards alliance” instead of ”Connectivity Standards Alliance”, or writing ”Iot” instead of ”IoT” as abbriviation for ”Internet of Things”

Maybe I'm looking in the wrong place. I looked at a source from the zibeealliance.org. There, they use sentence-style capitalization on both end device and router device quite often (although, they also use the heading-style version) image

c0ffeeca7 avatar Jul 03 '24 13:07 c0ffeeca7