esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Update rf_bridge.rst

Open zd3sf opened this issue 11 months ago • 9 comments

Added references to mightymos firmware

Description:

  1. Clarified introduction for easier readability.
  2. Clarified uart_id configuration variable
  3. Added reference to "Mightymos" firmware alongside Portisch
  4. Moved bridge.beep out of portisch section because no Portisch is needed for beeping
  5. Add a link for another, more user friendly B1 converter
  6. extended the example at the end.

Closes #4521

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#<esphome PR number goes here>

Checklist:

  • [ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [x] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • [ ] Link added in /index.rst when creating new documents for new components or cookbook.

zd3sf avatar Dec 28 '24 03:12 zd3sf

Walkthrough

The pull request updates the RF Bridge component documentation to clarify hardware variants, UART configuration, and event handling. It reintroduces the send_raw action, adds a new beep action, and expands support for advanced firmware features including sniffing and sending advanced codes. Home Assistant integration and ESPHome examples are enhanced with new actions and triggers.

Changes

File Changes
components/rf_bridge.rst - Clarified MCU types for black (EFM8BB1) and white (OB38S003) Sonoff RF Bridges
- Updated UART config with explicit id, reordered variables
- Refined on_code_received trigger description
- Updated rf_bridge.send_code with standard code and id usage
- Reintroduced rf_bridge.send_raw with OEM and advanced firmware examples
- Added new rf_bridge.beep action
- Added advanced firmware support: on_advanced_code_received, send_advanced_code, start_advanced_sniffing, stop_advanced_sniffing
- Updated start_bucket_sniffing with overflow fix note and new conversion tool
- Added radio reset instructions
- Expanded Home Assistant examples with UART, logger, raw sending, and event handling
- Added ESPHome template buttons and switches for advanced sniffing, beeping, and radio reset
- Updated "See Also" with Mightymos firmware link

Assessment against linked issues

Objective Addressed Explanation
Update rf_bridge.rst documentation (#4521)
Clarify support for new white box firmware Documentation includes Mightymos firmware and advanced features for white Sonoff bridge
Provide updated UART and event handling info UART configuration and event triggers updated with detailed examples and explanations
Add examples for advanced sniffing and sending New actions, triggers, and example automations for advanced sniffing and sending included

Suggested reviewers

  • nagyrobi

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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 Dec 28 '24 04:12 coderabbitai[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit 513d029dfc09a1f1903a47d9f66fb3feef336518
Latest deploy log https://app.netlify.com/projects/esphome/deploys/685c8ade2b7a010008478834
Deploy Preview https://deploy-preview-4541--esphome.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 project configuration.

netlify[bot] avatar Dec 28 '24 04:12 netlify[bot]

Hi thanks for the review.

Yes UART_id is not a valid syntax in esphome, there's a id for the UART component and and id for the bridge component. UART_id was confusing to some users and I have seen few questions about it in the community forum. we can remove the id for UART hub as users can go to the UART component page if they want to learn more about UART.

zd3sf avatar Jan 05 '25 18:01 zd3sf

You can't have in the documentation, in the same section two id options meaning different things...

nagyrobi avatar Jan 05 '25 18:01 nagyrobi

Now worries, UART id configuration variable was removed.

zd3sf avatar Jan 05 '25 19:01 zd3sf

@nagyrobi Is it good to go now?

zd3sf avatar Jan 12 '25 05:01 zd3sf

@nagyrobi. Please let me know if you propose any additional changes.

zd3sf avatar Mar 20 '25 18:03 zd3sf

Still pending review?

zd3sf avatar May 23 '25 02:05 zd3sf

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.

esphome[bot] avatar May 28 '25 05:05 esphome[bot]