Skip to content

Add time platform for eheimdigital #38603

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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

autinerd
Copy link
Contributor

@autinerd autinerd commented Apr 17, 2025

Proposed change

This adds the time 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

  • Documentation
    • Updated integration documentation to include a new "Time" section for supported devices.
    • Added details about configuring "Day start time" and "Night start time" for Bio mode on EHEIM thermocontrol+e and classicVARIO+e devices.

@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 17, 2025
Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d909f22
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6801228edd51040008356158
😎 Deploy Preview https://deploy-preview-38603--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 17, 2025

📝 Walkthrough

Walkthrough

The documentation for the EHEIM Digital integration was updated to include support for time-based configuration entities. The integration metadata now lists "Time" as both a category and a platform. New sections were added to the documentation for the EHEIM thermocontrol+e and EHEIM classicVARIO+e devices, describing "Day start time" and "Night start time" entities that allow configuration of day and night settings for temperature and pump speed in Bio mode. No existing entities or functionality were removed or changed.

Changes

File(s) Change Summary
source/_integrations/eheimdigital.markdown Added "Time" to integration metadata categories and platforms; documented new "Day start time" and "Night start time" entities for relevant devices.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant EHEIM_Device

    User -> HomeAssistant: Set "Day start time" or "Night start time"
    HomeAssistant -> EHEIM_Device: Update Bio mode configuration with new time
    EHEIM_Device -> HomeAssistant: Confirm configuration update
    HomeAssistant -> User: Reflect updated time entity state
Loading

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

61-65: Document the expected time format for Bio mode temperature
Great addition of the Time section under the EHEIM thermocontrol+e device. To improve clarity for end users, consider specifying the required time input format (e.g., HH:MM) or linking to the Home Assistant time entity documentation.


80-84: Document the expected time format for Bio mode pump speed
The new Time section for the EHEIM classicVARIO+e device is helpful. As a refinement, you could mention the unit or format (for example, HH:MM), and note any default values or acceptable range constraints.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0ae37c0 and d909f22.

📒 Files selected for processing (1)
  • source/_integrations/eheimdigital.markdown (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/eheimdigital.markdown (1)

4-9:

❓ Verification inconclusive

Time category and platform entries look correct
The new “Time” entry in ha_category and the corresponding lowercase time in ha_platforms are inserted in alphabetical order and follow existing conventions. Please verify that the eheimdigital integration’s manifest.json also declares "time" under its platforms so the documentation and implementation remain in sync.

Also applies to: 17-22


🏁 Script executed:

#!/bin/bash
# Verify that 'time' is declared under platforms in manifest.json
grep -R '"platforms":' manifest.json -A 5 | grep '"time"'

Length of output: 106


🏁 Script executed:

#!/bin/bash
# Locate all manifest.json files in the repo
echo "Searching for manifest.json files..."
fd manifest.json

# Filter for the eheimdigital integration’s manifest
manifest=$(fd manifest.json | grep -i eheimdigital | head -n1)
if [ -z "$manifest" ]; then
  echo "Error: Could not find eheimdigital/manifest.json"
  exit 1
fi
echo "Using manifest file: $manifest"

# Show the platforms section for context
echo -e "\nPlatforms section in manifest:"
grep -R '"platforms"' "$manifest" -A 5

# Verify that 'time' is declared under platforms
echo -e "\nChecking for '\"time\"' in platforms:"
grep -R '"time"' "$manifest" || echo "'time' not found in platforms"

Length of output: 301


Ensure time platform is declared in the integration manifest
I don’t see a manifest.json for the eheimdigital integration in this documentation repo. Please manually verify in the integration’s code (for example under custom_components/eheimdigital/manifest.json or homeassistant/components/eheimdigital/manifest.json) that the "platforms" array includes "time", so the docs and implementation stay in sync.

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.

@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Apr 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants