Skip to main content
GET
/
api
/
heatpumps
/
{hpId}
Get heat pump status
curl --request GET \
  --url http://aris.local/api/heatpumps/{hpId} \
  --header 'Authorization: Bearer <token>'
{
  "hpId": "hp_outdoor_1",
  "parentHcuId": "hcu_main",
  "compressorSpeedPercent": 65,
  "compressorHz": 78,
  "fanRpm": 850,
  "defrostActive": false,
  "highPressureBar": 28.5,
  "lowPressureBar": 8.2,
  "compressorDischargeTempC": 85,
  "compressorSuctionTempC": 12,
  "thermalPowerKw": 12.5,
  "electricalPowerKw": 3.2,
  "copInstant": 3.9,
  "acVoltageV": 230,
  "acCurrentA": 12.5,
  "firmwareVersion": "v2.4.1",
  "activeFaults": []
}

Authorizations

​
Authorization
string
header
required

Session token or API token

Path Parameters

​
hpId
string
required

Response

Heat pump status

The Heat Pump represents the physical outdoor machinery and its internal electronics. It is a child of an HCU and provides deep diagnostic data required by technicians. This device has no direct control points exposed to the system; it is controlled exclusively by the logic within the HCU.

​
hpId
string

Unique identifier for the heat pump

Example:

"hp_outdoor_1"

​
parentHcuId
string

ID of the HCU that manages this heat pump

Example:

"hcu_main"

​
compressorSpeedPercent
integer

Current inverter compressor speed (0-100%)

Required range: 0 <= x <= 100
Example:

65

​
compressorHz
number

Inverter frequency in Hz (typically 30-120 Hz). Precise diagnostic data for performance analysis. May not be present on all systems.

Example:

78

​
fanRpm
integer

Outdoor fan speed in RPM. May not be present on all systems.

Example:

850

​
defrostActive
boolean

True during defrost cycle. Supply temp may dip during defrost.

Example:

false

​
highPressureBar
number

Refrigerant high-side pressure. For diagnosing blockages or overcharge. Diagnostic field - may not be present on all systems.

Example:

28.5

​
lowPressureBar
number

Refrigerant low-side pressure. For diagnosing leaks or expansion valve faults. Diagnostic field - may not be present on all systems.

Example:

8.2

​
compressorDischargeTempC
number

Temperature of refrigerant leaving compressor. High values indicate stress or low charge. Diagnostic field - may not be present on all systems.

Example:

85

​
compressorSuctionTempC
number

Temperature of refrigerant entering compressor. Diagnostic field - may not be present on all systems.

Example:

12

​
thermalPowerKw
number

Real-time thermal power output. May not be present on all systems.

Example:

12.5

​
electricalPowerKw
number

Real-time electrical power consumption. May not be present on all systems.

Example:

3.2

​
copInstant
number

Heat pump efficiency (COP). Only present when compressor is running. Omitted when idle or defrosting.

Example:

3.9

​
acVoltageV
number

Input voltage from grid. For detecting brownouts or dirty power. Diagnostic field - may not be present on all systems.

Example:

230

​
acCurrentA
number

Input amperage draw. Diagnostic field - may not be present on all systems.

Example:

12.5

​
firmwareVersion
string

Manufacturer firmware version. May not be present on all systems.

Example:

"v2.4.1"

​
activeFaults
string[]

List of active fault codes (see Fault Codes reference)

Example:
[]