@deeptrekker/api-domain 1.0.54-x4-updates.1 → 1.0.54-x4-updates.3
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.
|
|
1
|
+
export declare const API_VERSION = "1.0.54-x4-updates.3";
|
|
@@ -5,18 +5,18 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export type X4UpdateKind = "minor" | "major";
|
|
7
7
|
/**
|
|
8
|
-
* The sizes in bytes of the files the app
|
|
8
|
+
* The sizes in bytes of the files the app transfers to the vehicle over the data channel.
|
|
9
9
|
* @group X4
|
|
10
10
|
* @category Software Updates
|
|
11
11
|
*/
|
|
12
|
-
export type
|
|
12
|
+
export type X4UpdateTransferSizes = {
|
|
13
13
|
payload?: number;
|
|
14
14
|
manifest?: number;
|
|
15
15
|
signature?: number;
|
|
16
16
|
tools?: number;
|
|
17
17
|
};
|
|
18
18
|
/**
|
|
19
|
-
* Asks the vehicle to
|
|
19
|
+
* Asks the vehicle to fetch an update from a URL itself.
|
|
20
20
|
* @group X4
|
|
21
21
|
* @category Software Updates
|
|
22
22
|
*/
|
|
@@ -29,14 +29,15 @@ export type X4UpdateFetchUrlRequest = {
|
|
|
29
29
|
signatureUrl?: string;
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* Asks the vehicle to receive an update that the app
|
|
32
|
+
* Asks the vehicle to receive an update that the app transfers over the `UPDATE_TRANSFER`
|
|
33
|
+
* data channel.
|
|
33
34
|
* @group X4
|
|
34
35
|
* @category Software Updates
|
|
35
36
|
*/
|
|
36
|
-
export type
|
|
37
|
+
export type X4UpdateFetchTransferRequest = {
|
|
37
38
|
type: X4UpdateKind;
|
|
38
39
|
transport: "datachannel";
|
|
39
|
-
|
|
40
|
+
transfer: X4UpdateTransferSizes;
|
|
40
41
|
};
|
|
41
42
|
/**
|
|
42
43
|
* Cancels the update fetch in progress.
|
|
@@ -51,17 +52,37 @@ export type X4UpdateFetchCancelRequest = {
|
|
|
51
52
|
* @group X4
|
|
52
53
|
* @category Software Updates
|
|
53
54
|
*/
|
|
54
|
-
export type X4UpdateFetchRequest = X4UpdateFetchUrlRequest |
|
|
55
|
+
export type X4UpdateFetchRequest = X4UpdateFetchUrlRequest | X4UpdateFetchTransferRequest | X4UpdateFetchCancelRequest;
|
|
55
56
|
/**
|
|
56
57
|
* The state of an update fetch as the vehicle reports it.
|
|
57
58
|
* @group X4
|
|
58
59
|
* @category Software Updates
|
|
59
60
|
*/
|
|
60
|
-
export type X4UpdateFetchState = "idle" | "
|
|
61
|
+
export type X4UpdateFetchState = "idle" | "starting" | "transferring" | "verifying" | "applying" | "staging" | "staged" | "applied" | "cancelling" | "cancelled" | "failed" | "unknown";
|
|
62
|
+
/**
|
|
63
|
+
* The state of the vehicle's peripheral firmware as it reports it.
|
|
64
|
+
* @group X4
|
|
65
|
+
* @category Software Updates
|
|
66
|
+
*/
|
|
67
|
+
export type X4FirmwareState = "no_bundle" | "checking" | "flashing" | "up_to_date" | "incomplete" | "disabled";
|
|
68
|
+
/**
|
|
69
|
+
* The peripheral firmware status the vehicle reports as `updateFetch.firmware`.
|
|
70
|
+
* `flashingMac` is only present while a board is being flashed, and `failedMacs` lists the
|
|
71
|
+
* boards that failed to update since the vehicle started. Board versions are in the network tree.
|
|
72
|
+
* @group X4
|
|
73
|
+
* @category Software Updates
|
|
74
|
+
*/
|
|
75
|
+
export type X4FirmwareStatus = {
|
|
76
|
+
state?: X4FirmwareState;
|
|
77
|
+
bundleVersion?: string;
|
|
78
|
+
flashingMac?: string;
|
|
79
|
+
failedMacs?: string[];
|
|
80
|
+
};
|
|
61
81
|
/**
|
|
62
82
|
* The status the vehicle reports as `updateFetch`.
|
|
63
83
|
* The progress fields are only present while the vehicle knows the total size,
|
|
64
|
-
* and `finishedAt` only once the fetch has ended.
|
|
84
|
+
* and `finishedAt` only once the fetch has ended. `detail` is a code such as
|
|
85
|
+
* `awaiting-transfer`, `transfer-stalled` or `interrupted-by-restart`, or a sentence for logs.
|
|
65
86
|
* @group X4
|
|
66
87
|
* @category Software Updates
|
|
67
88
|
*/
|
|
@@ -77,13 +98,14 @@ export type X4UpdateFetchStatus = {
|
|
|
77
98
|
etaS?: number;
|
|
78
99
|
elapsedS?: number;
|
|
79
100
|
finishedAt?: string;
|
|
101
|
+
firmware?: X4FirmwareStatus;
|
|
80
102
|
};
|
|
81
103
|
/**
|
|
82
104
|
* The state of a rollback as the vehicle reports it.
|
|
83
105
|
* @group X4
|
|
84
106
|
* @category Software Updates
|
|
85
107
|
*/
|
|
86
|
-
export type X4RollbackState = "idle" | "
|
|
108
|
+
export type X4RollbackState = "idle" | "running" | "succeeded" | "failed" | "rolled-back-os" | "unknown";
|
|
87
109
|
/**
|
|
88
110
|
* The status the vehicle reports as `rollback` and `rollbackOs`. An OS rollback ends in
|
|
89
111
|
* `rolled-back-os` just before the vehicle reboots onto the other OS.
|
|
@@ -121,7 +143,7 @@ export type X4SystemVersion = {
|
|
|
121
143
|
* @group X4
|
|
122
144
|
* @category Software Updates
|
|
123
145
|
*/
|
|
124
|
-
export type X4UpdateRefusalReason = "update-in-progress" | "rollback-in-progress" | "firmware-flashing" | "
|
|
146
|
+
export type X4UpdateRefusalReason = "update-in-progress" | "rollback-in-progress" | "firmware-flashing" | "cancel-refused" | "cancel-failed" | "invalid-request" | "unavailable" | "refused";
|
|
125
147
|
/**
|
|
126
148
|
* The API setting a software update error came from.
|
|
127
149
|
* @group X4
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deeptrekker/api-domain",
|
|
3
|
-
"version": "1.0.54-x4-updates.
|
|
3
|
+
"version": "1.0.54-x4-updates.3",
|
|
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": {
|