@deeptrekker/api-domain 1.0.29 → 1.0.30-clean-up-x4-api.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.
@@ -1 +1 @@
1
- export declare const API_VERSION = "1.0.29";
1
+ export declare const API_VERSION = "1.0.30-clean-up-x4-api.0";
@@ -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.29";
5
+ exports.API_VERSION = "1.0.30-clean-up-x4-api.0";
@@ -148,12 +148,6 @@ export type X4DriveCommand = {
148
148
  * Can also be set to "BODY" or "FOOTPRINT"
149
149
  */
150
150
  referenceFrame?: string;
151
- /**
152
- * When set to true, the vehicle will disable all motors.
153
- * This is useful for safety purposes or when the vehicle needs to be stationary. When set to true, the vehicle will not respond to any movement commands.
154
- * When set to false, the vehicle will respond to movement commands as usual.
155
- */
156
- disableMotors?: boolean;
157
151
  /**
158
152
  * The control mode for the drive command, which can be used to specify how the vehicle should respond to the command.
159
153
  * This allows the user to choose between different control strategies (e.g., open loop, closed loop, adaptive).
@@ -312,53 +306,11 @@ export type X4Position = {
312
306
  */
313
307
  heading?: number;
314
308
  /**
315
- * Indicates that a position for x has been set. Sending a velocity command for x will disable the lock.
316
- *
317
- * @readonly
318
- */
319
- xLock?: boolean;
320
- /**
321
- * Indicates that a position for y has been set. Sending a velocity command for y will disable the lock.
322
- *
323
- * @readonly
324
- */
325
- yLock?: boolean;
326
- /**
327
- * Indicates that a position for zDepth has been set. Sending a velocity command for zDepth will disable the lock.
328
- *
329
- * @readonly
330
- */
331
- zDepthLock?: boolean;
332
- /**
333
- * Indicates that a position for zAltitude has been set. Sending a velocity command for zAltitude will disable the lock.
334
- *
335
- * @readonly
336
- */
337
- zAltitudeLock?: boolean;
338
- /**
339
- * Indicates that a position for roll has been set. Sending a velocity command for roll will disable the lock.
340
- *
341
- * @readonly
342
- */
343
- rollLock?: boolean;
344
- /**
345
- * Indicates that a position for pitch has been set. Sending a velocity command for pitch will disable the lock.
346
- *
347
- * @readonly
348
- */
349
- pitchLock?: boolean;
350
- /**
351
- * Indicates that a position for yaw has been set. Sending a velocity command for yaw or a drive command for heading will disable the yaw lock.
352
- *
353
- * @readonly
354
- */
355
- yawLock?: boolean;
356
- /**
357
- * Indicates that a position for heading has been set. Sending a velocity command for heading or a drive command for yaw will disable the heading lock.
309
+ * The quaternion representation of the vehicle's orientation. This is used to represent the vehicle's orientation in 3D space.
310
+ * It is used to track the vehicle's orientation in space and can be used for advanced control and navigation algorithms.
358
311
  *
359
312
  * @readonly
360
313
  */
361
- headingLock?: boolean;
362
314
  imuQuat?: Quaternion;
363
315
  };
364
316
  /**
@@ -518,7 +470,7 @@ export type X4MediaSession = {
518
470
  * "vehicleTurns": 69,
519
471
  * "vehicleTime": 68,
520
472
  * "waterTemperature": 70,
521
- * "motorsEnabled": true,
473
+ * "disableMotors": true,
522
474
  * "networkDevices": {
523
475
  * "MAC": {
524
476
  * "model": 13,
@@ -653,8 +605,7 @@ export type X4MediaSession = {
653
605
  * },
654
606
  * "driveCommands": {
655
607
  * "referenceFrame": "REFERENCE_FRAME",
656
- * "controlMode": "CONTROL_MODE",
657
- * "disableMotors": true,
608
+ * "controlMode": "CONTROL_MODE",*
658
609
  * "x": { "speed": 0, "position": 0, "enabled": false },
659
610
  * "y": { "speed": 0, "position": 0, "enabled": false },
660
611
  * "zDepth": { "speed": 0, "position": 0, "enabled": false },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.29",
3
+ "version": "1.0.30-clean-up-x4-api.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
  }