Skip to main content
GET
/
api
/
hcu
Get HCU status
curl --request GET \
  --url http://aris.local/api/hcu \
  --header 'Authorization: Bearer <token>'
{
  "hcuId": "hcu_main",
  "sourceType": "heat_pump",
  "mode": "heat",
  "state": "running",
  "supplyTempC": 48.5,
  "returnTempC": 42,
  "flowRateLpm": 4.2,
  "thermalPowerKw": 12.5,
  "electricalPowerKw": 3.2,
  "lifetimeThermalKwh": 1420.5,
  "lifetimeElecKwh": 450.2,
  "copInstant": 3.9,
  "outdoorTempC": -2.5,
  "backupHeaterActive": false,
  "activeFaults": []
}

Authorizations

​
Authorization
string
header
required

Session token or API token

Response

HCU status

​
hcuId
string

Unique identifier for the HCU

Example:

"hcu_main"

​
sourceType
enum<string>
Available options:
heat_pump,
district_interface
Example:

"heat_pump"

​
mode
enum<string>

Resolved operating state - "heat", "cool", "dhw_charge", or "idle"

Available options:
heat,
cool,
dhw_charge,
idle
Example:

"heat"

​
state
enum<string>

Operational state - "running", "standby", "defrost", or "fault"

Available options:
running,
standby,
defrost,
fault
Example:

"running"

​
supplyTempC
number

Temperature of water leaving HCU to the system

Example:

48.5

​
returnTempC
number

Temperature of water returning to HCU. Used for energy calculations.

Example:

42

​
flowRateLpm
number

Current flow rate through the source side (liters per minute)

Example:

4.2

​
thermalPowerKw
number

Real-time thermal output - the useful energy moving into the water

Example:

12.5

​
electricalPowerKw
number

Real-time electrical input - total power draw including compressor, pumps, electronics

Example:

3.2

​
lifetimeThermalKwh
number

Total accumulated thermal energy delivered

Example:

1420.5

​
lifetimeElecKwh
number

Total accumulated electricity consumed

Example:

450.2

​
copInstant
number

Real-time efficiency (thermal/electrical). Only present when running. COP of 3.0 = 300% efficient vs resistance heating.

Example:

3.9

​
outdoorTempC
number

Outdoor ambient temperature

Example:

-2.5

​
backupHeaterActive
boolean

True if electric backup heater is currently energized

Example:

false

​
activeFaults
string[]

List of active fault codes

Example:
[]