---
title: Setup
description: Setting up the Integration
previous: /integration
previousTitle: Installation
next: /integration/entities
nextTitle: Features
---
To configure the integration, you'll need your iopool API key to connect to the iopool Cloud service.
The `iopool` integration communicates with the iopool API to retrieve data from your EcO device.
This integration is provided as-is, without any warranty of any kind. The developer of this integration cannot be held liable for any issues arising from its use.
The user installs and uses this integration at their own risk and with full knowledge of the potential implications. The data provided by this integration does not replace professional pool maintenance.
## Requirements
1. An iopool EcO device
2. An active iopool account
3. Internet connectivity for your Home Assistant instance
4. One of the following methods to connect your EcO sensor to the iopool cloud:
- **Recommended:** An [iopool Connect WiFi Gateway](https://iopool.com/en-fr/collections/accessories/products/connect-bluetooth-wi-fi-gateway) that maintains a constant Bluetooth connection to your EcO sensor and sends data to the cloud via WiFi
- Alternatively: Regular use of the iopool mobile app near your EcO sensor to sync data via Bluetooth (this method provides less frequent and less reliable data updates)
The iopool Connect WiFi Gateway is strongly recommended for this integration as it provides continuous, reliable data updates. Without the gateway, data will only be updated when someone manually synchronizes the EcO sensor with their smartphone near the pool, which can lead to outdated information in Home Assistant.
## Required Information
You'll need just a few details to configure the iopool integration:
- Your iopool API key
### Getting Your API Key
You can obtain your API key directly from the iopool mobile application:
1. Open the iopool app on your smartphone
2. Go to the `Plus` menu, `Settings` > `API Key` section
3. Copy your API key
The API key is used to securely access your pool data through the iopool API.
## Integration Setup in Home Assistant
Start the setup process by clicking the button below:
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=iopool)
The setup process is simple:
- Enter your `API Key`
- Select the pool you want to integrate (if you have several pools under your account)
Fill in the API key field and click `Submit`.
A success popup will appear where you can select an area for your iopool device.
Click `Finish` to complete the setup! 🎉
Please check your Home Assistant logs to ensure there are no errors related to the iopool Integration.
[](https://my.home-assistant.io/redirect/logs/?)
## Automatic Filtration Setup
After installing the integration, you can configure automatic pool filtration management from the integration options in Home Assistant.
Automatic filtration management allows Home Assistant to control your pool pump according to time slots and personalized recommendations, based on water temperature, season, and your preferences.
### Where to configure?
1. Go to **Settings > Devices & Services > Integrations**.
2. Find your iopool integration and click **Configure** (or the gear icon).
3. Fill in the fields as needed (see explanations below).
---
### Filtration Parameters
**How does the automation mode selection work?**
- **Summer Filtration (Standard)** is active when the pool mode is set to **Standard** (via the "Pool Mode" select entity in Home Assistant).
- **Winter Filtration (Active-Winter)** is active when the pool mode is set to **Active-Winter**.
Only one mode is active at a time, depending on the selected pool mode.
If both summer and winter filtration are enabled, the integration will automatically use the correct schedule based on the current pool mode.
#### Switch Entity
- **Switch entity to control filtration**
Select the `switch` entity that controls your pool filtration pump (e.g., a connected relay).
---
#### Summer Filtration (Standard)
- **Enable summer automatic filtration**
Enable or disable automatic filtration management in summer mode.
- **Minimum duration (minutes)**
Minimum daily filtration duration (in minutes). Leave empty or 0 for no minimum.
- **Maximum duration (minutes)**
Maximum daily filtration duration (in minutes). Leave empty or 0 for no maximum.
##### Filtration Slots (for Summer mode)
You can define up to two time slots to spread filtration throughout the day.
- **Slot #1 Name**
Free name to identify the slot (e.g., "Morning").
- **Slot #1 Start Time**
Time when the first filtration slot starts.
- **Slot #1 Percentage**
Percentage of the total filtration duration to be performed in this slot (e.g., 60%).
- **Slot #2 Name**
Free name for the second slot (e.g., "Evening").
- **Slot #2 Start Time**
Start time for the second slot.
- **Slot #2 Percentage**
Percentage of the total filtration duration to be performed in this slot (e.g., 40%).
The sum of the percentages for both slots must equal 100%.
The second slot is optional (set to 0% to disable).
---
#### Winter Filtration (Active-Winter)
- **Enable winter automatic filtration**
Enable or disable automatic filtration management in active winter mode.
- **Start time**
Time when daily winter filtration starts.
- **Duration (minutes)**
Daily filtration duration in winter mode (in minutes).
---
### Configuration Tips
- **Required**: The switch entity must be set if automatic filtration (summer or winter) is enabled.
- **Summer slots**: Slot #1 must start before slot #2.
- **Validation**: The interface automatically checks the consistency of times and percentages.
- **Disabling**: To disable automatic management, uncheck the corresponding activation boxes.
---
### Example Configuration
| Parameter | Value |
|----------------------------------|------------------------|
| Switch entity | `switch.pompe_piscine` |
| Summer filtration enabled | Yes |
| Minimum duration | 240 |
| Maximum duration | 480 |
| Slot #1 - Name | Morning |
| Slot #1 - Start | 06:00 |
| Slot #1 - % | 60 |
| Slot #2 - Name | Evening |
| Slot #2 - Start | 18:00 |
| Slot #2 - % | 40 |
| Winter filtration enabled | Yes |
| Winter - Start | 03:00 |
| Winter - Duration | 120 |
---
You can adjust these parameters at any time from the integration options to adapt filtration to your needs or the season.
## Features and Sensors
The iopool integration will automatically create the following entities for each of your pools:
### Sensors
- **Temperature** (`sensor.iopool_*_temperature`): The current temperature of your pool water
- **pH** (`sensor.iopool_*_ph`): The pH level of your pool water
- **ORP** (`sensor.iopool_*_orp`): The oxidation-reduction potential of your pool water
- **Mode** (`sensor.iopool_*_iopool_mode`): The current mode of your iopool device
- **Filtration Recommendation** (`sensor.iopool_*_filtration_recommendation`): The recommended daily filtration duration (in minutes)
- **Elapsed Filtration Duration** (`sensor.iopool_*_elapsed_filtration_duration`): The total filtration time elapsed today (in minutes)
_Only available if filtration automation is enabled and a switch entity is configured in the integration options._
### Binary Sensors
- **Action Required** (`binary_sensor.iopool_*_action_required`): Indicates if any maintenance action is needed for your pool
- **Filtration** (`binary_sensor.iopool_*_filtration`): Indicates if the filtration system is currently running
_Only available if filtration automation is enabled and a switch entity is configured in the integration options._
### Select Entities
- **Boost Selector** (`select.iopool_*_boost_selector`): Allows you to temporarily increase filtration for 1h, 2h, 4h, 8h, or 24h
_Only available if filtration automation is enabled and a switch entity is configured in the integration options._
- **Pool Mode** (`select.iopool_*_pool_mode`): Allows you to switch between Standard, Active-Winter, and Passive-Winter modes
_Only available if filtration automation is enabled and a switch entity is configured in the integration options._
All sensors include additional attributes such as measurement validity, measurement mode, and timestamp of the last measurement.