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

Deprecate multiprotocol #3833

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

puddly
Copy link
Collaborator

@puddly puddly commented Nov 21, 2024

I've removed the ability of the addon to flash multiprotocol firmware and have updated the README to reflect the addon's formal deprecation. It hasn't received any updates in about a year now and will not receive any for the foreseeable future, as we are focusing on improving our individual Zigbee and Thread firmwares.

Summary by CodeRabbit

  • Documentation

    • Updated add-on documentation and version information to 2.4.6. The add-on is now clearly marked as deprecated, advising users to migrate to a single-protocol (either Zigbee or Thread) setup.
  • Chores

    • Disabled automatic firmware flashing. Users requiring firmware reinstallation can perform this manually using the available flashing tools.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 8 out of 12 changed files in this pull request and generated no suggestions.

Files not reviewed (4)
  • silabs-multiprotocol/Dockerfile: Language not supported
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type: Language not supported
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up: Language not supported
  • silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up: Language not supported
@github-actions github-actions bot added the stale label Jan 26, 2025
@github-actions github-actions bot closed this Feb 2, 2025
@puddly puddly reopened this Feb 19, 2025
@puddly puddly force-pushed the puddly/multiprotocol-deprecation branch 2 times, most recently from 3956c20 to b6abdb1 Compare February 19, 2025 15:33
@puddly
Copy link
Collaborator Author

puddly commented Feb 19, 2025

@agners Have you run into this before? This image no longer builds on armhf because of a SIGSEGV during bytecode compilation of python3-async-timeout. This exact image built a few months ago but I guess something changed 😅.

#32 100.3 Setting up python3-async-timeout (3.0.1-1.1) ...
#32 101.1 Traceback (most recent call last):
#32 101.1   File "/usr/bin/py3compile", line 319, in <module>
#32 101.1     main()
#32 101.1   File "/usr/bin/py3compile", line 298, in main
#32 101.1     compile(files, versions,
#32 101.1   File "/usr/bin/py3compile", line 185, in compile
#32 101.1     cfn = interpreter.cache_file(fn, version)
#32 101.1   File "/usr/share/python3/debpython/interpreter.py", line 212, in cache_file
#32 101.1     (fname[:-3], self.magic_tag(version), last_char))
#32 101.1   File "/usr/share/python3/debpython/interpreter.py", line 246, in magic_tag
#32 101.1     return self._execute('import imp; print(imp.get_tag())', version)
#32 101.1   File "/usr/share/python3/debpython/interpreter.py", line 359, in _execute
#32 101.1     raise Exception('{} failed with status code {}'.format(command, output['returncode']))
#32 101.1 Exception: python3.9 -c 'import imp; print(imp.get_tag())' failed with status code 139
#32 101.1 dpkg: error processing package python3-async-timeout (--configure):
#32 101.1  installed python3-async-timeout package post-installation script subprocess returned error exit status 1

@github-actions github-actions bot removed the stale label Feb 19, 2025
@agners
Copy link
Member

agners commented Feb 20, 2025

@agners Have you run into this before? This image no longer builds on armhf because of a SIGSEGV during bytecode compilation of python3-async-timeout. This exact image built a few months ago but I guess something changed 😅.

