@blueyerobotics/protocol-definitions 3.3.0-fe575d02 → 3.4.0-296e61b2
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/README.md +24 -0
- package/README.npm.md +24 -0
- package/dist/aquatroll.js +113 -132
- package/dist/control.d.ts +32 -3
- package/dist/control.js +539 -399
- package/dist/google/protobuf/any.js +5 -8
- package/dist/google/protobuf/duration.js +5 -8
- package/dist/google/protobuf/timestamp.js +5 -8
- package/dist/index.blueye.d.ts +1 -1
- package/dist/index.blueye.js +1 -37
- package/dist/index.blueye.protocol.d.ts +6 -6
- package/dist/index.blueye.protocol.js +6 -22
- package/dist/index.d.ts +2 -2
- package/dist/index.google.d.ts +1 -1
- package/dist/index.google.js +1 -37
- package/dist/index.google.protobuf.d.ts +3 -3
- package/dist/index.google.protobuf.js +3 -19
- package/dist/index.js +2 -38
- package/dist/message_formats.d.ts +304 -9
- package/dist/message_formats.js +2723 -1090
- package/dist/mission_planning.d.ts +1 -1
- package/dist/mission_planning.js +208 -223
- package/dist/req_rep.d.ts +23 -3
- package/dist/req_rep.js +473 -296
- package/dist/telemetry.d.ts +45 -3
- package/dist/telemetry.js +930 -646
- package/package.json +13 -3
|
@@ -1,11 +1,37 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
|
-
import { Any } from "./google/protobuf/any";
|
|
3
|
-
import { Duration } from "./google/protobuf/duration";
|
|
2
|
+
import { Any } from "./google/protobuf/any.js";
|
|
3
|
+
import { Duration } from "./google/protobuf/duration.js";
|
|
4
4
|
/**
|
|
5
5
|
* Common messages
|
|
6
6
|
*
|
|
7
7
|
* These are used for logging as well as building requests and responses.
|
|
8
8
|
*/
|
|
9
|
+
/** How the arm input of the last command was read, as reported in telemetry. */
|
|
10
|
+
export declare enum ManipulatorControlMode {
|
|
11
|
+
/** MANIPULATOR_CONTROL_MODE_UNSPECIFIED - No arm input. */
|
|
12
|
+
MANIPULATOR_CONTROL_MODE_UNSPECIFIED = 0,
|
|
13
|
+
/** MANIPULATOR_CONTROL_MODE_CYLINDRICAL - CylindricalManipulatorInput. */
|
|
14
|
+
MANIPULATOR_CONTROL_MODE_CYLINDRICAL = 1,
|
|
15
|
+
/** MANIPULATOR_CONTROL_MODE_CARTESIAN - CartesianManipulatorInput. */
|
|
16
|
+
MANIPULATOR_CONTROL_MODE_CARTESIAN = 2,
|
|
17
|
+
/** MANIPULATOR_CONTROL_MODE_KNOWN_POSE - KnownPoseManipulatorInput. */
|
|
18
|
+
MANIPULATOR_CONTROL_MODE_KNOWN_POSE = 3,
|
|
19
|
+
UNRECOGNIZED = -1
|
|
20
|
+
}
|
|
21
|
+
export declare function manipulatorControlModeFromJSON(object: any): ManipulatorControlMode;
|
|
22
|
+
export declare function manipulatorControlModeToJSON(object: ManipulatorControlMode): string;
|
|
23
|
+
/** Named manipulator poses. */
|
|
24
|
+
export declare enum ManipulatorPose {
|
|
25
|
+
/** MANIPULATOR_POSE_UNSPECIFIED - No pose. */
|
|
26
|
+
MANIPULATOR_POSE_UNSPECIFIED = 0,
|
|
27
|
+
/** MANIPULATOR_POSE_STOWED - Folded for transport, launch and recovery. */
|
|
28
|
+
MANIPULATOR_POSE_STOWED = 1,
|
|
29
|
+
/** MANIPULATOR_POSE_DEPLOYED - Unfolded and ready to work. */
|
|
30
|
+
MANIPULATOR_POSE_DEPLOYED = 2,
|
|
31
|
+
UNRECOGNIZED = -1
|
|
32
|
+
}
|
|
33
|
+
export declare function manipulatorPoseFromJSON(object: any): ManipulatorPose;
|
|
34
|
+
export declare function manipulatorPoseToJSON(object: ManipulatorPose): string;
|
|
9
35
|
/** Interval type for time-lapse photos. */
|
|
10
36
|
export declare enum IntervalType {
|
|
11
37
|
/** INTERVAL_TYPE_UNSPECIFIED - Unspecified. */
|
|
@@ -252,17 +278,19 @@ export declare function resolutionToJSON(object: Resolution): string;
|
|
|
252
278
|
* Available camera frame rates.
|
|
253
279
|
*
|
|
254
280
|
* If the requested frame rate is higher than what is supported at the current resolution,
|
|
255
|
-
* the frame rate will be reduced while the resolution is respected.
|
|
281
|
+
* the frame rate will be reduced while the resolution is respected: 60 to 30 and 50 to 25.
|
|
256
282
|
*/
|
|
257
283
|
export declare enum Framerate {
|
|
258
284
|
/** FRAMERATE_UNSPECIFIED - Framerate not specified. */
|
|
259
285
|
FRAMERATE_UNSPECIFIED = 0,
|
|
260
286
|
/** FRAMERATE_FPS_30 - 30 frames per second. */
|
|
261
287
|
FRAMERATE_FPS_30 = 1,
|
|
262
|
-
/** FRAMERATE_FPS_25 - 25 frames per second.
|
|
288
|
+
/** FRAMERATE_FPS_25 - 25 frames per second. */
|
|
263
289
|
FRAMERATE_FPS_25 = 2,
|
|
264
290
|
/** FRAMERATE_FPS_60 - 60 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
|
|
265
291
|
FRAMERATE_FPS_60 = 3,
|
|
292
|
+
/** FRAMERATE_FPS_50 - 50 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
|
|
293
|
+
FRAMERATE_FPS_50 = 4,
|
|
266
294
|
UNRECOGNIZED = -1
|
|
267
295
|
}
|
|
268
296
|
export declare function framerateFromJSON(object: any): Framerate;
|
|
@@ -354,7 +382,10 @@ export declare function thicknessUnitFromJSON(object: any): ThicknessUnit;
|
|
|
354
382
|
export declare function thicknessUnitToJSON(object: ThicknessUnit): string;
|
|
355
383
|
/** Available font sizes for overlay text elements. */
|
|
356
384
|
export declare enum FontSize {
|
|
357
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* FONT_SIZE_UNSPECIFIED - Font size and margins derived from the recording resolution (Blunux >= 5.2).
|
|
387
|
+
* Older firmware defaults to 25px.
|
|
388
|
+
*/
|
|
358
389
|
FONT_SIZE_UNSPECIFIED = 0,
|
|
359
390
|
/** FONT_SIZE_PX15 - 15 px. */
|
|
360
391
|
FONT_SIZE_PX15 = 1,
|
|
@@ -481,6 +512,16 @@ export declare enum GuestPortDeviceID {
|
|
|
481
512
|
GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 = 49,
|
|
482
513
|
/** GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 - Waterlinked DVL A100. */
|
|
483
514
|
GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 = 50,
|
|
515
|
+
/** GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 - Outland Technology MP-200 Manipulator. */
|
|
516
|
+
GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 = 51,
|
|
517
|
+
/** GUEST_PORT_DEVICE_ID_REACH_ROBOTICS_REACH_ALPHA_5 - Reach Robotics Reach Alpha 5 Manipulator. */
|
|
518
|
+
GUEST_PORT_DEVICE_ID_REACH_ROBOTICS_REACH_ALPHA_5 = 52,
|
|
519
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V3 - Blueye Multibeam Skid Servo V3. */
|
|
520
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_MULTIBEAM_SERVO_V3 = 53,
|
|
521
|
+
/** GUEST_PORT_DEVICE_ID_BLUE_ROBOTICS_DETACHABLE_NEWTON_V2 - Detachable Blue Robotics Newton V2. */
|
|
522
|
+
GUEST_PORT_DEVICE_ID_BLUE_ROBOTICS_DETACHABLE_NEWTON_V2 = 54,
|
|
523
|
+
/** GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER_V2 - Blueye Scaling Laser V2. */
|
|
524
|
+
GUEST_PORT_DEVICE_ID_BLUEYE_SCALING_LASER_V2 = 55,
|
|
484
525
|
UNRECOGNIZED = -1
|
|
485
526
|
}
|
|
486
527
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -528,6 +569,10 @@ export declare enum GuestPortCapability {
|
|
|
528
569
|
GUEST_PORT_CAPABILITY_PWM = 6,
|
|
529
570
|
/** GUEST_PORT_CAPABILITY_ETHERNET_1G - Gigabit Ethernet. */
|
|
530
571
|
GUEST_PORT_CAPABILITY_ETHERNET_1G = 7,
|
|
572
|
+
/** GUEST_PORT_CAPABILITY_I2C_IO - TCA9536 I/O expander. */
|
|
573
|
+
GUEST_PORT_CAPABILITY_I2C_IO = 8,
|
|
574
|
+
/** GUEST_PORT_CAPABILITY_I2C_IO_V2 - PCA9554A I/O expander. */
|
|
575
|
+
GUEST_PORT_CAPABILITY_I2C_IO_V2 = 9,
|
|
531
576
|
UNRECOGNIZED = -1
|
|
532
577
|
}
|
|
533
578
|
export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
|
|
@@ -846,6 +891,11 @@ export interface LaserDetection {
|
|
|
846
891
|
correctedPixelDistance: number;
|
|
847
892
|
/** Estimated subject distance (m). */
|
|
848
893
|
estimatedDistance: number;
|
|
894
|
+
/**
|
|
895
|
+
* Id of the camera frame the detection was computed from, 0 if unknown. Matches the frame id
|
|
896
|
+
* embedded in recorded video; ModelDetections describes the format.
|
|
897
|
+
*/
|
|
898
|
+
frameId: number;
|
|
849
899
|
}
|
|
850
900
|
/** Latitude and longitude position in WGS 84 decimal degrees format. */
|
|
851
901
|
export interface LatLongPosition {
|
|
@@ -999,6 +1049,167 @@ export interface GripperVelocities {
|
|
|
999
1049
|
/** The rotating velocity (-1.0..1.0). */
|
|
1000
1050
|
rotateVelocity: number;
|
|
1001
1051
|
}
|
|
1052
|
+
/**
|
|
1053
|
+
* Cartesian velocity of the end of a manipulator arm, in the drone body frame.
|
|
1054
|
+
*
|
|
1055
|
+
* Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
|
|
1056
|
+
*/
|
|
1057
|
+
export interface CartesianManipulatorInput {
|
|
1058
|
+
/** Forward (positive) and backward (negative). */
|
|
1059
|
+
x: number;
|
|
1060
|
+
/** Right (positive) and left (negative). */
|
|
1061
|
+
y: number;
|
|
1062
|
+
/** Down (positive) and up (negative). */
|
|
1063
|
+
z: number;
|
|
1064
|
+
}
|
|
1065
|
+
/**
|
|
1066
|
+
* Cylindrical velocity of the end of a manipulator arm, about the axis of the arm's base joint.
|
|
1067
|
+
*
|
|
1068
|
+
* Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
|
|
1069
|
+
*/
|
|
1070
|
+
export interface CylindricalManipulatorInput {
|
|
1071
|
+
/** Out from the base axis (positive) and in towards it (negative). */
|
|
1072
|
+
radial: number;
|
|
1073
|
+
/** Along the base axis: down (positive) and up (negative), as in the drone body frame. */
|
|
1074
|
+
vertical: number;
|
|
1075
|
+
/** Swing about the base axis: clockwise seen from above (positive). */
|
|
1076
|
+
azimuth: number;
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* Movement of a manipulator arm towards a named pose, along a path the drone chooses.
|
|
1080
|
+
*
|
|
1081
|
+
* Hold-to-run: the arm moves only while the velocity is above zero, and resumes from wherever it
|
|
1082
|
+
* stopped.
|
|
1083
|
+
*/
|
|
1084
|
+
export interface KnownPoseManipulatorInput {
|
|
1085
|
+
/** The pose to move towards. */
|
|
1086
|
+
pose: ManipulatorPose;
|
|
1087
|
+
/** Speed along the path (0.0..1.0): 0 holds the arm where it is. */
|
|
1088
|
+
velocity: number;
|
|
1089
|
+
}
|
|
1090
|
+
/** Gripper state: of its arm too, when the gripper is a manipulator arm. */
|
|
1091
|
+
export interface Gripper {
|
|
1092
|
+
/** How the arm input of the last command was read. */
|
|
1093
|
+
mode: ManipulatorControlMode;
|
|
1094
|
+
/** Joint positions from the jaws to the base: jaws opening (m), then joint angles (rad). */
|
|
1095
|
+
jointPositions: number[];
|
|
1096
|
+
/** Position of the base of the jaws in the drone body frame (m). */
|
|
1097
|
+
endPosition: Vector3 | undefined;
|
|
1098
|
+
/** A joint at the end of its range keeps the arm from going further. */
|
|
1099
|
+
atLimit: boolean;
|
|
1100
|
+
/** The arm stopped itself short of an obstacle or of itself. */
|
|
1101
|
+
collision: boolean;
|
|
1102
|
+
/** The jaws closed on something. */
|
|
1103
|
+
holding: boolean;
|
|
1104
|
+
/** A joint reports a hardware fault. */
|
|
1105
|
+
fault: boolean;
|
|
1106
|
+
/** Named pose the arm is moving towards, if any. */
|
|
1107
|
+
movingTo: ManipulatorPose;
|
|
1108
|
+
}
|
|
1109
|
+
/**
|
|
1110
|
+
* Hardware status flags a device of a Reach Robotics gripper raises about itself, named as Reach names them.
|
|
1111
|
+
* A gripper of another make would need flags of its own.
|
|
1112
|
+
*/
|
|
1113
|
+
export interface ReachHardwareStatus {
|
|
1114
|
+
/** Reading the device's flash memory failed. */
|
|
1115
|
+
flashFailedRead: boolean;
|
|
1116
|
+
/** Humidity in the housing is too high: water may have got in. */
|
|
1117
|
+
overHumidity: boolean;
|
|
1118
|
+
/** The housing is too hot. */
|
|
1119
|
+
overTemperature: boolean;
|
|
1120
|
+
/** Error on the serial line. */
|
|
1121
|
+
commsSerialError: boolean;
|
|
1122
|
+
/** A packet failed its checksum. */
|
|
1123
|
+
commsCrcError: boolean;
|
|
1124
|
+
/** The motor driver reports a fault. */
|
|
1125
|
+
motorDriverFault: boolean;
|
|
1126
|
+
/** The position encoder reads an invalid position. */
|
|
1127
|
+
encoderPositionError: boolean;
|
|
1128
|
+
/** The position encoder is not detected. */
|
|
1129
|
+
encoderNotDetected: boolean;
|
|
1130
|
+
/** Another device has the same axis. */
|
|
1131
|
+
deviceAxisConflict: boolean;
|
|
1132
|
+
/** The motor is not connected. */
|
|
1133
|
+
motorNotConnected: boolean;
|
|
1134
|
+
/** The motor draws too much current. */
|
|
1135
|
+
motorOverCurrent: boolean;
|
|
1136
|
+
/** The input encoder reads an invalid position. */
|
|
1137
|
+
inputEncoderPositionError: boolean;
|
|
1138
|
+
/** Another device has the same ID. */
|
|
1139
|
+
deviceIdConflict: boolean;
|
|
1140
|
+
/** Pressure in the housing is too high: the seal may have failed. */
|
|
1141
|
+
overPressure: boolean;
|
|
1142
|
+
/** Over current or under voltage in the motor driver. */
|
|
1143
|
+
motorDriverOverCurrentAndUnderVoltage: boolean;
|
|
1144
|
+
/** The motor driver is too hot. */
|
|
1145
|
+
motorDriverOverTemperature: boolean;
|
|
1146
|
+
/** The device is due for service. */
|
|
1147
|
+
jointServiceDue: boolean;
|
|
1148
|
+
/** The position encoder reports a fault. */
|
|
1149
|
+
encoderFault: boolean;
|
|
1150
|
+
/** The supply voltage is too low. */
|
|
1151
|
+
lowSupplyVoltage: boolean;
|
|
1152
|
+
/** A position report the device waits for has not arrived. */
|
|
1153
|
+
positionReportNotReceived: boolean;
|
|
1154
|
+
}
|
|
1155
|
+
/**
|
|
1156
|
+
* Health of one device of a gripper: a joint, or a device of its own.
|
|
1157
|
+
*
|
|
1158
|
+
* A value the device did not report is 0, with its is_*_valid false.
|
|
1159
|
+
*/
|
|
1160
|
+
export interface GripperDeviceDiagnostics {
|
|
1161
|
+
/** Address of the device on the gripper's bus. On a Reach Robotics arm, 1 is the jaws. */
|
|
1162
|
+
address: number;
|
|
1163
|
+
/** Supply voltage (V). */
|
|
1164
|
+
supplyVoltage: number;
|
|
1165
|
+
/** True when the device reported its supply voltage. */
|
|
1166
|
+
isSupplyVoltageValid: boolean;
|
|
1167
|
+
/** Temperature in the housing (°C). */
|
|
1168
|
+
temperature: number;
|
|
1169
|
+
/** True when the device reported the temperature in its housing. */
|
|
1170
|
+
isTemperatureValid: boolean;
|
|
1171
|
+
/** Relative humidity in the housing (%). */
|
|
1172
|
+
humidity: number;
|
|
1173
|
+
/** True when the device reported the humidity in its housing. */
|
|
1174
|
+
isHumidityValid: boolean;
|
|
1175
|
+
/** Absolute pressure in the housing (bar), a partial vacuum: a rise can mean a leak. */
|
|
1176
|
+
internalPressure: number;
|
|
1177
|
+
/** True when the device reported the pressure in its housing. */
|
|
1178
|
+
isInternalPressureValid: boolean;
|
|
1179
|
+
/** Motor current (A). */
|
|
1180
|
+
current: number;
|
|
1181
|
+
/** True when the device reported its motor current. */
|
|
1182
|
+
isCurrentValid: boolean;
|
|
1183
|
+
/**
|
|
1184
|
+
* Flags the device reported, and those it raised since the last report.
|
|
1185
|
+
* Not set if the device sent no hardware status.
|
|
1186
|
+
*/
|
|
1187
|
+
hardwareStatus: ReachHardwareStatus | undefined;
|
|
1188
|
+
}
|
|
1189
|
+
/**
|
|
1190
|
+
* Identity of a gripper: what it is, and what it reports of itself.
|
|
1191
|
+
*
|
|
1192
|
+
* A value the gripper does not report is empty.
|
|
1193
|
+
*/
|
|
1194
|
+
export interface GripperInfo {
|
|
1195
|
+
/** Guest port the gripper is on. */
|
|
1196
|
+
guestPortNumber: GuestPortNumber;
|
|
1197
|
+
/** What the gripper is, as its guest-port connector names it. */
|
|
1198
|
+
deviceId: GuestPortDeviceID;
|
|
1199
|
+
/** Serial number of the gripper, such as 5854. */
|
|
1200
|
+
serialNumber: string;
|
|
1201
|
+
/** Model number of the gripper, such as 5001 for a Reach Alpha 5 or 2130 for a Reach Alpha 2. */
|
|
1202
|
+
modelNumber: string;
|
|
1203
|
+
/** Firmware version of the gripper, such as 5.2.0. */
|
|
1204
|
+
firmwareVersion: string;
|
|
1205
|
+
}
|
|
1206
|
+
/** Health of a gripper and its devices, for diagnostics. */
|
|
1207
|
+
export interface GripperDiagnostics {
|
|
1208
|
+
/** One for each device of the gripper that answered. */
|
|
1209
|
+
devices: GripperDeviceDiagnostics[];
|
|
1210
|
+
/** Guest port the gripper is on. */
|
|
1211
|
+
guestPortNumber: GuestPortNumber;
|
|
1212
|
+
}
|
|
1002
1213
|
/** Information about a remote client. */
|
|
1003
1214
|
export interface ClientInfo {
|
|
1004
1215
|
/** The type of client (such as Blueye App, Observer App, SDK, etc). */
|
|
@@ -1117,6 +1328,20 @@ export interface CanisterHumidity {
|
|
|
1117
1328
|
/** Air humidity (%). */
|
|
1118
1329
|
humidity: number;
|
|
1119
1330
|
}
|
|
1331
|
+
/** Sensor readings inside the X7 power canister. */
|
|
1332
|
+
export interface PowerCanister {
|
|
1333
|
+
/** Front ESC board; absent when no recent reading is available. */
|
|
1334
|
+
frontEsc: PowerCanister_Sensors | undefined;
|
|
1335
|
+
/** Rear ESC board; absent when no recent reading is available. */
|
|
1336
|
+
rearEsc: PowerCanister_Sensors | undefined;
|
|
1337
|
+
}
|
|
1338
|
+
/** Sensor readings from an ESC board. */
|
|
1339
|
+
export interface PowerCanister_Sensors {
|
|
1340
|
+
/** Temperature (°C). */
|
|
1341
|
+
temperature: number;
|
|
1342
|
+
/** Relative humidity (%). */
|
|
1343
|
+
humidity: number;
|
|
1344
|
+
}
|
|
1120
1345
|
/** Essential battery information. */
|
|
1121
1346
|
export interface Battery {
|
|
1122
1347
|
/** Battery voltage (V). */
|
|
@@ -1942,6 +2167,14 @@ export interface ErrorFlags {
|
|
|
1942
2167
|
videoUrbError: boolean;
|
|
1943
2168
|
/** Hardware not supported on current blunux version. */
|
|
1944
2169
|
hardwareNotSupported: boolean;
|
|
2170
|
+
/** MPU 1 unavailable at observer startup. */
|
|
2171
|
+
imu1: boolean;
|
|
2172
|
+
/** MPU 2 unavailable at observer startup. */
|
|
2173
|
+
imu2: boolean;
|
|
2174
|
+
/** HP IMU unavailable on X3 Ultra or X7. */
|
|
2175
|
+
imuHp: boolean;
|
|
2176
|
+
/** No attitude source: manual body-frame control only. */
|
|
2177
|
+
imuAttitude: boolean;
|
|
1945
2178
|
}
|
|
1946
2179
|
/** Camera parameters. */
|
|
1947
2180
|
export interface CameraParameters {
|
|
@@ -2041,11 +2274,14 @@ export interface OverlayParameters {
|
|
|
2041
2274
|
thicknessUnit: ThicknessUnit;
|
|
2042
2275
|
/** Timezone offset from UTC (min). */
|
|
2043
2276
|
timezoneOffset: number;
|
|
2044
|
-
/** Horizontal margins of text elements (px). */
|
|
2277
|
+
/** Horizontal margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
|
|
2045
2278
|
marginWidth: number;
|
|
2046
|
-
/** Vertical margins of text elements (px). */
|
|
2279
|
+
/** Vertical margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
|
|
2047
2280
|
marginHeight: number;
|
|
2048
|
-
/**
|
|
2281
|
+
/**
|
|
2282
|
+
* Font size of text elements. FONT_SIZE_UNSPECIFIED derives font size and margins from the
|
|
2283
|
+
* recording resolution (Blunux >= 5.2). Older firmware defaults to 25px.
|
|
2284
|
+
*/
|
|
2049
2285
|
fontSize: FontSize;
|
|
2050
2286
|
/** Optional title. */
|
|
2051
2287
|
title: string;
|
|
@@ -2451,6 +2687,17 @@ export interface MultibeamDiscovery {
|
|
|
2451
2687
|
/** Error flags specific for the connected multibeam device. */
|
|
2452
2688
|
errorFlags: MultibeamErrorFlags | undefined;
|
|
2453
2689
|
}
|
|
2690
|
+
/**
|
|
2691
|
+
* Color filter used to render the multibeam sonar fan.
|
|
2692
|
+
*
|
|
2693
|
+
* The fan renderer maps each echo intensity (0..255) to a color through this
|
|
2694
|
+
* lookup table. The drone keeps the last filter received in memory and applies
|
|
2695
|
+
* it to the sonar RTSP stream; grayscale is used until one is set.
|
|
2696
|
+
*/
|
|
2697
|
+
export interface MultibeamColorFilter {
|
|
2698
|
+
/** 768 bytes: 256 consecutive R,G,B triplets, indexed by echo intensity. */
|
|
2699
|
+
rgb: Uint8Array;
|
|
2700
|
+
}
|
|
2454
2701
|
/** Error flags for multibeam sonar devices. */
|
|
2455
2702
|
export interface MultibeamErrorFlags {
|
|
2456
2703
|
/**
|
|
@@ -2785,7 +3032,26 @@ export interface ObjectDetection {
|
|
|
2785
3032
|
/** Instance segmentation mask (absent if model has no segmentation). */
|
|
2786
3033
|
mask: SegmentationMask | undefined;
|
|
2787
3034
|
}
|
|
2788
|
-
/**
|
|
3035
|
+
/**
|
|
3036
|
+
* A list of object detections from a single model for a single video frame.
|
|
3037
|
+
*
|
|
3038
|
+
* frame_id matches detections to the exact frame of a recording. The video pipeline on the X3 Ultra
|
|
3039
|
+
* assigns an id to each camera frame once, passes it to the computer vision models and the recorder,
|
|
3040
|
+
* and writes it into the recorded video. An id is never reused within one boot of the drone, and stays
|
|
3041
|
+
* below 2^53, so it is exact as a JavaScript number. The models do not process every frame, so the ids
|
|
3042
|
+
* of successive results can skip.
|
|
3043
|
+
*
|
|
3044
|
+
* Recorded video carries the id in a user_data_unregistered SEI message (payload type 5), one per access
|
|
3045
|
+
* unit, placed before the first slice: NAL unit type 6 in H.264 and PREFIX_SEI_NUT (type 39) in H.265.
|
|
3046
|
+
* The payload is 32 bytes, counted after the emulation prevention bytes are removed:
|
|
3047
|
+
*
|
|
3048
|
+
* - Bytes 0-15: UUID 6b1e2f0c-935d-4a8e-b17a-52d40e3c91f6, in the byte order written.
|
|
3049
|
+
* - Bytes 16-23: frame_id, uint64 big-endian.
|
|
3050
|
+
* - Bytes 24-31: capture time of the frame in CLOCK_MONOTONIC on the drone (ns), uint64 big-endian, 0 if unknown.
|
|
3051
|
+
*
|
|
3052
|
+
* A frame that the recorder repeats to keep the frame rate carries the id of the frame it repeats.
|
|
3053
|
+
* Re-encoding the video drops the SEI, so only the original recording carries the ids.
|
|
3054
|
+
*/
|
|
2789
3055
|
export interface ModelDetections {
|
|
2790
3056
|
/** List of detections in the frame. */
|
|
2791
3057
|
detections: ObjectDetection[];
|
|
@@ -2797,6 +3063,11 @@ export interface ModelDetections {
|
|
|
2797
3063
|
imageHeight: number;
|
|
2798
3064
|
/** Name of the computer vision model that produced the detections. */
|
|
2799
3065
|
modelName: string;
|
|
3066
|
+
/**
|
|
3067
|
+
* Id of the camera frame the detections were computed from, 0 if unknown. Matches the frame id
|
|
3068
|
+
* embedded in recorded video; the message description gives the format.
|
|
3069
|
+
*/
|
|
3070
|
+
frameId: number;
|
|
2800
3071
|
}
|
|
2801
3072
|
/** Generic filter settings. */
|
|
2802
3073
|
export interface FilterMessage {
|
|
@@ -2805,6 +3076,13 @@ export interface FilterMessage {
|
|
|
2805
3076
|
/** Intensity of the filter (0..1). */
|
|
2806
3077
|
intensity: number;
|
|
2807
3078
|
}
|
|
3079
|
+
/** Frames that the marine snow filter compares each frame with. */
|
|
3080
|
+
export interface MarineSnowFilterFrames {
|
|
3081
|
+
/** Past frames to compare with (1..4). */
|
|
3082
|
+
pastFrames: number;
|
|
3083
|
+
/** Future frames to compare with (0..2). Each one delays the video by 33 to 40 ms. */
|
|
3084
|
+
futureFrames: number;
|
|
3085
|
+
}
|
|
2808
3086
|
/**
|
|
2809
3087
|
* Digital pan, tilt, and zoom state for the main camera.
|
|
2810
3088
|
*
|
|
@@ -2855,6 +3133,11 @@ export interface SotState {
|
|
|
2855
3133
|
vs: number;
|
|
2856
3134
|
/** Kalman rate of change of the bounding box aspect ratio, width / height (1/s). */
|
|
2857
3135
|
vr: number;
|
|
3136
|
+
/**
|
|
3137
|
+
* Id of the camera frame the state was computed from, 0 if unknown. Matches the frame id embedded
|
|
3138
|
+
* in recorded video; ModelDetections describes the format.
|
|
3139
|
+
*/
|
|
3140
|
+
frameId: number;
|
|
2858
3141
|
}
|
|
2859
3142
|
/** Current state of the SOT tracker. */
|
|
2860
3143
|
export declare enum SotState_State {
|
|
@@ -2927,6 +3210,14 @@ export declare const ControlMode: MessageFns<ControlMode>;
|
|
|
2927
3210
|
export declare const TiltStabilizationState: MessageFns<TiltStabilizationState>;
|
|
2928
3211
|
export declare const SystemTime: MessageFns<SystemTime>;
|
|
2929
3212
|
export declare const GripperVelocities: MessageFns<GripperVelocities>;
|
|
3213
|
+
export declare const CartesianManipulatorInput: MessageFns<CartesianManipulatorInput>;
|
|
3214
|
+
export declare const CylindricalManipulatorInput: MessageFns<CylindricalManipulatorInput>;
|
|
3215
|
+
export declare const KnownPoseManipulatorInput: MessageFns<KnownPoseManipulatorInput>;
|
|
3216
|
+
export declare const Gripper: MessageFns<Gripper>;
|
|
3217
|
+
export declare const ReachHardwareStatus: MessageFns<ReachHardwareStatus>;
|
|
3218
|
+
export declare const GripperDeviceDiagnostics: MessageFns<GripperDeviceDiagnostics>;
|
|
3219
|
+
export declare const GripperInfo: MessageFns<GripperInfo>;
|
|
3220
|
+
export declare const GripperDiagnostics: MessageFns<GripperDiagnostics>;
|
|
2930
3221
|
export declare const ClientInfo: MessageFns<ClientInfo>;
|
|
2931
3222
|
export declare const ConnectedClient: MessageFns<ConnectedClient>;
|
|
2932
3223
|
export declare const RecordState: MessageFns<RecordState>;
|
|
@@ -2937,6 +3228,8 @@ export declare const WaterTemperature: MessageFns<WaterTemperature>;
|
|
|
2937
3228
|
export declare const CPUTemperature: MessageFns<CPUTemperature>;
|
|
2938
3229
|
export declare const CanisterTemperature: MessageFns<CanisterTemperature>;
|
|
2939
3230
|
export declare const CanisterHumidity: MessageFns<CanisterHumidity>;
|
|
3231
|
+
export declare const PowerCanister: MessageFns<PowerCanister>;
|
|
3232
|
+
export declare const PowerCanister_Sensors: MessageFns<PowerCanister_Sensors>;
|
|
2940
3233
|
export declare const Battery: MessageFns<Battery>;
|
|
2941
3234
|
export declare const BatteryBQ40Z50: MessageFns<BatteryBQ40Z50>;
|
|
2942
3235
|
export declare const BatteryBQ40Z50_Voltage: MessageFns<BatteryBQ40Z50_Voltage>;
|
|
@@ -2995,6 +3288,7 @@ export declare const MedusaSpectrometerData: MessageFns<MedusaSpectrometerData>;
|
|
|
2995
3288
|
export declare const MultibeamPing: MessageFns<MultibeamPing>;
|
|
2996
3289
|
export declare const MultibeamConfig: MessageFns<MultibeamConfig>;
|
|
2997
3290
|
export declare const MultibeamDiscovery: MessageFns<MultibeamDiscovery>;
|
|
3291
|
+
export declare const MultibeamColorFilter: MessageFns<MultibeamColorFilter>;
|
|
2998
3292
|
export declare const MultibeamErrorFlags: MessageFns<MultibeamErrorFlags>;
|
|
2999
3293
|
export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
3000
3294
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
@@ -3015,6 +3309,7 @@ export declare const SegmentationMask: MessageFns<SegmentationMask>;
|
|
|
3015
3309
|
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
3016
3310
|
export declare const ModelDetections: MessageFns<ModelDetections>;
|
|
3017
3311
|
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
3312
|
+
export declare const MarineSnowFilterFrames: MessageFns<MarineSnowFilterFrames>;
|
|
3018
3313
|
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
3019
3314
|
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
3020
3315
|
export declare const SotState: MessageFns<SotState>;
|