Changelog

1.5.1

Added

  • route GET /environmental-conditions

  • route GET /environmental-conditions/{id}

1.5.0

Added

  • route GET /autochecker/main

  • route GET /autochecker/extra

    New endpoints to be used by the Autochecker tool.

1.4.2

Changed

  • route GET /modules

    The response does not any longer include 3rd party speakers.

1.4.1

Added

  • field online for GET /modules endpoints.

    If a module is offline, the response will contain blinking=false and power_status=unknown.

1.4.0

Added

  • route GET /processors

  • route GET /processors/{processorID}

  • route PATCH /processors/{processorID}/active-pairing

  • route GET /ws/processors

    The new endpoints provide information about processors and allow changing their active pairings.

  • New BeamType "generic-beam".

Changed

  • route GET /status/health

  • route GET /ws/status/health

    These routes are extended to provide physical processor health statuses.

1.3.1

Added

  • route GET /modules/summary

    New endpoint that returns a summary of all modules in TSV format (Tab-separated values). This includes health information, online and power statuses, software version, etc.

1.3.0

Added

  • route GET /status/cluster/ready

    New endpoint to check if the Kubernetes cluster is ready to be used. If the response status is 200 (OK), the cluster exhibits no apparent problems and can be used. If the status is 5XX or if the server does not reply, the cluster should be considered not ready for usage.

1.2.2

Changed

  • route GET /status/health

  • route GET /ws/status/health

    Controllers' health now also report hardware_status and network_status fields. The two new statuses correspond to the health state of the controller's hardware components (hard drives, fans, PSUs) and its network setup (NTP, Internet connection, network interfaces' speed, etc.). The already existing status field will be the worst of the two new statuses.

1.2.1

Added

  • route GET /presets

    New endpoint to get all presets in a single request.

1.2.0

Changed

  • route GET /status/health

  • route GET /ws/status/health

    Modules' health now also report hardware_status and network_status fields. The two new statuses correspond to the health state of the module's hardware components (amplifiers, PSUs, drivers, sublinks, etc.) and its network setup. The already existing status field will be the worst of the two new statuses.

Fixed

  • The critical health status is now correctly reported in the OpenAPI spec.

1.1.2

Added

  • route GET /audio-streams

    New endpoint to retrieve information on audio streams known to the system. Audio streams can be networked or analog audio streams. A networked audio stream consists of one or two Ravenna streams (the second stream serving as a backup).

1.1.1

Added

  • route GET /analog-mode

  • route PUT /analog-mode

    New endpoints to control whether analog mode is enforced system-wide.

    The endpoints under the /modules path now also contain information on the analog mode of the modules.

1.1.0

Added

  • route PUT /beams/{beamID}/mute

  • route PUT /beams/{beamID}/solo

  • route PUT /modules/{moduleID}/power

  • route PUT /modules/{moduleID}/blink

  • route GET /modules/{moduleID}/blink

  • route PUT /arrays/{arrayID}/power

  • route PUT /arrays/{arrayID}/blink

  • route GET /presets/{presetID}

    Returns the preset with the given ID, including a map of beams, each of which contains a name and a beam type. The beam ID is the key of the map.

Changed

  • route GET /spaces and /spaces/{spaceID}

    The response now contains a list of preset IDs that are available for the space.

  • route GET /arrays and /arrays/{arrayID}

    The response now contains a map of modules where the key is the virtual module ID and the value is the physical module ID. The response also contains the current power status of the array.

1.0.4

Added

  • route GET /gain/linear

  • route GET /gain/db

  • route PUT /gain/linear

  • route PUT /gain/db

  • route PUT /gain/increase

  • route PUT /gain/decrease

  • route GET /ws/gain/linear

  • route GET /ws/gain/db

1.0.3

Added

  • route POST /spaces/{spaceID}/environmental-conditions/apply

Changed

  • route PATCH /spaces/{spaceID}

    Changes to the environmental conditions are not any longer applied immediately. They will be applied on the next preset change or when the new apply endpoint is used.

1.0.2

Fixed

  • Health status is now in sync with Controller UI

1.0.1

Fixed

  • When a space doesn't have an empty preset, the "active_preset_id" field is set to null instead of an empty string

1.0

Added

  • route GET /power

  • route PUT /power

  • websocket route /ws/power

  • route GET /status/power

  • websocket route /ws/status/power

  • route GET /modules

  • route GET /modules/{id}

  • route GET /controllers

  • route GET /controllers/{id}

  • route GET /arrays

  • route GET /arrays/{id}

Changed

  • Use strings for health status enum

  • Display health for arrays

  • Use UUIDs as identifiers for modules and controllers

0.3

Added

  • route GET /status/health

  • websocket route /ws/status/health

Changed

  • Amend documentation for PATCH /spaces

0.2

Added

  • route GET /mute

  • route PUT /mute

  • websocket route /ws/mute

Fixed

  • websocket route /ws/spaces didn't send updates

0.1

Added

  • route GET /spaces

  • route GET /spaces/{spaceID}

  • route PATCH /spaces/{spaceID}

  • websocket route /ws/spaces

Last updated

Was this helpful?