@deeptrekker/api-domain 1.0.46 → 1.0.48-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.
Files changed (9) hide show
  1. package/dist/constants/schema/schema.json +295 -72
  2. package/dist/constants/versions/index.d.ts +1 -1
  3. package/dist/constants/versions/index.js +1 -1
  4. package/dist/types/devices/index.d.ts +5 -2
  5. package/dist/types/devices/index.js +4 -1
  6. package/dist/types/devices/sonar/index.d.ts +8 -4
  7. package/dist/types/devices/vehicles/rov/index.d.ts +6 -1
  8. package/dist/types/devices/vehicles/x4/index.d.ts +3 -4
  9. package/package.json +7 -8
package/dist/constants/schema/schema.json CHANGED
@@ -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,28 +642,26 @@
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
  },
637
- "pressure": {
638
- "additionalProperties": false,
639
- "properties": {
640
- "calibrate": {
641
- "type": "boolean"
642
- }
643
- },
644
- "required": [
645
- "calibrate"
646
- ],
647
- "type": "object"
648
- },
649
645
  "version": {
650
646
  "$ref": "#/definitions/DeviceVersion"
651
647
  }
652
648
  },
653
- "required": ["model"],
649
+ "required": [
650
+ "model"
651
+ ],
654
652
  "type": "object"
655
653
  },
656
654
  "CalibrationStates": {
657
655
  "description": "Calibration states for the sensor pod.",
658
- "enum": [0, 1, 2, 3, 4, 5, 6],
656
+ "enum": [
657
+ 0,
658
+ 1,
659
+ 2,
660
+ 3,
661
+ 4,
662
+ 5,
663
+ 6
664
+ ],
659
665
  "type": "number"
660
666
  },
661
667
  "Camera": {
@@ -670,7 +676,14 @@
670
676
  "type": "string"
671
677
  },
672
678
  "model": {
673
- "enum": [240, 5, 206, 243, 241, 207],
679
+ "enum": [
680
+ 240,
681
+ 5,
682
+ 206,
683
+ 243,
684
+ 241,
685
+ 207
686
+ ],
674
687
  "type": "number"
675
688
  },
676
689
  "osd": {
@@ -692,22 +705,33 @@
692
705
  "$ref": "#/definitions/DeviceVersion"
693
706
  }
694
707
  },
695
- "required": ["model"],
708
+ "required": [
709
+ "model"
710
+ ],
696
711
  "type": "object"
697
712
  },
698
713
  "CameraHeadOrientation": {
699
714
  "description": "Camera head orientation config\n\nThe orientation in which the camera head is physically assembled",
700
- "enum": ["HORIZONTAL", "VERTICAL"],
715
+ "enum": [
716
+ "HORIZONTAL",
717
+ "VERTICAL"
718
+ ],
701
719
  "type": "string"
702
720
  },
703
721
  "CameraHeadSensorType": {
704
722
  "description": "Camera head sensor type",
705
- "enum": ["IMU", "HALL_EFFECT"],
723
+ "enum": [
724
+ "IMU",
725
+ "HALL_EFFECT"
726
+ ],
706
727
  "type": "string"
707
728
  },
708
729
  "CameraType": {
709
730
  "description": "Camera type enums",
710
- "enum": ["MAIN", "AUX"],
731
+ "enum": [
732
+ "MAIN",
733
+ "AUX"
734
+ ],
711
735
  "type": "string"
712
736
  },
713
737
  "Cameras": {
@@ -775,7 +799,11 @@
775
799
  },
776
800
  "CrawlerDriveMode": {
777
801
  "description": "Drive Modes",
778
- "enum": ["NORMAL", "RETRIEVAL_ASSIST", "RETRIEVAL_CRUISE"],
802
+ "enum": [
803
+ "NORMAL",
804
+ "RETRIEVAL_ASSIST",
805
+ "RETRIEVAL_CRUISE"
806
+ ],
779
807
  "type": "string"
780
808
  },
781
809
  "CygnusType": {
@@ -862,7 +890,9 @@
862
890
  "$ref": "#/definitions/DeviceVersion"
863
891
  }
864
892
  },
865
- "required": ["model"],
893
+ "required": [
894
+ "model"
895
+ ],
866
896
  "type": "object"
