@deeptrekker/api-domain 1.0.53 → 1.0.54-omniscan.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constants/schema/schema.json +109 -257
- package/dist/constants/versions/index.d.ts +1 -1
- package/dist/constants/versions/index.js +1 -1
- package/dist/types/devices/index.d.ts +8 -2
- package/dist/types/devices/index.js +7 -1
- package/dist/types/devices/sonar/index.d.ts +10 -0
- package/dist/types/devices/vehicles/rov/index.d.ts +8 -1
- package/package.json +7 -8
|
@@ -113,9 +113,7 @@
|
|
|
113
113
|
"$ref": "#/definitions/DeviceVersion"
|
|
114
114
|
}
|
|
115
115
|
},
|
|
116
|
-
"required": [
|
|
117
|
-
"model"
|
|
118
|
-
],
|
|
116
|
+
"required": ["model"],
|
|
119
117
|
"type": "object"
|
|
120
118
|
},
|
|
121
119
|
"A150CameraHead": {
|
|
@@ -180,9 +178,7 @@
|
|
|
180
178
|
"$ref": "#/definitions/DeviceVersion"
|
|
181
179
|
}
|
|
182
180
|
},
|
|
183
|
-
"required": [
|
|
184
|
-
"model"
|
|
185
|
-
],
|
|
181
|
+
"required": ["model"],
|
|
186
182
|
"type": "object"
|
|
187
183
|
},
|
|
188
184
|
"A200": {
|
|
@@ -297,9 +293,7 @@
|
|
|
297
293
|
"$ref": "#/definitions/DeviceVersion"
|
|
298
294
|
}
|
|
299
295
|
},
|
|
300
|
-
"required": [
|
|
301
|
-
"model"
|
|
302
|
-
],
|
|
296
|
+
"required": ["model"],
|
|
303
297
|
"type": "object"
|
|
304
298
|
},
|
|
305
299
|
"A200CameraHead": {
|
|
@@ -372,9 +366,7 @@
|
|
|
372
366
|
"$ref": "#/definitions/DeviceVersion"
|
|
373
367
|
}
|
|
374
368
|
},
|
|
375
|
-
"required": [
|
|
376
|
-
"model"
|
|
377
|
-
],
|
|
369
|
+
"required": ["model"],
|
|
378
370
|
"type": "object"
|
|
379
371
|
},
|
|
380
372
|
"AutoSnapshot": {
|
|
@@ -655,22 +647,12 @@
|
|
|
655
647
|
"$ref": "#/definitions/DeviceVersion"
|
|
656
648
|
}
|
|
657
649
|
},
|
|
658
|
-
"required": [
|
|
659
|
-
"model"
|
|
660
|
-
],
|
|
650
|
+
"required": ["model"],
|
|
661
651
|
"type": "object"
|
|
662
652
|
},
|
|
663
653
|
"CalibrationStates": {
|
|
664
654
|
"description": "Calibration states for the sensor pod.",
|
|
665
|
-
"enum": [
|
|
666
|
-
0,
|
|
667
|
-
1,
|
|
668
|
-
2,
|
|
669
|
-
3,
|
|
670
|
-
4,
|
|
671
|
-
5,
|
|
672
|
-
6
|
|
673
|
-
],
|
|
655
|
+
"enum": [0, 1, 2, 3, 4, 5, 6],
|
|
674
656
|
"type": "number"
|
|
675
657
|
},
|
|
676
658
|
"Camera": {
|
|
@@ -685,14 +667,7 @@
|
|
|
685
667
|
"type": "string"
|
|
686
668
|
},
|
|
687
669
|
"model": {
|
|
688
|
-
"enum": [
|
|
689
|
-
240,
|
|
690
|
-
5,
|
|
691
|
-
206,
|
|
692
|
-
243,
|
|
693
|
-
241,
|
|
694
|
-
207
|
|
695
|
-
],
|
|
670
|
+
"enum": [240, 5, 206, 243, 241, 207],
|
|
696
671
|
"type": "number"
|
|
697
672
|
},
|
|
698
673
|
"osd": {
|
|
@@ -714,33 +689,22 @@
|
|
|
714
689
|
"$ref": "#/definitions/DeviceVersion"
|
|
715
690
|
}
|
|
716
691
|
},
|
|
717
|
-
"required": [
|
|
718
|
-
"model"
|
|
719
|
-
],
|
|
692
|
+
"required": ["model"],
|
|
720
693
|
"type": "object"
|
|
721
694
|
},
|
|
722
695
|
"CameraHeadOrientation": {
|
|
723
696
|
"description": "Camera head orientation config\n\nThe orientation in which the camera head is physically assembled",
|
|
724
|
-
"enum": [
|
|
725
|
-
"HORIZONTAL",
|
|
726
|
-
"VERTICAL"
|
|
727
|
-
],
|
|
697
|
+
"enum": ["HORIZONTAL", "VERTICAL"],
|
|
728
698
|
"type": "string"
|
|
729
699
|
},
|
|
730
700
|
"CameraHeadSensorType": {
|
|
731
701
|
"description": "Camera head sensor type",
|
|
732
|
-
"enum": [
|
|
733
|
-
"IMU",
|
|
734
|
-
"HALL_EFFECT"
|
|
735
|
-
],
|
|
702
|
+
"enum": ["IMU", "HALL_EFFECT"],
|
|
736
703
|
"type": "string"
|
|
737
704
|
},
|
|
738
705
|
"CameraType": {
|
|
739
706
|
"description": "Camera type enums",
|
|
740
|
-
"enum": [
|
|
741
|
-
"MAIN",
|
|
742
|
-
"AUX"
|
|
743
|
-
],
|
|
707
|
+
"enum": ["MAIN", "AUX"],
|
|
744
708
|
"type": "string"
|
|
745
709
|
},
|
|
746
710
|
"Cameras": {
|
|
@@ -808,11 +772,7 @@
|
|
|
808
772
|
},
|
|
809
773
|
"CrawlerDriveMode": {
|
|
810
774
|
"description": "Drive Modes",
|
|
811
|
-
"enum": [
|
|
812
|
-
"NORMAL",
|
|
813
|
-
"RETRIEVAL_ASSIST",
|
|
814
|
-
"RETRIEVAL_CRUISE"
|
|
815
|
-
],
|
|
775
|
+
"enum": ["NORMAL", "RETRIEVAL_ASSIST", "RETRIEVAL_CRUISE"],
|
|
816
776
|
"type": "string"
|
|
817
777
|
},
|
|
818
778
|
"CygnusType": {
|
|
@@ -899,9 +859,7 @@
|
|
|
899
859
|
"$ref": "#/definitions/DeviceVersion"
|
|
900
860
|
}
|
|
901
861
|
},
|
|
902
|
-
"required": [
|
|
903
|
-
"model"
|
|
904
|
-
],
|
|
862
|
+
"required": ["model"],
|
|
905
863
|
"type": "object"
|
|
906
864
|
},
|
|
907
865
|
"DT645Drive": {
|
|
@@ -980,9 +938,7 @@
|
|
|
980
938
|
"description": "White Balance Settings for adjusting the white balance of the camera."
|
|
981
939
|
}
|
|
982
940
|
},
|
|
983
|
-
"required": [
|
|
984
|
-
"model"
|
|
985
|
-
],
|
|
941
|
+
"required": ["model"],
|
|
986
942
|
"type": "object"
|
|
987
943
|
},
|
|
988
944
|
"DVL": {
|
|
@@ -1005,9 +961,7 @@
|
|
|
1005
961
|
"$ref": "#/definitions/DeviceVersion"
|
|
1006
962
|
}
|
|
1007
963
|
},
|
|
1008
|
-
"required": [
|
|
1009
|
-
"model"
|
|
1010
|
-
],
|
|
964
|
+
"required": ["model"],
|
|
1011
965
|
"type": "object"
|
|
1012
966
|
},
|
|
1013
967
|
"DateTime": {
|
|
@@ -1085,12 +1039,11 @@
|
|
|
1085
1039
|
204,
|
|
1086
1040
|
205,
|
|
1087
1041
|
244,
|
|
1088
|
-
245
|
|
1042
|
+
245,
|
|
1043
|
+
249,
|
|
1044
|
+
250
|
|
1089
1045
|
],
|
|
1090
|
-
"type": [
|
|
1091
|
-
"string",
|
|
1092
|
-
"number"
|
|
1093
|
-
]
|
|
1046
|
+
"type": ["string", "number"]
|
|
1094
1047
|
},
|
|
1095
1048
|
"DeviceVersion": {
|
|
1096
1049
|
"additionalProperties": false,
|
|
@@ -1211,15 +1164,7 @@
|
|
|
1211
1164
|
},
|
|
1212
1165
|
"ErrorCode": {
|
|
1213
1166
|
"description": "Error Codes",
|
|
1214
|
-
"enum": [
|
|
1215
|
-
400,
|
|
1216
|
-
401,
|
|
1217
|
-
403,
|
|
1218
|
-
405,
|
|
1219
|
-
500,
|
|
1220
|
-
503,
|
|
1221
|
-
519
|
|
1222
|
-
],
|
|
1167
|
+
"enum": [400, 401, 403, 405, 500, 503, 519],
|
|
1223
1168
|
"type": "number"
|
|
1224
1169
|
},
|
|
1225
1170
|
"ExposureSettings": {
|
|
@@ -1311,15 +1256,7 @@
|
|
|
1311
1256
|
},
|
|
1312
1257
|
"GpsFixState": {
|
|
1313
1258
|
"description": "Enumerates the possible GPS FIX states.",
|
|
1314
|
-
"enum": [
|
|
1315
|
-
0,
|
|
1316
|
-
1,
|
|
1317
|
-
2,
|
|
1318
|
-
3,
|
|
1319
|
-
4,
|
|
1320
|
-
5,
|
|
1321
|
-
6
|
|
1322
|
-
],
|
|
1259
|
+
"enum": [0, 1, 2, 3, 4, 5, 6],
|
|
1323
1260
|
"type": "number"
|
|
1324
1261
|
},
|
|
1325
1262
|
"GpsStatus": {
|
|
@@ -1405,9 +1342,7 @@
|
|
|
1405
1342
|
"type": "boolean"
|
|
1406
1343
|
}
|
|
1407
1344
|
},
|
|
1408
|
-
"required": [
|
|
1409
|
-
"enabled"
|
|
1410
|
-
],
|
|
1345
|
+
"required": ["enabled"],
|
|
1411
1346
|
"type": "object"
|
|
1412
1347
|
},
|
|
1413
1348
|
"Light": {
|
|
@@ -1421,9 +1356,7 @@
|
|
|
1421
1356
|
"type": "number"
|
|
1422
1357
|
}
|
|
1423
1358
|
},
|
|
1424
|
-
"required": [
|
|
1425
|
-
"intensity"
|
|
1426
|
-
],
|
|
1359
|
+
"required": ["intensity"],
|
|
1427
1360
|
"type": "object"
|
|
1428
1361
|
},
|
|
1429
1362
|
"LocalPosition": {
|
|
@@ -1448,11 +1381,7 @@
|
|
|
1448
1381
|
},
|
|
1449
1382
|
"LocationConsumerType": {
|
|
1450
1383
|
"description": "Enumerates the possible consumers of a location provider.",
|
|
1451
|
-
"enum": [
|
|
1452
|
-
0,
|
|
1453
|
-
1,
|
|
1454
|
-
2
|
|
1455
|
-
],
|
|
1384
|
+
"enum": [0, 1, 2],
|
|
1456
1385
|
"type": "number"
|
|
1457
1386
|
},
|
|
1458
1387
|
"LocationForwarderConfig": {
|
|
@@ -1534,9 +1463,7 @@
|
|
|
1534
1463
|
"$ref": "#/definitions/DeviceVersion"
|
|
1535
1464
|
}
|
|
1536
1465
|
},
|
|
1537
|
-
"required": [
|
|
1538
|
-
"model"
|
|
1539
|
-
],
|
|
1466
|
+
"required": ["model"],
|
|
1540
1467
|
"type": "object"
|
|
1541
1468
|
},
|
|
1542
1469
|
"MotorDiagnostics": {
|
|
@@ -1629,10 +1556,7 @@
|
|
|
1629
1556
|
},
|
|
1630
1557
|
"NetworkRole": {
|
|
1631
1558
|
"description": "Network Diagnostics Physical Location enum",
|
|
1632
|
-
"enum": [
|
|
1633
|
-
"CCO",
|
|
1634
|
-
"STA"
|
|
1635
|
-
],
|
|
1559
|
+
"enum": ["CCO", "STA"],
|
|
1636
1560
|
"type": "string"
|
|
1637
1561
|
},
|
|
1638
1562
|
"OcleaCam": {
|
|
@@ -1708,9 +1632,7 @@
|
|
|
1708
1632
|
"description": "White Balance"
|
|
1709
1633
|
}
|
|
1710
1634
|
},
|
|
1711
|
-
"required": [
|
|
1712
|
-
"model"
|
|
1713
|
-
],
|
|
1635
|
+
"required": ["model"],
|
|
1714
1636
|
"type": "object"
|
|
1715
1637
|
},
|
|
1716
1638
|
"OcleaDptz": {
|
|
@@ -1737,9 +1659,7 @@
|
|
|
1737
1659
|
"type": "object"
|
|
1738
1660
|
}
|
|
1739
1661
|
},
|
|
1740
|
-
"required": [
|
|
1741
|
-
"direction"
|
|
1742
|
-
],
|
|
1662
|
+
"required": ["direction"],
|
|
1743
1663
|
"type": "object"
|
|
1744
1664
|
},
|
|
1745
1665
|
"roi": {
|
|
@@ -1780,25 +1700,33 @@
|
|
|
1780
1700
|
},
|
|
1781
1701
|
"OcleaVersion": {
|
|
1782
1702
|
"description": "Oclea Sensor version",
|
|
1783
|
-
"enum": [
|
|
1784
|
-
"4K UHD v274",
|
|
1785
|
-
"4K UHD v415",
|
|
1786
|
-
"4K UHD v678",
|
|
1787
|
-
"Zoom v3010"
|
|
1788
|
-
],
|
|
1703
|
+
"enum": ["4K UHD v274", "4K UHD v415", "4K UHD v678", "Zoom v3010"],
|
|
1789
1704
|
"type": "string"
|
|
1790
1705
|
},
|
|
1791
1706
|
"OfflineUpdateState": {
|
|
1792
1707
|
"description": "Offline Update State",
|
|
1793
|
-
"enum": [
|
|
1794
|
-
0,
|
|
1795
|
-
1,
|
|
1796
|
-
2,
|
|
1797
|
-
3,
|
|
1798
|
-
4
|
|
1799
|
-
],
|
|
1708
|
+
"enum": [0, 1, 2, 3, 4],
|
|
1800
1709
|
"type": "number"
|
|
1801
1710
|
},
|
|
1711
|
+
"Omniscan": {
|
|
1712
|
+
"additionalProperties": false,
|
|
1713
|
+
"description": "Cerulean Omniscan 450 / 450C sonar. `model` is `DeviceModel.CeruleanOmniscan450` (0xF9) or `DeviceModel.CeruleanOmniscan450Compact` (0xFA).",
|
|
1714
|
+
"properties": {
|
|
1715
|
+
"ip": {
|
|
1716
|
+
"description": "IP address",
|
|
1717
|
+
"type": "string"
|
|
1718
|
+
},
|
|
1719
|
+
"mac": {
|
|
1720
|
+
"type": "string"
|
|
1721
|
+
},
|
|
1722
|
+
"model": {
|
|
1723
|
+
"$ref": "#/definitions/DeviceModel",
|
|
1724
|
+
"description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
|
|
1725
|
+
}
|
|
1726
|
+
},
|
|
1727
|
+
"required": ["model"],
|
|
1728
|
+
"type": "object"
|
|
1729
|
+
},
|
|
1802
1730
|
"Onyx": {
|
|
1803
1731
|
"additionalProperties": false,
|
|
1804
1732
|
"description": "Onyx Class",
|
|
@@ -1918,6 +1846,13 @@
|
|
|
1918
1846
|
"$ref": "#/definitions/NavigationOptions",
|
|
1919
1847
|
"description": "Navigation Options"
|
|
1920
1848
|
},
|
|
1849
|
+
"omniscans": {
|
|
1850
|
+
"additionalProperties": {
|
|
1851
|
+
"$ref": "#/definitions/Omniscan"
|
|
1852
|
+
},
|
|
1853
|
+
"description": "Omniscan sonars (450 and 450C) attached to the vehicle, keyed by MAC address without colons. Several may be connected at once. Device information is provided without the HW and FW versions.",
|
|
1854
|
+
"type": "object"
|
|
1855
|
+
},
|
|
1921
1856
|
"pitch": {
|
|
1922
1857
|
"maximum": 180,
|
|
1923
1858
|
"minimum": -180,
|
|
@@ -1977,9 +1912,7 @@
|
|
|
1977
1912
|
"type": "number"
|
|
1978
1913
|
}
|
|
1979
1914
|
},
|
|
1980
|
-
"required": [
|
|
1981
|
-
"model"
|
|
1982
|
-
],
|
|
1915
|
+
"required": ["model"],
|
|
1983
1916
|
"type": "object"
|
|
1984
1917
|
},
|
|
1985
1918
|
"Osd": {
|
|
@@ -2112,6 +2045,13 @@
|
|
|
2112
2045
|
"$ref": "#/definitions/NavigationOptions",
|
|
2113
2046
|
"description": "Navigation Options"
|
|
2114
2047
|
},
|
|
2048
|
+
"omniscans": {
|
|
2049
|
+
"additionalProperties": {
|
|
2050
|
+
"$ref": "#/definitions/Omniscan"
|
|
2051
|
+
},
|
|
2052
|
+
"description": "Omniscan sonars (450 and 450C) attached to the vehicle, keyed by MAC address without colons. Several may be connected at once. Device information is provided without the HW and FW versions.",
|
|
2053
|
+
"type": "object"
|
|
2054
|
+
},
|
|
2115
2055
|
"pitch": {
|
|
2116
2056
|
"maximum": 180,
|
|
2117
2057
|
"minimum": -180,
|
|
@@ -2172,17 +2112,12 @@
|
|
|
2172
2112
|
"type": "number"
|
|
2173
2113
|
}
|
|
2174
2114
|
},
|
|
2175
|
-
"required": [
|
|
2176
|
-
"model"
|
|
2177
|
-
],
|
|
2115
|
+
"required": ["model"],
|
|
2178
2116
|
"type": "object"
|
|
2179
2117
|
},
|
|
2180
2118
|
"PhysicalLocation": {
|
|
2181
2119
|
"description": "Network Diagnostics Physical Location enum",
|
|
2182
|
-
"enum": [
|
|
2183
|
-
"LOC",
|
|
2184
|
-
"REM"
|
|
2185
|
-
],
|
|
2120
|
+
"enum": ["LOC", "REM"],
|
|
2186
2121
|
"type": "string"
|
|
2187
2122
|
},
|
|
2188
2123
|
"Pivot": {
|
|
@@ -2295,6 +2230,13 @@
|
|
|
2295
2230
|
"$ref": "#/definitions/NavigationOptions",
|
|
2296
2231
|
"description": "Navigation Options"
|
|
2297
2232
|
},
|
|
2233
|
+
"omniscans": {
|
|
2234
|
+
"additionalProperties": {
|
|
2235
|
+
"$ref": "#/definitions/Omniscan"
|
|
2236
|
+
},
|
|
2237
|
+
"description": "Omniscan sonars (450 and 450C) attached to the vehicle, keyed by MAC address without colons. Several may be connected at once. Device information is provided without the HW and FW versions.",
|
|
2238
|
+
"type": "object"
|
|
2239
|
+
},
|
|
2298
2240
|
"pitch": {
|
|
2299
2241
|
"maximum": 180,
|
|
2300
2242
|
"minimum": -180,
|
|
@@ -2369,9 +2311,7 @@
|
|
|
2369
2311
|
"type": "number"
|
|
2370
2312
|
}
|
|
2371
2313
|
},
|
|
2372
|
-
"required": [
|
|
2373
|
-
"model"
|
|
2374
|
-
],
|
|
2314
|
+
"required": ["model"],
|
|
2375
2315
|
"type": "object"
|
|
2376
2316
|
},
|
|
2377
2317
|
"Position": {
|
|
@@ -2577,17 +2517,11 @@
|
|
|
2577
2517
|
"$ref": "#/definitions/DeviceVersion"
|
|
2578
2518
|
}
|
|
2579
2519
|
},
|
|
2580
|
-
"required": [
|
|
2581
|
-
"model"
|
|
2582
|
-
],
|
|
2520
|
+
"required": ["model"],
|
|
2583
2521
|
"type": "object"
|
|
2584
2522
|
},
|
|
2585
2523
|
"Rate": {
|
|
2586
|
-
"enum": [
|
|
2587
|
-
-1,
|
|
2588
|
-
0,
|
|
2589
|
-
1
|
|
2590
|
-
],
|
|
2524
|
+
"enum": [-1, 0, 1],
|
|
2591
2525
|
"type": "number"
|
|
2592
2526
|
},
|
|
2593
2527
|
"Removable<A150CameraHead>": {
|
|
@@ -2808,6 +2742,13 @@
|
|
|
2808
2742
|
"$ref": "#/definitions/NavigationOptions",
|
|
2809
2743
|
"description": "Navigation Options"
|
|
2810
2744
|
},
|
|
2745
|
+
"omniscans": {
|
|
2746
|
+
"additionalProperties": {
|
|
2747
|
+
"$ref": "#/definitions/Omniscan"
|
|
2748
|
+
},
|
|
2749
|
+
"description": "Omniscan sonars (450 and 450C) attached to the vehicle, keyed by MAC address without colons. Several may be connected at once. Device information is provided without the HW and FW versions.",
|
|
2750
|
+
"type": "object"
|
|
2751
|
+
},
|
|
2811
2752
|
"pitch": {
|
|
2812
2753
|
"maximum": 180,
|
|
2813
2754
|
"minimum": -180,
|
|
@@ -2881,9 +2822,7 @@
|
|
|
2881
2822
|
"type": "number"
|
|
2882
2823
|
}
|
|
2883
2824
|
},
|
|
2884
|
-
"required": [
|
|
2885
|
-
"model"
|
|
2886
|
-
],
|
|
2825
|
+
"required": ["model"],
|
|
2887
2826
|
"type": "object"
|
|
2888
2827
|
},
|
|
2889
2828
|
"RotaryJoint": {
|
|
@@ -2986,9 +2925,7 @@
|
|
|
2986
2925
|
"type": "object"
|
|
2987
2926
|
}
|
|
2988
2927
|
},
|
|
2989
|
-
"required": [
|
|
2990
|
-
"controls"
|
|
2991
|
-
],
|
|
2928
|
+
"required": ["controls"],
|
|
2992
2929
|
"type": "object"
|
|
2993
2930
|
},
|
|
2994
2931
|
"RovThrust": {
|
|
@@ -3008,10 +2945,7 @@
|
|
|
3008
2945
|
"type": "number"
|
|
3009
2946
|
}
|
|
3010
2947
|
},
|
|
3011
|
-
"required": [
|
|
3012
|
-
"forward",
|
|
3013
|
-
"yaw"
|
|
3014
|
-
],
|
|
2948
|
+
"required": ["forward", "yaw"],
|
|
3015
2949
|
"type": "object"
|
|
3016
2950
|
},
|
|
3017
2951
|
"SWUpdate": {
|
|
@@ -3066,34 +3000,17 @@
|
|
|
3066
3000
|
"type": "string"
|
|
3067
3001
|
}
|
|
3068
3002
|
},
|
|
3069
|
-
"required": [
|
|
3070
|
-
"name"
|
|
3071
|
-
],
|
|
3003
|
+
"required": ["name"],
|
|
3072
3004
|
"type": "object"
|
|
3073
3005
|
},
|
|
3074
3006
|
"SerialDeviceType": {
|
|
3075
3007
|
"description": "Denotes the origin of the serial device.",
|
|
3076
|
-
"enum": [
|
|
3077
|
-
"ROV",
|
|
3078
|
-
"Web",
|
|
3079
|
-
"Internal",
|
|
3080
|
-
"Controller"
|
|
3081
|
-
],
|
|
3008
|
+
"enum": ["ROV", "Web", "Internal", "Controller"],
|
|
3082
3009
|
"type": "string"
|
|
3083
3010
|
},
|
|
3084
3011
|
"SnapshotIntervals": {
|
|
3085
3012
|
"description": "Snapshot intervals (in seconds) for auto snapshot feature.",
|
|
3086
|
-
"enum": [
|
|
3087
|
-
1,
|
|
3088
|
-
2,
|
|
3089
|
-
3,
|
|
3090
|
-
4,
|
|
3091
|
-
5,
|
|
3092
|
-
10,
|
|
3093
|
-
15,
|
|
3094
|
-
30,
|
|
3095
|
-
60
|
|
3096
|
-
],
|
|
3013
|
+
"enum": [1, 2, 3, 4, 5, 10, 15, 30, 60],
|
|
3097
3014
|
"type": "number"
|
|
3098
3015
|
},
|
|
3099
3016
|
"SoftwareUpdate": {
|
|
@@ -3107,10 +3024,7 @@
|
|
|
3107
3024
|
"$ref": "#/definitions/VersionNote"
|
|
3108
3025
|
}
|
|
3109
3026
|
},
|
|
3110
|
-
"required": [
|
|
3111
|
-
"releaseDate",
|
|
3112
|
-
"versionNotes"
|
|
3113
|
-
],
|
|
3027
|
+
"required": ["releaseDate", "versionNotes"],
|
|
3114
3028
|
"type": "object"
|
|
3115
3029
|
},
|
|
3116
3030
|
"Sonar": {
|
|
@@ -3193,25 +3107,17 @@
|
|
|
3193
3107
|
"description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
|
|
3194
3108
|
}
|
|
3195
3109
|
},
|
|
3196
|
-
"required": [
|
|
3197
|
-
"model"
|
|
3198
|
-
],
|
|
3110
|
+
"required": ["model"],
|
|
3199
3111
|
"type": "object"
|
|
3200
3112
|
},
|
|
3201
3113
|
"SonarFrequency": {
|
|
3202
3114
|
"description": "Sonar frequency levels",
|
|
3203
|
-
"enum": [
|
|
3204
|
-
"HIGH",
|
|
3205
|
-
"LOW"
|
|
3206
|
-
],
|
|
3115
|
+
"enum": ["HIGH", "LOW"],
|
|
3207
3116
|
"type": "string"
|
|
3208
3117
|
},
|
|
3209
3118
|
"SonarModel": {
|
|
3210
3119
|
"description": "Sonar models",
|
|
3211
|
-
"enum": [
|
|
3212
|
-
"oculus",
|
|
3213
|
-
"tritech"
|
|
3214
|
-
],
|
|
3120
|
+
"enum": ["oculus", "tritech"],
|
|
3215
3121
|
"type": "string"
|
|
3216
3122
|
},
|
|
3217
3123
|
"Sonde": {
|
|
@@ -3222,17 +3128,12 @@
|
|
|
3222
3128
|
"type": "boolean"
|
|
3223
3129
|
}
|
|
3224
3130
|
},
|
|
3225
|
-
"required": [
|
|
3226
|
-
"enabled"
|
|
3227
|
-
],
|
|
3131
|
+
"required": ["enabled"],
|
|
3228
3132
|
"type": "object"
|
|
3229
3133
|
},
|
|
3230
3134
|
"SpragBearing": {
|
|
3231
3135
|
"description": "Sprag Bearing Types",
|
|
3232
|
-
"enum": [
|
|
3233
|
-
"FKNN6204-2RS",
|
|
3234
|
-
"FKNN6205-2RS"
|
|
3235
|
-
],
|
|
3136
|
+
"enum": ["FKNN6204-2RS", "FKNN6205-2RS"],
|
|
3236
3137
|
"type": "string"
|
|
3237
3138
|
},
|
|
3238
3139
|
"Stream": {
|
|
@@ -3259,9 +3160,7 @@
|
|
|
3259
3160
|
"description": "Stream resolution"
|
|
3260
3161
|
}
|
|
3261
3162
|
},
|
|
3262
|
-
"required": [
|
|
3263
|
-
"active"
|
|
3264
|
-
],
|
|
3163
|
+
"required": ["active"],
|
|
3265
3164
|
"type": "object"
|
|
3266
3165
|
},
|
|
3267
3166
|
"StreamMode": {
|
|
@@ -3290,10 +3189,7 @@
|
|
|
3290
3189
|
},
|
|
3291
3190
|
"StreamModes": {
|
|
3292
3191
|
"description": "Streaming Mode for the camera",
|
|
3293
|
-
"enum": [
|
|
3294
|
-
"RTSP",
|
|
3295
|
-
"WEBRTC"
|
|
3296
|
-
],
|
|
3192
|
+
"enum": ["RTSP", "WEBRTC"],
|
|
3297
3193
|
"type": "string"
|
|
3298
3194
|
},
|
|
3299
3195
|
"SystemDiagnostics": {
|
|
@@ -3317,10 +3213,7 @@
|
|
|
3317
3213
|
},
|
|
3318
3214
|
"SystemOfMeasurement": {
|
|
3319
3215
|
"description": "System unit of measurement enum",
|
|
3320
|
-
"enum": [
|
|
3321
|
-
"IMPERIAL",
|
|
3322
|
-
"METRIC"
|
|
3323
|
-
],
|
|
3216
|
+
"enum": ["IMPERIAL", "METRIC"],
|
|
3324
3217
|
"type": "string"
|
|
3325
3218
|
},
|
|
3326
3219
|
"SystemSettings": {
|
|
@@ -3361,14 +3254,7 @@
|
|
|
3361
3254
|
},
|
|
3362
3255
|
"nearLimit": {
|
|
3363
3256
|
"description": "Focus near limit",
|
|
3364
|
-
"enum": [
|
|
3365
|
-
10,
|
|
3366
|
-
34,
|
|
3367
|
-
90,
|
|
3368
|
-
250,
|
|
3369
|
-
800,
|
|
3370
|
-
2300
|
|
3371
|
-
],
|
|
3257
|
+
"enum": [10, 34, 90, 250, 800, 2300],
|
|
3372
3258
|
"type": "number"
|
|
3373
3259
|
},
|
|
3374
3260
|
"rate": {
|
|
@@ -3444,9 +3330,7 @@
|
|
|
3444
3330
|
"$ref": "#/definitions/ZoomControl"
|
|
3445
3331
|
}
|
|
3446
3332
|
},
|
|
3447
|
-
"required": [
|
|
3448
|
-
"model"
|
|
3449
|
-
],
|
|
3333
|
+
"required": ["model"],
|
|
3450
3334
|
"type": "object"
|
|
3451
3335
|
},
|
|
3452
3336
|
"TamronOcleaZoomCamera": {
|
|
@@ -3506,9 +3390,7 @@
|
|
|
3506
3390
|
"$ref": "#/definitions/DeviceVersion"
|
|
3507
3391
|
}
|
|
3508
3392
|
},
|
|
3509
|
-
"required": [
|
|
3510
|
-
"model"
|
|
3511
|
-
],
|
|
3393
|
+
"required": ["model"],
|
|
3512
3394
|
"type": "object"
|
|
3513
3395
|
},
|
|
3514
3396
|
"TiltCameraHead": {
|
|
@@ -3554,17 +3436,12 @@
|
|
|
3554
3436
|
"$ref": "#/definitions/DeviceVersion"
|
|
3555
3437
|
}
|
|
3556
3438
|
},
|
|
3557
|
-
"required": [
|
|
3558
|
-
"model"
|
|
3559
|
-
],
|
|
3439
|
+
"required": ["model"],
|
|
3560
3440
|
"type": "object"
|
|
3561
3441
|
},
|
|
3562
3442
|
"TiltCameraHeadModel": {
|
|
3563
3443
|
"description": "Tilt Camera Head Model",
|
|
3564
|
-
"enum": [
|
|
3565
|
-
102,
|
|
3566
|
-
103
|
|
3567
|
-
],
|
|
3444
|
+
"enum": [102, 103],
|
|
3568
3445
|
"type": "number"
|
|
3569
3446
|
},
|
|
3570
3447
|
"TiltPlatform": {
|
|
@@ -3599,11 +3476,7 @@
|
|
|
3599
3476
|
},
|
|
3600
3477
|
"TopPositionSources": {
|
|
3601
3478
|
"description": "Enumerates the possible topside location provider sources available to the Web App.",
|
|
3602
|
-
"enum": [
|
|
3603
|
-
"NONE",
|
|
3604
|
-
"EXTERNAL_GPS",
|
|
3605
|
-
"STATIC"
|
|
3606
|
-
],
|
|
3479
|
+
"enum": ["NONE", "EXTERNAL_GPS", "STATIC"],
|
|
3607
3480
|
"type": "string"
|
|
3608
3481
|
},
|
|
3609
3482
|
"TopsidePosition": {
|
|
@@ -3638,21 +3511,12 @@
|
|
|
3638
3511
|
"type": "string"
|
|
3639
3512
|
}
|
|
3640
3513
|
},
|
|
3641
|
-
"required": [
|
|
3642
|
-
"code",
|
|
3643
|
-
"message"
|
|
3644
|
-
],
|
|
3514
|
+
"required": ["code", "message"],
|
|
3645
3515
|
"type": "object"
|
|
3646
3516
|
},
|
|
3647
3517
|
"TransferMethodType": {
|
|
3648
3518
|
"description": "The different kinds of payload requests that can be sent and received.",
|
|
3649
|
-
"enum": [
|
|
3650
|
-
"GET",
|
|
3651
|
-
"SET",
|
|
3652
|
-
"UPDATE",
|
|
3653
|
-
"DELETE",
|
|
3654
|
-
"ERROR"
|
|
3655
|
-
],
|
|
3519
|
+
"enum": ["GET", "SET", "UPDATE", "DELETE", "ERROR"],
|
|
3656
3520
|
"type": "string"
|
|
3657
3521
|
},
|
|
3658
3522
|
"TransferPayload<BridgeBox>": {
|
|
@@ -3673,11 +3537,7 @@
|
|
|
3673
3537
|
"$ref": "#/definitions/BridgeBox"
|
|
3674
3538
|
}
|
|
3675
3539
|
},
|
|
3676
|
-
"required": [
|
|
3677
|
-
"apiVersion",
|
|
3678
|
-
"method",
|
|
3679
|
-
"payload"
|
|
3680
|
-
],
|
|
3540
|
+
"required": ["apiVersion", "method", "payload"],
|
|
3681
3541
|
"type": "object"
|
|
3682
3542
|
},
|
|
3683
3543
|
"TurbidityFilter": {
|
|
@@ -3714,12 +3574,7 @@
|
|
|
3714
3574
|
"type": "string"
|
|
3715
3575
|
}
|
|
3716
3576
|
},
|
|
3717
|
-
"required": [
|
|
3718
|
-
"buildDate",
|
|
3719
|
-
"size",
|
|
3720
|
-
"sha256",
|
|
3721
|
-
"changelog"
|
|
3722
|
-
],
|
|
3577
|
+
"required": ["buildDate", "size", "sha256", "changelog"],
|
|
3723
3578
|
"type": "object"
|
|
3724
3579
|
},
|
|
3725
3580
|
"UsageTime": {
|
|
@@ -3803,10 +3658,7 @@
|
|
|
3803
3658
|
"type": "array"
|
|
3804
3659
|
}
|
|
3805
3660
|
},
|
|
3806
|
-
"required": [
|
|
3807
|
-
"improvements",
|
|
3808
|
-
"fixes"
|
|
3809
|
-
],
|
|
3661
|
+
"required": ["improvements", "fixes"],
|
|
3810
3662
|
"type": "object"
|
|
3811
3663
|
},
|
|
3812
3664
|
"WhiteBalanceSettings": {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.
|
|
1
|
+
export declare const API_VERSION = "1.0.54-omniscan.0";
|
|
@@ -49,7 +49,9 @@ export declare enum DeviceModel {
|
|
|
49
49
|
OculusSonar = 204,
|
|
50
50
|
GeminiSonar = 205,
|
|
51
51
|
Echosounder = 244,
|
|
52
|
-
WATERLINKED_3D_SONAR = 245
|
|
52
|
+
WATERLINKED_3D_SONAR = 245,
|
|
53
|
+
CeruleanOmniscan450 = 249,
|
|
54
|
+
CeruleanOmniscan450Compact = 250
|
|
53
55
|
}
|
|
54
56
|
/**
|
|
55
57
|
* Deep Trekker's Bandwidth Degradation Thresholds
|
|
@@ -124,6 +126,8 @@ export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
|
|
|
124
126
|
readonly 205: "Gemini Sonar";
|
|
125
127
|
readonly 244: "Echosounder";
|
|
126
128
|
readonly 245: "Water Linked 3D Sonar";
|
|
129
|
+
readonly 249: "Omniscan 450";
|
|
130
|
+
readonly 250: "Omniscan 450C";
|
|
127
131
|
readonly 104: "DT840 Hoser";
|
|
128
132
|
readonly 105: "DT840 Manipulator Arm";
|
|
129
133
|
readonly 113: "Power Distribution Module";
|
|
@@ -179,6 +183,8 @@ export declare const DEVICE_MODEL_LABELS: {
|
|
|
179
183
|
readonly 205: "Gemini Sonar";
|
|
180
184
|
readonly 244: "Echosounder";
|
|
181
185
|
readonly 245: "Water Linked 3D Sonar";
|
|
186
|
+
readonly 249: "Omniscan 450";
|
|
187
|
+
readonly 250: "Omniscan 450C";
|
|
182
188
|
readonly 104: "DT840 Hoser";
|
|
183
189
|
readonly 105: "DT840 Manipulator Arm";
|
|
184
190
|
readonly 113: "Power Distribution Module";
|
|
@@ -250,7 +256,7 @@ export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, D
|
|
|
250
256
|
* @group Devices
|
|
251
257
|
* @category Peripherals
|
|
252
258
|
*/
|
|
253
|
-
export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
|
|
259
|
+
export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.CeruleanOmniscan450, DeviceModel.CeruleanOmniscan450Compact, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
|
|
254
260
|
/**
|
|
255
261
|
* Device Version is a base interface for hardware and software version sample payloads.
|
|
256
262
|
* -1 hardware versions and 0.0 software versions refer to not applicable
|
|
@@ -97,6 +97,8 @@ var DeviceModel;
|
|
|
97
97
|
DeviceModel[DeviceModel["GeminiSonar"] = 205] = "GeminiSonar";
|
|
98
98
|
DeviceModel[DeviceModel["Echosounder"] = 244] = "Echosounder";
|
|
99
99
|
DeviceModel[DeviceModel["WATERLINKED_3D_SONAR"] = 245] = "WATERLINKED_3D_SONAR";
|
|
100
|
+
DeviceModel[DeviceModel["CeruleanOmniscan450"] = 249] = "CeruleanOmniscan450";
|
|
101
|
+
DeviceModel[DeviceModel["CeruleanOmniscan450Compact"] = 250] = "CeruleanOmniscan450Compact";
|
|
100
102
|
})(DeviceModel || (exports.DeviceModel = DeviceModel = {}));
|
|
101
103
|
/**
|
|
102
104
|
* Deep Trekker's Bandwidth Degradation Thresholds
|
|
@@ -174,6 +176,8 @@ exports.PERIPHERAL_DEVICE_MODEL_LABELS = (_c = {},
|
|
|
174
176
|
_c[DeviceModel.GeminiSonar] = "Gemini Sonar",
|
|
175
177
|
_c[DeviceModel.Echosounder] = "Echosounder",
|
|
176
178
|
_c[DeviceModel.WATERLINKED_3D_SONAR] = "Water Linked 3D Sonar",
|
|
179
|
+
_c[DeviceModel.CeruleanOmniscan450] = "Omniscan 450",
|
|
180
|
+
_c[DeviceModel.CeruleanOmniscan450Compact] = "Omniscan 450C",
|
|
177
181
|
/* Legacy / Special Components */
|
|
178
182
|
_c[DeviceModel.DT840Hoser] = "DT840 Hoser",
|
|
179
183
|
_c[DeviceModel.DT840Arm] = "DT840 Manipulator Arm",
|
|
@@ -301,7 +305,9 @@ exports.PERIPHERAL_DEVICE_MODELS = __spreadArray(__spreadArray([
|
|
|
301
305
|
DeviceModel.OculusSonar,
|
|
302
306
|
DeviceModel.GeminiSonar,
|
|
303
307
|
DeviceModel.Echosounder,
|
|
304
|
-
DeviceModel.WATERLINKED_3D_SONAR
|
|
308
|
+
DeviceModel.WATERLINKED_3D_SONAR,
|
|
309
|
+
DeviceModel.CeruleanOmniscan450,
|
|
310
|
+
DeviceModel.CeruleanOmniscan450Compact
|
|
305
311
|
], exports.SENSOR_POD_DEVICE_MODELS, true), exports.X4_PERIPHERAL_DEVICE_MODELS, true);
|
|
306
312
|
__exportStar(require("./cameraHeads"), exports);
|
|
307
313
|
__exportStar(require("./cameras"), exports);
|
|
@@ -98,3 +98,13 @@ export type Sonar3D = {
|
|
|
98
98
|
*/
|
|
99
99
|
acoustics?: boolean;
|
|
100
100
|
} & Omit<Device, "version">;
|
|
101
|
+
/**
|
|
102
|
+
* Cerulean Omniscan 450 / 450C sonar.
|
|
103
|
+
* `model` is `DeviceModel.CeruleanOmniscan450` (0xF9) or
|
|
104
|
+
* `DeviceModel.CeruleanOmniscan450Compact` (0xFA).
|
|
105
|
+
* @group Devices
|
|
106
|
+
* @category Peripherals
|
|
107
|
+
*/
|
|
108
|
+
export type Omniscan = {
|
|
109
|
+
mac?: string;
|
|
110
|
+
} & Omit<Device, "version">;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CalibratableSensorPod, DeviceVersion, Echosounder, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
|
|
1
|
+
import { CalibratableSensorPod, DeviceVersion, Echosounder, Omniscan, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
|
|
2
2
|
import { RovDrive } from "../rovDrive";
|
|
3
3
|
import { Navigation } from "../navigation";
|
|
4
4
|
import { RovInputDiagnostics } from "../../diagnostics";
|
|
@@ -275,4 +275,11 @@ export type RovVehicle = {
|
|
|
275
275
|
* @see {@link Sonar3D | Sonar3D}
|
|
276
276
|
*/
|
|
277
277
|
sonar3d?: Sonar3D;
|
|
278
|
+
/**
|
|
279
|
+
* Omniscan sonars (450 and 450C) attached to the vehicle, keyed by MAC address
|
|
280
|
+
* without colons. Several may be connected at once. Device information is
|
|
281
|
+
* provided without the HW and FW versions.
|
|
282
|
+
* @see {@link Omniscan | Omniscan}
|
|
283
|
+
*/
|
|
284
|
+
omniscans?: Record<string, Omniscan>;
|
|
278
285
|
} & Vehicle & Navigation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deeptrekker/api-domain",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.54-omniscan.0",
|
|
4
4
|
"description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"engines": {
|
|
@@ -37,16 +37,16 @@
|
|
|
37
37
|
"@knodes/typedoc-plugin-code-blocks": "^0.22.7",
|
|
38
38
|
"@types/lodash": "^4.14.182",
|
|
39
39
|
"@types/node": "^22.0.0",
|
|
40
|
-
"@typescript-eslint/eslint-plugin": "^6.1.0",
|
|
41
|
-
"@typescript-eslint/parser": "^6.1.0",
|
|
42
40
|
"@zamiell/typedoc-plugin-not-exported": "^0.2.0",
|
|
43
|
-
"eslint": "^8.45.0",
|
|
44
|
-
"eslint-config-prettier": "^8.8.0",
|
|
45
|
-
"eslint-plugin-unused-imports": "^3.0.0",
|
|
46
41
|
"prettier": "3.0.3",
|
|
47
42
|
"rimraf": "^3.0.2",
|
|
48
43
|
"semver-compare-cli": "^2.0.0",
|
|
49
44
|
"ts-json-schema-generator": "2.4.0",
|
|
45
|
+
"eslint": "^8.45.0",
|
|
46
|
+
"@typescript-eslint/eslint-plugin": "^6.1.0",
|
|
47
|
+
"@typescript-eslint/parser": "^6.1.0",
|
|
48
|
+
"eslint-plugin-unused-imports": "^3.0.0",
|
|
49
|
+
"eslint-config-prettier": "^8.8.0",
|
|
50
50
|
"ts-node": "^10.8.1",
|
|
51
51
|
"tslib": "^2.4.0",
|
|
52
52
|
"typedoc": "^0.28.9",
|
|
@@ -62,7 +62,6 @@
|
|
|
62
62
|
"mkdirp": "^1.0.4",
|
|
63
63
|
"ts-pattern": "^4.3.0",
|
|
64
64
|
"ts-toolbelt": "^9.6.0",
|
|
65
|
-
"type-zoo": "^3.4.1"
|
|
66
|
-
"yarn": "^1.22.22"
|
|
65
|
+
"type-zoo": "^3.4.1"
|
|
67
66
|
}
|
|
68
67
|
}
|