Skip to main content

​
Heat Pump State

Heat pump state parameters provide real-time operational data, sensor readings, and consumption metrics. These fields are read-only and automatically updated from the manufacturer’s API.
State data refresh frequency depends on the manufacturer’s API. Most values update every 5-15 minutes.

​
Operational Status

​
operational_mode
enum
Current operational mode of the heat pump.Options:
  • Hot Water - Heating domestic hot water only
  • Heating - Space heating active
  • Pool Heating - Pool heating mode (if applicable)
  • Standby - Device is on but not actively heating
  • Off - Device is powered off
Example: Hot Water
​
current_power_consumption_w
float
Current power consumption in Watts.Example: 2341.0
​
current_state_last_updated_at
datetime
Timestamp when the device state was last updated from the manufacturer’s API.Use this to determine data freshness.Example: 2023-03-22T13:54:34.000Z

​
Temperature Readings

​
outdoor_temperature
float
Current outdoor temperature in °C measured by the heat pump.Example: 9.3
​
indoor_actual_temperature
float
Current indoor temperature in °C (if indoor sensor is available).May be null if the device doesn’t have an indoor temperature sensor.Example: 21.2
​
dhw_actual_temperature
float
Current temperature of domestic hot water in °C.Example: 51.1

​
Energy Consumption

​
consumption_last_day_kwh
float
Energy consumption for the previous day in kWh.Example: 9.4
​
consumption_last_week_kwh
float
Energy consumption for the previous week in kWh.Example: 72.5
​
consumption_last_month_kwh
float
Energy consumption for the previous month in kWh.Example: 351.3
​
consumption_last_updated_at
datetime
Timestamp when consumption data was last calculated.Example: 2023-03-22T13:54:34.000Z

​
Usage Examples

​
Get Device State

curl -X GET \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{device_id}' \
  -H 'Authorization: Bearer {auth_token}' \
  -H 'Accept: application/json'

​
Understanding Operational Modes

The heat pump is actively heating domestic hot water to reach the target temperature.Typical Duration: 30-90 minutes per cyclePower Consumption: Medium to High

​
Best Practices

  • Poll device state every 5-15 minutes for dashboard updates
  • Check current_state_last_updated_at to avoid unnecessary API calls
  • Implement caching to reduce API load
  • Show last update timestamp to users for transparency
  • Compare daily consumption across similar timeframes
  • Account for outdoor temperature when analyzing trends
  • Use weekly/monthly averages for meaningful comparisons
  • Alert users to unusual consumption spikes
  • Show both indoor and outdoor temperatures for context
  • Highlight when indoor temperature is outside comfort range
  • DHW temperature should typically be 45-55°C
  • Consider outdoor temperature for heating efficiency expectations
  • Handle null values gracefully (e.g., missing indoor sensor)
  • Display user-friendly messages for stale data
  • Provide troubleshooting steps when data stops updating
  • Check is_authenticated before displaying state data

Heat Pump Attributes

Writable parameters and configuration

Dashboard Integration

Building end-user dashboards

Energy Contracts

Energy pricing parameters

Buildings

Building parameters reference