Skip to content

Release v2.2024.11.10.0
Compare
Choose a tag to compare
@kritsel kritsel released this 10 Nov 12:03
· 123 commits to main since this release
v2.2024.11.10.0
9b06e7e

All changes are relative to the previous released version.

Note: status identifiers like 'new' and 'unchanged' does not apply to the API itself; it only applies to this specification of the API.

Acknowledgements

Many thanks to Christophe Lambin for contributing these API spec improvements.

Schema model changes - affecting the API contract

  • ErrorResponse and ErrorResponse422 : fixed error related to incorrect error array definition
  • percentage property of PercentageDatapoint changed from integer to float

Schema model changes - schema component design changes not affecting the API contract

  • location property of MobileDevice modelled as a separate schema component
  • activityDataPoints and sensorDataPoints properties of ZoneState modelled as separate schema components
  • openWindow property of ZoneState modelled as a separate schema component
  • termination property of ZoneOverlay modelled as a separate schema component

Paths covered

home

  • GET /homes: unchanged
  • GET /homes/{homeId}/airComfort: unchanged
  • PUT /homes/{homeId}/awayRadiusInMeters: unchanged
  • PUT /homes/{homeId}/details: unchanged
  • GET /homes/{homeId}/heatingSystem: unchanged
  • PUT /homes/{homeId}/heatingSystem/boiler: unchanged
  • PUT /homes/{homeId}/heatingSystem/underfloorHeating: unchanged
  • GET /homes/{homeId}/incidentDetection: unchanged
  • PUT /homes/{homeId}/incidentDetection: unchanged
  • GET /homes/{homeId}/weather: unchanged

home control

  • POST /homes/{homeId}/overlay: unchanged
  • DELETE /homes/{homeId}/overlay: unchanged
  • PUT /homes/{homeId}/presenceLock: unchanged
  • DELETE /homes/{homeId}/presenceLock: new
  • GET /homes/{homeId}/state: unchanged

heating circuit (new section)

  • GET /homes/{homeId}/heatingCircuits: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/control/heatingCircuit:unchanged

zone

  • GET /homes/{homeId}/zones: unchanged
  • POST /homes/{homeId}/zones: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/capabilities: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/dazzle: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/details unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/openWindowDetection unchanged
  • GET /homes/{homeId}/zones/{zoneId}/state: unchanged
  • GET /homes/{homeId}/zoneStates: unchanged

zone control

  • GET /homes/{homeId}/zones/{zoneId}/defaultOverlay: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/defaultOverlay: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/earlyStart: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/earlyStart: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/overlay: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/overlay: unchanged
  • DELETE /homes/{homeId}/zones/{zoneId}/overlay: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/awayConfiguration: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/schedule/awayConfiguration: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/activeTimetable: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/schedule/activeTimetable: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks/{dayType}: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks/{dayType}: unchanged

device

  • GET /devices/{deviceId}: unchanged
  • GET /devices/{deviceId}/temperatureOffset: unchanged
  • PUT /devices/{deviceId}/temperatureOffset: unchanged
  • GET /homes/{homeId}/devices: unchanged
  • POST /homes/{homeId}/identify: unchanged
  • GET /homes/{homeId}/deviceList: unchanged
  • GET /homes/{homeId}/installations: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/control: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/control/heatingCircuit: unchanged
  • POST /homes/{homeId}/zones/{zoneId}/devices: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/measuringDevice: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/measuringDevice: unchanged

user

  • GET /me: unchanged
  • GET /users: unchanged

mobile device

  • GET /homes/{homeId}/mobileDevices: unchanged
  • GET /homes/{homeId}/mobileDevices/{mobileDeviceId}: unchanged
  • DELETE /homes/{homeId}/mobileDevices/{mobileDeviceId}: unchanged
  • GET /homes/{homeId}/mobileDevices/{mobileDeviceId}/settings: unchanged
  • PUT /homes/{homeId}/mobileDevices/{mobileDeviceId}/settings: unchanged

report

  • GET /homes/{homeId}/zones/{zoneId}/dayReport: unchanged
Assets 2
Loading