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

Remove universal XZG Firmware under recommended adapters #35118

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

Hedda
Copy link
Contributor

@Hedda Hedda commented Oct 7, 2024

Proposed change

Remove listing of universal XZG Firmware under the list of recommended radio adapters since the XZG Firmware linked is not actually a Zigbee Coordinator adapter pruduct itself but instead a open-source firmware SDK for ESP32 that allows anyone to create a network-attached Zigbee Coordinator as a Serial over IP proxy, and because it is not a specific product it would not be a good idea to add it to the list there as blanket recommendation for any adapter that is built using XZG Firmware, and there is today in fact multiple companies and people making XZG Firmware based adapters that use different Zigbee Coordinator chips (including both various Texas Instruments and Silicon Labs radio MCUs as well as others).

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

This will partially revert #33161 but not the important part about auto discovery.

Please do not get me wrong, @xyzroe is doing a great job, but the "XZG Firmware" itself does not belong under the list of recommend radio adapters for ZHA as it is not a specific adapter so it can not be generalized as a catch-all for all possible adapters based on it today and in the future.

  • 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
    • Enhanced documentation for the Zigbee Home Automation (ZHA) integration.
    • Improved clarity on device compatibility and configuration instructions.
    • Expanded hardware compatibility section with detailed recommendations.
    • Updated troubleshooting guidance for common issues and best practices.

Remove universal XZG Firmware since it itself is an Zigbee Coordinator adapter

  - [XZG - Universal Firmware for Zigbee Gateway](https://xzg.xyzroe.cc/)
@home-assistant home-assistant bot added current This PR goes into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 7, 2024
Copy link

netlify bot commented Oct 7, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 9d509ba
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6718e735cce33d0008aeb992
😎 Deploy Preview https://deploy-preview-35118--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.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Oct 7, 2024
@home-assistant
Copy link

home-assistant bot commented Oct 7, 2024

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

📝 Walkthrough

Walkthrough

The changes in the source/_integrations/zha.markdown file involve significant updates to the documentation for the Zigbee Home Automation (ZHA) integration within Home Assistant. The updates include a refined introduction, expanded sections on device compatibility, enhanced configuration instructions, and a comprehensive troubleshooting guide. These modifications aim to improve the clarity and usability of the documentation, providing users with detailed information on hardware compatibility, configuration options, and troubleshooting steps.

Changes

File Change Summary
source/_integrations/zha.markdown Extensive updates to documentation, including enhanced sections on device compatibility, configuration, and troubleshooting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ZHA
    participant ZigbeeDevice

    User->>ZHA: Configure Zigbee integration
    ZHA->>User: Provide configuration options
    User->>ZHA: Select device and set parameters
    ZHA->>ZigbeeDevice: Permit new device
    ZigbeeDevice-->>ZHA: Device connected
    ZHA->>User: Device added successfully
    User->>ZHA: Troubleshoot connection issues
    ZHA->>User: Provide troubleshooting steps
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6a57e7e and 0d32b59.

📒 Files selected for processing (1)
  • source/_integrations/zha.markdown (0 hunks)
💤 Files with no reviewable changes (1)
  • source/_integrations/zha.markdown

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.

@xyzroe
Copy link
Contributor

xyzroe commented Oct 23, 2024

today in fact multiple companies and people making XZG Firmware based adapters that use different Zigbee Coordinator chips (including both various Texas Instruments and Silicon Labs radio MCUs as well as others).

@Hedda This statement is not true, because XZG only supports TI 2652*. Support for other families is not implemented.

@Hedda
Copy link
Contributor Author

Hedda commented Oct 23, 2024

@xyzroe XZG firmware is open-source so what is stopping anyone from using it on for example anDIY or Smlight’s EFR32MG21 and/or EFR32MG24 based adapters? They might not be able to use all the extra features out of the box but can still use the serial to iP server which is the only feature that is direct relevant to the ZHA integration.

https://smlight.tech/

image

@xyzroe
Copy link
Contributor

xyzroe commented Oct 23, 2024

xyzroe/XZG#66
xyzroe/XZG#77
and many others cases in PM and community chats

@puddly
Copy link
Contributor

puddly commented Oct 23, 2024

I don't think a generic serial-to-TCP firmware itself is useful to note in ZHA documentation, as issues with specific adapters won't reflect in the firmware.

Once home-assistant/core#126294 is finished the specific TCP-enabling firmware will be irrelevant, since they all will be supported identically.

@puddly puddly merged commit 2761168 into home-assistant:current Oct 23, 2024
7 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Oct 23, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants