Skip to content

Add number platform to eheimdigital #38504

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

Merged
merged 1 commit into from
Apr 15, 2025

Conversation

autinerd
Copy link
Contributor

@autinerd autinerd commented Apr 13, 2025

Proposed change

This adds the number platform to eheimdigital.

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

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.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced numerical settings for precise control over temperature readings, enabling adjustments for both standard and night temperature offsets.
    • Enhanced pump speed management for EHEIM classicVARIO+e, offering manual, day, and night speed options.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 13, 2025
Copy link

netlify bot commented Apr 13, 2025

Deploy Preview for home-assistant-docs ready!

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

Copy link
Contributor

coderabbitai bot commented Apr 13, 2025

📝 Walkthrough

Walkthrough

The changes update the EHEIM Digital integration documentation by introducing a new "Number" category. This category is now included in both the ha_category and ha_platforms sections. The documentation elaborates on numerical functionalities by detailing "Temperature offset" and "Night temperature offset" settings. Additionally, the EHEIM classicVARIO+e section has been expanded to include pump speed settings through the "Manual speed", "Day speed", and "Night speed" features.

Changes

File Change Summary
source/_integrations/eheimdigital.markdown Added a new "Number" category in ha_category and a new platform "number" in ha_platforms. Documented new features: "Temperature offset", "Night temperature offset", "Manual speed", "Day speed", and "Night speed".

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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.
    • 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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)
source/_integrations/eheimdigital.markdown (2)

54-57: New 'Number' Section for Temperature Offsets:
This new section under the EHEIM thermocontrol+e heading clearly outlines the temperature offset features—both for the standard and night settings. You might consider adding a brief example or clarification on ideal offset ranges to enhance user understanding.


61-65: New 'Number' Section for Pump Speed Settings:
The added Number section for the EHEIM classicVARIO+e integration effectively documents the pump speed settings across different modes. For additional clarity, consider outlining the expected range or units for these speed settings if applicable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6426cd and 9cdd36b.

📒 Files selected for processing (1)
  • source/_integrations/eheimdigital.markdown (3 hunks)
🔇 Additional comments (2)
source/_integrations/eheimdigital.markdown (2)

7-7: Addition of 'Number' in ha_category:
The new entry Number in the ha_category list clearly communicates that the integration now supports numerical controls. Please ensure that this aligns with Home Assistant’s documentation schema for categories.


19-19: Addition of 'number' in ha_platforms:
Including number in the ha_platforms section is consistent with the naming conventions (using lowercase) and accurately reflects the new feature support.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

✅ Approved. Can be merged as soon as the parent PR gets merged.

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 14, 2025
@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Apr 14, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 15, 2025
@joostlek joostlek merged commit 3e8e6cc into home-assistant:next Apr 15, 2025
7 checks passed
@home-assistant home-assistant bot removed parent-merged The parent PR has been merged already awaits-parent Awaits the merge of an parent PR labels Apr 15, 2025
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 15, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants