XENON API Changelog

This topics contains changes to the XENON API.
We constantly evolve our APIs in a non-breaking manner. All changes will be recorded here, so you can follow along and become aware of new capabilities, optimization and deprecations.

For breaking changes, there will be prior deprecation with long-enough grace periods. Details on future API evolution processes will follow.

Changelog 2024-12-13T10:04:17.357Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /clusters/{clusterID}/live

  • added the optional property ‘heatPumps/items/sgReadyState’ to the response with the ‘200’ status

GET /gateways

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/live

  • added the optional property ‘heatPumps/items/sgReadyState’ to the response with the ‘200’ status

GET /user/stars/systems

  • :warning: added the new ‘GOODWE_MODBUS_TCP_INVERTER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

(sha 74b537dd)

Changelog 2024-12-18T10:19:57.369Z

GET /clusters/{clusterID}/live

  • :warning: added the new ‘SG_READY_AUTO’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_OFF’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_RECOMMEND_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_UNKNOWN’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • the ‘sgReadyState’ response’s property default value ‘SG_READY_UNKNOWN’ was added for the status ‘200’

GET /systems/{systemID}/live

  • :warning: added the new ‘SG_READY_AUTO’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_OFF’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_RECOMMEND_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘SG_READY_UNKNOWN’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • the ‘sgReadyState’ response’s property default value ‘SG_READY_UNKNOWN’ was added for the status ‘200’

GET /systems/{systemID}/timeofuse/settings

  • the response property ‘enabledPVCurtailment’ became required for the status ‘200’

PATCH /systems/{systemID}/timeofuse/settings

  • the response property ‘enabledPVCurtailment’ became required for the status ‘200’

PUT /systems/{systemID}/timeofuse/settings

  • the response property ‘enabledPVCurtailment’ became required for the status ‘200’

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘PV_CURTAILMENT_NOT_SUPPORTED’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘PV_CURTAILMENT_NOT_SUPPORTED’ enum value to the ‘status/error_code’ response property for the response status ‘200’

(sha f625ca89)

Good afternoon everyone. We recently added the HeatPump SGReadyState to the live measurements. Unfortunately, we didn’t realize the inconsistent enum values. For example, in the raw measurements they are:

* AUTO
* OFF
* ON
* RECOMMENDED_ON
* UNKNOWN

We would like to correct this inconsistent naming and propose to make the changes on Monday, 2024-12-23T10:00:00Z. We’ll closely monitor for issues and roll back if there are any.

Apologies if you’ve already started using this field. If so, please let us know, so we can arrange a time to rollout the changes that is more convient.

1 Like

Changelog 2024-12-23T10:44:19.745Z

GET /clusters/{clusterID}/live

  • :warning: added the new ‘AUTO’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘OFF’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘RECOMMEND_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘UNKNOWN’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • the ‘sgReadyState’ response’s property default value changed from ‘SG_READY_UNKNOWN’ to ‘UNKNOWN’ for the status ‘200’
  • removed the ‘SG_READY_AUTO’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_OFF’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_ON’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_RECOMMEND_ON’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_UNKNOWN’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’

GET /systems/{systemID}/live

  • :warning: added the new ‘AUTO’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘OFF’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘RECOMMEND_ON’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • :warning: added the new ‘UNKNOWN’ enum value to the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • the ‘sgReadyState’ response’s property default value changed from ‘SG_READY_UNKNOWN’ to ‘UNKNOWN’ for the status ‘200’
  • removed the ‘SG_READY_AUTO’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_OFF’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_ON’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_RECOMMEND_ON’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’
  • removed the ‘SG_READY_UNKNOWN’ enum value from the ‘heatPumps/items/sgReadyState’ response property for the response status ‘200’

(sha 0b8502c7)