Skip to content

sonar api: update for release 1.7.0 #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tholok97 merged 1 commit into from
Mar 3, 2026
Merged

sonar api: update for release 1.7.0 #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 121 additions & 7 deletions docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
}
}
},
Expand Down
13 changes: 10 additions & 3 deletions docs/sonar-3d/sonar-3d-15-software-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down