home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Documentation for new Seko PoolDose integration

Open lmaertin opened this issue 5 months ago • 3 comments

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

Type of change

  • [ ] Spelling, grammar or other readability improvements (current branch).
  • [ ] Adjusted missing or incorrect information in the current documentation (current branch).
  • [x] 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

  • Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/146972
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • [x] 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.
  • [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced the "Seko Pooldose" integration for local monitoring and control of pool water treatment systems with live sensor data, manual overrides, and configurable settings.
  • Documentation
    • Added comprehensive user guide with setup, configuration options, supported entities, and operational details for the Pooldose integration.

lmaertin avatar Jun 16 '25 19:06 lmaertin

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

home-assistant[bot] avatar Jun 16 '25 19:06 home-assistant[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit 522ed124dccd48e1096902bba075c133586d842f
Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/685354b07ce45f0008934594
Deploy Preview https://deploy-preview-39581--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.

netlify[bot] avatar Jun 16 '25 19:06 netlify[bot]

📝 Walkthrough

Walkthrough

A new documentation file for the "Seko Pooldose" integration has been added to Home Assistant. This document describes setup prerequisites, configuration options, supported entity types, and operational notes for connecting and controlling a Seko Pooldose water treatment system via its local HTTP API.

Changes

File(s) Change Summary
source/_integrations/pooldose.markdown Added documentation for the new Seko Pooldose integration, covering setup, configuration, and entities.
.github/workflows/test.yml Added a workflow step to detect .md files in source/_integrations and fail the build with a warning to rename them to .markdown.
CODEOWNERS Updated code owners for multiple integration docs, adding and removing owners, and adding new entries for new integrations.
Gemfile Bumped versions of development gems: rake, sass-embedded, rubocop, ruby-lsp.
_config.yml Updated Home Assistant release version and release date.
package.json Updated textlint devDependency version from ^14.7.2 to ^14.8.4.
source/_docs/authentication/providers.markdown Removed note restricting command line authentication provider to Core installation type.
source/_docs/blueprint/schema.markdown Clarified blueprint schema metadata and inputs descriptions, emphasizing terminology and requirements.
source/_docs/configuration/templating.markdown Corrected Jinja filter links; expanded as_datetime filter behavior description.
source/_docs/z-wave/controllers.markdown Added "related" metadata linking to Z-Wave integration documentation.
source/_includes/asides/component_navigation.html Simplified rendering of "Works with Home Assistant" section to render once instead of looping.
source/_includes/common-tasks/update.md Restructured update instructions with clearer prerequisites and post-update checks.
source/_includes/custom/news.html Moved "Community Day 2025" promo link to bottom of recent blog posts with updated URL and image.
source/_includes/installation/container.md Changed Docker Compose filename reference from .yml to .yaml.
source/_integrations/adax.markdown Added "Sensor" platform and "Energy monitoring" section; added new code owner.
source/_integrations/airgradient.markdown Expanded documentation with use cases, supported devices, update entity, examples, and troubleshooting.
source/_integrations/airthings.markdown Added ha_dhcp: true flag in integration metadata.
source/_integrations/alexa_devices.markdown Added "Switch" platform for Do Not Disturb; changed IoT class to Cloud Polling; corrected device list.
source/_integrations/balay.markdown Added ha_zeroconf: true to integration metadata.
source/_integrations/blue_current.markdown Added "button" platform to supported platforms.
source/_integrations/bluesound.markdown Reordered platforms, moving button before media_player.
source/_integrations/bosch_alarm.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/comelit.markdown Updated quality scale from bronze to silver.
source/_integrations/constructa.markdown Added ha_zeroconf: true to integration metadata.
source/_integrations/eafm.markdown Changed frontmatter delimiters from four to three dashes.
source/_integrations/eheimdigital.markdown Added "diagnostics" platform to supported platforms.
source/_integrations/esphome.markdown Improved consistency and formatting; moved "Removing the integration" section to end.
source/_integrations/eve.markdown Added works_with: matter to integration metadata.
source/_integrations/ezviz.markdown Removed @baqs from code owners.
source/_integrations/gaggenau.markdown Added ha_zeroconf: true to integration metadata.
source/_integrations/govee_ble.markdown Added note "(Active scans required)" for certain devices; added new device H5129.
source/_integrations/growatt_server.markdown Added "Prerequisites" section listing Growatt account requirements.
source/_integrations/home_connect.markdown Added ha_dhcp: true; corrected heading label from "binary sensors" to "sensors".
source/_integrations/homee.markdown Changed alarm control panel platform identifier from alarm-control-panel to alarm_control_panel.
source/_integrations/immich.markdown Changed ha_integration_type from "service" to "integration"; added ha_quality_scale: silver.
source/_integrations/ipp.markdown Changed frontmatter delimiters from four to three dashes.
source/_integrations/jewish_calendar.markdown Added "diagnostics" platform to supported platforms.
source/_integrations/knocki.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/knx.markdown Clarified respond_to_read parameter descriptions across multiple entity platforms.
source/_integrations/lcn.markdown Added detailed required configuration parameters section.
source/_integrations/linkplay.markdown Changed frontmatter delimiters from four to three dashes; re-indented content.
source/_integrations/locative.markdown Changed frontmatter delimiters from four to three dashes; formatting only.
source/_integrations/matter.markdown Clarified supported usage of Thread-based Matter devices and unsupported Docker container usage.
source/_integrations/met_eireann.markdown Updated URLs for API notes and license summary.
source/_integrations/motionmount.markdown Reformatted markdown from hyphens to plus signs without content changes.
source/_integrations/mqtt.markdown Minor formatting and link updates; updated Tydom2MQTT URL.
source/_integrations/neff.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/nextcloud.markdown Added detailed list of sensors per integration entry; noted update entity creation.
source/_integrations/octoprint.markdown Reordered sensor and button lists; added new temperature sensors.
source/_integrations/openweathermap.markdown Added new code owner @wittypluck.
source/_integrations/paperless_ngx.markdown Added ha_platforms with "diagnostics" and "sensor".
source/_integrations/pitsos.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/probe_plus.markdown Capitalized ha_iot_class value from "local_push" to "Local Push".
source/_integrations/profilo.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/recorder.markdown Added new documented action recorder.get_statistics with detailed parameters and example.
source/_integrations/rehlko.markdown Added "binary_sensor" to supported platforms list.
source/_integrations/remote_calendar.markdown Fixed typo "an resource" to "a resource".
source/_integrations/russound_rio.markdown Added Russound ACA-E5 controller to supported devices.
source/_integrations/russound_rnet.markdown Removed Russound ACA-E5 from supported controllers list.
source/_integrations/scrape.markdown Added payload_template configuration option supporting templates for POST payloads.
source/_integrations/shelly.markdown Added ha_quality_scale: silver to integration metadata.
source/_integrations/shelly_zwave.markdown Removed works_with: zwave metadata and simplified introductory paragraph.
source/_integrations/siemens.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/spotify.markdown Formatting and indentation improvements; used term macro for "polls".
source/_integrations/sql.markdown Added "Data updates" section explaining default polling and custom polling interval.
source/_integrations/squeezebox.markdown Added "Update" to ha_category list.
source/_integrations/sun.markdown Changed code owner from @Swamp-Ig to @home-assistant/core.
source/_integrations/switchbot.markdown Reordered "Fan" category; added code owner @zerzhang; added ha_quality_scale: gold.
source/_integrations/switchbot_cloud.markdown Added newline at end of file.
source/_integrations/tasmota.markdown Added detailed instructions for configuring SetOption19 0 via Tasmota web console.
source/_integrations/template.markdown Extensive reordering, clarification, and restructuring of YAML configuration reference for template entities; no functional changes.
source/_integrations/tesla_fleet.markdown Completely rewritten and expanded setup and troubleshooting documentation with detailed steps and commands.
source/_integrations/thermador.markdown Added ha_dhcp: true to integration metadata.
source/_integrations/tts.markdown Expanded documentation for tts.speak and legacy say actions; added preferred audio settings and troubleshooting.
source/_integrations/voip.markdown Added new code owner @jaminh.
source/_integrations/zimi.markdown Changed title to lowercase; removed a code owner; added ha_quality_scale: bronze and ha_integration_type: integration.
source/_integrations/zwave_js.markdown Extensively expanded documentation with detailed setup, removal, migration, backup, reset, and removal procedures; updated hardware recommendations.
source/_posts/*.markdown Updated multiple blog posts to change URLs from home-assistant.github.io/intents/ to ohf-voice.github.io/intents/.
source/_posts/2025-06-11-release-20256.markdown New blog post announcing Home Assistant 2025.6 release with detailed highlights and changes.
source/_changelogs/core-2025.6.markdown Comprehensive changelog for Home Assistant Core 2025.6 release and 2025.6.1 patch with new integrations, features, fixes, and improvements.
source/common-tasks/general.markdown Downgraded heading levels for two sections under "Defining a custom polling interval".
source/common-tasks/os.markdown Enhanced OS update documentation with clarifications, troubleshooting, and advanced details on boot slots.
source/green/index.html Removed price reference "$99" from Home Assistant Green description.
source/installation/troubleshooting.markdown Updated onboarding troubleshooting step to "Select Show details" for viewing logs.
source/more-info/unsupported/lxc.markdown Fixed typo "prosed" to "proceed".
source/voice-pe/index.html Updated pricing display to show "$69 / €59" and expanded pricing disclaimer text.
source/voice-pe/styles.css Adjusted responsive CSS variables and margins for pricing section.
source/voice_control/index.markdown Changed capitalization of two section headers.
source/voice_control/thirteen-usd-voice-remote.markdown Updated ATOM Echo setup instructions to use a voice assistant customization wizard; added Wi-Fi credentials removal instructions.
source/_includes/integrations/wwha.md Added new Liquid template snippet to generate standardized "Works with Home Assistant" integration descriptions for partners.
source/_integrations/third_reality.markdown Removed detailed integration description and replaced with include of standardized "Works with Home Assistant" snippet.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant PooldoseDevice

    User->>HomeAssistant: Configure Pooldose integration (host, scan_interval, timeout)
    HomeAssistant->>PooldoseDevice: Connect via HTTP API (using provided host)
    PooldoseDevice-->>HomeAssistant: Responds with device info and sensor data
    HomeAssistant-->>User: Displays entities (sensors, switches, etc.)
    User->>HomeAssistant: Interact with entities (e.g., adjust dosing, set targets)
    HomeAssistant->>PooldoseDevice: Send control commands (if applicable)
    PooldoseDevice-->>HomeAssistant: Acknowledge command/status update

📜 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 e48ae57c140e84f8b5c3f779ec03b8e4eecbebdd and 62e7aedd918d38acd4f75641754210fdeff45fb7.

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

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.

coderabbitai[bot] avatar Jun 16 '25 19:06 coderabbitai[bot]

Hi there, @lmaertin :wave: Thank you for contributing :muscle:

There are unrelated commits and changes in this PR, probably because it was based against the current branch. The easiest way to fix this, is to close this PR. The get the latest next branch and create a new PR based against the nextbranch.

c0ffeeca7 avatar Jul 02 '25 06:07 c0ffeeca7

I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again.

c0ffeeca7 avatar Jul 02 '25 06:07 c0ffeeca7

Hi there, @lmaertin :wave: Thank you for contributing :muscle:

There are unrelated commits and changes in this PR, probably because it was based against the current branch. The easiest way to fix this, is to close this PR. The get the latest next branch and create a new PR based against the nextbranch.

Thanks for your feedback. I'm working on parent core PR currently. After next update is done, I will proceed to update the documentation and re-create a next-based PR.

lmaertin avatar Jul 02 '25 07:07 lmaertin

Replaced with new PR, based on next branch: https://github.com/home-assistant/home-assistant.io/pull/39855

lmaertin avatar Jul 04 '25 21:07 lmaertin