867
897
  },
868
898
  "DT645Drive": {
@@ -941,7 +971,9 @@
941
971
  "description": "White Balance Settings for adjusting the white balance of the camera."
942
972
  }
943
973
  },
944
- "required": ["model"],
974
+ "required": [
975
+ "model"
976
+ ],
945
977
  "type": "object"
946
978
  },
947
979
  "DVL": {
@@ -964,7 +996,9 @@
964
996
  "$ref": "#/definitions/DeviceVersion"
965
997
  }
966
998
  },
967
- "required": ["model"],
999
+ "required": [
1000
+ "model"
1001
+ ],
968
1002
  "type": "object"
969
1003
  },
970
1004
  "DateTime": {
@@ -1042,9 +1076,13 @@
1042
1076
  204,
1043
1077
  205,
1044
1078
  244,
1045
- 245
1079
+ 245,
1080
+ 247
1046
1081
  ],
1047
- "type": ["string", "number"]
1082
+ "type": [
1083
+ "string",
1084
+ "number"
1085
+ ]
1048
1086
  },
1049
1087
  "DeviceVersion": {
1050
1088
  "additionalProperties": false,
@@ -1165,7 +1203,15 @@
1165
1203
  },
1166
1204
  "ErrorCode": {
1167
1205
  "description": "Error Codes",
1168
- "enum": [400, 401, 403, 405, 500, 503, 519],
1206
+ "enum": [
1207
+ 400,
1208
+ 401,
1209
+ 403,
1210
+ 405,
1211
+ 500,
1212
+ 503,
1213
+ 519
1214
+ ],
1169
1215
  "type": "number"
1170
1216
  },
1171
1217
  "ExposureSettings": {
@@ -1257,7 +1303,15 @@
1257
1303
  },
1258
1304
  "GpsFixState": {
1259
1305
  "description": "Enumerates the possible GPS FIX states.",
1260
- "enum": [0, 1, 2, 3, 4, 5, 6],
1306
+ "enum": [
1307
+ 0,
1308
+ 1,
1309
+ 2,
1310
+ 3,
1311
+ 4,
1312
+ 5,
1313
+ 6
1314
+ ],
1261
1315
  "type": "number"
1262
1316
  },
1263
1317
  "GpsStatus": {
@@ -1343,7 +1397,9 @@
1343
1397
  "type": "boolean"
1344
1398
  }
1345
1399
  },
1346
- "required": ["enabled"],
1400
+ "required": [
1401
+ "enabled"
1402
+ ],
1347
1403
  "type": "object"
1348
1404
  },
1349
1405
  "Light": {
@@ -1357,7 +1413,9 @@
1357
1413
  "type": "number"
1358
1414
  }
1359
1415
  },
1360
- "required": ["intensity"],
1416
+ "required": [
1417
+ "intensity"
1418
+ ],
1361
1419
  "type": "object"
1362
1420
  },
1363
1421
  "LocalPosition": {
@@ -1382,7 +1440,11 @@
1382
1440
  },
1383
1441
  "LocationConsumerType": {
1384
1442
  "description": "Enumerates the possible consumers of a location provider.",
1385
- "enum": [0, 1, 2],
1443
+ "enum": [
1444
+ 0,
1445
+ 1,
1446
+ 2
1447
+ ],
1386
1448
  "type": "number"
1387
1449
  },
1388
1450
  "LocationForwarderConfig": {
@@ -1464,7 +1526,9 @@
1464
1526
  "$ref": "#/definitions/DeviceVersion"
1465
1527
  }
1466
1528
  },
1467
- "required": ["model"],
1529
+ "required": [
1530
+ "model"
1531
+ ],
1468
1532
  "type": "object"
1469
1533
  },
1470
1534
  "MotorDiagnostics": {
@@ -1557,7 +1621,10 @@
1557
1621
  },
1558
1622
  "NetworkRole": {
1559
1623
  "description": "Network Diagnostics Physical Location enum",
1560
- "enum": ["CCO", "STA"],
1624
+ "enum": [
1625
+ "CCO",
1626
+ "STA"
1627
+ ],
1561
1628
  "type": "string"
1562
1629
  },
1563
1630
  "OcleaCam": {
@@ -1633,7 +1700,9 @@
1633
1700
  "description": "White Balance"
1634
1701
  }
1635
1702
  },
1636
- "required": ["model"],
1703
+ "required": [
1704
+ "model"
1705
+ ],
1637
1706
  "type": "object"
1638
1707
  },
1639
1708
  "OcleaDptz": {
@@ -1660,7 +1729,9 @@
1660
1729
  "type": "object"
1661
1730
  }
1662
1731
  },
1663
- "required": ["direction"],
1732
+ "required": [
1733
+ "direction"
1734
+ ],
1664
1735
  "type": "object"
1665
1736
  },
1666
1737
  "roi": {
@@ -1701,14 +1772,46 @@
1701
1772
  },
1702
1773
  "OcleaVersion": {
1703
1774
  "description": "Oclea Sensor version",
1704
- "enum": ["4K UHD v274", "4K UHD v415", "4K UHD v678", "Zoom v3010"],
1775
+ "enum": [
1776
+ "4K UHD v274",
1777
+ "4K UHD v415",
1778
+ "4K UHD v678",
1779
+ "Zoom v3010"
1780
+ ],
1705
1781
  "type": "string"
1706
1782
  },
1707
1783
  "OfflineUpdateState": {
1708
1784
  "description": "Offline Update State",
1709
- "enum": [0, 1, 2, 3, 4],
1785
+ "enum": [
1786
+ 0,
1787
+ 1,
1788
+ 2,
1789
+ 3,
1790
+ 4
1791
+ ],
1710
1792
  "type": "number"
1711
1793
  },
1794
+ "Omniscan": {
1795
+ "additionalProperties": false,
1796
+ "description": "Cerulean Omniscan 450 sonar",
1797
+ "properties": {
1798
+ "ip": {
1799
+ "description": "IP address",
1800
+ "type": "string"
1801
+ },
1802
+ "mac": {
1803
+ "type": "string"
1804
+ },
1805
+ "model": {
1806
+ "$ref": "#/definitions/DeviceModel",
1807
+ "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
1808
+ }
1809
+ },
1810
+ "required": [
1811
+ "model"
1812
+ ],
1813
+ "type": "object"
1814
+ },
1712
1815
  "Onyx": {
1713
1816
  "additionalProperties": false,
1714
1817
  "description": "Onyx Class",
@@ -1828,6 +1931,10 @@
1828
1931
  "$ref": "#/definitions/NavigationOptions",
1829
1932
  "description": "Navigation Options"
1830
1933
  },
1934
+ "omniscan": {
1935
+ "$ref": "#/definitions/Omniscan",
1936
+ "description": "Omniscan 450 sonar device information without the HW and FW versions"
1937
+ },
1831
1938
  "pitch": {
1832
1939
  "maximum": 180,
1833
1940
  "minimum": -180,
@@ -1887,7 +1994,9 @@
1887
1994
  "type": "number"
1888
1995
  }
1889
1996
  },
1890
- "required": ["model"],
1997
+ "required": [
1998
+ "model"
1999
+ ],
1891
2000
  "type": "object"
1892
2001
  },
1893
2002
  "Osd": {
@@ -2020,6 +2129,10 @@
2020
2129
  "$ref": "#/definitions/NavigationOptions",
2021
2130
  "description": "Navigation Options"
2022
2131
  },
2132
+ "omniscan": {
2133
+ "$ref": "#/definitions/Omniscan",
2134
+ "description": "Omniscan 450 sonar device information without the HW and FW versions"
2135
+ },
2023
2136
  "pitch": {
2024
2137
  "maximum": 180,
2025
2138
  "minimum": -180,
@@ -2080,12 +2193,17 @@
2080
2193
  "type": "number"
2081
2194
  }
2082
2195
  },
2083
- "required": ["model"],
2196
+ "required": [
2197
+ "model"
2198
+ ],
2084
2199
  "type": "object"
2085
2200
  },
2086
2201
  "PhysicalLocation": {
2087
2202
  "description": "Network Diagnostics Physical Location enum",
2088
- "enum": ["LOC", "REM"],
2203
+ "enum": [
2204
+ "LOC",
2205
+ "REM"
2206
+ ],
2089
2207
  "type": "string"
2090
2208
  },
2091
2209
  "Pivot": {
@@ -2198,6 +2316,10 @@
2198
2316
  "$ref": "#/definitions/NavigationOptions",
2199
2317
  "description": "Navigation Options"
2200
2318
  },
2319
+ "omniscan": {
2320
+ "$ref": "#/definitions/Omniscan",
2321
+ "description": "Omniscan 450 sonar device information without the HW and FW versions"
2322
+ },
2201
2323
  "pitch": {
2202
2324
  "maximum": 180,
2203
2325
  "minimum": -180,
@@ -2272,7 +2394,9 @@
2272
2394
  "type": "number"
2273
2395
  }
2274
2396
  },
2275
- "required": ["model"],
2397
+ "required": [
2398
+ "model"
2399
+ ],
2276
2400
  "type": "object"
2277
2401
  },
2278
2402
  "Position": {
@@ -2478,11 +2602,17 @@
2478
2602
  "$ref": "#/definitions/DeviceVersion"
2479
2603
  }
2480
2604
  },
2481
- "required": ["model"],
2605
+ "required": [
2606
+ "model"
2607
+ ],
2482
2608
  "type": "object"
2483
2609
  },
2484
2610
  "Rate": {
2485
- "enum": [-1, 0, 1],
2611
+ "enum": [
2612
+ -1,
2613
+ 0,
2614
+ 1
2615
+ ],
2486
2616
  "type": "number"
2487
2617
  },
2488
2618
  "Removable<A150CameraHead>": {
@@ -2703,6 +2833,10 @@
2703
2833
  "$ref": "#/definitions/NavigationOptions",
2704
2834
  "description": "Navigation Options"
2705
2835
  },
2836
+ "omniscan": {
2837
+ "$ref": "#/definitions/Omniscan",
2838
+ "description": "Omniscan 450 sonar device information without the HW and FW versions"
2839
+ },
2706
2840
  "pitch": {
2707
2841
  "maximum": 180,
2708
2842
  "minimum": -180,
@@ -2776,7 +2910,9 @@
2776
2910
  "type": "number"
2777
2911
  }
2778
2912
  },
2779
- "required": ["model"],
2913
+ "required": [
2914
+ "model"
2915
+ ],
2780
2916
  "type": "object"
2781
2917
  },
2782
2918
  "RotaryJoint": {
@@ -2879,7 +3015,9 @@
2879
3015
  "type": "object"
2880
3016
  }
2881
3017
  },
2882
- "required": ["controls"],
3018
+ "required": [
3019
+ "controls"
3020
+ ],
2883
3021
  "type": "object"
2884
3022
  },
2885
3023
  "RovThrust": {
@@ -2899,7 +3037,10 @@
2899
3037
  "type": "number"
2900
3038
  }
2901
3039
  },
2902
- "required": ["forward", "yaw"],
3040
+ "required": [
3041
+ "forward",
3042
+ "yaw"
3043
+ ],
2903
3044
  "type": "object"
2904
3045
  },
2905
3046
  "SWUpdate": {
@@ -2954,17 +3095,34 @@
2954
3095
  "type": "string"
2955
3096
  }
2956
3097
  },
2957
- "required": ["name"],
3098
+ "required": [
3099
+ "name"
3100
+ ],
2958
3101
  "type": "object"
2959
3102
  },
2960
3103
  "SerialDeviceType": {
2961
3104
  "description": "Denotes the origin of the serial device.",
2962
- "enum": ["ROV", "Web", "Internal", "Controller"],
3105
+ "enum": [
3106
+ "ROV",
3107
+ "Web",
3108
+ "Internal",
3109
+ "Controller"
3110
+ ],
2963
3111
  "type": "string"
2964
3112
  },
2965
3113
  "SnapshotIntervals": {
2966
3114
  "description": "Snapshot intervals (in seconds) for auto snapshot feature.",
2967
- "enum": [1, 2, 3, 4, 5, 10, 15, 30, 60],
3115
+ "enum": [
3116
+ 1,
3117
+ 2,
3118
+ 3,
3119
+ 4,
3120
+ 5,
3121
+ 10,
3122
+ 15,
3123
+ 30,
3124
+ 60
3125
+ ],
2968
3126
  "type": "number"
2969
3127
  },
2970
3128
  "SoftwareUpdate": {
@@ -2978,7 +3136,10 @@
2978
3136
  "$ref": "#/definitions/VersionNote"
2979
3137
  }
2980
3138
  },
2981
- "required": ["releaseDate", "versionNotes"],
3139
+ "required": [
3140
+ "releaseDate",
3141
+ "versionNotes"
3142
+ ],
2982
3143
  "type": "object"
2983
3144
  },
2984
3145
  "Sonar": {
@@ -3061,17 +3222,25 @@
3061
3222
  "description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
3062
3223
  }
3063
3224
  },
3064
- "required": ["model"],
3225
+ "required": [
3226
+ "model"
3227
+ ],
3065
3228
  "type": "object"
3066
3229
  },
3067
3230
  "SonarFrequency": {
3068
3231
  "description": "Sonar frequency levels",
3069
- "enum": ["HIGH", "LOW"],
3232
+ "enum": [
3233
+ "HIGH",
3234
+ "LOW"
3235
+ ],
3070
3236
  "type": "string"
3071
3237
  },
3072
3238
  "SonarModel": {
3073
3239
  "description": "Sonar models",
3074
- "enum": ["oculus", "tritech"],
3240
+ "enum": [
3241
+ "oculus",
3242
+ "tritech"
3243
+ ],
3075
3244
  "type": "string"
3076
3245
  },
3077
3246
  "Sonde": {
@@ -3082,12 +3251,17 @@
3082
3251
  "type": "boolean"
3083
3252
  }
3084
3253
  },
3085
- "required": ["enabled"],
3254
+ "required": [
3255
+ "enabled"
3256
+ ],
3086
3257
  "type": "object"
3087
3258
  },
3088
3259
  "SpragBearing": {
3089
3260
  "description": "Sprag Bearing Types",
3090
- "enum": ["FKNN6204-2RS", "FKNN6205-2RS"],
3261
+ "enum": [
3262
+ "FKNN6204-2RS",
3263
+ "FKNN6205-2RS"
3264
+ ],
3091
3265
  "type": "string"
3092
3266
  },
3093
3267
  "Stream": {
@@ -3114,7 +3288,9 @@
3114
3288
  "description": "Stream resolution"
3115
3289
  }
3116
3290
  },
3117
- "required": ["active"],
3291
+ "required": [
3292
+ "active"
3293
+ ],
3118
3294
  "type": "object"
3119
3295
  },
3120
3296
  "StreamMode": {
@@ -3143,7 +3319,10 @@
3143
3319
  },
3144
3320
  "StreamModes": {
3145
3321
  "description": "Streaming Mode for the camera",
3146
- "enum": ["RTSP", "WEBRTC"],
3322
+ "enum": [
3323
+ "RTSP",
3324
+ "WEBRTC"
3325
+ ],
3147
3326
  "type": "string"
3148
3327
  },
3149
3328
  "SystemDiagnostics": {
@@ -3167,7 +3346,10 @@
3167
3346
  },
3168
3347
  "SystemOfMeasurement": {
3169
3348
  "description": "System unit of measurement enum",
3170
- "enum": ["IMPERIAL", "METRIC"],
3349
+ "enum": [
3350
+ "IMPERIAL",
3351
+ "METRIC"
3352
+ ],
3171
3353
  "type": "string"
3172
3354
  },
3173
3355
  "SystemSettings": {
@@ -3208,7 +3390,14 @@
3208
3390
  },
3209
3391
  "nearLimit": {
3210
3392
  "description": "Focus near limit",
3211
- "enum": [10, 34, 90, 250, 800, 2300],
3393
+ "enum": [
3394
+ 10,
3395
+ 34,
3396
+ 90,
3397
+ 250,
3398
+ 800,
3399
+ 2300
3400
+ ],
3212
3401
  "type": "number"
3213
3402
  },
3214
3403
  "rate": {
@@ -3284,7 +3473,9 @@
3284
3473
  "$ref": "#/definitions/ZoomControl"
3285
3474
  }
3286
3475
  },
3287
- "required": ["model"],
3476
+ "required": [
3477
+ "model"
3478
+ ],
3288
3479
  "type": "object"
3289
3480
  },
3290
3481
  "TamronOcleaZoomCamera": {
@@ -3344,7 +3535,9 @@
3344
3535
  "$ref": "#/definitions/DeviceVersion"
3345
3536
  }
3346
3537
  },
3347
- "required": ["model"],
3538
+ "required": [
3539
+ "model"
3540
+ ],
3348
3541
  "type": "object"
3349
3542
  },
3350
3543
  "TiltCameraHead": {
@@ -3390,12 +3583,17 @@
3390
3583
  "$ref": "#/definitions/DeviceVersion"
3391
3584
  }
3392
3585
  },
3393
- "required": ["model"],
3586
+ "required": [
3587
+ "model"
3588
+ ],
3394
3589
  "type": "object"
3395
3590
  },
3396
3591
  "TiltCameraHeadModel": {
3397
3592
  "description": "Tilt Camera Head Model",
3398
- "enum": [102, 103],
3593
+ "enum": [
3594
+ 102,
3595
+ 103
3596
+ ],
3399
3597
  "type": "number"
3400
3598
  },
3401
3599
  "TiltPlatform": {
@@ -3430,7 +3628,11 @@
3430
3628
  },
3431
3629
  "TopPositionSources": {
3432
3630
  "description": "Enumerates the possible topside location provider sources available to the Web App.",
3433
- "enum": ["NONE", "EXTERNAL_GPS", "STATIC"],
3631
+ "enum": [
3632
+ "NONE",
3633
+ "EXTERNAL_GPS",
3634
+ "STATIC"
3635
+ ],
3434
3636
  "type": "string"
3435
3637
  },
3436
3638
  "TopsidePosition": {
@@ -3465,12 +3667,21 @@
3465
3667
  "type": "string"
3466
3668
  }
3467
3669
  },
3468
- "required": ["code", "message"],
3670
+ "required": [
3671
+ "code",
3672
+ "message"
3673
+ ],
3469
3674
  "type": "object"
3470
3675
  },
3471
3676
  "TransferMethodType": {
3472
3677
  "description": "The different kinds of payload requests that can be sent and received.",
3473
- "enum": ["GET", "SET", "UPDATE", "DELETE", "ERROR"],
3678
+ "enum": [
3679
+ "GET",
3680
+ "SET",
3681
+ "UPDATE",
3682
+ "DELETE",
3683
+ "ERROR"
3684
+ ],
3474
3685
  "type": "string"
3475
3686
  },
3476
3687
  "TransferPayload<BridgeBox>": {
@@ -3491,7 +3702,11 @@
3491
3702
  "$ref": "#/definitions/BridgeBox"
3492
3703
  }
3493
3704
  },
3494
- "required": ["apiVersion", "method", "payload"],
3705
+ "required": [
3706
+ "apiVersion",
3707
+ "method",
3708
+ "payload"
3709
+ ],
3495
3710
  "type": "object"
3496
3711
  },
3497
3712
  "TurbidityFilter": {
@@ -3528,7 +3743,12 @@
3528
3743
  "type": "string"
3529
3744
  }
3530
3745
  },
3531
- "required": ["buildDate", "size", "sha256", "changelog"],
3746
+ "required": [
3747
+ "buildDate",
3748
+ "size",
3749
+ "sha256",
3750
+ "changelog"
3751
+ ],
3532
3752
  "type": "object"
3533
3753
  },
3534
3754
  "UsageTime": {
@@ -3612,7 +3832,10 @@
3612
3832
  "type": "array"
3613
3833
  }
3614
3834
  },
3615
- "required": ["improvements", "fixes"],
3835
+ "required": [
3836
+ "improvements",
3837
+ "fixes"
3838
+ ],
3616
3839
  "type": "object"
3617
3840
  },
3618
3841
  "WhiteBalanceSettings": {
package/dist/constants/versions/index.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const API_VERSION = "1.0.46";
1
+ export declare const API_VERSION = "1.0.48-omniscan.0";
package/dist/constants/versions/index.js CHANGED
@@ -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";
5
+ exports.API_VERSION = "1.0.48-omniscan.0";
package/dist/types/devices/index.d.ts CHANGED
@@ -49,7 +49,8 @@ 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
+ CeruleanOmniscan = 247
53
54
  }
54
55
  /**
55
56
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -124,6 +125,7 @@ export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
124
125
  readonly 205: "Gemini Sonar";
125
126
  readonly 244: "Echosounder";
126
127
  readonly 245: "Water Linked 3D Sonar";
128
+ readonly 247: "Omniscan 450";
127
129
  readonly 104: "DT840 Hoser";
128
130
  readonly 105: "DT840 Manipulator Arm";
129
131
  readonly 113: "Power Distribution Module";
@@ -179,6 +181,7 @@ export declare const DEVICE_MODEL_LABELS: {
179
181
  readonly 205: "Gemini Sonar";
180
182
  readonly 244: "Echosounder";
181
183
  readonly 245: "Water Linked 3D Sonar";
184
+ readonly 247: "Omniscan 450";
182
185
  readonly 104: "DT840 Hoser";
183
186
  readonly 105: "DT840 Manipulator Arm";
184
187
  readonly 113: "Power Distribution Module";
@@ -250,7 +253,7 @@ export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, D
250
253
  * @group Devices
251
254
  * @category Peripherals
252
255
  */
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];
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];
254
257
  /**
255
258
  * Device Version is a base interface for hardware and software version sample payloads.
256
259
  * -1 hardware versions and 0.0 software versions refer to not applicable
package/dist/types/devices/index.js CHANGED
@@ -97,6 +97,7 @@ 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";
100
101
  })(DeviceModel || (exports.DeviceModel = DeviceModel = {}));
101
102
  /**
102
103
  * Deep Trekker's Bandwidth Degradation Thresholds
@@ -174,6 +175,7 @@ exports.PERIPHERAL_DEVICE_MODEL_LABELS = (_c = {},
174
175
  _c[DeviceModel.GeminiSonar] = "Gemini Sonar",
175
176
  _c[DeviceModel.Echosounder] = "Echosounder",
176
177
  _c[DeviceModel.WATERLINKED_3D_SONAR] = "Water Linked 3D Sonar",
178
+ _c[DeviceModel.CeruleanOmniscan] = "Omniscan 450",
177
179
  /* Legacy / Special Components */
178
180
  _c[DeviceModel.DT840Hoser] = "DT840 Hoser",
179
181
  _c[DeviceModel.DT840Arm] = "DT840 Manipulator Arm",
@@ -301,7 +303,8 @@ exports.PERIPHERAL_DEVICE_MODELS = __spreadArray(__spreadArray([
301
303
  DeviceModel.OculusSonar,
302
304
  DeviceModel.GeminiSonar,
303
305
  DeviceModel.Echosounder,
304
- DeviceModel.WATERLINKED_3D_SONAR
306
+ DeviceModel.WATERLINKED_3D_SONAR,
307
+ DeviceModel.CeruleanOmniscan
305
308
  ], exports.SENSOR_POD_DEVICE_MODELS, true), exports.X4_PERIPHERAL_DEVICE_MODELS, true);
306
309
  __exportStar(require("./cameraHeads"), exports);
307
310
  __exportStar(require("./cameras"), exports);
package/dist/types/devices/sonar/index.d.ts CHANGED
@@ -93,8 +93,12 @@ export type Sonar = {
93
93
  */
94
94
  export type Sonar3D = {
95
95
  mac?: string;
96
- /**
97
- * Enables/disables acoustics
98
- */
99
- acoustics?: boolean;
96
+ } & Omit<Device, "version">;
97
+ /**
98
+ * Cerulean Omniscan 450 sonar
99
+ * @group Devices
100
+ * @category Peripherals
101
+ */
102
+ export type Omniscan = {
103
+ mac?: string;
100
104
  } & Omit<Device, "version">;
package/dist/types/devices/vehicles/rov/index.d.ts CHANGED
@@ -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,9 @@ 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;
278
283
  } & Vehicle & Navigation;
package/dist/types/devices/vehicles/x4/index.d.ts CHANGED
@@ -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",
3
+ "version": "1.0.48-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
  }