@deeptrekker/api-domain 1.0.54-x4-updates.6 → 1.0.54-x4-updates.8

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.54-x4-updates.6";
1
+ export declare const API_VERSION = "1.0.54-x4-updates.8";
@@ -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.54-x4-updates.6";
5
+ exports.API_VERSION = "1.0.54-x4-updates.8";
@@ -2,7 +2,7 @@ import { Movement } from "../../../core";
2
2
  import { DeviceModel, MotorDiagnostics, SerialDevice, Sonar, Sonar3D, StereoCamera, X4CameraHead } from "../../cameraHeads";
3
3
  import { ImpaqDriver, SensorPod, X4Light } from "../../peripherals";
4
4
  import { LightConfig, ThrusterConfig } from "./deviceAllocation";
5
- import { X4RollbackStatus, X4SoftwareVersion, X4UpdateFetchRequest, X4UpdateFetchStatus } from "./softwareUpdates";
5
+ import { X4RollbackStatus, X4SoftwareVersion, X4SoftwareUpdateRequest, X4SoftwareUpdateStatus } from "./softwareUpdates";
6
6
  export * from "./deviceAllocation";
7
7
  export * from "./softwareUpdates";
8
8
  import { CygnusType } from "../..";
@@ -925,20 +925,20 @@ export type X4 = {
925
925
  */
926
926
  lowPowerMode?: boolean;
927
927
  /**
928
- * The app sends an {@link X4UpdateFetchRequest | X4UpdateFetchRequest} to start
929
- * a Spectra update, and the vehicle reports an {@link X4UpdateFetchStatus | X4UpdateFetchStatus}.
928
+ * The app sends an {@link X4SoftwareUpdateRequest | X4SoftwareUpdateRequest} to start
929
+ * a Spectra update, and the vehicle reports an {@link X4SoftwareUpdateStatus | X4SoftwareUpdateStatus}.
930
930
  */
931
- updateFetch?: X4UpdateFetchRequest | X4UpdateFetchStatus;
931
+ softwareUpdate?: X4SoftwareUpdateRequest | X4SoftwareUpdateStatus;
932
932
  /**
933
933
  * The app sends `true` to roll back to the previous application slot, and the vehicle
934
934
  * reports an {@link X4RollbackStatus | X4RollbackStatus}.
935
935
  */
936
- rollback?: boolean | X4RollbackStatus;
936
+ softwareRollback?: boolean | X4RollbackStatus;
937
937
  /**
938
938
  * The app sends `true` to roll the OS back to the other rootfs slot, which reboots the
939
939
  * vehicle, and the vehicle reports an {@link X4RollbackStatus | X4RollbackStatus}.
940
940
  */
941
- rollbackOs?: boolean | X4RollbackStatus;
941
+ softwareRollbackOs?: boolean | X4RollbackStatus;
942
942
  /**
943
943
  * The OS and application versions installed on the vehicle. Read only.
944
944
  */
@@ -16,12 +16,12 @@ export type X4UpdateTransferSizes = {
16
16
  tools?: number;
17
17
  };
18
18
  /**
19
- * The request the app sends as `updateFetch` to start an update. The app then transfers the
19
+ * The request the app sends as `softwareUpdate` to start an update. The app then transfers the
20
20
  * files over the `UPDATE_TRANSFER` data channel.
21
21
  * @group X4
22
22
  * @category Software Updates
23
23
  */
24
- export type X4UpdateFetchRequest = {
24
+ export type X4SoftwareUpdateRequest = {
25
25
  type: X4UpdateKind;
26
26
  transfer: X4UpdateTransferSizes;
27
27
  };
@@ -39,7 +39,7 @@ export type X4UpdateState = "idle" | "running" | "succeeded" | "failed";
39
39
  */
40
40
  export type X4FirmwareState = "no_bundle" | "checking" | "flashing" | "up_to_date" | "incomplete" | "disabled";
41
41
  /**
42
- * The peripheral firmware status the vehicle reports as `updateFetch.firmware`.
42
+ * The peripheral firmware status the vehicle reports as `softwareUpdate.firmware`.
43
43
  * `flashingMac` is only present while a board is being flashed, and `failedMacs` lists the
44
44
  * boards that failed to update since the vehicle started. Board versions are in the network tree.
45
45
  * @group X4
@@ -52,28 +52,20 @@ export type X4FirmwareStatus = {
52
52
  failedMacs?: string[];
53
53
  };
54
54
  /**
55
- * The status the vehicle reports as `updateFetch`.
56
- * The progress fields are only present while the vehicle knows the total size,
57
- * and `finishedAt` only once the fetch has ended. `detail` is a code such as
55
+ * The status the vehicle reports as `softwareUpdate`. `detail` is a code such as
58
56
  * `awaiting-transfer`, `transfer-stalled` or `interrupted-by-restart`, or a sentence for logs.
59
57
  * @group X4
60
58
  * @category Software Updates
61
59
  */
62
- export type X4UpdateFetchStatus = {
60
+ export type X4SoftwareUpdateStatus = {
63
61
  state?: X4UpdateState;
64
62
  detail?: string;
65
63
  run?: string;
66
64
  type?: string;
67
- percent?: number;
68
- bytes?: number;
69
- total?: number;
70
- etaS?: number;
71
- elapsedS?: number;
72
- finishedAt?: string;
73
65
  firmware?: X4FirmwareStatus;
74
66
  };
75
67
  /**
76
- * The status the vehicle reports as `rollback` and `rollbackOs`. An OS rollback reports
68
+ * The status the vehicle reports as `softwareRollback` and `softwareRollbackOs`. An OS rollback reports
77
69
  * `succeeded` just before the vehicle reboots onto the other OS.
78
70
  * @group X4
79
71
  * @category Software Updates
@@ -82,7 +74,6 @@ export type X4RollbackStatus = {
82
74
  state?: X4UpdateState;
83
75
  detail?: string;
84
76
  run?: string;
85
- finishedAt?: string;
86
77
  };
87
78
  /**
88
79
  * The OS and application versions the vehicle reports as `softwareVersion`,
@@ -109,10 +100,10 @@ export type X4SoftwareVersion = {
109
100
  * @group X4
110
101
  * @category Software Updates
111
102
  */
112
- export type X4UpdateErrorSource = "updateFetch" | "rollback" | "rollbackOs";
103
+ export type X4UpdateErrorSource = "softwareUpdate" | "softwareRollback" | "softwareRollbackOs";
113
104
  /**
114
- * The error the vehicle sends when it refuses an `updateFetch`, `rollback` or
115
- * `rollbackOs` request. `message` is for logs only. Errors from other settings carry no `source`.
105
+ * The error the vehicle sends when it refuses a `softwareUpdate`, `softwareRollback` or
106
+ * `softwareRollbackOs` request. `message` is for logs only. Errors from other settings carry no `source`.
116
107
  * @group X4
117
108
  * @category Software Updates
118
109
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.54-x4-updates.6",
3
+ "version": "1.0.54-x4-updates.8",
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": {