-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
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
base: next
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this 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
topython-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. |
There was a problem hiding this comment.
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.”
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.
📝 WalkthroughWalkthroughA 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
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
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 tripleTriple 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” phrasingThe 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 codeMinor 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
📒 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 thatha_category
values are valid
Water
looks correct, but it’s unclear whetherPool
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 againsthome-assistant.io
’s allowed category list (or dropping the second entry if not supported).
Adapted ha categoried
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
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit