Skip to content

Documentation for new Seko PoolDose integration (update) #39855

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 4 commits into
base: next
Choose a base branch
from

Conversation

lmaertin
Copy link

@lmaertin lmaertin commented Jul 4, 2025

Proposed change

Documentation for a new integration for local polling of SEKO PoolDose devices. This integration enables cloudless monitoring and control of a PoolDose Dual/Double device for automatic dosing of Pools or Spas.

Brands also planned in PRs on the dedicated repo.

This is an update of former PR 39581: Now next-based and slightly updated documentation wrt. implications from review of main integration PR.

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
    • Added comprehensive user-facing documentation for the SEKO PoolDose integration, detailing setup, configuration options, supported entities, and operational notes for managing pool and spa dosing systems within Home Assistant.

@Copilot Copilot AI review requested due to automatic review settings July 4, 2025 21:56
@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 Jul 4, 2025
Copy link

netlify bot commented Jul 4, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7a25a7b
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6868c287dea6ef000811b081
😎 Deploy Preview https://deploy-preview-39855--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 project configuration.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive documentation for the new SEKO PoolDose integration, covering setup, configuration options, entity listings, and operational notes.

  • Introduces a new pooldose.markdown doc for the SEKO PoolDose integration.
  • Details setup prerequisites, config flow options, and removal steps.
  • Lists major entities, binary sensors, switches, numbers, and selects.
Comments suppressed due to low confidence (4)

source/_integrations/pooldose.markdown:24

  • Use inline code formatting for the PyPI project name: change python-pooldose to python-pooldose.
This integration uses an undocumented local HTTP API, implemented in the PyPi project ```python-pooldose```. It provides live readings for pool sensors such as temperature, pH, ORP/Redox, as well as status information and control over the dosing logic.

source/_integrations/pooldose.markdown:44

  • Avoid the abbreviation “resp.” – use “or” for clarity. For example: “The IP address or hostname of your PoolDose device.”
  description: The IP address resp. hostname of your PoolDose device. Identify the IP address resp. hostname in the web interface of the device or of your router.

source/_integrations/pooldose.markdown:50

  • Replace “e.g.,” with “for example” to follow style guidelines: “Fetch sensitive data from the device, for example WiFi keys.”
  description: Fetch sensitive data from the device, e.g., WiFi keys.

source/_integrations/pooldose.markdown:65

  • Replace “i.e.,” with clearer phrasing like “that is” or “meaning”: “must be set to default (deactivated), meaning 0000.”
- The password for the Web Interface must be set to default (deactivated), i.e., 0000.

ha_integration_type: integration
---

The `PoolDose` integration connects a [SEKO](https://www.seko.com/) pool dosing system with Home Assistant. SEKO is a manufacturer of various monitoring and control devices for Pools and Spas.
Copy link
Preview

Copilot AI Jul 4, 2025

Choose a reason for hiding this comment

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

The terms “Pools” and “Spas” are common nouns and should be lowercased. Change “Pools and Spas” to “pools and spas.”

Suggested change
The `PoolDose` integration connects a [SEKO](https://www.seko.com/) pool dosing system with Home Assistant. SEKO is a manufacturer of various monitoring and control devices for Pools and Spas.
The `PoolDose` integration connects a [SEKO](https://www.seko.com/) pool dosing system with Home Assistant. SEKO is a manufacturer of various monitoring and control devices for pools and spas.

Copilot uses AI. Check for mistakes.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

📝 Walkthrough

Walkthrough

A new documentation file has been added for the SEKO PoolDose integration in Home Assistant. This document outlines setup instructions, configuration options, supported entity platforms, and operational notes for connecting and controlling PoolDose devices via a local HTTP API.

Changes

File(s) Change Summary
source/_integrations/pooldose.markdown Added new documentation for the SEKO PoolDose Home Assistant integration, detailing setup and usage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant PoolDoseDevice

    User->>HomeAssistant: Configure PoolDose integration (provide host, options)
    HomeAssistant->>PoolDoseDevice: Connect via HTTP API
    PoolDoseDevice-->>HomeAssistant: Return device info, sensor data
    HomeAssistant-->>User: Display entities (sensors, switches, etc.)
    User->>HomeAssistant: Interact with entities (e.g., set target pH)
    HomeAssistant->>PoolDoseDevice: Send control command (if applicable)
    PoolDoseDevice-->>HomeAssistant: Confirm action/status update
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between f54cacb and ab5e783.

📒 Files selected for processing (1)
  • source/_integrations/pooldose.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/pooldose.markdown

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 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 (3)
source/_integrations/pooldose.markdown (3)

24-24: Use single back-ticks for inline code, not triple

Triple back-ticks start fenced code blocks and could break the markup when used mid-sentence.

-This integration uses an undocumented local HTTP API, implemented in the PyPi project ```python-pooldose```.
+This integration uses an undocumented local HTTP API, implemented in the PyPi project `python-pooldose`.

34-35: Tighten wording & avoid ambiguous “cloudless-only” phrasing

The current wording is a bit awkward. Suggested tweak:

-Optionally: Block the device from internet access to ensure cloudless-only operation and potentially breaking firmware updates.
+Optional: Block the device’s internet access to guarantee fully local operation and prevent potentially breaking firmware updates.

65-65: Format default password as inline code

Minor readability win:

-The password for the Web Interface must be set to default (deactivated), i.e., 0000.
+The password for the web interface must be set to its default (`0000`).
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 399f77f and f54cacb.

📒 Files selected for processing (1)
  • source/_integrations/pooldose.markdown (1 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/pooldose.markdown (1)

4-7: Check that ha_category values are valid

Water looks correct, but it’s unclear whether Pool is an accepted category in the current doc build. If the docs builder doesn’t recognise it, the page will fail front-matter validation.
Consider verifying against home-assistant.io’s allowed category list (or dropping the second entry if not supported).

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Jul 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants