Skip to content

feat(heishamon): declare the heat curve offset as a control a host can render #66

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.

Sign up for GitHub

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

Open
frahlg wants to merge 1 commit into
base: heishamon-power-and-outdoor-metric
Choose a base branch
from
Open

feat(heishamon): declare the heat curve offset as a control a host can render #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Driver versions follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html
## [Unreleased]

### Added
- **heishamon** 0.7.0 — **the driver now states what an operator may command, so a host can render a control for it.** A `controls` entry in the `DRIVER` block names `set_heat_curve_offset`, labels it, and describes its one input: number, −3…+3, step 1, °C. FTW reads this and draws the row; before it, a hardware-verified control had no way to reach a person and its author was told to write a Home Assistant automation instead (srcfl/ftw#520, srcfl/ftw#738). The bounds are the defaults — `min_offset`/`max_offset` narrow them in config and `driver_command` clamps to whichever is tighter, so a narrowed site is safe; its UI just offers a step or two that land on the configured limit
- **The declared evidence is `write_ack`, not `readback`, because that is what the driver actually does.** `apply_offset` returns as soon as the publish succeeds. The pump does echo the value on `main/Z1_Heat_Request_Temp`, but it arrives on a later poll and nothing waits for it or compares it. Declaring `readback` would tell a host the setting was confirmed when all we know is that a message left, and it would suppress the "the pump does not confirm this setting" line the host shows for exactly this case. Making it a real readback means completing the command asynchronously against that echo — a larger change to the control path, not a metadata edit
- **heishamon** 0.6.0 — **the pump now reports its electrical draw, and its outdoor temperature under the name every other heat pump uses.** FTW's heating view finds a heat pump by `hp_power_w` and finds nothing else if that metric is absent, so a working, hardware-verified driver had no page at all: not a chart, not a reading, not an entry. It emits `hp_power_w` from `main/Heat_Power_Consumption`, which `power_topic` overrides for a Heishamon build that names it differently, and only once that topic has arrived — a wrong name costs the power reading and nothing else. `hp_outside_temp_c` becomes `hp_outdoor_temp_c`, which is what nibe_local and myuplink report and what the view charts; the old name was read by nobody. Existing history under the old key stays where it is and stops growing
- The Lua `DRIVER` version said 0.4.0 while the manifest said 0.5.0. Both now say 0.6.0. The drift was invisible because nothing compares them outside `make bump-driver`
- The example config carried what reads like a real MQTT password. It is now a placeholder
Expand Down
4 changes: 2 additions & 2 deletions SUPPORT_STATUS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Catalog source is not proof that a target can install or run a driver.
| growatt | 2.1.1 | blixt-l1 | not_assessed | — | — | not_recorded | — | not_assessed | no |
| hardybarth | 1.0.1 | ftw-core | not_assessed | — | — | not_recorded | — | not_assessed | no |
| hardybarth | 1.0.1 | blixt-l1 | not_assessed | — | — | not_recorded | — | not_assessed | no |
| heishamon | 0.6.0 | ftw-core | not_assessed | — | — | not_recorded | — | not_assessed | no |
| heishamon | 0.6.0 | blixt-l1 | not_assessed | — | — | not_recorded | — | not_assessed | no |
| heishamon | 0.7.0 | ftw-core | not_assessed | — | — | not_recorded | — | not_assessed | no |
| heishamon | 0.7.0 | blixt-l1 | not_assessed | — | — | not_recorded | — | not_assessed | no |
| hello | 1.1.2 | ftw-core | not_assessed | — | — | not_recorded | — | not_assessed | no |
| hello | 1.1.2 | blixt-l1 | not_assessed | — | — | not_recorded | — | not_assessed | no |
| huawei | 2.1.1 | ftw-core | not_assessed | — | — | not_recorded | — | not_assessed | no |
Expand Down
2 changes: 1 addition & 1 deletion devices.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,7 +1015,7 @@ manufacturers:
protocols:
- protocol: mqtt
driver: "heishamon"
version: "0.6.0"
version: "0.7.0"
ders: [heatpump]
control: true
firmware_versions: ""
Expand Down
21 changes: 20 additions & 1 deletion drivers/lua/heishamon.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ DRIVER = {
id = "heishamon",
name = "Panasonic Aquarea (Heishamon)",
manufacturer = "Panasonic",
version = "0.6.0",
version = "0.7.0",
protocols = { "mqtt" },
capabilities = { "heatpump" },
description = "Panasonic Aquarea H/J/K/L/M-series heat pump via Heishamon MQTT bridge. Controls Zone 1 heat curve offset (Z1_Heat_Request_Temp) in range -3..+3 °C.",
Expand All @@ -49,6 +49,25 @@ DRIVER = {
verified_by = { "Rolf (Runneval)" },
verified_at = "2026-06-21",
verification_notes = "Tested on WH-SXC09H3E8 (H-series) with Heishamon Large v4.1.6 on ESP32. MQTT via core-mosquitto on HA Green. Live metrics confirmed. Offset control verified via Z1_Heat_Request_Temp.",
-- What an operator may command, in terms a host UI can render without
-- knowing this driver. The bounds are the defaults below; min_offset and
-- max_offset can narrow them in config, and driver_command clamps to
-- whichever is tighter, so a narrowed site is safe — its UI just offers a
-- couple of steps that land on the configured limit.
--
-- evidence is write_ack, not readback: apply_offset returns as soon as the
-- publish succeeds. The pump does echo the value back on
-- main/Z1_Heat_Request_Temp, but that arrives on a later poll and nothing
-- here waits for it or compares it. Claiming readback would tell a host
-- the setting was confirmed when all we know is that a message left.
controls = {

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Preserve the control metadata in the signed artifact

When this driver is installed from the signed FTW channel, .github/workflows/ftw-drivers-release.yml builds it through _ftw_artifact, but tools/ftw_repository.py:251-273 reconstructs __sourceful_ftw_metadata without controls, and line 327 reassigns DRIVER to that reduced table after loading the source. Consequently the published artifact's final driver metadata has no declared control, so the host cannot render the new row even though the catalog source has it; propagate this field into the generated metadata and cover the signed artifact in a test.

AGENTS.md reference: AGENTS.md:L25-L26

Useful? React with 👍 / 👎.

{
id = "set_heat_curve_offset",
label = "Heat curve offset",
evidence = "write_ack",
input = { type = "number", min = -3, max = 3, step = 1, unit = "°C" },
},
},
}

PROTOCOL = "mqtt"
Expand Down
6 changes: 3 additions & 3 deletions index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,13 @@ drivers:
size_bytes: 2193
sha256: "517e086af899dc511c86b00460cd8ce052a8d4973edee8b018e5824d4b550d6e"
- name: "heishamon"
version: "0.6.0"
version: "0.7.0"
tier: core
protocol: mqtt
ders: [heatpump]
control: true
size_bytes: 8065
sha256: "410f947f4eca8c4ab1436604c1cdc879a94057b7f9e345fb7cc8c07e70517dc9"
size_bytes: 9012
sha256: "999a10f9c87534a5185636e55ed16ad994b12e6212740e78c3d1691e6166c96e"
- name: "hello"
version: "1.1.2"
tier: community
Expand Down
6 changes: 3 additions & 3 deletions manifests/heishamon.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "heishamon"
version: "0.6.0"
version: "0.7.0"
tier: core
author: "Sourceful Labs AB"
protocol: mqtt
Expand All @@ -14,9 +14,9 @@ tested_devices:
notes: "Panasonic Aquarea H/J/K/L/M-series heat pump via Heishamon MQTT bridge. Controls Zone 1 heat curve offset (Z1_Heat_Request_Temp) in range -3..+3 °C."
min_driver_version: "0.4.0"
min_host_version: "2.0.0"
size_bytes: 8065
size_bytes: 9012
dkb_id: "heishamon"
sha256: "410f947f4eca8c4ab1436604c1cdc879a94057b7f9e345fb7cc8c07e70517dc9"
sha256: "999a10f9c87534a5185636e55ed16ad994b12e6212740e78c3d1691e6166c96e"
signature: ""

bytecode_sha256: ""
2 changes: 1 addition & 1 deletion support-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,7 @@
},
{
"catalog_source": true,
"catalog_version": "0.6.0",
"catalog_version": "0.7.0",
"driver_id": "heishamon",
"package_id": null,
"targets": {
Expand Down