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

Add min_request_interval to WBE2-I-EBUS template #832

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

KraPete
Copy link
Contributor

@KraPete KraPete commented Nov 18, 2024

Boiler's controller is not designed for fast polling. Limit requests to it by setting min_request_interval=1000

В инструкции по подключению модуля указано использование устаревшей настройки wb-mqtt-serial. Она нужна для ограничения числа запросов к бойлеру. Заменим эту настройку на актуальную

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration option to the WBE2-I-EBUS template, allowing users to set a minimum request interval of 1000 milliseconds.
  • Improvements

    • Enhanced reliability by ensuring press_counter register values are stored immediately, preventing outdated data publication after unexpected service restarts.
    • Improved handling of fast Modbus events after device restarts.

Boiler's controller is not designed for fast polling. Limit requests to it by setting min_request_interval=1000
@KraPete KraPete requested review from a team November 18, 2024 10:44
@KraPete KraPete requested a review from sikmir as a code owner November 18, 2024 10:44
Copy link

coderabbitai bot commented Nov 18, 2024

Walkthrough

The changes in this pull request involve updates to the wb-mqtt-serial package, specifically in the changelog and the configuration for the WBE2-I-EBUS device. A new configuration option, min_request_interval=1000, has been added to regulate the minimum interval between requests. The changelog reflects these updates, documenting the addition of this feature and summarizing previous improvements, including enhancements to device templates and the handling of register values.

Changes

File Change Summary
debian/changelog Updated to version 2.147.2; added min_request_interval=1000 for WBE2-I-EBUS template.
templates/config-wbe2-i-ebus.json Introduced new property "min_request_interval": 1000 in the device object; no other changes.

Possibly related PRs

  • Fix reconfiguration of fast modbus events #831: The main PR introduces a new configuration option related to request intervals, while the retrieved PR focuses on reconfiguring fast Modbus events after a device restart, indicating a direct connection in terms of device communication and configuration management.

Suggested reviewers

  • ekateluv

Poem

In the garden of code, changes bloom,
A new interval, dispelling the gloom.
With requests spaced just right,
Devices dance in delight,
As the rabbit hops, dispelling the room! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c8fc963 and 87f264c.

📒 Files selected for processing (1)
  • debian/changelog (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • debian/changelog

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 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

@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

🧹 Outside diff range and nitpick comments (1)
templates/config-wbe2-i-ebus.json (1)

8-8: Consider adding a comment to document the min_request_interval parameter.

While the parameter name is self-explanatory, it would be helpful to add a JSON comment or update the documentation to explain:

  • The purpose of this parameter (preventing rapid polling)
  • The unit of measurement (milliseconds)
  • The recommended range of values

Would you like me to help draft the documentation for this parameter?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eef5e74 and c8fc963.

📒 Files selected for processing (2)
  • debian/changelog (1 hunks)
  • templates/config-wbe2-i-ebus.json (1 hunks)
🔇 Additional comments (2)
templates/config-wbe2-i-ebus.json (1)

8-8: LGTM! The min_request_interval addition looks good.

The addition of min_request_interval: 1000 is well-placed at the device level and will effectively prevent rapid polling of the boiler controller. The 1-second interval is a reasonable default that balances responsiveness with controller stability.

debian/changelog (1)

1-5: Changelog entry matches PR objectives

The changelog entry correctly documents:

  • The addition of min_request_interval=1000 to WBE2-I-EBUS template
  • Version increment from 2.147.0 to 2.147.1
  • Proper maintainer information and date

@KraPete KraPete merged commit 60a2dfe into master Nov 21, 2024
7 of 14 checks passed
@KraPete KraPete deleted the bugfix/SOFT-4615-ebus-template branch November 21, 2024 06:25
@coderabbitai coderabbitai bot mentioned this pull request Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants