✨ Add the remaining site-level metrics as sensors #19

Open

mat wants to merge 1 commit from feat/40-site-metrics into main

pull from: feat/40-site-metrics

merge into: mat:main

mat:main

mat:fix/5-energy-hour-offset

mat:feat/c7-reauth

mat:docs/api-exploration

mat:docs/47-setup-tutorial

mat:fix/46-value-guard

mat:chore/release-0.4.0

mat:7-problème-de-connexion-version-anterieure-a-gen4-2

mat:update-python-comwatt

mat:7-problème-de-connexion-version-anterieure-a-gen4

mat:3-adjust-update-frequency-for-comwattenergysensor

mat:9-enhancement-request-additional-device-control-modes-for-comwatt-integration

mat:fix/power-sensor

mat:fix/device-child-not-containing-id#10

mat:4-optimize-api-client-handling-for-multiple-sensors

mat:use-go.comwatt.com

Conversation 0 Commits 1 Files changed 3 +213 -27

mat commented 2026-04-24 17:12:34 +00:00

Owner

Copy link

Summary

Closes MateoGreil/homeassistant-comwatt#40.

The Comwatt site time-series API returns ten metric keys but only autoproductionRates was surfaced. Expose all ten: production, consumption, injection, withdrawal, charge, discharge, and their rate counterparts (auto-production / auto-consumption / injection / withdrawal).

Design

• Coordinator extracts every known key into sites_data[site_id] via a single _extract_site_metrics helper. Rates are multiplied by 100 in one place.
• Sensor platform replaces the bespoke ComwattAutoProductionRateSensor with a generic ComwattSiteMetricSensor driven by a ComwattSiteMetricDescription. Adding a new metric is a one-line addition to SITE_METRICS.
• Backward compatible: unique_id of the existing sensor unchanged (site_{site_id}_auto_production_rate). No registry churn for current users.

Notes on units and state classes

• Rate sensors: PERCENTAGE + MEASUREMENT (as before).
• Delta sensors (production/consumption/injection/withdrawal/charge/discharge): UnitOfEnergy.WATT_HOUR + MEASUREMENT. Intentionally no device_class=ENERGY — each reading is a per-hour delta, not a cumulative counter, and HA rejects ENERGY + MEASUREMENT. Users wanting Energy-dashboard-quality cumulative figures should use the existing {device}_total_energy entity or the new comwatt:{device}_total_energy external statistic from #18.

Test plan

• Updated topology tests to match the full expected unique_id set.
• New test_site_metrics_expose_every_known_key round-trips every API key to an entity state with the right unit.
• pytest tests/ — 25 passed; ruff + mypy clean.
• Hands-on: after deploy, look for 9 new sensors under your Comwatt site device in HA. Values should match what you see in the Comwatt app for the last hour.

## Summary Closes [MateoGreil/homeassistant-comwatt#40](https://github.com/MateoGreil/homeassistant-comwatt/issues/40). The Comwatt site time-series API returns ten metric keys but only `autoproductionRates` was surfaced. Expose all ten: production, consumption, injection, withdrawal, charge, discharge, and their rate counterparts (auto-production / auto-consumption / injection / withdrawal). ## Design - Coordinator extracts every known key into `sites_data[site_id]` via a single `_extract_site_metrics` helper. Rates are multiplied by 100 in one place. - Sensor platform replaces the bespoke `ComwattAutoProductionRateSensor` with a generic `ComwattSiteMetricSensor` driven by a `ComwattSiteMetricDescription`. Adding a new metric is a one-line addition to `SITE_METRICS`. - **Backward compatible**: unique_id of the existing sensor unchanged (`site_{site_id}_auto_production_rate`). No registry churn for current users. ## Notes on units and state classes - Rate sensors: `PERCENTAGE` + `MEASUREMENT` (as before). - Delta sensors (production/consumption/injection/withdrawal/charge/discharge): `UnitOfEnergy.WATT_HOUR` + `MEASUREMENT`. Intentionally **no** `device_class=ENERGY` — each reading is a per-hour delta, not a cumulative counter, and HA rejects `ENERGY + MEASUREMENT`. Users wanting Energy-dashboard-quality cumulative figures should use the existing `{device}_total_energy` entity or the new `comwatt:{device}_total_energy` external statistic from [#18](https://git.greil.fr/mat/homeassistant-comwatt/pulls/18). ## Test plan - [x] Updated topology tests to match the full expected unique_id set. - [x] New `test_site_metrics_expose_every_known_key` round-trips every API key to an entity state with the right unit. - [x] `pytest tests/` — 25 passed; `ruff` + `mypy` clean. - [ ] Hands-on: after deploy, look for 9 new sensors under your Comwatt site device in HA. Values should match what you see in the Comwatt app for the last hour.

mat added 1 commit 2026-04-24 17:12:34 +00:00

✨ Add the remaining site-level metrics as sensors ... b1dc5f4c60

Closes #40.

The Comwatt site time-series API returns ten keys under
`get_site_networks_ts_time_ago`:

    productions, consumptions, injections, withdrawals,
    charges, discharges,
    autoproductionRates, autoconsumptionRates,
    injectionRates, withdrawalRates

Previously only `autoproductionRates` was surfaced. Expose all ten.

Structure:

- Coordinator: extract every known key into `sites_data[site_id]`, with
  a single helper (`_extract_site_metrics`). Rates are multiplied by
  100 once, in one place.
- Sensor platform: replace the bespoke `ComwattAutoProductionRateSensor`
  class with a generic `ComwattSiteMetricSensor` driven by a
  `ComwattSiteMetricDescription` (frozen dataclass). Each metric is a
  tuple entry in `SITE_METRICS`. Adding a new one is a one-line change.
- Backwards compatibility: the existing sensor keeps its unique_id
  (`site_{site_id}_auto_production_rate`) because that's the
  description's `key` — existing users see no registry churn.

Energy delta sensors (production/consumption/etc.) are declared with
unit Wh and `SensorStateClass.MEASUREMENT` but intentionally **no**
`device_class=ENERGY`: each reading is the last hourly bucket's delta
rather than a cumulative counter, and HA rejects the MEASUREMENT +
ENERGY combination. Users wanting Energy-dashboard-quality cumulative
figures should pick the existing `{device}_total_energy` entity or the
external `comwatt:{device}_total_energy` statistic (see PR #18).

## Tests

- `test_simple_device_creates_site_and_device_sensors` and the parent
  variant: updated expected unique_ids to match the new set.
- `test_site_metrics_expose_every_known_key`: verifies every API key
  round-trips to the expected sensor state (rate × 100, delta as-is),
  with correct units.

mat referenced this pull request 2026-04-24 17:14:55 +00:00

🔒️ Drop non-finite values before they reach the recorder #20

mat referenced this pull request from a commit 2026-04-24 18:43:35 +00:00

📝 Document the energy.comwatt.com API and WebSocket stream

mat referenced this pull request 2026-04-24 18:43:50 +00:00

📝 Document the energy.comwatt.com API and WebSocket stream #22

mat force-pushed feat/40-site-metrics from b1dc5f4c60 to 9348329645 2026-04-24 21:53:03 +00:00 Compare

mat referenced this pull request from a commit 2026-04-24 21:53:08 +00:00

📝 Document the energy.comwatt.com API and WebSocket stream

All checks were successful

Hide all checks

Validate / validate-hacs (pull_request) Has been skipped

Details

Validate / validate-hassfest (pull_request) Has been skipped

Details

Validate / lint-ruff (pull_request) Successful in 7s

Details

Validate / test-pytest (pull_request) Successful in 1m46s

Details

Validate / type-check-mypy (pull_request) Successful in 1m48s

Details

Validate / validate-hacs (push) Has been skipped

Details

Validate / validate-hassfest (push) Has been skipped

Details

Validate / lint-ruff (push) Successful in 7s

Details

Validate / test-pytest (push) Successful in 1m45s

Details

Validate / type-check-mypy (push) Successful in 1m48s

Details

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin feat/40-site-metrics:feat/40-site-metrics

git switch feat/40-site-metrics

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff feat/40-site-metrics

git switch feat/40-site-metrics

git rebase main

git switch main

git merge --ff-only feat/40-site-metrics

git switch feat/40-site-metrics

git rebase main

git switch main

git merge --no-ff feat/40-site-metrics

git switch main

git merge --squash feat/40-site-metrics

git switch main

git merge --ff-only feat/40-site-metrics

git switch main

git merge feat/40-site-metrics

git push origin main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

mat/homeassistant-comwatt!19

No description provided.