@deeptrekker/api-domain 1.0.53-x4-updates.0 → 1.0.53-x4-system-settings.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.53-x4-updates.0";
1
+ export declare const API_VERSION = "1.0.53-x4-system-settings.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.53-x4-updates.0";
5
+ exports.API_VERSION = "1.0.53-x4-system-settings.0";
@@ -2,10 +2,9 @@ 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, X4SystemVersion, X4UpdateFetchRequest, X4UpdateFetchStatus } from "./softwareUpdates";
6
5
  export * from "./deviceAllocation";
7
- export * from "./softwareUpdates";
8
6
  import { CygnusType } from "../..";
7
+ import { SystemSettings } from "../../../clients";
9
8
  import { NavigationOptions } from "../navigation";
10
9
  /**
11
10
  * The coordinate system used for navigation and positioning.
@@ -861,17 +860,11 @@ export type X4 = {
861
860
  */
862
861
  lowPowerMode?: boolean;
863
862
  /**
864
- * The app sends an {@link X4UpdateFetchRequest | X4UpdateFetchRequest} to start or cancel
865
- * a Spectra update, and the vehicle reports an {@link X4UpdateFetchStatus | X4UpdateFetchStatus}.
866
- */
867
- updateFetch?: X4UpdateFetchRequest | X4UpdateFetchStatus;
868
- /**
869
- * The app sends `true` to roll back to the previous application slot, and the vehicle
870
- * reports an {@link X4RollbackStatus | X4RollbackStatus}.
871
- */
872
- rollback?: boolean | X4RollbackStatus;
873
- /**
874
- * The OS and application versions installed on the vehicle. Read only.
863
+ * @remarks
864
+ * The X4 accepts `dateTime.timestamp` only. It corrects its clock when it is 30 s or more off and out of the
865
+ * water, then restarts its ROS stack. `networkTimeSync` is always false because the X4 has no network time source.
866
+ *
867
+ * @see {@link SystemSettings | SystemSettings}
875
868
  */
876
- systemVersion?: X4SystemVersion;
869
+ systemSettings?: SystemSettings;
877
870
  };
@@ -16,7 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  exports.ControlMode = exports.CoordinateType = void 0;
18
18
  __exportStar(require("./deviceAllocation"), exports);
19
- __exportStar(require("./softwareUpdates"), exports);
20
19
  /**
21
20
  * The coordinate system used for navigation and positioning.
22
21
  * @internal
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.53-x4-updates.0",
3
+ "version": "1.0.53-x4-system-settings.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": {
@@ -1,119 +0,0 @@
1
- /**
2
- * The kind of Spectra update. A minor update replaces the ROS application, a major update replaces the OS.
3
- * @group X4
4
- * @category Software Updates
5
- */
6
- export type X4UpdateKind = "minor" | "major";
7
- /**
8
- * The sizes in bytes of the files the app will upload over the data channel.
9
- * @group X4
10
- * @category Software Updates
11
- */
12
- export type X4UpdateUploadSizes = {
13
- payload?: number;
14
- manifest?: number;
15
- signature?: number;
16
- tools?: number;
17
- };
18
- /**
19
- * Asks the vehicle to download an update from a URL.
20
- * @group X4
21
- * @category Software Updates
22
- */
23
- export type X4UpdateFetchUrlRequest = {
24
- url: string;
25
- type: X4UpdateKind;
26
- toolsUrl?: string;
27
- manifestUrl?: string;
28
- signatureUrl?: string;
29
- };
30
- /**
31
- * Asks the vehicle to receive an update that the app uploads over the data channel.
32
- * @group X4
33
- * @category Software Updates
34
- */
35
- export type X4UpdateFetchUploadRequest = {
36
- type: X4UpdateKind;
37
- transport: "datachannel";
38
- upload: X4UpdateUploadSizes;
39
- };
40
- /**
41
- * Cancels the update fetch in progress.
42
- * @group X4
43
- * @category Software Updates
44
- */
45
- export type X4UpdateFetchCancelRequest = {
46
- cancel: true;
47
- };
48
- /**
49
- * A request the app sends as `updateFetch`.
50
- * @group X4
51
- * @category Software Updates
52
- */
53
- export type X4UpdateFetchRequest = X4UpdateFetchUrlRequest | X4UpdateFetchUploadRequest | X4UpdateFetchCancelRequest;
54
- /**
55
- * The state of an update fetch as the vehicle reports it.
56
- * @group X4
57
- * @category Software Updates
58
- */
59
- export type X4UpdateFetchState = "idle" | "requested" | "starting" | "downloading" | "verifying" | "applying" | "staging" | "staged" | "applied" | "cancelling" | "cancelled" | "failed" | "unknown";
60
- /**
61
- * The status the vehicle reports as `updateFetch`.
62
- * The progress fields are only present while the vehicle knows the total size,
63
- * and `finished_at` only once the fetch has ended.
64
- * @group X4
65
- * @category Software Updates
66
- */
67
- export type X4UpdateFetchStatus = {
68
- state?: X4UpdateFetchState;
69
- detail?: string;
70
- run?: string;
71
- url?: string;
72
- type?: string;
73
- cancellable?: boolean;
74
- percent?: number;
75
- bytes?: number;
76
- total?: number;
77
- eta_s?: number;
78
- elapsed_s?: number;
79
- finished_at?: string;
80
- };
81
- /**
82
- * The state of a rollback as the vehicle reports it.
83
- * @group X4
84
- * @category Software Updates
85
- */
86
- export type X4RollbackState = "idle" | "requested" | "running" | "succeeded" | "failed" | "unknown";
87
- /**
88
- * The status the vehicle reports as `rollback`. `from` and `to` are application slots.
89
- * @group X4
90
- * @category Software Updates
91
- */
92
- export type X4RollbackStatus = {
93
- state?: X4RollbackState;
94
- detail?: string;
95
- run?: string;
96
- from?: string;
97
- to?: string;
98
- finished_at?: string;
99
- };
100
- /**
101
- * The OS and application versions the vehicle reports as `systemVersion`,
102
- * including the previous application slot that a rollback would return to.
103
- * @group X4
104
- * @category Software Updates
105
- */
106
- export type X4SystemVersion = {
107
- osHash?: string;
108
- osVersion?: string;
109
- appSlot?: string;
110
- appVersion?: string;
111
- appBuildDate?: string;
112
- appBranch?: string;
113
- appCommit?: string;
114
- appBuiltVersion?: string;
115
- rollbackSlot?: string;
116
- rollbackVersion?: string;
117
- rollbackBuildDate?: string;
118
- rollbackAvailable?: boolean;
119
- };
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });