Oklyn Card

Custom Lovelace card for the Oklyn pool controller integration. Multilingual (11 languages: EN, FR, DE, ES, IT, NL, SV, NO, DA, PL, RU) — follows your Home Assistant language automatically, English by default.

🇫🇷 Lire en français

Features

• pH, RedOx, salt and water temperature with 3-color coding (blue = below, green = in range, orange = above), by thresholds or driven by the Oklyn API status attribute (color_source: oklyn).
• Pump control — AUTO / ON / OFF buttons with real running status — and air temperature.
• Auxiliary 1 and 2 — independently shown/hidden, switch (toggleable) or regulator (read-only), name taken from the entity.
• pH calibration offset, optional last-update time, full visual editor, zero dependencies.

Requires the Oklyn integration to provide the entities:

Installation (HACS)

Available directly in HACS — no custom repository needed.

1. Open HACS, search for Oklyn Card and download it
2. Reload your browser (the resource is registered automatically)

As a custom repository: HACS → ⋮ → Custom repositories → add https://github.com/ADNPolymerase/oklyn-card with category Dashboard.

Manual alternative: copy dist/oklyn-card.js to config/www/, then add /local/oklyn-card.js as a JavaScript-module resource.

Usage

Add the card from the dashboard UI (search "Oklyn") — entities are auto-detected. Or in YAML:

type: custom:oklyn-card
title: Piscine
model: analysis
ph_entity: sensor.oklyn_ph
orp_entity: sensor.oklyn_redox
water_entity: sensor.oklyn_temperature_eau
air_entity: sensor.oklyn_temperature_air
pump_entity: select.oklyn_mode_pompe
show_pump_runtime: false
show_aux1: true
aux1_entity: switch.oklyn_auxiliaire_1
aux1_mode: switch
aux1_icon: mdi:lightbulb
show_aux2: false
aux2_entity: switch.oklyn_auxiliaire_2
aux2_mode: switch
aux2_icon: mdi:power-socket-eu
ph_offset: 0
ph_color: true
ph_min: 6.8
ph_max: 7.6
orp_color: true
orp_min: 550
orp_max: 800
water_color: true
water_temp_blue: 26
water_temp_green: 30
color_source: threshold  # or "oklyn" to use Oklyn API status attribute
show_last_updated: true

Options

Option	Default	Description
model	analysis	Oklyn model: filtration (temperatures only), analysis (+ pH, RedOx), analysis_salt (+ salt). Hides irrelevant metrics and editor options
title	auto	Card title (defaults to a localized "Pool" / "Piscine")
language	auto	UI language: en, fr, de, es, it, nl, sv, no, da, pl, ru. Auto-detected from Home Assistant (English fallback). Also selectable in the editor
metrics_order	[ph, orp, salt, water, air, runtime]	Display order of the metric tiles — drag to reorder in the editor
ph_entity	—	pH sensor (analysis / analysis_salt)
orp_entity	—	RedOx/ORP sensor (analysis / analysis_salt)
water_entity	—	Water temperature sensor
air_entity	—	Air temperature sensor
pump_entity	—	Pump mode select entity
show_pump_runtime	false	24h cumulative pump runtime tile (from the pump status history)
salt_entity	—	Salt sensor in g/L (analysis_salt only)
show_aux1	true	Show the Auxiliary 1 row
aux1_entity	—	Auxiliary 1 switch or binary_sensor
aux1_name	—	Display name for Auxiliary 1. Defaults to the entity name (without device prefix)
aux1_mode	switch	switch = toggleable, regulator = read-only display
aux1_icon	mdi:lightbulb	Icon for the Auxiliary 1 row
show_aux2	false	Show the Auxiliary 2 row
aux2_entity	—	Auxiliary 2 switch or binary_sensor
aux2_name	—	Display name for Auxiliary 2. Same logic as aux1_name
aux2_mode	switch	Same as aux1_mode
aux2_icon	mdi:power-socket-eu	Icon for the Auxiliary 2 row
show_last_updated	true	Show last data update time (top right)
ph_offset	0	pH calibration correction, positive or negative (e.g. -0.99)
ph_color	true	Enable color coding for pH
ph_min / ph_max	6.8 / 7.6	Green zone for pH — used in threshold mode
orp_color	true	Enable color coding for RedOx
orp_min / orp_max	550 / 800	Green zone for RedOx (mV) — used in threshold mode
color_source	threshold	threshold (min/max below) or oklyn (Oklyn API status attribute)
salt_color	true	Enable color coding for salt
salt_min / salt_max	3 / 5	Green zone for salt (g/L) — used in threshold mode
water_color	true	Enable color coding for water temperature
water_temp_blue	26	Below this threshold → blue (cold)
water_temp_green	30	Between blue and green threshold → green (ideal), above → orange (warm)

Color modes

color_source: threshold (default) colors pH/RedOx/salt from your min/max (🔵 below, 🟢 in range, 🟠 above). color_source: oklyn uses the status attribute from the Oklyn API instead (low/normal/high, requires ha-oklyn ≥ v0.4.0). Water temperature follows water_temp_blue / water_temp_green the same way.

pH calibration offset

If your pH probe drifts (e.g. reads 8.38 when a manual test says 7.39), set ph_offset: -0.99 — the card shows the corrected value ("pH corrigé") and the thresholds apply to it.

License

MIT