@deeptrekker/api-domain 1.0.5-rca-1594-add-photogrammetry-support-for.3 → 1.0.6-imu-quat-msg.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.5-rca-1594-add-photogrammetry-support-for.3";
1
+ export declare const API_VERSION = "1.0.6-imu-quat-msg.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.5-rca-1594-add-photogrammetry-support-for.3";
5
+ exports.API_VERSION = "1.0.6-imu-quat-msg.0";
@@ -231,19 +231,6 @@ export type TransferError = {
231
231
  */
232
232
  message: string;
233
233
  };
234
- /**
235
- * Error message from the Bridge Box
236
- * @category Core
237
- * @group X4
238
- */
239
- export type OnBoardRecording = {
240
- /**
241
- * Snapshots, holds the values for onBoard snapshots, enabled dictating if they're on.
242
- */
243
- snapshots: {
244
- enabled: boolean;
245
- };
246
- };
247
234
  /**
248
235
  * Error Codes
249
236
  * @category Core
@@ -368,7 +368,6 @@ export type UsageTime = {
368
368
  * @group Devices
369
369
  */
370
370
  export declare enum SnapshotIntervals {
371
- HALF = 0.5,
372
371
  ONE = 1,
373
372
  TWO = 2,
374
373
  THREE = 3,
@@ -97,7 +97,6 @@ var PivotRotaryPosition;
97
97
  */
98
98
  var SnapshotIntervals;
99
99
  (function (SnapshotIntervals) {
100
- SnapshotIntervals[SnapshotIntervals["HALF"] = 0.5] = "HALF";
101
100
  SnapshotIntervals[SnapshotIntervals["ONE"] = 1] = "ONE";
102
101
  SnapshotIntervals[SnapshotIntervals["TWO"] = 2] = "TWO";
103
102
  SnapshotIntervals[SnapshotIntervals["THREE"] = 3] = "THREE";
@@ -1,4 +1,4 @@
1
- import { OnBoardRecording, Movement } from "../../../core";
1
+ import { Movement } from "../../../core";
2
2
  import { DeviceModel, MotorDiagnostics, Sonar, StereoCamera, X4CameraHead } from "../../cameraHeads";
3
3
  import { SensorPod, X4Light } from "../../peripherals";
4
4
  /**
@@ -23,6 +23,12 @@ export declare enum ControlMode {
23
23
  ClosedLoop = "CLOSED_LOOP",
24
24
  Adaptive = "ADAPTIVE"
25
25
  }
26
+ export type Quaternion = {
27
+ w: number;
28
+ x: number;
29
+ y: number;
30
+ z: number;
31
+ };
26
32
  /**
27
33
  * A network device structure that includes properties such as IP address, model, hardware, and time tracking.
28
34
  * This structure is used to represent devices that are part of the X4 vehicle's network.
@@ -314,6 +320,7 @@ export type X4Position = {
314
320
  * @readonly
315
321
  */
316
322
  headingLock?: boolean;
323
+ imuQuat?: Quaternion;
317
324
  };
318
325
  /**
319
326
  * The X4 tracked position type.
@@ -446,6 +453,7 @@ export type PCM = {
446
453
  * "vehicleTurns": 69,
447
454
  * "vehicleTime": 68,
448
455
  * "waterTemperature": 70,
456
+ * "motorsEnabled": true,
449
457
  * "networkDevices": {
450
458
  * "MAC": {
451
459
  * "model": 13,
@@ -632,6 +640,19 @@ export type X4 = {
632
640
  * @readonly
633
641
  */
634
642
  networkDevices?: Record<string, NetworkDevice>;
643
+ /**
644
+ * Indicates whether the vehicle's motors are currently enabled.
645
+ * When set to false, all thruster motors are disabled and will not
646
+ * accept commands.
647
+ *
648
+ * @example
649
+ * ```json
650
+ * {
651
+ * "motorsEnabled": true
652
+ * }
653
+ * ```
654
+ */
655
+ motorsEnabled?: boolean;
635
656
  /**
636
657
  * A record of sensor pods associated with the X4 vehicle.
637
658
  * Each sensor pod is identified by its unique MAC address and contains properties such as IMU calibration,
@@ -729,9 +750,4 @@ export type X4 = {
729
750
  * The current water temperature around the vehicle.
730
751
  */
731
752
  waterTemperature?: number;
732
- /**
733
- * Indicates that autoSnapshots has been set. Sending a enabled command for will turn on autoSnapshots, disabled turning it off.
734
- *
735
- */
736
- onBoardRecording?: OnBoardRecording;
737
753
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.5-rca-1594-add-photogrammetry-support-for.3",
3
+ "version": "1.0.6-imu-quat-msg.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": {