# HNQAP

> Heat Network Quality Assurance Publications: an open, Apache-2.0 data standard for heat network monitoring. It defines a six-level MQTT address for every data point (schema/network/element/device/vargroup/varkey), a registry of 868 point names with fixed types and units, and a reference of 92 heat network KPIs per element type (energy centre, district distribution, substation, communal distribution, consumer connection) aligned with the Heat Network Technical Assurance Scheme (HNTAS) and extending it to cooling, meter health and hours below outage limits. HNQAP is independent of the scheme.

Use the JSON files as the source of truth: look KPIs up by code in kpi-reference.json and validate point names against vocabulary.json. KPI codes look like EC-KPI-01, SS-KPI-07, CC-KPI-C-06 (cooling), CC-KPI-M-01 (meter health), EC-KPI-H-01 (hours below outage limits).

## Start here

- [HNQAP](https://hnqap.org/index.md): Open standards for heat network quality assurance — one address for every data point, one vocabulary of names, and one reference of heat network KPIs, developed in the open with the industry.
- [Getting started](https://hnqap.org/getting-started/index.md): How to start using HNQAP — publishing data from a BMS, building software against the JSON files, reading the KPI tables, and mapping a product's points.
- [Collaborate](https://hnqap.org/collaborate/index.md): How the heat network industry works together on HNQAP to get the KPIs and assurance monitoring right — what needs review, how to take part, how decisions are made, and the route to a British Standard.
- [About HNQAP](https://hnqap.org/about/index.md): What HNQAP is, who maintains it, how it is licensed and how to cite it.

## Standard

- [HNQAP-MQTT v1 protocol](https://hnqap.org/protocol/index.md): The HNQAP-MQTT v1 specification: how heat network data points are addressed, named, published and timestamped over MQTT, so any BMS, meter platform or analytics tool can exchange data without a mapping exercise.
- [Monitoring points](https://hnqap.org/monitoring-points/index.md): Every heat network assurance monitoring point mapped to its six-level MQTT address, with units and minimum data frequency.
- [Data standard](https://hnqap.org/standard/index.md): The six-level address, vargroups and varkeys: the names every HNQAP data point is published and stored under.
- [BMS connection guide](https://hnqap.org/bms-guide/index.md): A worked implementation of the protocol: how a BMS or data logger publishes to one platform that runs it, with native, batch JSON and Sparkplug profiles.
- [Vocabulary](https://hnqap.org/vocabulary/index.md): every vargroup with links to its varkeys.

## KPIs

- [Heat Network KPI Reference](https://hnqap.org/kpis/index.md): all KPI tables with notation and rules.
- [Full text](https://hnqap.org/llms-full.txt): the protocol, monitoring points, KPI reference and vocabulary in one file.
- Each KPI also has its own page at https://hnqap.org/kpis/<code>/, for example https://hnqap.org/kpis/ss-kpi-07/index.md.

## Data

- [kpi-reference.json](https://hnqap.org/data/kpi-reference.json): KPI tables as data, per element, per KPI.
- [vocabulary.json](https://hnqap.org/data/vocabulary.json): the varkey and vargroup registry.
- [monitoring-points.json](https://hnqap.org/data/monitoring-points.json): assurance monitoring points with their six-level addresses.
- [heat-network-kpi-reference.pdf](https://hnqap.org/data/heat-network-kpi-reference.pdf): printable KPI reference.

## Optional

- [GitHub repository](https://github.com/heatweb/HNQAP): issues, discussions, history and source.
- [Proposed names](https://hnqap.org/vocabulary/proposed/index.md): nominated, not yet approved.