From f11c6e4a0c3fa8b6b46e8ab491fbe558512077fc Mon Sep 17 00:00:00 2001 From: tholok Date: Thu, 26 Feb 2026 13:34:01 +0100 Subject: [PATCH] sonar api: update for 1.7 --- .../sonar-3d-15-api-swagger/swagger.json | 128 +++++++++++++++++- .../sonar-3d-15-software-changelog.md | 13 +- 2 files changed, 131 insertions(+), 10 deletions(-) diff --git a/docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json b/docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json index 65cd9bc..82ad6dc 100644 --- a/docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json +++ b/docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json @@ -73,6 +73,63 @@ } } }, + "/api/v1/integration/acoustics/mode": { + "get": { + "description": "Get acoustics mode (\"low-frequency\" or \"high-frequency\")", + "tags": [ + "acoustics", + "integrationAPI" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "204": { + "description": "No Content" + } + } + }, + "post": { + "description": "Set acoustics mode to either \"low-frequency\" or \"high-frequency\"", + "tags": [ + "acoustics", + "integrationAPI" + ], + "parameters": [ + { + "description": " ", + "name": "request", + "in": "body", + "required": true, + "schema": { + "type": "string", + "enum": [ + "\"low-frequency\"", + "\"high-frequency\"" + ], + "example": "\"low-frequency\"" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request" + }, + "408": { + "description": "Request Timeout" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, "/api/v1/integration/acoustics/range": { "get": { "description": "Get range", @@ -122,9 +179,66 @@ } } }, + "/api/v1/integration/acoustics/salinity": { + "get": { + "description": "Get salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".", + "tags": [ + "acoustics", + "integrationAPI" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "204": { + "description": "No Content" + } + } + }, + "post": { + "description": "Set salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".", + "tags": [ + "acoustics", + "integrationAPI" + ], + "parameters": [ + { + "description": " ", + "name": "request", + "in": "body", + "required": true, + "schema": { + "type": "string", + "enum": [ + "\"fresh\"", + "\"salt\"" + ], + "example": "\"salt\"" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request" + }, + "408": { + "description": "Request Timeout" + }, + "409": { + "description": "Conflict" + } + } + } + }, "/api/v1/integration/acoustics/speed_of_sound": { "get": { - "description": "Get speed of sound", + "description": "Get speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.", "tags": [ "acoustics", "integrationAPI" @@ -142,7 +256,7 @@ } }, "post": { - "description": "Set speed of sound", + "description": "Set speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.", "tags": [ "acoustics", "integrationAPI" @@ -294,8 +408,8 @@ } ] }, - "calibration": { - "description": "Calibration is the status of the Sonar calibration", + "systems_check": { + "description": "SystemsCheck is the status of internal processing of the Sonar", "allOf": [ { "$ref": "#/definitions/integrationapi.GinSystemStatusEntryResponse" @@ -330,10 +444,10 @@ "type": "boolean", "example": true }, - "severity": { - "description": "Severity is the severity of the status message: info, warning, error", + "status": { + "description": "Status is \"ok\", \"warning\", or \"error\"", "type": "string", - "example": "info" + "example": "ok" } } }, diff --git a/docs/sonar-3d/sonar-3d-15-software-changelog.md b/docs/sonar-3d/sonar-3d-15-software-changelog.md index f867788..cea2aab 100644 --- a/docs/sonar-3d/sonar-3d-15-software-changelog.md +++ b/docs/sonar-3d/sonar-3d-15-software-changelog.md @@ -1,8 +1,15 @@ # Software Versions -## v1.6.1 (2026-02) - -- Improve network stability +## v1.7.0 (2026-02) + +- Introduce high-frequency 2.4 MHz mode +- Add estimation of speed of sound based on temperature and salinity +- Improve accuracy of image timestamp +- Rework of status API: + - Add "systems_check" status + - Remove "calibration" status + - Replace "severity" with "status": "ok", "warning" or "error" +- Move changelog to docs.waterlinked.com ## v1.6.0 (2025-11)