@deeptrekker/api-domain 1.0.38 → 1.0.40-collisionavoidanceprototype.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.
|
@@ -766,6 +766,30 @@
|
|
|
766
766
|
},
|
|
767
767
|
"type": "object"
|
|
768
768
|
},
|
|
769
|
+
"CollisionAvoidance": {
|
|
770
|
+
"additionalProperties": false,
|
|
771
|
+
"description": "Collision Avoidance",
|
|
772
|
+
"properties": {
|
|
773
|
+
"active": {
|
|
774
|
+
"type": "boolean"
|
|
775
|
+
},
|
|
776
|
+
"downError": {
|
|
777
|
+
"type": "string"
|
|
778
|
+
},
|
|
779
|
+
"downState": {
|
|
780
|
+
"description": "\"unknown\" | \"outside\" | \"inside\"",
|
|
781
|
+
"type": "string"
|
|
782
|
+
},
|
|
783
|
+
"fwdError": {
|
|
784
|
+
"type": "string"
|
|
785
|
+
},
|
|
786
|
+
"fwdState": {
|
|
787
|
+
"description": "\"unknown\" | \"outside\" | \"inside\"",
|
|
788
|
+
"type": "string"
|
|
789
|
+
}
|
|
790
|
+
},
|
|
791
|
+
"type": "object"
|
|
792
|
+
},
|
|
769
793
|
"CrawlerDrive": {
|
|
770
794
|
"additionalProperties": false,
|
|
771
795
|
"description": "Crawler drive",
|
|
@@ -2891,6 +2915,9 @@
|
|
|
2891
2915
|
"autoStabilization": {
|
|
2892
2916
|
"type": "boolean"
|
|
2893
2917
|
},
|
|
2918
|
+
"collisionAvoidance": {
|
|
2919
|
+
"$ref": "#/definitions/CollisionAvoidance"
|
|
2920
|
+
},
|
|
2894
2921
|
"depthLock": {
|
|
2895
2922
|
"type": "boolean"
|
|
2896
2923
|
},
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.
|
|
1
|
+
export declare const API_VERSION = "1.0.40-collisionavoidanceprototype.0";
|
|
@@ -15,4 +15,4 @@ export type Cameras = Camera | TamronHarrierZoomCamera | DTCam | OcleaCam | Tamr
|
|
|
15
15
|
* @group Devices
|
|
16
16
|
* @category Cameras
|
|
17
17
|
*/
|
|
18
|
-
export type CameraModels = DeviceModel.TamronHarrierZoomCamera | DeviceModel.TamronOcleaZoomCamera | DeviceModel.DTCam | DeviceModel.OcleaCam | DeviceModel.MiniAuxCamera;
|
|
18
|
+
export type CameraModels = DeviceModel.TamronHarrierZoomCamera | DeviceModel.TamronOcleaZoomCamera | DeviceModel.DTCam | DeviceModel.OcleaCam | DeviceModel.MiniAuxCamera | DeviceModel.X4Cam;
|
|
@@ -34,6 +34,7 @@ export type RovDrive = {
|
|
|
34
34
|
motorsDisabled?: boolean;
|
|
35
35
|
stationHolding?: boolean;
|
|
36
36
|
distanceLock?: DistanceLock;
|
|
37
|
+
collisionAvoidance?: CollisionAvoidance;
|
|
37
38
|
};
|
|
38
39
|
};
|
|
39
40
|
/**
|
|
@@ -46,3 +47,21 @@ export type DistanceLock = {
|
|
|
46
47
|
setPoint?: number;
|
|
47
48
|
error?: string;
|
|
48
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* Collision Avoidance
|
|
52
|
+
*
|
|
53
|
+
* @remarks Toggling this mode toggles both forward and downward collision avoidance together,
|
|
54
|
+
* though the two axes are tracked and reported independently. Cannot be active at the same
|
|
55
|
+
* time as Distance Lock.
|
|
56
|
+
* @group Devices
|
|
57
|
+
* @category ROV
|
|
58
|
+
*/
|
|
59
|
+
export type CollisionAvoidance = {
|
|
60
|
+
active?: boolean;
|
|
61
|
+
/** "unknown" | "outside" | "inside" */
|
|
62
|
+
fwdState?: string;
|
|
63
|
+
fwdError?: string;
|
|
64
|
+
/** "unknown" | "outside" | "inside" */
|
|
65
|
+
downState?: string;
|
|
66
|
+
downError?: string;
|
|
67
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deeptrekker/api-domain",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.40-collisionavoidanceprototype.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
|
}
|