@deeptrekker/api-domain 1.0.33 → 1.0.34-laketesting.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 +29 -0
- package/dist/constants/versions/index.d.ts +1 -1
- package/dist/constants/versions/index.js +1 -1
- package/dist/types/core/index.d.ts +9 -1
- package/dist/types/core/index.js +6 -2
- package/dist/types/devices/cameras/core/index.d.ts +20 -0
- package/dist/types/devices/cameras/ocleaCam/index.d.ts +8 -1
- package/dist/types/devices/vehicles/x4/index.d.ts +5 -0
- package/package.json +7 -8
|
@@ -1013,6 +1013,32 @@
|
|
|
1013
1013
|
},
|
|
1014
1014
|
"type": "object"
|
|
1015
1015
|
},
|
|
1016
|
+
"DenoiseMode": {
|
|
1017
|
+
"description": "Denoise mode",
|
|
1018
|
+
"enum": [
|
|
1019
|
+
"off",
|
|
1020
|
+
"fast",
|
|
1021
|
+
"high_quality"
|
|
1022
|
+
],
|
|
1023
|
+
"type": "string"
|
|
1024
|
+
},
|
|
1025
|
+
"DenoiseSettings": {
|
|
1026
|
+
"additionalProperties": false,
|
|
1027
|
+
"description": "Denoise Settings",
|
|
1028
|
+
"properties": {
|
|
1029
|
+
"mode": {
|
|
1030
|
+
"$ref": "#/definitions/DenoiseMode",
|
|
1031
|
+
"description": "Mode"
|
|
1032
|
+
},
|
|
1033
|
+
"strength": {
|
|
1034
|
+
"description": "Strength\n\nControls the strength of the denoise filter.",
|
|
1035
|
+
"maximum": 100,
|
|
1036
|
+
"minimum": 0,
|
|
1037
|
+
"type": "number"
|
|
1038
|
+
}
|
|
1039
|
+
},
|
|
1040
|
+
"type": "object"
|
|
1041
|
+
},
|
|
1016
1042
|
"DeviceModel": {
|
|
1017
1043
|
"description": "Deep Trekker internal device model numbers.",
|
|
1018
1044
|
"enum": [
|
|
@@ -1628,6 +1654,9 @@
|
|
|
1628
1654
|
"cpuTemp": {
|
|
1629
1655
|
"type": "number"
|
|
1630
1656
|
},
|
|
1657
|
+
"denoise": {
|
|
1658
|
+
"$ref": "#/definitions/DenoiseSettings"
|
|
1659
|
+
},
|
|
1631
1660
|
"dptz": {
|
|
1632
1661
|
"$ref": "#/definitions/OcleaDptz"
|
|
1633
1662
|
},
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.
|
|
1
|
+
export declare const API_VERSION = "1.0.34-laketesting.0";
|
|
@@ -55,13 +55,16 @@ export type TransferPayload<T> = {
|
|
|
55
55
|
payload: T;
|
|
56
56
|
};
|
|
57
57
|
export declare enum ReferencePoints {
|
|
58
|
-
Body = "body",
|
|
59
58
|
Altitude = "altitude",
|
|
60
59
|
Depth = "depth",
|
|
61
60
|
Global = "global",
|
|
62
61
|
Local = "local",
|
|
63
62
|
Distance = "distance"
|
|
64
63
|
}
|
|
64
|
+
export declare enum ControlFrames {
|
|
65
|
+
Body = "body",
|
|
66
|
+
Footprint = "footprint"
|
|
67
|
+
}
|
|
65
68
|
/**
|
|
66
69
|
* Movement
|
|
67
70
|
*
|
|
@@ -99,6 +102,11 @@ export type Movement = {
|
|
|
99
102
|
* A reference to the position or heading that the vehicle should target and base its locking on.
|
|
100
103
|
*/
|
|
101
104
|
reference?: ReferencePoints;
|
|
105
|
+
/**
|
|
106
|
+
* @remarks
|
|
107
|
+
* The frame of reference for the movement. This is used to determine how the vehicle should interpret the movement command.
|
|
108
|
+
*/
|
|
109
|
+
controlFrame?: ControlFrames;
|
|
102
110
|
};
|
|
103
111
|
/**
|
|
104
112
|
* The different kinds of payload requests that can be sent and received.
|
package/dist/types/core/index.js
CHANGED
|
@@ -15,16 +15,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
var _a;
|
|
17
17
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ReferencePoints = void 0;
|
|
18
|
+
exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ControlFrames = exports.ReferencePoints = void 0;
|
|
19
19
|
var ReferencePoints;
|
|
20
20
|
(function (ReferencePoints) {
|
|
21
|
-
ReferencePoints["Body"] = "body";
|
|
22
21
|
ReferencePoints["Altitude"] = "altitude";
|
|
23
22
|
ReferencePoints["Depth"] = "depth";
|
|
24
23
|
ReferencePoints["Global"] = "global";
|
|
25
24
|
ReferencePoints["Local"] = "local";
|
|
26
25
|
ReferencePoints["Distance"] = "distance";
|
|
27
26
|
})(ReferencePoints || (exports.ReferencePoints = ReferencePoints = {}));
|
|
27
|
+
var ControlFrames;
|
|
28
|
+
(function (ControlFrames) {
|
|
29
|
+
ControlFrames["Body"] = "body";
|
|
30
|
+
ControlFrames["Footprint"] = "footprint";
|
|
31
|
+
})(ControlFrames || (exports.ControlFrames = ControlFrames = {}));
|
|
28
32
|
/**
|
|
29
33
|
* The different kinds of payload requests that can be sent and received.
|
|
30
34
|
* @category Core
|
|
@@ -213,6 +213,26 @@ export type TurbidityFilter = {
|
|
|
213
213
|
*/
|
|
214
214
|
strength?: number;
|
|
215
215
|
};
|
|
216
|
+
/**
|
|
217
|
+
* Denoise Settings
|
|
218
|
+
* @group Devices
|
|
219
|
+
* @category Cameras
|
|
220
|
+
*/
|
|
221
|
+
export type DenoiseSettings = {
|
|
222
|
+
/**
|
|
223
|
+
* Strength
|
|
224
|
+
*
|
|
225
|
+
* Controls the strength of the denoise filter.
|
|
226
|
+
* @minimum 0
|
|
227
|
+
* @maximum 100
|
|
228
|
+
*/
|
|
229
|
+
strength?: number;
|
|
230
|
+
/**
|
|
231
|
+
* Enabled
|
|
232
|
+
*
|
|
233
|
+
*/
|
|
234
|
+
enabled?: boolean;
|
|
235
|
+
};
|
|
216
236
|
/**
|
|
217
237
|
* Exposure Settings
|
|
218
238
|
* @group Devices
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Camera, DeviceModel } from "../..";
|
|
2
|
-
import { ExposureSettings, OcleaDptz, OcleaVersion, TurbidityFilter, WhiteBalanceSettings } from "../core";
|
|
2
|
+
import { DenoiseSettings, ExposureSettings, OcleaDptz, OcleaVersion, TurbidityFilter, WhiteBalanceSettings } from "../core";
|
|
3
3
|
/**
|
|
4
4
|
*
|
|
5
5
|
* 📷 4k UHD Camera
|
|
@@ -92,4 +92,11 @@ export type OcleaCam = Camera & {
|
|
|
92
92
|
* @see {@link TurbidityFilter | TurbidityFilter}
|
|
93
93
|
*/
|
|
94
94
|
turbidityFilter?: TurbidityFilter;
|
|
95
|
+
/**
|
|
96
|
+
* @remarks
|
|
97
|
+
* Denoise filter settings
|
|
98
|
+
*
|
|
99
|
+
* @see {@link DenoiseSettings | DenoiseSettings}
|
|
100
|
+
*/
|
|
101
|
+
denoise?: DenoiseSettings;
|
|
95
102
|
};
|
|
@@ -158,6 +158,11 @@ export type X4DriveCommand = {
|
|
|
158
158
|
* See {@link ControlMode | ControlMode} for more details.
|
|
159
159
|
*/
|
|
160
160
|
controlMode?: ControlMode;
|
|
161
|
+
/**
|
|
162
|
+
* The velocity control option for the drive command, which can be used to specify whether the vehicle should use velocity control or position control.
|
|
163
|
+
* If true the vehicle is locked to velocity control.
|
|
164
|
+
*/
|
|
165
|
+
useVelocityControl?: boolean;
|
|
161
166
|
/**
|
|
162
167
|
* The forward movement command, which includes speed and position.
|
|
163
168
|
* This allows the user to control the vehicle's forward movement. (Forward and backward)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deeptrekker/api-domain",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.34-laketesting.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
|
}
|