Hm, yeah, lately the whole QEMU based builds started too be rather unreliable, especially for aarch64. We run into that problem also in the Docker base images (see home-assistant/docker-base#294). What did help so far is using the ubuntu-22.04 runners instead. This would affect all add-on, but that is fine from my point of view.

@puddly puddly force-pushed the puddly/multiprotocol-deprecation branch from 7fc26c8 to bf08819 Compare February 20, 2025 18:09
@puddly puddly marked this pull request as ready for review February 20, 2025 18:34
Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

📝 Walkthrough

Walkthrough

The multiprotocol add-on has been updated to mark it as deprecated and disable automatic firmware flashing. Documentation files (CHANGELOG, README, and config) now reflect a version bump to 2.4.6, a deprecated status, and a recommendation for manual flashing. The Dockerfile and build configuration have been modified to replace the Git-based Gecko SDK retrieval with a ZIP download via curl and to remove any reference to the UNIVERSAL_SILABS_FLASHER dependency. Additionally, several service scripts related to the automatic flashing mechanism have been removed from the s6-overlay directories.

Changes

File(s) Change Summary
silabs-multiprotocol/CHANGELOG.md, silabs-multiprotocol/README.md, silabs-multiprotocol/config.yaml Updated version (2.4.6), marked the add-on as deprecated, added notes on disabling automatic firmware flashing, and updated documentation details.
silabs-multiprotocol/Dockerfile, silabs-multiprotocol/build.yaml Modified Dockerfile to use a curl-based ZIP download for the Gecko SDK; removed ARG UNIVERSAL_SILABS_FLASHER and its corresponding variable from build configurations.
silabs-multiprotocol/rootfs/.../universal-silabs-flasher (files: type, up, and scripts/universal-silabs-flasher-up) Removed service configuration and initialization scripts that previously handled automatic firmware flashing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Addon
    participant ManualFlasher
    User->>Addon: Install/Update multiprotocol add-on
    Addon-->>User: Return version 2.4.6 with deprecation notice and auto flashing disabled
    Note right of Addon: Auto firmware flash scripts removed
    User->>ManualFlasher: Initiate manual firmware flashing
    ManualFlasher-->>User: Firmware flashing completed
Loading

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
silabs-multiprotocol/README.md (1)

5-5: Review markdown header formatting.
The header currently escapes the square brackets (\[DEPRECATED\]). Consider removing the backslashes so that the text renders naturally as [DEPRECATED] for clarity and consistency with standard Markdown practices.

silabs-multiprotocol/CHANGELOG.md (1)

4-4: Enhance sentence clarity.
Insert a comma before but in the sentence “It will continue running as usual but you should…” to improve readability and adhere to proper punctuation rules.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...

(COMMA_COMPOUND_SENTENCE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 13c92fd and bf08819.

📒 Files selected for processing (8)
  • silabs-multiprotocol/CHANGELOG.md (1 hunks)
  • silabs-multiprotocol/Dockerfile (1 hunks)
  • silabs-multiprotocol/README.md (1 hunks)
  • silabs-multiprotocol/build.yaml (0 hunks)
  • silabs-multiprotocol/config.yaml (2 hunks)
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type (0 hunks)
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up (0 hunks)
  • silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up (0 hunks)
💤 Files with no reviewable changes (4)
  • silabs-multiprotocol/build.yaml
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/type
  • silabs-multiprotocol/rootfs/etc/s6-overlay/s6-rc.d/universal-silabs-flasher/up
  • silabs-multiprotocol/rootfs/etc/s6-overlay/scripts/universal-silabs-flasher-up
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...

*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...

*/**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.
  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Be brief in your replies and don...

*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...

*/**(html|markdown|md): - Use sentence-style capitalization also in headings.

  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: do not comment on HTML used for ic...

*/**(html|markdown|md): do not comment on HTML used for icons

  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...

*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

  • silabs-multiprotocol/CHANGELOG.md
  • silabs-multiprotocol/README.md
  • silabs-multiprotocol/Dockerfile
  • silabs-multiprotocol/config.yaml
🪛 LanguageTool
silabs-multiprotocol/CHANGELOG.md

[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...

(COMMA_COMPOUND_SENTENCE)

🔇 Additional comments (7)
silabs-multiprotocol/README.md (1)

1-4: Deprecation notice is clear and actionable.
The caution block clearly informs users that multiprotocol support is discontinued and directs them to the appropriate migration instructions.

silabs-multiprotocol/config.yaml (3)

2-2: Version update verified.
The version is updated to 2.4.6, which aligns with the deprecation change.


4-4: Add-on naming correctly reflects deprecation.
The name "[Deprecated] Silicon Labs Multiprotocol" clearly communicates the add-on’s status.


53-53: Stage update confirms deprecation status.
Setting the stage to deprecated ensures that users are aware of the add-on’s status in the ecosystem.

silabs-multiprotocol/CHANGELOG.md (1)

3-6: Changelog entry documents deprecation and flashing changes.
The new 2.4.6 entry clearly explains that the add-on is deprecated and that automatic firmware flashing is disabled in favor of manual flashing options.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~4-~4: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...addon. It will continue running as usual but you should find an alternative way to r...

(COMMA_COMPOUND_SENTENCE)

silabs-multiprotocol/Dockerfile (2)

1-10: Verify removal of unused build argument.
The Dockerfile no longer references ARG UNIVERSAL_SILABS_FLASHER, which is consistent with the deprecation of multiprotocol functionality. Confirm that no lingering references to this argument exist in any associated build scripts.


110-112: Streamlined Gecko SDK retrieval is efficient.
Using curl to download the Gecko SDK ZIP and cleaning up afterward with rm helps to reduce unnecessary build image clutter.

@@ -1,5 +1,9 @@
# Changelog

## 2.4.6
- Formally deprecate the addon. It will continue running as usual but you should find an alternative way to run both Zigbee and Thread if you use both with the same adapter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changelog will be shown quite prominently for most users on upgrade. Ideally we use this to link to instructions how users can move their installation to Zigbee/Thread only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants