@deeptrekker/api-domain 1.0.46-omniscan.0 → 1.0.46
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 +13 -37
- package/dist/constants/versions/index.d.ts +1 -1
- package/dist/constants/versions/index.js +1 -1
- package/dist/types/devices/index.d.ts +2 -5
- package/dist/types/devices/index.js +1 -4
- package/dist/types/devices/peripherals/sensorPod/index.d.ts +3 -0
- package/dist/types/devices/sonar/index.d.ts +0 -8
- package/dist/types/devices/vehicles/rov/index.d.ts +1 -6
- package/package.json +8 -7
|
@@ -634,6 +634,18 @@
|
|
|
634
634
|
"$ref": "#/definitions/DeviceModel",
|
|
635
635
|
"description": "Deep Trekker internal device model numbers. This can be used for selecting the associated device schema."
|
|
636
636
|
},
|
|
637
|
+
"pressure": {
|
|
638
|
+
"additionalProperties": false,
|
|
639
|
+
"properties": {
|
|
640
|
+
"calibrate": {
|
|
641
|
+
"type": "boolean"
|
|
642
|
+
}
|
|
643
|
+
},
|
|
644
|
+
"required": [
|
|
645
|
+
"calibrate"
|
|
646
|
+
],
|
|
647
|
+
"type": "object"
|
|
648
|
+
},
|
|
637
649
|
"version": {
|
|
638
650
|
"$ref": "#/definitions/DeviceVersion"
|
|
639
651
|
}
|
|
@@ -1030,8 +1042,7 @@
|
|
|
1030
1042
|
204,
|
|
1031
1043
|
205,
|
|
1032
1044
|
244,
|
|
1033
|
-
245
|
|
1034
|
-
247
|
|
1045
|
+
245
|
|
1035
1046
|
],
|
|
1036
1047
|
"type": ["string", "number"]
|
|
1037
1048
|
},
|
|
@@ -1698,25 +1709,6 @@
|
|
|
1698
1709
|
"enum": [0, 1, 2, 3, 4],
|
|
1699
1710
|
"type": "number"
|
|
1700
1711
|
},
|
|
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
1712
|
"Onyx": {
|
|
1721
1713
|
"additionalProperties": false,
|
|
1722
1714
|
"description": "Onyx Class",
|
|
@@ -1836,10 +1828,6 @@
|
|
|
1836
1828
|
"$ref": "#/definitions/NavigationOptions",
|
|
1837
1829
|
"description": "Navigation Options"
|
|
1838
1830
|
},
|
|
1839
|
-
"omniscan": {
|
|
1840
|
-
"$ref": "#/definitions/Omniscan",
|
|
1841
|
-
"description": "Omniscan 450 sonar device information without the HW and FW versions"
|
|
1842
|
-
},
|
|
1843
1831
|
"pitch": {
|
|
1844
1832
|
"maximum": 180,
|
|
1845
1833
|
"minimum": -180,
|
|
@@ -2032,10 +2020,6 @@
|
|
|
2032
2020
|
"$ref": "#/definitions/NavigationOptions",
|
|
2033
2021
|
"description": "Navigation Options"
|
|
2034
2022
|
},
|
|
2035
|
-
"omniscan": {
|
|
2036
|
-
"$ref": "#/definitions/Omniscan",
|
|
2037
|
-
"description": "Omniscan 450 sonar device information without the HW and FW versions"
|
|
2038
|
-
},
|
|
2039
2023
|
"pitch": {
|
|
2040
2024
|
"maximum": 180,
|
|
2041
2025
|
"minimum": -180,
|
|
@@ -2214,10 +2198,6 @@
|
|
|
2214
2198
|
"$ref": "#/definitions/NavigationOptions",
|
|
2215
2199
|
"description": "Navigation Options"
|
|
2216
2200
|
},
|
|
2217
|
-
"omniscan": {
|
|
2218
|
-
"$ref": "#/definitions/Omniscan",
|
|
2219
|
-
"description": "Omniscan 450 sonar device information without the HW and FW versions"
|
|
2220
|
-
},
|
|
2221
2201
|
"pitch": {
|
|
2222
2202
|
"maximum": 180,
|
|
2223
2203
|
"minimum": -180,
|
|
@@ -2723,10 +2703,6 @@
|
|
|
2723
2703
|
"$ref": "#/definitions/NavigationOptions",
|
|
2724
2704
|
"description": "Navigation Options"
|
|
2725
2705
|
},
|
|
2726
|
-
"omniscan": {
|
|
2727
|
-
"$ref": "#/definitions/Omniscan",
|
|
2728
|
-
"description": "Omniscan 450 sonar device information without the HW and FW versions"
|
|
2729
|
-
},
|
|
2730
2706
|
"pitch": {
|
|
2731
2707
|
"maximum": 180,
|
|
2732
2708
|
"minimum": -180,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.46
|
|
1
|
+
export declare const API_VERSION = "1.0.46";
|
|
@@ -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.
|
|
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);
|
|
@@ -98,11 +98,3 @@ export type Sonar3D = {
|
|
|
98
98
|
*/
|
|
99
99
|
acoustics?: boolean;
|
|
100
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
|
-
} & Omit<Device, "version">;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CalibratableSensorPod, DeviceVersion, Echosounder,
|
|
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;
|
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.46",
|
|
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
|
}
|