Skip to content

Commit f11c6e4

Browse files
committed
sonar api: update for 1.7
1 parent 0d95557 commit f11c6e4

2 files changed

Lines changed: 131 additions & 10 deletions

File tree

docs/sonar-3d/sonar-3d-15-api-swagger/swagger.json

Lines changed: 121 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,63 @@
7373
}
7474
}
7575
},
76+
"/api/v1/integration/acoustics/mode": {
77+
"get": {
78+
"description": "Get acoustics mode (\"low-frequency\" or \"high-frequency\")",
79+
"tags": [
80+
"acoustics",
81+
"integrationAPI"
82+
],
83+
"responses": {
84+
"200": {
85+
"description": "OK",
86+
"schema": {
87+
"type": "string"
88+
}
89+
},
90+
"204": {
91+
"description": "No Content"
92+
}
93+
}
94+
},
95+
"post": {
96+
"description": "Set acoustics mode to either \"low-frequency\" or \"high-frequency\"",
97+
"tags": [
98+
"acoustics",
99+
"integrationAPI"
100+
],
101+
"parameters": [
102+
{
103+
"description": " ",
104+
"name": "request",
105+
"in": "body",
106+
"required": true,
107+
"schema": {
108+
"type": "string",
109+
"enum": [
110+
"\"low-frequency\"",
111+
"\"high-frequency\""
112+
],
113+
"example": "\"low-frequency\""
114+
}
115+
}
116+
],
117+
"responses": {
118+
"204": {
119+
"description": "No Content"
120+
},
121+
"400": {
122+
"description": "Bad Request"
123+
},
124+
"408": {
125+
"description": "Request Timeout"
126+
},
127+
"500": {
128+
"description": "Internal Server Error"
129+
}
130+
}
131+
}
132+
},
76133
"/api/v1/integration/acoustics/range": {
77134
"get": {
78135
"description": "Get range",
@@ -122,9 +179,66 @@
122179
}
123180
}
124181
},
182+
"/api/v1/integration/acoustics/salinity": {
183+
"get": {
184+
"description": "Get salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".",
185+
"tags": [
186+
"acoustics",
187+
"integrationAPI"
188+
],
189+
"responses": {
190+
"200": {
191+
"description": "OK",
192+
"schema": {
193+
"type": "string"
194+
}
195+
},
196+
"204": {
197+
"description": "No Content"
198+
}
199+
}
200+
},
201+
"post": {
202+
"description": "Set salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".",
203+
"tags": [
204+
"acoustics",
205+
"integrationAPI"
206+
],
207+
"parameters": [
208+
{
209+
"description": " ",
210+
"name": "request",
211+
"in": "body",
212+
"required": true,
213+
"schema": {
214+
"type": "string",
215+
"enum": [
216+
"\"fresh\"",
217+
"\"salt\""
218+
],
219+
"example": "\"salt\""
220+
}
221+
}
222+
],
223+
"responses": {
224+
"204": {
225+
"description": "No Content"
226+
},
227+
"400": {
228+
"description": "Bad Request"
229+
},
230+
"408": {
231+
"description": "Request Timeout"
232+
},
233+
"409": {
234+
"description": "Conflict"
235+
}
236+
}
237+
}
238+
},
125239
"/api/v1/integration/acoustics/speed_of_sound": {
126240
"get": {
127-
"description": "Get speed of sound",
241+
"description": "Get speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.",
128242
"tags": [
129243
"acoustics",
130244
"integrationAPI"
@@ -142,7 +256,7 @@
142256
}
143257
},
144258
"post": {
145-
"description": "Set speed of sound",
259+
"description": "Set speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.",
146260
"tags": [
147261
"acoustics",
148262
"integrationAPI"
@@ -294,8 +408,8 @@
294408
}
295409
]
296410
},
297-
"calibration": {
298-
"description": "Calibration is the status of the Sonar calibration",
411+
"systems_check": {
412+
"description": "SystemsCheck is the status of internal processing of the Sonar",
299413
"allOf": [
300414
{
301415
"$ref": "#/definitions/integrationapi.GinSystemStatusEntryResponse"
@@ -330,10 +444,10 @@
330444
"type": "boolean",
331445
"example": true
332446
},
333-
"severity": {
334-
"description": "Severity is the severity of the status message: info, warning, error",
447+
"status": {
448+
"description": "Status is \"ok\", \"warning\", or \"error\"",
335449
"type": "string",
336-
"example": "info"
450+
"example": "ok"
337451
}
338452
}
339453
},

docs/sonar-3d/sonar-3d-15-software-changelog.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# Software Versions
22

3-
## v1.6.1 (2026-02)
4-
5-
- Improve network stability
3+
## v1.7.0 (2026-02)
4+
5+
- Introduce high-frequency 2.4 MHz mode
6+
- Add estimation of speed of sound based on temperature and salinity
7+
- Improve accuracy of image timestamp
8+
- Rework of status API:
9+
- Add "systems_check" status
10+
- Remove "calibration" status
11+
- Replace "severity" with "status": "ok", "warning" or "error"
12+
- Move changelog to docs.waterlinked.com
613

714
## v1.6.0 (2025-11)
815

0 commit comments

Comments
 (0)