@deeptrekker/api-domain 1.0.46-omniscan.0 → 1.0.47

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.
@@ -113,7 +113,9 @@
113
113
  "$ref": "#/definitions/DeviceVersion"
114
114
  }
115
115
  },
116
- "required": ["model"],
116
+ "required": [
117
+ "model"
118
+ ],
117
119
  "type": "object"
118
120
  },
119
121
  "A150CameraHead": {
@@ -178,7 +180,9 @@
178
180
  "$ref": "#/definitions/DeviceVersion"
179
181
  }
180
182
  },
181
- "required": ["model"],
183
+ "required": [
184
+ "model"
185
+ ],
182
186
  "type": "object"
183
187
  },
184
188
  "A200": {
@@ -293,7 +297,9 @@
293
297
  "$ref": "#/definitions/DeviceVersion"
294
298
  }
295
299
  },
296
- "required": ["model"],
300
+ "required": [
301
+ "model"
302
+ ],
297
303
  "type": "object"
298
304
  },
299
305
  "A200CameraHead": {
@@ -366,7 +372,9 @@
366
372
  "$ref": "#/definitions/DeviceVersion"
367
373
  }
368
374
  },
369
- "required": ["model"],
375
+ "required": [
376
+ "model"
377
+ ],
370
378
  "type": "object"
371
379
  },
372
380
  "AutoSnapshot": {
@@ -634,16 +642,35 @@
634
642
  "$ref": "#/definitions/DeviceModel",
635
643
  "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
636
644
  },
645
+ "pressure": {
646
+ "additionalProperties": false,
647
+ "properties": {
648
+ "calibrate": {
649
+ "type": "boolean"
650
+ }
651
+ },
652
+ "type": "object"
653
+ },
637
654
  "version": {
638
655
  "$ref": "#/definitions/DeviceVersion"
639
656
  }
640
657
  },
641
- "required": ["model"],
658
+ "required": [
659
+ "model"
660
+ ],
642
661
  "type": "object"
643
662
  },
644
663
  "CalibrationStates": {
645
664
  "description": "Calibration states for the sensor pod.",
646
- "enum": [0, 1, 2, 3, 4, 5, 6],
665
+ "enum": [
666
+ 0,
667
+ 1,
668
+ 2,
669
+ 3,
670
+ 4,
671
+ 5,
672
+ 6
673
+ ],
647
674
  "type": "number"
648
675
  },
649
676
  "Camera": {
@@ -658,7 +685,14 @@
658
685
  "type": "string"
659
686
  },
660
687
  "model": {
661
- "enum": [240, 5, 206, 243, 241, 207],
688
+ "enum": [
689
+ 240,
690
+ 5,
691
+ 206,
692
+ 243,
693
+ 241,
694
+ 207
695
+ ],
662
696
  "type": "number"
663
697
  },
664
698
  "osd": {
@@ -680,22 +714,33 @@
680
714
  "$ref": "#/definitions/DeviceVersion"
681
715
  }
682
716
  },
683
- "required": ["model"],
717
+ "required": [
718
+ "model"
719
+ ],
684
720
  "type": "object"
685
721
  },
686
722
  "CameraHeadOrientation": {
687
723
  "description": "Camera head orientation config\n\nThe orientation in which the camera head is physically assembled",
688
- "enum": ["HORIZONTAL", "VERTICAL"],
724
+ "enum": [
725
+ "HORIZONTAL",
726
+ "VERTICAL"
727
+ ],
689
728
  "type": "string"
690
729
  },
691
730
  "CameraHeadSensorType": {
692
731
  "description": "Camera head sensor type",
693
- "enum": ["IMU", "HALL_EFFECT"],
732
+ "enum": [
733
+ "IMU",
734
+ "HALL_EFFECT"
735
+ ],
694
736
  "type": "string"
695
737
  },
696
738
  "CameraType": {
697
739
  "description": "Camera type enums",
698
- "enum": ["MAIN", "AUX"],
740
+ "enum": [
741
+ "MAIN",
742
+ "AUX"
743
+ ],
699
744
  "type": "string"
700
745
  },
701
746
  "Cameras": {
@@ -763,7 +808,11 @@
763
808
  },
764
809
  "CrawlerDriveMode": {
765
810
  "description": "Drive Modes",
766
- "enum": ["NORMAL", "RETRIEVAL_ASSIST", "RETRIEVAL_CRUISE"],
811
+ "enum": [
812
+ "NORMAL",
813
+ "RETRIEVAL_ASSIST",
814
+ "RETRIEVAL_CRUISE"
815
+ ],
767
816
  "type": "string"
768
817
  },
769
818
  "CygnusType": {
@@ -850,7 +899,9 @@
850
899
  "$ref": "#/definitions/DeviceVersion"
851
900
  }
852
901
  },
853
- "required": ["model"],
902
+ "required": [
903
+ "model"
904
+ ],
854
905
  "type": "object"
855
906
  },
856
907
  "DT645Drive": {
@@ -929,7 +980,9 @@
929
980
  "description": "White Balance Settings for adjusting the white balance of the camera."
930
981
  }
931
982
  },
932
- "required": ["model"],
983
+ "required": [
984
+ "model"
985
+ ],
933
986
  "type": "object"
934
987
  },
935
988
  "DVL": {
@@ -952,7 +1005,9 @@
952
1005
  "$ref": "#/definitions/DeviceVersion"
953
1006
  }
954
1007
  },
955
- "required": ["model"],
1008
+ "required": [
1009
+ "model"
1010
+ ],
956
1011
  "type": "object"
957
1012
  },
958
1013
  "DateTime": {
@@ -1030,10 +1085,12 @@
1030
1085
  204,
1031
1086
  205,
1032
1087
  244,
1033
- 245,
1034
- 247
1088
+ 245
1035
1089
  ],
1036
- "type": ["string", "number"]
1090
+ "type": [
1091
+ "string",
1092
+ "number"
1093
+ ]
1037
1094
  },
1038
1095
  "DeviceVersion": {
1039
1096
  "additionalProperties": false,
@@ -1154,7 +1211,15 @@
1154
1211
  },
1155
1212
  "ErrorCode": {
1156
1213
  "description": "Error Codes",
1157
- "enum": [400, 401, 403, 405, 500, 503, 519],
1214
+ "enum": [
1215
+ 400,
1216
+ 401,
1217
+ 403,
1218
+ 405,
1219
+ 500,
1220
+ 503,
1221
+ 519
1222
+ ],
1158
1223
  "type": "number"
1159
1224
  },
1160
1225
  "ExposureSettings": {
@@ -1246,7 +1311,15 @@
1246
1311
  },
1247
1312
  "GpsFixState": {
1248
1313
  "description": "Enumerates the possible GPS FIX states.",
1249
- "enum": [0, 1, 2, 3, 4, 5, 6],
1314
+ "enum": [
1315
+ 0,
1316
+ 1,
1317
+ 2,
1318
+ 3,
1319
+ 4,
1320
+ 5,
1321
+ 6
1322
+ ],
1250
1323
  "type": "number"
1251
1324
  },
1252
1325
  "GpsStatus": {
@@ -1332,7 +1405,9 @@
1332
1405
  "type": "boolean"
1333
1406
  }
1334
1407
  },
1335
- "required": ["enabled"],
1408
+ "required": [
1409
+ "enabled"
1410
+ ],
1336
1411
  "type": "object"
1337
1412
  },
1338
1413
  "Light": {
@@ -1346,7 +1421,9 @@
1346
1421
  "type": "number"
1347
1422
  }
1348
1423
  },
1349
- "required": ["intensity"],
1424
+ "required": [
1425
+ "intensity"
1426
+ ],
1350
1427
  "type": "object"
1351
1428
  },
1352
1429
  "LocalPosition": {
@@ -1371,7 +1448,11 @@
1371
1448
  },
1372
1449
  "LocationConsumerType": {
1373
1450
  "description": "Enumerates the possible consumers of a location provider.",
1374
- "enum": [0, 1, 2],
1451
+ "enum": [
1452
+ 0,
1453
+ 1,
1454
+ 2
1455
+ ],
1375
1456
  "type": "number"
1376
1457
  },
1377
1458
  "LocationForwarderConfig": {
@@ -1453,7 +1534,9 @@
1453
1534
  "$ref": "#/definitions/DeviceVersion"
1454
1535
  }
1455
1536
  },
1456
- "required": ["model"],
1537
+ "required": [
1538
+ "model"
1539
+ ],
1457
1540
  "type": "object"
1458
1541
  },
1459
1542
  "MotorDiagnostics": {
@@ -1546,7 +1629,10 @@
1546
1629
  },
1547
1630
  "NetworkRole": {
1548
1631
  "description": "Network Diagnostics Physical Location enum",
1549
- "enum": ["CCO", "STA"],
1632
+ "enum": [
1633
+ "CCO",
1634
+ "STA"
1635
+ ],
1550
1636
  "type": "string"
1551
1637
  },
1552
1638
  "OcleaCam": {
@@ -1622,7 +1708,9 @@
1622
1708
  "description": "White Balance"
1623
1709
  }
1624
1710
  },
1625
- "required": ["model"],
1711
+ "required": [
1712
+ "model"
1713
+ ],
1626
1714
  "type": "object"
1627
1715
  },
1628
1716
  "OcleaDptz": {
@@ -1649,7 +1737,9 @@
1649
1737
  "type": "object"
1650
1738
  }
1651
1739
  },
1652
- "required": ["direction"],
1740
+ "required": [
1741
+ "direction"
1742
+ ],
1653
1743
  "type": "object"
1654
1744
  },
1655
1745
  "roi": {
@@ -1690,33 +1780,25 @@
1690
1780
  },
1691
1781
  "OcleaVersion": {
1692
1782
  "description": "Oclea Sensor version",
1693
- "enum": ["4K UHD v274", "4K UHD v415", "4K UHD v678", "Zoom v3010"],
1783
+ "enum": [
1784
+ "4K UHD v274",
1785
+ "4K UHD v415",
1786
+ "4K UHD v678",
1787
+ "Zoom v3010"
1788
+ ],
1694
1789
  "type": "string"
1695
1790
  },
1696
1791
  "OfflineUpdateState": {
1697
1792
  "description": "Offline Update State",
1698
- "enum": [0, 1, 2, 3, 4],
1793
+ "enum": [
1794
+ 0,
1795
+ 1,
1796
+ 2,
1797
+ 3,
1798
+ 4
1799
+ ],
1699
1800
  "type": "number"
1700
1801
  },
1701
- "Omniscan": {
1702
- "additionalProperties": false,
1703
- "description": "Cerulean Omniscan 450 sonar",
1704
- "properties": {
1705
- "ip": {
1706
- "description": "IP address",
1707
- "type": "string"
1708
- },
1709
- "mac": {
1710
- "type": "string"
1711
- },
1712
- "model": {
1713
- "$ref": "#/definitions/DeviceModel",
1714
- "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
1715
- }
1716
- },
1717
- "required": ["model"],
1718
- "type": "object"
1719
- },
1720
1802
  "Onyx": {
1721
1803
  "additionalProperties": false,
1722
1804
  "description": "Onyx Class",
@@ -1836,10 +1918,6 @@
1836
1918
  "$ref": "#/definitions/NavigationOptions",
1837
1919
  "description": "Navigation Options"
1838
1920
  },
1839
- "omniscan": {
1840
- "$ref": "#/definitions/Omniscan",
1841
- "description": "Omniscan 450 sonar device information without the HW and FW versions"
1842
- },
1843
1921
  "pitch": {
1844
1922
  "maximum": 180,
1845
1923
  "minimum": -180,
@@ -1899,7 +1977,9 @@
1899
1977
  "type": "number"
1900
1978
  }
1901
1979
  },
1902
- "required": ["model"],
1980
+ "required": [
1981
+ "model"
1982
+ ],
1903
1983
  "type": "object"
1904
1984
  },
1905
1985
  "Osd": {
@@ -2032,10 +2112,6 @@
2032
2112
  "$ref": "#/definitions/NavigationOptions",
2033
2113
  "description": "Navigation Options"
2034
2114
  },
2035
- "omniscan": {
2036
- "$ref": "#/definitions/Omniscan",
2037
- "description": "Omniscan 450 sonar device information without the HW and FW versions"
2038
- },
2039
2115
  "pitch": {
2040
2116
  "maximum": 180,
2041
2117
  "minimum": -180,
@@ -2096,12 +2172,17 @@
2096
2172
  "type": "number"
2097
2173
  }
2098
2174
  },
2099
- "required": ["model"],
2175
+ "required": [
2176
+ "model"
2177
+ ],
2100
2178
  "type": "object"
2101
2179
  },
2102
2180
  "PhysicalLocation": {
2103
2181
  "description": "Network Diagnostics Physical Location enum",
2104
- "enum": ["LOC", "REM"],
2182
+ "enum": [
2183
+ "LOC",
2184
+ "REM"
2185
+ ],
2105
2186
  "type": "string"
2106
2187
  },
2107
2188
  "Pivot": {
@@ -2214,10 +2295,6 @@
2214
2295
  "$ref": "#/definitions/NavigationOptions",
2215
2296
  "description": "Navigation Options"
2216
2297
  },
2217
- "omniscan": {
2218
- "$ref": "#/definitions/Omniscan",
2219
- "description": "Omniscan 450 sonar device information without the HW and FW versions"
2220
- },
2221
2298
  "pitch": {
2222
2299
  "maximum": 180,
2223
2300
  "minimum": -180,
@@ -2292,7 +2369,9 @@
2292
2369
  "type": "number"
2293
2370
  }
2294
2371
  },
2295
- "required": ["model"],
2372
+ "required": [
2373
+ "model"
2374
+ ],
2296
2375
  "type": "object"
2297
2376
  },
2298
2377
  "Position": {
@@ -2498,11 +2577,17 @@
2498
2577
  "$ref": "#/definitions/DeviceVersion"
2499
2578
  }
2500
2579
  },
2501
- "required": ["model"],
2580
+ "required": [
2581
+ "model"
2582
+ ],
2502
2583
  "type": "object"
2503
2584
  },
2504
2585
  "Rate": {
2505
- "enum": [-1, 0, 1],
2586
+ "enum": [
2587
+ -1,
2588
+ 0,
2589
+ 1
2590
+ ],
2506
2591
  "type": "number"
2507
2592
  },
2508
2593
  "Removable<A150CameraHead>": {
@@ -2723,10 +2808,6 @@
2723
2808
  "$ref": "#/definitions/NavigationOptions",
2724
2809
  "description": "Navigation Options"
2725
2810
  },
2726
- "omniscan": {
2727
- "$ref": "#/definitions/Omniscan",
2728
- "description": "Omniscan 450 sonar device information without the HW and FW versions"
2729
- },
2730
2811
  "pitch": {
2731
2812
  "maximum": 180,
2732
2813
  "minimum": -180,
@@ -2800,7 +2881,9 @@
2800
2881
  "type": "number"
2801
2882
  }
2802
2883
  },
2803
- "required": ["model"],
2884
+ "required": [
2885
+ "model"
2886
+ ],
2804
2887
  "type": "object"
2805
2888
  },
2806
2889
  "RotaryJoint": {
@@ -2903,7 +2986,9 @@
2903
2986
  "type": "object"
2904
2987
  }
2905
2988
  },
2906
- "required": ["controls"],
2989
+ "required": [
2990
+ "controls"
2991
+ ],
2907
2992
  "type": "object"
2908
2993
  },
2909
2994
  "RovThrust": {
@@ -2923,7 +3008,10 @@
2923
3008
  "type": "number"
2924
3009
  }
2925
3010
  },
2926
- "required": ["forward", "yaw"],
3011
+ "required": [
3012
+ "forward",
3013
+ "yaw"
3014
+ ],
2927
3015
  "type": "object"
2928
3016
  },
2929
3017
  "SWUpdate": {
@@ -2978,17 +3066,34 @@
2978
3066
  "type": "string"
2979
3067
  }
2980
3068
  },
2981
- "required": ["name"],
3069
+ "required": [
3070
+ "name"
3071
+ ],
2982
3072
  "type": "object"
2983
3073
  },
2984
3074
  "SerialDeviceType": {
2985
3075
  "description": "Denotes the origin of the serial device.",
2986
- "enum": ["ROV", "Web", "Internal", "Controller"],
3076
+ "enum": [
3077
+ "ROV",
3078
+ "Web",
3079
+ "Internal",
3080
+ "Controller"
3081
+ ],
2987
3082
  "type": "string"
2988
3083
  },
2989
3084
  "SnapshotIntervals": {
2990
3085
  "description": "Snapshot intervals (in seconds) for auto snapshot feature.",
2991
- "enum": [1, 2, 3, 4, 5, 10, 15, 30, 60],
3086
+ "enum": [
3087
+ 1,
3088
+ 2,
3089
+ 3,
3090
+ 4,
3091
+ 5,
3092
+ 10,
3093
+ 15,
3094
+ 30,
3095
+ 60
3096
+ ],
2992
3097
  "type": "number"
2993
3098
  },
2994
3099
  "SoftwareUpdate": {
@@ -3002,7 +3107,10 @@
3002
3107
  "$ref": "#/definitions/VersionNote"
3003
3108
  }
3004
3109
  },
3005
- "required": ["releaseDate", "versionNotes"],
3110
+ "required": [
3111
+ "releaseDate",
3112
+ "versionNotes"
3113
+ ],
3006
3114
  "type": "object"
3007
3115
  },
3008
3116
  "Sonar": {
@@ -3019,7 +3127,7 @@
3019
3127
  "type": "boolean"
3020
3128
  },
3021
3129
  "errorCode": {
3022
- "description": "Oculus sonar throws errors if something goes wrong within it. This property will only appear if there is an active error and will show the error code.",
3130
+ "description": "Oculus sonar throws errors if something goes wrong within it. This property will only appear if there is an active error and will show the error code.",
3023
3131
  "type": "number"
3024
3132
  },
3025
3133
  "frequency": {
@@ -3069,10 +3177,6 @@
3069
3177
  "additionalProperties": false,
3070
3178
  "description": "Sonar 3D",
3071
3179
  "properties": {
3072
- "acoustics": {
3073
- "description": "Enables/disables acoustics",
3074
- "type": "boolean"
3075
- },
3076
3180
  "ip": {
3077
3181
  "description": "IP address",
3078
3182
  "type": "string"
@@ -3085,17 +3189,25 @@
3085
3189
  "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
3086
3190
  }
3087
3191
  },
3088
- "required": ["model"],
3192
+ "required": [
3193
+ "model"
3194
+ ],
3089
3195
  "type": "object"
3090
3196
  },
3091
3197
  "SonarFrequency": {
3092
3198
  "description": "Sonar frequency levels",
3093
- "enum": ["HIGH", "LOW"],
3199
+ "enum": [
3200
+ "HIGH",
3201
+ "LOW"
3202
+ ],
3094
3203
  "type": "string"
3095
3204
  },
3096
3205
  "SonarModel": {
3097
3206
  "description": "Sonar models",
3098
- "enum": ["oculus", "tritech"],
3207
+ "enum": [
3208
+ "oculus",
3209
+ "tritech"
3210
+ ],
3099
3211
  "type": "string"
3100
3212
  },
3101
3213
  "Sonde": {
@@ -3106,12 +3218,17 @@
3106
3218
  "type": "boolean"
3107
3219
  }
3108
3220
  },
3109
- "required": ["enabled"],
3221
+ "required": [
3222
+ "enabled"
3223
+ ],
3110
3224
  "type": "object"
3111
3225
  },
3112
3226
  "SpragBearing": {
3113
3227
  "description": "Sprag Bearing Types",
3114
- "enum": ["FKNN6204-2RS", "FKNN6205-2RS"],
3228
+ "enum": [
3229
+ "FKNN6204-2RS",
3230
+ "FKNN6205-2RS"
3231
+ ],
3115
3232
  "type": "string"
3116
3233
  },
3117
3234
  "Stream": {
@@ -3138,7 +3255,9 @@
3138
3255
  "description": "Stream resolution"
3139
3256
  }
3140
3257
  },
3141
- "required": ["active"],
3258
+ "required": [
3259
+ "active"
3260
+ ],
3142
3261
  "type": "object"
3143
3262
  },
3144
3263
  "StreamMode": {
@@ -3167,7 +3286,10 @@
3167
3286
  },
3168
3287
  "StreamModes": {
3169
3288
  "description": "Streaming Mode for the camera",
3170
- "enum": ["RTSP", "WEBRTC"],
3289
+ "enum": [
3290
+ "RTSP",
3291
+ "WEBRTC"
3292
+ ],
3171
3293
  "type": "string"
3172
3294
  },
3173
3295
  "SystemDiagnostics": {
@@ -3191,7 +3313,10 @@
3191
3313
  },
3192
3314
  "SystemOfMeasurement": {
3193
3315
  "description": "System unit of measurement enum",
3194
- "enum": ["IMPERIAL", "METRIC"],
3316
+ "enum": [
3317
+ "IMPERIAL",
3318
+ "METRIC"
3319
+ ],
3195
3320
  "type": "string"
3196
3321
  },
3197
3322
  "SystemSettings": {
@@ -3232,7 +3357,14 @@
3232
3357
  },
3233
3358
  "nearLimit": {
3234
3359
  "description": "Focus near limit",
3235
- "enum": [10, 34, 90, 250, 800, 2300],
3360
+ "enum": [
3361
+ 10,
3362
+ 34,
3363
+ 90,
3364
+ 250,
3365
+ 800,
3366
+ 2300
3367
+ ],
3236
3368
  "type": "number"
3237
3369
  },
3238
3370
  "rate": {
@@ -3308,7 +3440,9 @@
3308
3440
  "$ref": "#/definitions/ZoomControl"
3309
3441
  }
3310
3442
  },
3311
- "required": ["model"],
3443
+ "required": [
3444
+ "model"
3445
+ ],
3312
3446
  "type": "object"
3313
3447
  },
3314
3448
  "TamronOcleaZoomCamera": {
@@ -3368,7 +3502,9 @@
3368
3502
  "$ref": "#/definitions/DeviceVersion"
3369
3503
  }
3370
3504
  },
3371
- "required": ["model"],
3505
+ "required": [
3506
+ "model"
3507
+ ],
3372
3508
  "type": "object"
3373
3509
  },
3374
3510
  "TiltCameraHead": {
@@ -3414,12 +3550,17 @@
3414
3550
  "$ref": "#/definitions/DeviceVersion"
3415
3551
  }
3416
3552
  },
3417
- "required": ["model"],
3553
+ "required": [
3554
+ "model"
3555
+ ],
3418
3556
  "type": "object"
3419
3557
  },
3420
3558
  "TiltCameraHeadModel": {
3421
3559
  "description": "Tilt Camera Head Model",
3422
- "enum": [102, 103],
3560
+ "enum": [
3561
+ 102,
3562
+ 103
3563
+ ],
3423
3564
  "type": "number"
3424
3565
  },
3425
3566
  "TiltPlatform": {
@@ -3454,7 +3595,11 @@
3454
3595
  },
3455
3596
  "TopPositionSources": {
3456
3597
  "description": "Enumerates the possible topside location provider sources available to the Web App.",
3457
- "enum": ["NONE", "EXTERNAL_GPS", "STATIC"],
3598
+ "enum": [
3599
+ "NONE",
3600
+ "EXTERNAL_GPS",
3601
+ "STATIC"
3602
+ ],
3458
3603
  "type": "string"
3459
3604
  },
3460
3605
  "TopsidePosition": {
@@ -3489,12 +3634,21 @@
3489
3634
  "type": "string"
3490
3635
  }
3491
3636
  },
3492
- "required": ["code", "message"],
3637
+ "required": [
3638
+ "code",
3639
+ "message"
3640
+ ],
3493
3641
  "type": "object"
3494
3642
  },
3495
3643
  "TransferMethodType": {
3496
3644
  "description": "The different kinds of payload requests that can be sent and received.",
3497
- "enum": ["GET", "SET", "UPDATE", "DELETE", "ERROR"],
3645
+ "enum": [
3646
+ "GET",
3647
+ "SET",
3648
+ "UPDATE",
3649
+ "DELETE",
3650
+ "ERROR"
3651
+ ],
3498
3652
  "type": "string"
3499
3653
  },
3500
3654
  "TransferPayload<BridgeBox>": {
@@ -3515,7 +3669,11 @@
3515
3669
  "$ref": "#/definitions/BridgeBox"
3516
3670
  }
3517
3671
  },
3518
- "required": ["apiVersion", "method", "payload"],
3672
+ "required": [
3673
+ "apiVersion",
3674
+ "method",
3675
+ "payload"
3676
+ ],
3519
3677
  "type": "object"
3520
3678
  },
3521
3679
  "TurbidityFilter": {
@@ -3552,7 +3710,12 @@
3552
3710
  "type": "string"
3553
3711
  }
3554
3712
  },
3555
- "required": ["buildDate", "size", "sha256", "changelog"],
3713
+ "required": [
3714
+ "buildDate",
3715
+ "size",
3716
+ "sha256",
3717
+ "changelog"
3718
+ ],
3556
3719
  "type": "object"
3557
3720
  },
3558
3721
  "UsageTime": {
@@ -3636,7 +3799,10 @@
3636
3799
  "type": "array"
3637
3800
  }
3638
3801
  },
3639
- "required": ["improvements", "fixes"],
3802
+ "required": [
3803
+ "improvements",
3804
+ "fixes"
3805
+ ],
3640
3806
  "type": "object"
3641
3807
  },
3642
3808
  "WhiteBalanceSettings": {
@@ -1 +1 @@
1
- export declare const API_VERSION = "1.0.46-omniscan.0";
1
+ export declare const API_VERSION = "1.0.47";
@@ -2,4 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.API_VERSION = void 0;
4
4
  /* AUTO GENERATED FILE */
5
- exports.API_VERSION = "1.0.46-omniscan.0";
5
+ exports.API_VERSION = "1.0.47";
@@ -49,8 +49,7 @@ export declare enum DeviceModel {
49
49
  OculusSonar = 204,
50
50
  GeminiSonar = 205,
51
51
  Echosounder = 244,
52
- WATERLINKED_3D_SONAR = 245,
53
- CeruleanOmniscan = 247
52
+ WATERLINKED_3D_SONAR = 245
54
53
  }
55
54
  /**
56
55
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -125,7 +124,6 @@ export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
125
124
  readonly 205: "Gemini Sonar";
126
125
  readonly 244: "Echosounder";
127
126
  readonly 245: "Water Linked 3D Sonar";
128
- readonly 247: "Omniscan 450";
129
127
  readonly 104: "DT840 Hoser";
130
128
  readonly 105: "DT840 Manipulator Arm";
131
129
  readonly 113: "Power Distribution Module";
@@ -181,7 +179,6 @@ export declare const DEVICE_MODEL_LABELS: {
181
179
  readonly 205: "Gemini Sonar";
182
180
  readonly 244: "Echosounder";
183
181
  readonly 245: "Water Linked 3D Sonar";
184
- readonly 247: "Omniscan 450";
185
182
  readonly 104: "DT840 Hoser";
186
183
  readonly 105: "DT840 Manipulator Arm";
187
184
  readonly 113: "Power Distribution Module";
@@ -253,7 +250,7 @@ export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, D
253
250
  * @group Devices
254
251
  * @category Peripherals
255
252
  */
256
- 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.CeruleanOmniscan, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
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];
257
254
  /**
258
255
  * Device Version is a base interface for hardware and software version sample payloads.
259
256
  * -1 hardware versions and 0.0 software versions refer to not applicable
@@ -97,7 +97,6 @@ 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["CeruleanOmniscan"] = 247] = "CeruleanOmniscan";
101
100
  })(DeviceModel || (exports.DeviceModel = DeviceModel = {}));
102
101
  /**
103
102
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -175,7 +174,6 @@ exports.PERIPHERAL_DEVICE_MODEL_LABELS = (_c = {},
175
174
  _c[DeviceModel.GeminiSonar] = "Gemini Sonar",
176
175
  _c[DeviceModel.Echosounder] = "Echosounder",
177
176
  _c[DeviceModel.WATERLINKED_3D_SONAR] = "Water Linked 3D Sonar",
178
- _c[DeviceModel.CeruleanOmniscan] = "Omniscan 450",
179
177
  /* Legacy / Special Components */
180
178
  _c[DeviceModel.DT840Hoser] = "DT840 Hoser",
181
179
  _c[DeviceModel.DT840Arm] = "DT840 Manipulator Arm",
@@ -303,8 +301,7 @@ exports.PERIPHERAL_DEVICE_MODELS = __spreadArray(__spreadArray([
303
301
  DeviceModel.OculusSonar,
304
302
  DeviceModel.GeminiSonar,
305
303
  DeviceModel.Echosounder,
306
- DeviceModel.WATERLINKED_3D_SONAR,
307
- DeviceModel.CeruleanOmniscan
304
+ DeviceModel.WATERLINKED_3D_SONAR
308
305
  ], exports.SENSOR_POD_DEVICE_MODELS, true), exports.X4_PERIPHERAL_DEVICE_MODELS, true);
309
306
  __exportStar(require("./cameraHeads"), exports);
310
307
  __exportStar(require("./cameras"), exports);
@@ -80,6 +80,9 @@ export type SensorPod = {
80
80
  */
81
81
  state?: CalibrationStates;
82
82
  };
83
+ pressure?: {
84
+ calibrate?: boolean;
85
+ };
83
86
  };
84
87
  /**
85
88
  * Calibratable sensor pod representation.
@@ -93,16 +93,4 @@ export type Sonar = {
93
93
  */
94
94
  export type Sonar3D = {
95
95
  mac?: string;
96
- /**
97
- * Enables/disables acoustics
98
- */
99
- acoustics?: boolean;
100
- } & Omit<Device, "version">;
101
- /**
102
- * Cerulean Omniscan 450 sonar
103
- * @group Devices
104
- * @category Peripherals
105
- */
106
- export type Omniscan = {
107
- mac?: string;
108
96
  } & Omit<Device, "version">;
@@ -1,4 +1,4 @@
1
- import { CalibratableSensorPod, DeviceVersion, Echosounder, Omniscan, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
1
+ import { CalibratableSensorPod, DeviceVersion, Echosounder, Sonar3D, UsageTime, Vehicle } from "../../cameraHeads";
2
2
  import { RovDrive } from "../rovDrive";
3
3
  import { Navigation } from "../navigation";
4
4
  import { RovInputDiagnostics } from "../../diagnostics";
@@ -275,9 +275,4 @@ export type RovVehicle = {
275
275
  * @see {@link Sonar3D | Sonar3D}
276
276
  */
277
277
  sonar3d?: Sonar3D;
278
- /**
279
- * Omniscan 450 sonar device information without the HW and FW versions
280
- * @see {@link Omniscan | Omniscan}
281
- */
282
- omniscan?: Omniscan;
283
278
  } & Vehicle & Navigation;
@@ -1,5 +1,5 @@
1
1
  import { Movement } from "../../../core";
2
- import { DeviceModel, MotorDiagnostics, Sonar, Sonar3D, StereoCamera, X4CameraHead } from "../../cameraHeads";
2
+ import { DeviceModel, MotorDiagnostics, Sonar, StereoCamera, X4CameraHead } from "../../cameraHeads";
3
3
  import { ImpaqDriver, SensorPod, X4Light } from "../../peripherals";
4
4
  import { LightConfig, ThrusterConfig } from "./deviceAllocation";
5
5
  export * from "./deviceAllocation";
@@ -715,10 +715,9 @@ export type X4 = {
715
715
  /**
716
716
  * A record of sonars associated with the X4 vehicle.
717
717
  * Each sonar is identified by its unique MAC address and contains properties such as range, gain, frequency, and more.
718
- * Also includes 3D sonar devices.
719
- * See {@link Sonar | Sonar} and {@link Sonar3D | Sonar3D} for more details.
718
+ * See {@link Sonar | Sonar} for more details.
720
719
  */
721
- sonars?: Record<string, Sonar | Sonar3D>;
720
+ sonars?: Record<string, Sonar>;
722
721
  /**
723
722
  * A record of lights associated with the X4 vehicle.
724
723
  * Each light is identified by its unique MAC address and contains properties such as brightness and color.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.46-omniscan.0",
3
+ "version": "1.0.47",
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",
40
42
  "@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",
41
46
  "prettier": "3.0.3",
42
47
  "rimraf": "^3.0.2",
43
48
  "semver-compare-cli": "^2.0.0",
44
49
  "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,6 +62,7 @@
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"
65
+ "type-zoo": "^3.4.1",
66
+ "yarn": "^1.22.22"
66
67
  }
67
68
  }