@deeptrekker/api-domain 1.0.53-x4-updates.1 → 1.0.53

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.1";
1
+ export declare const API_VERSION = "1.0.53";
@@ -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.1";
5
+ exports.API_VERSION = "1.0.53";
@@ -2,9 +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, X4SystemVersion, X4UpdateFetchRequest, X4UpdateFetchStatus } from "./softwareUpdates";
6
5
  export * from "./deviceAllocation";
7
- export * from "./softwareUpdates";
8
6
  import { CygnusType } from "../..";
9
7
  import { NavigationOptions } from "../navigation";
10
8
  /**
@@ -130,6 +128,7 @@ export type X4Faults = {
130
128
  pdmMcuOvertemp: boolean;
131
129
  pdmOffline: boolean;
132
130
  pdmLeakageOvercurrent: boolean;
131
+ pdmPdmPortOffline: boolean;
133
132
  brushlessMotorMcuOvertemp: boolean;
134
133
  brushedMotorNotEnoughMessages: boolean;
135
134
  brushedMotorOvervoltage: boolean;
@@ -147,6 +146,69 @@ export type X4Faults = {
147
146
  pressureHighPressure: boolean;
148
147
  temperatureOvertemp: boolean;
149
148
  temperatureNotEnoughMessages: boolean;
149
+ thruster0Compensator: boolean;
150
+ thruster0EscNoComms: boolean;
151
+ thruster0NotEnoughMessages: boolean;
152
+ thruster0Offline: boolean;
153
+ thruster0Overcurrent: boolean;
154
+ thruster0Overtemp: boolean;
155
+ thruster0Overvoltage: boolean;
156
+ thruster0PropLoss: boolean;
157
+ thruster0Undervoltage: boolean;
158
+ thruster1Compensator: boolean;
159
+ thruster1EscNoComms: boolean;
160
+ thruster1NotEnoughMessages: boolean;
161
+ thruster1Offline: boolean;
162
+ thruster1Overcurrent: boolean;
163
+ thruster1Overtemp: boolean;
164
+ thruster1Overvoltage: boolean;
165
+ thruster1PropLoss: boolean;
166
+ thruster1Undervoltage: boolean;
167
+ thruster2Compensator: boolean;
168
+ thruster2EscNoComms: boolean;
169
+ thruster2NotEnoughMessages: boolean;
170
+ thruster2Offline: boolean;
171
+ thruster2Overcurrent: boolean;
172
+ thruster2Overtemp: boolean;
173
+ thruster2Overvoltage: boolean;
174
+ thruster2PropLoss: boolean;
175
+ thruster2Undervoltage: boolean;
176
+ thruster3Compensator: boolean;
177
+ thruster3EscNoComms: boolean;
178
+ thruster3NotEnoughMessages: boolean;
179
+ thruster3Offline: boolean;
180
+ thruster3Overcurrent: boolean;
181
+ thruster3Overtemp: boolean;
182
+ thruster3Overvoltage: boolean;
183
+ thruster3PropLoss: boolean;
184
+ thruster3Undervoltage: boolean;
185
+ thruster4Compensator: boolean;
186
+ thruster4EscNoComms: boolean;
187
+ thruster4NotEnoughMessages: boolean;
188
+ thruster4Offline: boolean;
189
+ thruster4Overcurrent: boolean;
190
+ thruster4Overtemp: boolean;
191
+ thruster4Overvoltage: boolean;
192
+ thruster4PropLoss: boolean;
193
+ thruster4Undervoltage: boolean;
194
+ thruster5Compensator: boolean;
195
+ thruster5EscNoComms: boolean;
196
+ thruster5NotEnoughMessages: boolean;
197
+ thruster5Offline: boolean;
198
+ thruster5Overcurrent: boolean;
199
+ thruster5Overtemp: boolean;
200
+ thruster5Overvoltage: boolean;
201
+ thruster5PropLoss: boolean;
202
+ thruster5Undervoltage: boolean;
203
+ thruster6Compensator: boolean;
204
+ thruster6EscNoComms: boolean;
205
+ thruster6NotEnoughMessages: boolean;
206
+ thruster6Offline: boolean;
207
+ thruster6Overcurrent: boolean;
208
+ thruster6Overtemp: boolean;
209
+ thruster6Overvoltage: boolean;
210
+ thruster6PropLoss: boolean;
211
+ thruster6Undervoltage: boolean;
150
212
  sfpMcuOvertemp: boolean;
151
213
  };
152
214
  /**
@@ -860,18 +922,4 @@ export type X4 = {
860
922
  * Low power mode for the vehicle
861
923
  */
