@deeptrekker/api-domain 1.0.24 → 1.0.26

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.
@@ -2404,7 +2404,7 @@
2404
2404
  "description": "Power Tool Generation 3 power tool that rotates and spins.",
2405
2405
  "properties": {
2406
2406
  "authorized": {
2407
- "description": "Flag to gain authorization to operate the power tool. This is an added layer of security since power tool can cause harm to humans and components.\n\nAuthorization is requested by setting this flag to true. \n\nIf the power tool is not used for over 60 seconds, the user looses Authorization and must request it again.",
2407
+ "description": "Flag to gain authorization to operate the power tool. This is an added layer of security since power tool can cause harm to humans and components.\n\nAuthorization is requested by setting this flag to true.\n\nIf the power tool is not used for over 60 seconds, the user looses Authorization and must request it again.",
2408
2408
  "type": "boolean"
2409
2409
  },
2410
2410
  "enabled": {
@@ -3517,6 +3517,9 @@
3517
3517
  "additionalProperties": false,
3518
3518
  "description": "The tilt platform on the pivot.",
3519
3519
  "properties": {
3520
+ "limitStatus": {
3521
+ "$ref": "#/definitions/TiltPlatformMaxRange"
3522
+ },
3520
3523
  "tilt": {
3521
3524
  "type": "number"
3522
3525
  },
@@ -3527,6 +3530,19 @@
3527
3530
  },
3528
3531
  "type": "object"
3529
3532
  },
3533
+ "TiltPlatformMaxRange": {
3534
+ "additionalProperties": false,
3535
+ "description": "Max range of tilt platform",
3536
+ "properties": {
3537
+ "downLimitReached": {
3538
+ "type": "boolean"
3539
+ },
3540
+ "upLimitReached": {
3541
+ "type": "boolean"
3542
+ }
3543
+ },
3544
+ "type": "object"
3545
+ },
3530
3546
  "TopPositionSources": {
3531
3547
  "description": "Enumerates the possible topside location provider sources available to the Web App.",
3532
3548
  "enum": [
@@ -1 +1 @@
1
- export declare const API_VERSION = "1.0.24";
1
+ export declare const API_VERSION = "1.0.26";
@@ -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.24";
5
+ exports.API_VERSION = "1.0.26";
@@ -283,12 +283,27 @@ export type PowerTool = {
283
283
  */
284
284
  spin?: number;
285
285
  };
286
+ /**
287
+ * Max range of tilt platform
288
+ * @group PIVOT
289
+ * @category Peripherals
290
+ */
291
+ export type TiltPlatformMaxRange = {
292
+ downLimitReached?: boolean;
293
+ upLimitReached?: boolean;
294
+ };
286
295
  /**
287
296
  * The tilt platform on the pivot.
288
297
  * @group PIVOT
289
298
  * @category Peripherals
290
299
  */
291
300
  export type TiltPlatform = {
301
+ /**
302
+ * @remarks
303
+ * Max range of tilt
304
+ *
305
+ */
306
+ limitStatus?: TiltPlatformMaxRange;
292
307
  /**
293
308
  * @remarks
294
309
  * The tilt angle of the platform.
@@ -301,3 +316,25 @@ export type TiltPlatform = {
301
316
  */
302
317
  tiltMotorDiagnostics?: MotorDiagnostics;
303
318
  };
319
+ /**
320
+ * @group SPECTRA
321
+ * @category Peripherals
322
+ */
323
+ export type ImpaqDriver = {
324
+ /**
325
+ * speed
326
+ *
327
+ * @remarks IMPAQ speed (in percentage)
328
+
329
+ * @example
330
+ * ```json
331
+ * {
332
+ * "speed": 50
333
+ * }
334
+ * ```
335
+ * @minimum 0
336
+ * @maximum 100
337
+ *
338
+ */
339
+ speed?: number;
340
+ };
@@ -1,6 +1,6 @@
1
1
  import { Movement } from "../../../core";
2
2
  import { DeviceModel, MotorDiagnostics, Sonar, StereoCamera, X4CameraHead } from "../../cameraHeads";
3
- import { SensorPod, X4Light } from "../../peripherals";
3
+ import { ImpaqDriver, SensorPod, X4Light } from "../../peripherals";
4
4
  /**
5
5
  * The coordinate system used for navigation and positioning.
6
6
  * @internal
@@ -784,6 +784,10 @@ export type X4 = {
784
784
  * @readonly
785
785
  */
786
786
  pcms?: Record<string, PCM>;
787
+ /**
788
+ * IMPAQ driver contains property such as enabled and speed
789
+ */
790
+ impaqDriver?: ImpaqDriver;
787
791
  /**
788
792
  * The current drive command for the X4 vehicle.
789
793
  * It includes properties for controlling the vehicle's movement in various directions (forward, lateral, vertical depth, roll, pitch, yaw).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
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": {