Repository navigation
Releases: Bitf1ip/ha-hydros
Releases · Bitf1ip/ha-hydros
Release list
HA-Hydros 0.4 BETA - MUST READ BEFORE UPGRADE
! READ BEFORE UPGRADE !
! NEW API KEY ARE REQUIRED BEFORE UPGRADE !
This is the first beta release which uses Coralvue's new API. You must have two api in hand before upgrading to this version.
- Request a provider key from CoralVue: https://www.coralvuehydros.com/api/#request-provider-key
- Have the device owner create a device key in the HYDROS app (Device Properties → Manage API Keys), choosing a permission level (read or read & write).
- This release will rename some of your entities, plan enough time to fix your automation and dashboard after upgrading.
** I have done my best to migrate sensors history to the new entities.
** Very few entity are no longer available because they are missing from the new API. No sensors were impacted.
Changed (breaking)
- Rebuilt on CoralVue's official HYDROS Public API through the new
pyhydros2library, replacing the unofficial Cognito/MQTT connection. Your Hydros username and password are no longer used: each device or collective needs a provider key and a device key (see "Getting your API keys" in the README). - Existing installs ask you to re-authenticate. Enter a key pair for each collective you had configured, and entities and their history are moved over wherever a matching entity exists in the new API. Entities without an equivalent are left as they are and can be deleted.
- Device state refreshes every 7 seconds (it was MQTT push); dosing totals every 5 minutes.
- Requires Home Assistant 2026.8 or newer.
- The API keys field is masked, and re-authentication now also works when a key is revoked or replaced.
Added
- Controls (need a read & write device key): On/Off/Auto selects for outputs, Auto/Off for dosers (Off suspends dosing), sliders for variable outputs with a Resume Schedule button, an operating-mode select, and buttons and number inputs for output commands such as a doser's manual dose, reverse dose and set reservoir.
- A Running binary sensor for each output.
- A Mode Ends sensor that shows when a timed mode such as Water Change ends.
- Per-controller health devices with bus voltage and current, temperature, boot time, last report, Wi-Fi and SD card status, and self-test counts.
- Output voltage, current, power and frequency sensors, dosing reservoir level, a Total Power sensor, an alerts summary, firmware version and collective status.
- The state-polling session is stored so restarts and reloads don't use up the API's limit of 5 new sessions per hour.
Removed
- The Debug Sample and MQTT Health sensors, and the remote-control opt-in and disclaimer (controls now follow the permission of your device key).
- The periodic entity-list refresh.
Known limitations
- The API reports no units, so analog input units are guessed from the firmware log type and the input name.
- Controller devices are named after their node ID, because the API doesn't return names for the controllers inside a collective. Use one device key per controller for friendly names, or rename them in Home Assistant.
- Collective and Wi-Fi/SD card status values are shown as raw numbers because their meanings are undocumented.
- If two outputs share an API key, their entities are told apart by name.
Version 0.3.5
Now report XP8 total power usage
New entity to report total power usage in W for XP8.
0.3.4beta2
fix power factor
XP8 Power monitoring
Full Changelog: 0.3.3...0.3.4beta
HACS support and bugfix
Added
- Support for HACS!
Fixed
- Fix crash during mode-change failure recovery:
select.pycalledasync_force_status_from_apiandinvalidate_collective_configonHydrosHub, but neither method existed. When a mode change failed, the recovery path raisedAttributeErrorbefore the original API error could be logged. Both methods are now implemented:invalidate_collective_configdrops the stale cached config so the next read re-fetches from the cloud;async_force_status_from_apipulls authoritative status from the REST API, merges it into the status cache, and dispatches the per-thing signal so dependent entities refresh. (Ported from JLay2026/ha-hydros@4d98d25 — credit to @JLay2026.)
Improve parsing of 0-10v variable pump value
0.3.2 - 2026-05-08
Added
- Support for Skimmer outputs on variable pumps (
type: o10vPump,family: vPump).
Fixed
- Normalize variable-pump
valueStateas a percentage by dividing by 100 (for example:4500->45.0%). - Prevent variable-pump
valueStatefrom being interpreted as binary on/off labels.
Enable Hydros' mode change from home assistant
Under the integration settings users can now "Enable remote control" which will unlock the ability to change hydros controller mode.
New feature: Support for changing controller's mode
New feature - v0.3.0
- Add support for changing Hydros' mode. This requires to enable remote control under the integration's configuration (and to accept the risks).
Improvement: Generic input state mapped to on/off
0.1.11 Remap generic output valueState to on/off