862
924
  lowPowerMode?: boolean;
863
- /**
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.
875
- */
876
- systemVersion?: X4SystemVersion;
877
925
  };
@@ -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.1",
3
+ "version": "1.0.53",
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",
40
42
  "@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",
41
46
  "prettier": "3.0.3",
42
47
  "rimraf": "^3.0.2",
43
48
  "semver-compare-cli": "^2.0.0",
44
49
  "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,6 +62,7 @@
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"
65
+ "type-zoo": "^3.4.1",
66
+ "yarn": "^1.22.22"
66
67
  }
67
68
  }
@@ -1,120 +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
- transport: "http";
27
- toolsUrl?: string;
28
- manifestUrl?: string;
29
- signatureUrl?: string;
30
- };
31
- /**
32
- * Asks the vehicle to receive an update that the app uploads over the data channel.
33
- * @group X4
34
- * @category Software Updates
35
- */
36
- export type X4UpdateFetchUploadRequest = {
37
- type: X4UpdateKind;
38
- transport: "datachannel";
39
- upload: X4UpdateUploadSizes;
40
- };
41
- /**
42
- * Cancels the update fetch in progress.
43
- * @group X4
44
- * @category Software Updates
45
- */
46
- export type X4UpdateFetchCancelRequest = {
47
- cancel: true;
48
- };
49
- /**
50
- * A request the app sends as `updateFetch`.
51
- * @group X4
52
- * @category Software Updates
53
- */
54
- export type X4UpdateFetchRequest = X4UpdateFetchUrlRequest | X4UpdateFetchUploadRequest | X4UpdateFetchCancelRequest;
55
- /**
56
- * The state of an update fetch as the vehicle reports it.
57
- * @group X4
58
- * @category Software Updates
59
- */
60
- export type X4UpdateFetchState = "idle" | "requested" | "starting" | "downloading" | "verifying" | "applying" | "staging" | "staged" | "applied" | "cancelling" | "cancelled" | "failed" | "unknown";
61
- /**
62
- * The status the vehicle reports as `updateFetch`.
63
- * The progress fields are only present while the vehicle knows the total size,
64
- * and `finished_at` only once the fetch has ended.
65
- * @group X4
66
- * @category Software Updates
67
- */
68
- export type X4UpdateFetchStatus = {
69
- state?: X4UpdateFetchState;
70
- detail?: string;
71
- run?: string;
72
- url?: string;
73
- type?: string;
74
- cancellable?: boolean;
75
- percent?: number;
76
- bytes?: number;
77
- total?: number;
78
- eta_s?: number;
79
- elapsed_s?: number;
80
- finished_at?: string;
81
- };
82
- /**
83
- * The state of a rollback as the vehicle reports it.
84
- * @group X4
85
- * @category Software Updates
86
- */
87
- export type X4RollbackState = "idle" | "requested" | "running" | "succeeded" | "failed" | "unknown";
88
- /**
89
- * The status the vehicle reports as `rollback`. `from` and `to` are application slots.
90
- * @group X4
91
- * @category Software Updates
92
- */
93
- export type X4RollbackStatus = {
94
- state?: X4RollbackState;
95
- detail?: string;
96
- run?: string;
97
- from?: string;
98
- to?: string;
99
- finished_at?: string;
100
- };
101
- /**
102
- * The OS and application versions the vehicle reports as `systemVersion`,
103
- * including the previous application slot that a rollback would return to.
104
- * @group X4
105
- * @category Software Updates
106
- */
107
- export type X4SystemVersion = {
108
- osHash?: string;
109
- osVersion?: string;
110
- appSlot?: string;
111
- appVersion?: string;
112
- appBuildDate?: string;
113
- appBranch?: string;
114
- appCommit?: string;
115
- appBuiltVersion?: string;
116
- rollbackSlot?: string;
117
- rollbackVersion?: string;
118
- rollbackBuildDate?: string;
119
- rollbackAvailable?: boolean;
120
- };
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });