Limitations
This section covers the features' limitations regarding, for instance, specific control unit types, as well as gateway and appliance types. A table with the nomenclature used for the gateways naming and the control unit types is also presented in the Compatibility section. This will help to map the referred gateway type to the corresponding denotation used by each country and to identify the type of control unit used by the different heat pump types.
✅ - No known limitation. ⭕ - Not implemented by Partner API. 🚫 - No support. ⚠️ - Limited support.
REST API
| Endpoint | Appliance Type | Gateway Type | Control Unit Type |
|---|---|---|---|
| /hvacs/{gatewayId}/dhwCircuits/{circuitId} | 🚫 Boiler | 🚫 RRC1 ⭕ RRC2 (RRCNG) ⚠️ ICOM | ✅ |
| /hvacs/{gatewayId}/dhwCircuits/{circuitId}/charge | 🚫 Boiler | ⭕ RRC1 ⭕ RRC2 (RRCNG) ⚠️ ICOM | ✅ |
| /hvacs/{gatewayId}/heatingCircuits/{circuitId} | ✅ | 🚫 RRC1 🚫 RRC2 (RRCNG) ⚠️ ICOM | ✅ |
| /hvacs/{gatewayId}/heatingCircuits/{circuitId}/heatingDistributionType | ✅ | 🚫 RRC1 🚫 RRC2 (RRCNG) 🚫 ICOM | ✅ |
| /hvacs/{gatewayId}/heatingCircuits/{circuitId}/heatCurve | ✅ | 🚫 RRC1 🚫 RRC2 (RRCNG) ⚠️ ICOM | ✅ |
| /hvacs/{gatewayId}/heatingCircuits/{circuitId}/timePrograms/{timeProgramId} | 🚫 Boiler | ✅ | ✅ |
| /hvacs/{gatewayId}/system/silentMode | 🚫 Boiler | 🚫 RRC1 🚫 RRC2 (RRCNG) 🚫 ICOM | ✅ |
| /hvacs/{gatewayId}/system/holidayModes | ✅ | 🚫 RRC1 🚫 RRC2 (RRCNG) ⭕ ICOM | ✅ |
| /hvacs/{gatewayId}/system/dateTime | ✅ | 🚫 RRC1 🚫 RRC2 (RRCNG) | ✅ |
| All other endpoints | ✅ | ✅ | ✅ |
Webhooks
Configuration
In a typical scenario, one client is connected with one company. However, it is possible to connect multiple clients with one company and share the same end-customer appliances.
This setup introduces some limitations:
- Multiple webhook URLs can be configured per company. Each webhook can be configured to receive different event types. For more details, refer to the steps to receive events.
- Both clients will share the same rate limits. For more information, see the Rate Limits section.
Events
| Event Type | Appliance Type | Gateway Type | Control Unit Type | Country |
|---|---|---|---|---|
| Connectivity Status Event | ✅ | ✅ | ✅ | ✅ |
| Appliance Status Event | ✅ | ⚠️ K30: See (1) | ✅ | ⚠️ See (2) |
| Data Point Event | ⚠️ Boiler: See (3) | 🚫 RRC1 | See data points | ✅ |
| Daily Aggregates | 🚫 Boiler 🚫 Hybrids | 🚫 RRC1 | See daily aggregates | ✅ |
(1) - After a gateway reset or restart, stops receiving error events. To address the issue in this scenario, please get in contact with the API team via the designated communication channel.
(2) - The translations for error descriptions are based on the target market of the component. The error event will still be delivered, but if the component is not supported, then the translated error description will be shown as n/a.
(3) - The outdoor temperature data point is supported by heat pumps and boilers. All other data points are only supported by heat pumps.