@blueyerobotics/protocol-definitions 3.2.0-35603a2b → 3.2.0-45dcae42
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.
- package/LICENSE +165 -0
- package/README.npm.md +40 -0
- package/dist/control.d.ts +6 -2
- package/dist/control.js +39 -8
- package/dist/message_formats.d.ts +140 -9
- package/dist/message_formats.js +733 -13
- package/dist/telemetry.d.ts +17 -1
- package/dist/telemetry.js +145 -1
- package/package.json +8 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
GNU LESSER GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 3, 29 June 2007
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
5
|
+
Everyone is permitted to copy and distribute verbatim copies
|
|
6
|
+
of this license document, but changing it is not allowed.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
This version of the GNU Lesser General Public License incorporates
|
|
10
|
+
the terms and conditions of version 3 of the GNU General Public
|
|
11
|
+
License, supplemented by the additional permissions listed below.
|
|
12
|
+
|
|
13
|
+
0. Additional Definitions.
|
|
14
|
+
|
|
15
|
+
As used herein, "this License" refers to version 3 of the GNU Lesser
|
|
16
|
+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
|
17
|
+
General Public License.
|
|
18
|
+
|
|
19
|
+
"The Library" refers to a covered work governed by this License,
|
|
20
|
+
other than an Application or a Combined Work as defined below.
|
|
21
|
+
|
|
22
|
+
An "Application" is any work that makes use of an interface provided
|
|
23
|
+
by the Library, but which is not otherwise based on the Library.
|
|
24
|
+
Defining a subclass of a class defined by the Library is deemed a mode
|
|
25
|
+
of using an interface provided by the Library.
|
|
26
|
+
|
|
27
|
+
A "Combined Work" is a work produced by combining or linking an
|
|
28
|
+
Application with the Library. The particular version of the Library
|
|
29
|
+
with which the Combined Work was made is also called the "Linked
|
|
30
|
+
Version".
|
|
31
|
+
|
|
32
|
+
The "Minimal Corresponding Source" for a Combined Work means the
|
|
33
|
+
Corresponding Source for the Combined Work, excluding any source code
|
|
34
|
+
for portions of the Combined Work that, considered in isolation, are
|
|
35
|
+
based on the Application, and not on the Linked Version.
|
|
36
|
+
|
|
37
|
+
The "Corresponding Application Code" for a Combined Work means the
|
|
38
|
+
object code and/or source code for the Application, including any data
|
|
39
|
+
and utility programs needed for reproducing the Combined Work from the
|
|
40
|
+
Application, but excluding the System Libraries of the Combined Work.
|
|
41
|
+
|
|
42
|
+
1. Exception to Section 3 of the GNU GPL.
|
|
43
|
+
|
|
44
|
+
You may convey a covered work under sections 3 and 4 of this License
|
|
45
|
+
without being bound by section 3 of the GNU GPL.
|
|
46
|
+
|
|
47
|
+
2. Conveying Modified Versions.
|
|
48
|
+
|
|
49
|
+
If you modify a copy of the Library, and, in your modifications, a
|
|
50
|
+
facility refers to a function or data to be supplied by an Application
|
|
51
|
+
that uses the facility (other than as an argument passed when the
|
|
52
|
+
facility is invoked), then you may convey a copy of the modified
|
|
53
|
+
version:
|
|
54
|
+
|
|
55
|
+
a) under this License, provided that you make a good faith effort to
|
|
56
|
+
ensure that, in the event an Application does not supply the
|
|
57
|
+
function or data, the facility still operates, and performs
|
|
58
|
+
whatever part of its purpose remains meaningful, or
|
|
59
|
+
|
|
60
|
+
b) under the GNU GPL, with none of the additional permissions of
|
|
61
|
+
this License applicable to that copy.
|
|
62
|
+
|
|
63
|
+
3. Object Code Incorporating Material from Library Header Files.
|
|
64
|
+
|
|
65
|
+
The object code form of an Application may incorporate material from
|
|
66
|
+
a header file that is part of the Library. You may convey such object
|
|
67
|
+
code under terms of your choice, provided that, if the incorporated
|
|
68
|
+
material is not limited to numerical parameters, data structure
|
|
69
|
+
layouts and accessors, or small macros, inline functions and templates
|
|
70
|
+
(ten or fewer lines in length), you do both of the following:
|
|
71
|
+
|
|
72
|
+
a) Give prominent notice with each copy of the object code that the
|
|
73
|
+
Library is used in it and that the Library and its use are
|
|
74
|
+
covered by this License.
|
|
75
|
+
|
|
76
|
+
b) Accompany the object code with a copy of the GNU GPL and this license
|
|
77
|
+
document.
|
|
78
|
+
|
|
79
|
+
4. Combined Works.
|
|
80
|
+
|
|
81
|
+
You may convey a Combined Work under terms of your choice that,
|
|
82
|
+
taken together, effectively do not restrict modification of the
|
|
83
|
+
portions of the Library contained in the Combined Work and reverse
|
|
84
|
+
engineering for debugging such modifications, if you also do each of
|
|
85
|
+
the following:
|
|
86
|
+
|
|
87
|
+
a) Give prominent notice with each copy of the Combined Work that
|
|
88
|
+
the Library is used in it and that the Library and its use are
|
|
89
|
+
covered by this License.
|
|
90
|
+
|
|
91
|
+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
|
92
|
+
document.
|
|
93
|
+
|
|
94
|
+
c) For a Combined Work that displays copyright notices during
|
|
95
|
+
execution, include the copyright notice for the Library among
|
|
96
|
+
these notices, as well as a reference directing the user to the
|
|
97
|
+
copies of the GNU GPL and this license document.
|
|
98
|
+
|
|
99
|
+
d) Do one of the following:
|
|
100
|
+
|
|
101
|
+
0) Convey the Minimal Corresponding Source under the terms of this
|
|
102
|
+
License, and the Corresponding Application Code in a form
|
|
103
|
+
suitable for, and under terms that permit, the user to
|
|
104
|
+
recombine or relink the Application with a modified version of
|
|
105
|
+
the Linked Version to produce a modified Combined Work, in the
|
|
106
|
+
manner specified by section 6 of the GNU GPL for conveying
|
|
107
|
+
Corresponding Source.
|
|
108
|
+
|
|
109
|
+
1) Use a suitable shared library mechanism for linking with the
|
|
110
|
+
Library. A suitable mechanism is one that (a) uses at run time
|
|
111
|
+
a copy of the Library already present on the user's computer
|
|
112
|
+
system, and (b) will operate properly with a modified version
|
|
113
|
+
of the Library that is interface-compatible with the Linked
|
|
114
|
+
Version.
|
|
115
|
+
|
|
116
|
+
e) Provide Installation Information, but only if you would otherwise
|
|
117
|
+
be required to provide such information under section 6 of the
|
|
118
|
+
GNU GPL, and only to the extent that such information is
|
|
119
|
+
necessary to install and execute a modified version of the
|
|
120
|
+
Combined Work produced by recombining or relinking the
|
|
121
|
+
Application with a modified version of the Linked Version. (If
|
|
122
|
+
you use option 4d0, the Installation Information must accompany
|
|
123
|
+
the Minimal Corresponding Source and Corresponding Application
|
|
124
|
+
Code. If you use option 4d1, you must provide the Installation
|
|
125
|
+
Information in the manner specified by section 6 of the GNU GPL
|
|
126
|
+
for conveying Corresponding Source.)
|
|
127
|
+
|
|
128
|
+
5. Combined Libraries.
|
|
129
|
+
|
|
130
|
+
You may place library facilities that are a work based on the
|
|
131
|
+
Library side by side in a single library together with other library
|
|
132
|
+
facilities that are not Applications and are not covered by this
|
|
133
|
+
License, and convey such a combined library under terms of your
|
|
134
|
+
choice, if you do both of the following:
|
|
135
|
+
|
|
136
|
+
a) Accompany the combined library with a copy of the same work based
|
|
137
|
+
on the Library, uncombined with any other library facilities,
|
|
138
|
+
conveyed under the terms of this License.
|
|
139
|
+
|
|
140
|
+
b) Give prominent notice with the combined library that part of it
|
|
141
|
+
is a work based on the Library, and explaining where to find the
|
|
142
|
+
accompanying uncombined form of the same work.
|
|
143
|
+
|
|
144
|
+
6. Revised Versions of the GNU Lesser General Public License.
|
|
145
|
+
|
|
146
|
+
The Free Software Foundation may publish revised and/or new versions
|
|
147
|
+
of the GNU Lesser General Public License from time to time. Such new
|
|
148
|
+
versions will be similar in spirit to the present version, but may
|
|
149
|
+
differ in detail to address new problems or concerns.
|
|
150
|
+
|
|
151
|
+
Each version is given a distinguishing version number. If the
|
|
152
|
+
Library as you received it specifies that a certain numbered version
|
|
153
|
+
of the GNU Lesser General Public License "or any later version"
|
|
154
|
+
applies to it, you have the option of following the terms and
|
|
155
|
+
conditions either of that published version or of any later version
|
|
156
|
+
published by the Free Software Foundation. If the Library as you
|
|
157
|
+
received it does not specify a version number of the GNU Lesser
|
|
158
|
+
General Public License, you may choose any version of the GNU Lesser
|
|
159
|
+
General Public License ever published by the Free Software Foundation.
|
|
160
|
+
|
|
161
|
+
If the Library as you received it specifies that a proxy can decide
|
|
162
|
+
whether future versions of the GNU Lesser General Public License shall
|
|
163
|
+
apply, that proxy's public statement of acceptance of any version is
|
|
164
|
+
permanent authorization for you to choose that version for the
|
|
165
|
+
Library.
|
package/README.npm.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @blueyerobotics/protocol-definitions
|
|
2
|
+
|
|
3
|
+
TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @blueyerobotics/protocol-definitions
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { blueye } from "@blueyerobotics/protocol-definitions";
|
|
15
|
+
|
|
16
|
+
// Create a new GetBatteryReq message
|
|
17
|
+
const request = blueye.protocol.GetBatteryReq.create();
|
|
18
|
+
|
|
19
|
+
// Serialize the message to a Uint8Array (binary)
|
|
20
|
+
const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
|
|
21
|
+
|
|
22
|
+
// ...
|
|
23
|
+
|
|
24
|
+
// For demonstration, we will simulate a response from the device
|
|
25
|
+
const response = blueye.protocol.GetBatteryRep.create({
|
|
26
|
+
battery: {
|
|
27
|
+
level: 85,
|
|
28
|
+
voltage: 12.5,
|
|
29
|
+
temperature: 25,
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
|
|
34
|
+
|
|
35
|
+
// Decode a binary response back into a message
|
|
36
|
+
const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
|
|
37
|
+
|
|
38
|
+
// Access fields
|
|
39
|
+
console.log(decoded.battery?.level);
|
|
40
|
+
```
|
package/dist/control.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
2
|
import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll";
|
|
3
|
-
import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
|
|
3
|
+
import { AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, ConnectionDuration, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, WaterDensity, WeatherVaningState } from "./message_formats";
|
|
4
4
|
/**
|
|
5
5
|
* Control
|
|
6
6
|
*
|
|
@@ -48,13 +48,17 @@ export interface WatchdogCtrl {
|
|
|
48
48
|
/** The ID of the client, received in the ConnectClientRep response. */
|
|
49
49
|
clientId: number;
|
|
50
50
|
}
|
|
51
|
-
/** Issue a command to start video recording. */
|
|
51
|
+
/** Issue a command to start video or multibeam recording. */
|
|
52
52
|
export interface RecordCtrl {
|
|
53
53
|
/** Message specifying which cameras to record. */
|
|
54
54
|
recordOn: RecordOn | undefined;
|
|
55
|
+
/** Storage location to use for the recordings. */
|
|
56
|
+
storageLocation: StorageLocation;
|
|
55
57
|
}
|
|
56
58
|
/** Issue a command to take a picture. */
|
|
57
59
|
export interface TakePictureCtrl {
|
|
60
|
+
/** Storage location to use for the picture. */
|
|
61
|
+
storageLocation: StorageLocation;
|
|
58
62
|
}
|
|
59
63
|
/** Issue a command to start compass calibration. */
|
|
60
64
|
export interface StartCalibrationCtrl {
|
package/dist/control.js
CHANGED
|
@@ -399,13 +399,16 @@ exports.WatchdogCtrl = {
|
|
|
399
399
|
},
|
|
400
400
|
};
|
|
401
401
|
function createBaseRecordCtrl() {
|
|
402
|
-
return { recordOn: undefined };
|
|
402
|
+
return { recordOn: undefined, storageLocation: 0 };
|
|
403
403
|
}
|
|
404
404
|
exports.RecordCtrl = {
|
|
405
405
|
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
406
406
|
if (message.recordOn !== undefined) {
|
|
407
407
|
message_formats_1.RecordOn.encode(message.recordOn, writer.uint32(10).fork()).join();
|
|
408
408
|
}
|
|
409
|
+
if (message.storageLocation !== 0) {
|
|
410
|
+
writer.uint32(16).int32(message.storageLocation);
|
|
411
|
+
}
|
|
409
412
|
return writer;
|
|
410
413
|
},
|
|
411
414
|
decode(input, length) {
|
|
@@ -422,6 +425,13 @@ exports.RecordCtrl = {
|
|
|
422
425
|
message.recordOn = message_formats_1.RecordOn.decode(reader, reader.uint32());
|
|
423
426
|
continue;
|
|
424
427
|
}
|
|
428
|
+
case 2: {
|
|
429
|
+
if (tag !== 16) {
|
|
430
|
+
break;
|
|
431
|
+
}
|
|
432
|
+
message.storageLocation = reader.int32();
|
|
433
|
+
continue;
|
|
434
|
+
}
|
|
425
435
|
}
|
|
426
436
|
if ((tag & 7) === 4 || tag === 0) {
|
|
427
437
|
break;
|
|
@@ -431,13 +441,19 @@ exports.RecordCtrl = {
|
|
|
431
441
|
return message;
|
|
432
442
|
},
|
|
433
443
|
fromJSON(object) {
|
|
434
|
-
return {
|
|
444
|
+
return {
|
|
445
|
+
recordOn: isSet(object.recordOn) ? message_formats_1.RecordOn.fromJSON(object.recordOn) : undefined,
|
|
446
|
+
storageLocation: isSet(object.storageLocation) ? (0, message_formats_1.storageLocationFromJSON)(object.storageLocation) : 0,
|
|
447
|
+
};
|
|
435
448
|
},
|
|
436
449
|
toJSON(message) {
|
|
437
450
|
const obj = {};
|
|
438
451
|
if (message.recordOn !== undefined) {
|
|
439
452
|
obj.recordOn = message_formats_1.RecordOn.toJSON(message.recordOn);
|
|
440
453
|
}
|
|
454
|
+
if (message.storageLocation !== 0) {
|
|
455
|
+
obj.storageLocation = (0, message_formats_1.storageLocationToJSON)(message.storageLocation);
|
|
456
|
+
}
|
|
441
457
|
return obj;
|
|
442
458
|
},
|
|
443
459
|
create(base) {
|
|
@@ -448,14 +464,18 @@ exports.RecordCtrl = {
|
|
|
448
464
|
message.recordOn = (object.recordOn !== undefined && object.recordOn !== null)
|
|
449
465
|
? message_formats_1.RecordOn.fromPartial(object.recordOn)
|
|
450
466
|
: undefined;
|
|
467
|
+
message.storageLocation = object.storageLocation ?? 0;
|
|
451
468
|
return message;
|
|
452
469
|
},
|
|
453
470
|
};
|
|
454
471
|
function createBaseTakePictureCtrl() {
|
|
455
|
-
return {};
|
|
472
|
+
return { storageLocation: 0 };
|
|
456
473
|
}
|
|
457
474
|
exports.TakePictureCtrl = {
|
|
458
|
-
encode(
|
|
475
|
+
encode(message, writer = new wire_1.BinaryWriter()) {
|
|
476
|
+
if (message.storageLocation !== 0) {
|
|
477
|
+
writer.uint32(8).int32(message.storageLocation);
|
|
478
|
+
}
|
|
459
479
|
return writer;
|
|
460
480
|
},
|
|
461
481
|
decode(input, length) {
|
|
@@ -465,6 +485,13 @@ exports.TakePictureCtrl = {
|
|
|
465
485
|
while (reader.pos < end) {
|
|
466
486
|
const tag = reader.uint32();
|
|
467
487
|
switch (tag >>> 3) {
|
|
488
|
+
case 1: {
|
|
489
|
+
if (tag !== 8) {
|
|
490
|
+
break;
|
|
491
|
+
}
|
|
492
|
+
message.storageLocation = reader.int32();
|
|
493
|
+
continue;
|
|
494
|
+
}
|
|
468
495
|
}
|
|
469
496
|
if ((tag & 7) === 4 || tag === 0) {
|
|
470
497
|
break;
|
|
@@ -473,18 +500,22 @@ exports.TakePictureCtrl = {
|
|
|
473
500
|
}
|
|
474
501
|
return message;
|
|
475
502
|
},
|
|
476
|
-
fromJSON(
|
|
477
|
-
return {};
|
|
503
|
+
fromJSON(object) {
|
|
504
|
+
return { storageLocation: isSet(object.storageLocation) ? (0, message_formats_1.storageLocationFromJSON)(object.storageLocation) : 0 };
|
|
478
505
|
},
|
|
479
|
-
toJSON(
|
|
506
|
+
toJSON(message) {
|
|
480
507
|
const obj = {};
|
|
508
|
+
if (message.storageLocation !== 0) {
|
|
509
|
+
obj.storageLocation = (0, message_formats_1.storageLocationToJSON)(message.storageLocation);
|
|
510
|
+
}
|
|
481
511
|
return obj;
|
|
482
512
|
},
|
|
483
513
|
create(base) {
|
|
484
514
|
return exports.TakePictureCtrl.fromPartial(base ?? {});
|
|
485
515
|
},
|
|
486
|
-
fromPartial(
|
|
516
|
+
fromPartial(object) {
|
|
487
517
|
const message = createBaseTakePictureCtrl();
|
|
518
|
+
message.storageLocation = object.storageLocation ?? 0;
|
|
488
519
|
return message;
|
|
489
520
|
},
|
|
490
521
|
};
|
|
@@ -154,6 +154,22 @@ export declare enum NotificationLevel {
|
|
|
154
154
|
}
|
|
155
155
|
export declare function notificationLevelFromJSON(object: any): NotificationLevel;
|
|
156
156
|
export declare function notificationLevelToJSON(object: NotificationLevel): string;
|
|
157
|
+
/**
|
|
158
|
+
* Storage location.
|
|
159
|
+
*
|
|
160
|
+
* Used to specify which storage location to use for recording photos and videos.
|
|
161
|
+
*/
|
|
162
|
+
export declare enum StorageLocation {
|
|
163
|
+
/** STORAGE_LOCATION_UNSPECIFIED - Unspecified. */
|
|
164
|
+
STORAGE_LOCATION_UNSPECIFIED = 0,
|
|
165
|
+
/** STORAGE_LOCATION_INTERNAL - Internal storage of the drone. */
|
|
166
|
+
STORAGE_LOCATION_INTERNAL = 1,
|
|
167
|
+
/** STORAGE_LOCATION_REMOVABLE - Removable storage device. */
|
|
168
|
+
STORAGE_LOCATION_REMOVABLE = 2,
|
|
169
|
+
UNRECOGNIZED = -1
|
|
170
|
+
}
|
|
171
|
+
export declare function storageLocationFromJSON(object: any): StorageLocation;
|
|
172
|
+
export declare function storageLocationToJSON(object: StorageLocation): string;
|
|
157
173
|
/** Drone models produced by Blueye. */
|
|
158
174
|
export declare enum Model {
|
|
159
175
|
/** MODEL_UNSPECIFIED - ModelName not specified. */
|
|
@@ -194,11 +210,13 @@ export declare function pressureSensorTypeToJSON(object: PressureSensorType): st
|
|
|
194
210
|
export declare enum Resolution {
|
|
195
211
|
/** RESOLUTION_UNSPECIFIED - Resolution not specified. */
|
|
196
212
|
RESOLUTION_UNSPECIFIED = 0,
|
|
197
|
-
/**
|
|
198
|
-
|
|
199
|
-
/** RESOLUTION_HD_720P - 720p HD
|
|
213
|
+
/** RESOLUTION_VGA_480P - VGA (640x480). */
|
|
214
|
+
RESOLUTION_VGA_480P = 4,
|
|
215
|
+
/** RESOLUTION_HD_720P - 720p HD (1280x720). */
|
|
200
216
|
RESOLUTION_HD_720P = 2,
|
|
201
|
-
/**
|
|
217
|
+
/** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
|
|
218
|
+
RESOLUTION_FULLHD_1080P = 1,
|
|
219
|
+
/** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
|
|
202
220
|
RESOLUTION_UHD_4K = 3,
|
|
203
221
|
UNRECOGNIZED = -1
|
|
204
222
|
}
|
|
@@ -210,7 +228,7 @@ export declare enum Framerate {
|
|
|
210
228
|
FRAMERATE_UNSPECIFIED = 0,
|
|
211
229
|
/** FRAMERATE_FPS_30 - 30 frames per second. */
|
|
212
230
|
FRAMERATE_FPS_30 = 1,
|
|
213
|
-
/** FRAMERATE_FPS_25 - 25 frames per second. */
|
|
231
|
+
/** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
|
|
214
232
|
FRAMERATE_FPS_25 = 2,
|
|
215
233
|
UNRECOGNIZED = -1
|
|
216
234
|
}
|
|
@@ -228,6 +246,17 @@ export declare enum Camera {
|
|
|
228
246
|
}
|
|
229
247
|
export declare function cameraFromJSON(object: any): Camera;
|
|
230
248
|
export declare function cameraToJSON(object: Camera): string;
|
|
249
|
+
export declare enum StreamingProtocol {
|
|
250
|
+
/** STREAMING_PROTOCOL_UNSPECIFIED - Streaming protocol not specified. */
|
|
251
|
+
STREAMING_PROTOCOL_UNSPECIFIED = 0,
|
|
252
|
+
/** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
|
|
253
|
+
STREAMING_PROTOCOL_RTSP_H264 = 1,
|
|
254
|
+
/** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
|
|
255
|
+
STREAMING_PROTOCOL_RTSP_MJPEG = 2,
|
|
256
|
+
UNRECOGNIZED = -1
|
|
257
|
+
}
|
|
258
|
+
export declare function streamingProtocolFromJSON(object: any): StreamingProtocol;
|
|
259
|
+
export declare function streamingProtocolToJSON(object: StreamingProtocol): string;
|
|
231
260
|
/** Available temperature units. */
|
|
232
261
|
export declare enum TemperatureUnit {
|
|
233
262
|
/** TEMPERATURE_UNIT_UNSPECIFIED - Temperature unit not specified. */
|
|
@@ -533,6 +562,49 @@ export declare enum LogEntry_LogLevel {
|
|
|
533
562
|
}
|
|
534
563
|
export declare function logEntry_LogLevelFromJSON(object: any): LogEntry_LogLevel;
|
|
535
564
|
export declare function logEntry_LogLevelToJSON(object: LogEntry_LogLevel): string;
|
|
565
|
+
export interface KernelLogEntry {
|
|
566
|
+
/** Log level, info, warning, error, etc. */
|
|
567
|
+
level: KernelLogEntry_KernelLogLevel;
|
|
568
|
+
/** Sequence number of the log entry. */
|
|
569
|
+
seqnum: number;
|
|
570
|
+
/** Timestamp of the log entry. */
|
|
571
|
+
timestamp: Date | undefined;
|
|
572
|
+
/** Log messages. */
|
|
573
|
+
messages: string[];
|
|
574
|
+
/** List of key-value pairs. */
|
|
575
|
+
fields: KernelLogEntry_KeyValuePair[];
|
|
576
|
+
}
|
|
577
|
+
/** Kernel log level. */
|
|
578
|
+
export declare enum KernelLogEntry_KernelLogLevel {
|
|
579
|
+
/** KERNEL_LOG_LEVEL_UNSPECIFIED - Unspecified log level. */
|
|
580
|
+
KERNEL_LOG_LEVEL_UNSPECIFIED = 0,
|
|
581
|
+
/** KERNEL_LOG_LEVEL_EMERG - Emergency log level. */
|
|
582
|
+
KERNEL_LOG_LEVEL_EMERG = 1,
|
|
583
|
+
/** KERNEL_LOG_LEVEL_ALERT - Alert log level. */
|
|
584
|
+
KERNEL_LOG_LEVEL_ALERT = 2,
|
|
585
|
+
/** KERNEL_LOG_LEVEL_CRIT - Critical log level. */
|
|
586
|
+
KERNEL_LOG_LEVEL_CRIT = 3,
|
|
587
|
+
/** KERNEL_LOG_LEVEL_ERR - Error log level. */
|
|
588
|
+
KERNEL_LOG_LEVEL_ERR = 4,
|
|
589
|
+
/** KERNEL_LOG_LEVEL_WARNING - Warning log level. */
|
|
590
|
+
KERNEL_LOG_LEVEL_WARNING = 5,
|
|
591
|
+
/** KERNEL_LOG_LEVEL_NOTICE - Notice log level. */
|
|
592
|
+
KERNEL_LOG_LEVEL_NOTICE = 6,
|
|
593
|
+
/** KERNEL_LOG_LEVEL_INFO - Informational log level. */
|
|
594
|
+
KERNEL_LOG_LEVEL_INFO = 7,
|
|
595
|
+
/** KERNEL_LOG_LEVEL_DEBUG - Debug log level. */
|
|
596
|
+
KERNEL_LOG_LEVEL_DEBUG = 8,
|
|
597
|
+
UNRECOGNIZED = -1
|
|
598
|
+
}
|
|
599
|
+
export declare function kernelLogEntry_KernelLogLevelFromJSON(object: any): KernelLogEntry_KernelLogLevel;
|
|
600
|
+
export declare function kernelLogEntry_KernelLogLevelToJSON(object: KernelLogEntry_KernelLogLevel): string;
|
|
601
|
+
/** Key-value pair used for structured logging. */
|
|
602
|
+
export interface KernelLogEntry_KeyValuePair {
|
|
603
|
+
/** Key of the key-value pair. */
|
|
604
|
+
key: string;
|
|
605
|
+
/** Value of the key-value pair. */
|
|
606
|
+
value: string;
|
|
607
|
+
}
|
|
536
608
|
/** If you use both values at the same time they cancel each other out. */
|
|
537
609
|
export interface MotionInput {
|
|
538
610
|
/** Forward (positive) and backwards (negative) movement. (-1..1). */
|
|
@@ -702,6 +774,8 @@ export interface RecordState {
|
|
|
702
774
|
multibeamSeconds: number;
|
|
703
775
|
/** Multibeam record fps. */
|
|
704
776
|
multibeamFps: number;
|
|
777
|
+
/** Storage location used for recording. */
|
|
778
|
+
storageLocation: StorageLocation;
|
|
705
779
|
}
|
|
706
780
|
/** Time-lapse state published if time-lapse mission is running. */
|
|
707
781
|
export interface TimeLapseState {
|
|
@@ -1169,7 +1243,7 @@ export interface DiveTime {
|
|
|
1169
1243
|
/** Number of seconds the drone has been submerged. */
|
|
1170
1244
|
value: number;
|
|
1171
1245
|
}
|
|
1172
|
-
/** Which cameras are supposed to be recording. */
|
|
1246
|
+
/** Which cameras or multibeam are supposed to be recording. */
|
|
1173
1247
|
export interface RecordOn {
|
|
1174
1248
|
/** Record the main camera. */
|
|
1175
1249
|
main: boolean;
|
|
@@ -1449,18 +1523,40 @@ export interface CameraParameters {
|
|
|
1449
1523
|
mjpgBitrate: number;
|
|
1450
1524
|
/** Shutter speed (1/10000 * s), -1 for automatic exposure. */
|
|
1451
1525
|
exposure: number;
|
|
1452
|
-
/** White balance
|
|
1526
|
+
/** White balance temp (Pioneer/Pro/X1/X3: 2800..9300, Ultra: 2300..15000), -1 for auto. */
|
|
1453
1527
|
whiteBalance: number;
|
|
1454
|
-
/** Hue (-40..40), 0 as default. */
|
|
1528
|
+
/** Hue (-40..40), 0 as default. Only available on Pioneer/Pro/X1/X3. */
|
|
1455
1529
|
hue: number;
|
|
1456
|
-
/** Iso gain (0..1). */
|
|
1530
|
+
/** Iso gain (0..1). Only available on Pioneer/Pro/X1/X3. */
|
|
1457
1531
|
gain: number;
|
|
1532
|
+
/** Brightness (-10..10), 0 as default. Only available on Ultra */
|
|
1533
|
+
brightness: number;
|
|
1534
|
+
/** Contrast (-50..50), 0 as default. Only available on Ultra. */
|
|
1535
|
+
contrast: number;
|
|
1536
|
+
/** Saturation (0..50), 8 as default. Only available on Ultra. */
|
|
1537
|
+
saturation: number;
|
|
1538
|
+
/** Gamma (4..79), 22 as default. Only available on Ultra. */
|
|
1539
|
+
gamma: number;
|
|
1540
|
+
/** Sharpness (-20..20), -20 as default. Only available on Ultra. */
|
|
1541
|
+
sharpness: number;
|
|
1542
|
+
/** Backlight compensation (-150..150), 10 as default. Only available on Ultra. */
|
|
1543
|
+
backlightCompensation: number;
|
|
1544
|
+
/** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
|
|
1545
|
+
denoise: number;
|
|
1546
|
+
/** Enable eHDR mode. Default true. Only available on Ultra. */
|
|
1547
|
+
ehdrEnabled: boolean;
|
|
1548
|
+
/** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
|
|
1549
|
+
ehdrExposureMinNumber: number;
|
|
1550
|
+
/** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
|
|
1551
|
+
ehdrExposureMaxNumber: number;
|
|
1458
1552
|
/** Stream, recording and image resolution (deprecated). */
|
|
1459
1553
|
resolution: Resolution;
|
|
1460
1554
|
/** Stream resolution. */
|
|
1461
1555
|
streamResolution: Resolution;
|
|
1462
1556
|
/** Recording and image resolution. */
|
|
1463
1557
|
recordingResolution: Resolution;
|
|
1558
|
+
/** Streaming protocol. */
|
|
1559
|
+
streamingProtocol: StreamingProtocol;
|
|
1464
1560
|
/** Stream and recording framerate. */
|
|
1465
1561
|
framerate: Framerate;
|
|
1466
1562
|
/** Which camera the parameters belong to. */
|
|
@@ -1847,8 +1943,41 @@ export interface CPUInfo {
|
|
|
1847
1943
|
/** Communication queue load (0..1). */
|
|
1848
1944
|
commQueueLoad: number;
|
|
1849
1945
|
}
|
|
1946
|
+
/**
|
|
1947
|
+
* Surface Unit battery information.
|
|
1948
|
+
*
|
|
1949
|
+
* This message is published by the Surface Unit, and re-published by
|
|
1950
|
+
* the drone over the communication protocol.
|
|
1951
|
+
*/
|
|
1952
|
+
export interface SurfaceUnitBatteryInfo {
|
|
1953
|
+
/** Battery charge status. */
|
|
1954
|
+
status: SurfaceUnitBatteryInfo_ChargeStatus;
|
|
1955
|
+
/** Battery level (0..1). */
|
|
1956
|
+
level: number;
|
|
1957
|
+
}
|
|
1958
|
+
export declare enum SurfaceUnitBatteryInfo_ChargeStatus {
|
|
1959
|
+
CHARGE_STATUS_UNSPECIFIED = 0,
|
|
1960
|
+
CHARGE_STATUS_DISCHARGE = 1,
|
|
1961
|
+
CHARGE_STATUS_CHARGE = 2,
|
|
1962
|
+
CHARGE_STATUS_CHARGE_ERROR = 3,
|
|
1963
|
+
UNRECOGNIZED = -1
|
|
1964
|
+
}
|
|
1965
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusFromJSON(object: any): SurfaceUnitBatteryInfo_ChargeStatus;
|
|
1966
|
+
export declare function surfaceUnitBatteryInfo_ChargeStatusToJSON(object: SurfaceUnitBatteryInfo_ChargeStatus): string;
|
|
1967
|
+
/**
|
|
1968
|
+
* Surface Unit version information.
|
|
1969
|
+
*
|
|
1970
|
+
* This message is published by the Surface Unit, and re-published by
|
|
1971
|
+
* the drone over the communication protocol.
|
|
1972
|
+
*/
|
|
1973
|
+
export interface SurfaceUnitVersionInfo {
|
|
1974
|
+
/** Surface Unit firmware version (x.y.z). */
|
|
1975
|
+
version: string;
|
|
1976
|
+
}
|
|
1850
1977
|
export declare const BinlogRecord: MessageFns<BinlogRecord>;
|
|
1851
1978
|
export declare const LogEntry: MessageFns<LogEntry>;
|
|
1979
|
+
export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
|
|
1980
|
+
export declare const KernelLogEntry_KeyValuePair: MessageFns<KernelLogEntry_KeyValuePair>;
|
|
1852
1981
|
export declare const MotionInput: MessageFns<MotionInput>;
|
|
1853
1982
|
export declare const Lights: MessageFns<Lights>;
|
|
1854
1983
|
export declare const Laser: MessageFns<Laser>;
|
|
@@ -1934,6 +2063,8 @@ export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
|
1934
2063
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
1935
2064
|
export declare const PersistentStorageSettings: MessageFns<PersistentStorageSettings>;
|
|
1936
2065
|
export declare const CPUInfo: MessageFns<CPUInfo>;
|
|
2066
|
+
export declare const SurfaceUnitBatteryInfo: MessageFns<SurfaceUnitBatteryInfo>;
|
|
2067
|
+
export declare const SurfaceUnitVersionInfo: MessageFns<SurfaceUnitVersionInfo>;
|
|
1937
2068
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
1938
2069
|
type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
|
|
1939
2070
|
[K in keyof T]?: DeepPartial<T[K]>;
|