Appearance
Enum - GaugePurpose
Not final. The final value set is being defined jointly with Petr, based on the Gauge Purpose Options source page (Confluence page 556400657). Only 3 sample values are documented below, to illustrate the structure — this list is not exhaustive. Do not treat it as complete; consult the current source page before relying on it.
Role change (2026-07-17): this enum is no longer the direct type of
gauge.purpose— that field is now aUUID(foreign key to the Gauge Purpose Options page/table).GaugePurposenow serves as the type ofgaugePurposeOption.purposeCategory— a business category that can be shared by several different options (different wordings leading to the samedirection/outputModecombination). The enum's values are unchanged by this; only which entity/attribute uses them has changed.
Key: enum.gaugePurpose
Describes the intended purpose of a gauge — what it measures and what role it plays in the building's energy balance. Used as gaugePurposeOption.purposeCategory — several gaugePurposeOption rows (different wordings offered to the user) may share the same purposeCategory and the same resulting (direction, outputMode), since the category describes business meaning, not a specific presented option. Nullable — required wherever outputMode + direction alone is ambiguous, and optional elsewhere.
Values
| Value | Description |
|---|---|
consumedFromGrid | Main supply meter at the grid boundary. Energy flows into the building from the distribution network. Corresponds to include + import. UI label: "Odběr ze sítě / Consumed from grid". |
fveProduction | Photovoltaic production meter. Energy flows into the building from the panels (treated as a boundary source, same as the grid). Corresponds to include + import. UI label: "Výroba FVE / FVE production". |
tenantConsumption | Sub-meter of a third-party tenant or sub-tenant who manages their own energy contract. Energy physically flows into the building but is excluded from the building manager's balance. Corresponds to subtract + import. UI label: "Spotřeba nájemníka / Tenant consumption". |
| … | Additional values are expected once the final set is agreed; not yet documented. |
References
gaugePurposeOption.purposeCategory- Gauge Management (feature)
- Gauge Purpose Options source page (Confluence page 556400657) — source of the final value set