@blueyerobotics/protocol-definitions 3.3.0-e472bef2 → 3.4.0-01d6bec3
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 +400 -14
- package/dist/message_formats.js +8222 -5832
- 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 +51 -3
- package/dist/telemetry.js +974 -637
- 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. */
|
|
@@ -138,6 +164,8 @@ export declare enum NotificationType {
|
|
|
138
164
|
NOTIFICATION_TYPE_DVL_THERMAL_PROTECTION_MODE_DETECTED = 32,
|
|
139
165
|
/** NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED - Video partition not mounted. */
|
|
140
166
|
NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED = 33,
|
|
167
|
+
/** NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED - DVL firmware speaks a protocol version Blunux does not support. */
|
|
168
|
+
NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED = 34,
|
|
141
169
|
UNRECOGNIZED = -1
|
|
142
170
|
}
|
|
143
171
|
export declare function notificationTypeFromJSON(object: any): NotificationType;
|
|
@@ -250,17 +278,19 @@ export declare function resolutionToJSON(object: Resolution): string;
|
|
|
250
278
|
* Available camera frame rates.
|
|
251
279
|
*
|
|
252
280
|
* If the requested frame rate is higher than what is supported at the current resolution,
|
|
253
|
-
* 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.
|
|
254
282
|
*/
|
|
255
283
|
export declare enum Framerate {
|
|
256
284
|
/** FRAMERATE_UNSPECIFIED - Framerate not specified. */
|
|
257
285
|
FRAMERATE_UNSPECIFIED = 0,
|
|
258
286
|
/** FRAMERATE_FPS_30 - 30 frames per second. */
|
|
259
287
|
FRAMERATE_FPS_30 = 1,
|
|
260
|
-
/** FRAMERATE_FPS_25 - 25 frames per second.
|
|
288
|
+
/** FRAMERATE_FPS_25 - 25 frames per second. */
|
|
261
289
|
FRAMERATE_FPS_25 = 2,
|
|
262
290
|
/** FRAMERATE_FPS_60 - 60 frames per second. (Only supported on X3 Ultra at QHD, 1080p and 720p) */
|
|
263
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,
|
|
264
294
|
UNRECOGNIZED = -1
|
|
265
295
|
}
|
|
266
296
|
export declare function framerateFromJSON(object: any): Framerate;
|
|
@@ -352,7 +382,10 @@ export declare function thicknessUnitFromJSON(object: any): ThicknessUnit;
|
|
|
352
382
|
export declare function thicknessUnitToJSON(object: ThicknessUnit): string;
|
|
353
383
|
/** Available font sizes for overlay text elements. */
|
|
354
384
|
export declare enum FontSize {
|
|
355
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* FONT_SIZE_UNSPECIFIED - Font size and margins derived from the recording resolution (Blunux >= 5.2).
|
|
387
|
+
* Older firmware defaults to 25px.
|
|
388
|
+
*/
|
|
356
389
|
FONT_SIZE_UNSPECIFIED = 0,
|
|
357
390
|
/** FONT_SIZE_PX15 - 15 px. */
|
|
358
391
|
FONT_SIZE_PX15 = 1,
|
|
@@ -479,6 +512,16 @@ export declare enum GuestPortDeviceID {
|
|
|
479
512
|
GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 = 49,
|
|
480
513
|
/** GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 - Waterlinked DVL A100. */
|
|
481
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,
|
|
482
525
|
UNRECOGNIZED = -1
|
|
483
526
|
}
|
|
484
527
|
export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
|
|
@@ -526,6 +569,10 @@ export declare enum GuestPortCapability {
|
|
|
526
569
|
GUEST_PORT_CAPABILITY_PWM = 6,
|
|
527
570
|
/** GUEST_PORT_CAPABILITY_ETHERNET_1G - Gigabit Ethernet. */
|
|
528
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,
|
|
529
576
|
UNRECOGNIZED = -1
|
|
530
577
|
}
|
|
531
578
|
export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
|
|
@@ -552,6 +599,36 @@ export declare enum NavigationSensorID {
|
|
|
552
599
|
}
|
|
553
600
|
export declare function navigationSensorIDFromJSON(object: any): NavigationSensorID;
|
|
554
601
|
export declare function navigationSensorIDToJSON(object: NavigationSensorID): string;
|
|
602
|
+
/** Position fix mode reported by the NMEA GSA sentence. */
|
|
603
|
+
export declare enum GnssFixMode {
|
|
604
|
+
/** GNSS_FIX_MODE_UNSPECIFIED - No GSA sentence has been received. */
|
|
605
|
+
GNSS_FIX_MODE_UNSPECIFIED = 0,
|
|
606
|
+
/** GNSS_FIX_MODE_NO_FIX - The receiver has no position fix. */
|
|
607
|
+
GNSS_FIX_MODE_NO_FIX = 1,
|
|
608
|
+
/** GNSS_FIX_MODE_2D - Horizontal fix only, no usable altitude. */
|
|
609
|
+
GNSS_FIX_MODE_2D = 2,
|
|
610
|
+
/** GNSS_FIX_MODE_3D - Full three dimensional fix. */
|
|
611
|
+
GNSS_FIX_MODE_3D = 3,
|
|
612
|
+
UNRECOGNIZED = -1
|
|
613
|
+
}
|
|
614
|
+
export declare function gnssFixModeFromJSON(object: any): GnssFixMode;
|
|
615
|
+
export declare function gnssFixModeToJSON(object: GnssFixMode): string;
|
|
616
|
+
/** GNSS constellation a satellite belongs to. */
|
|
617
|
+
export declare enum GnssConstellation {
|
|
618
|
+
/** GNSS_CONSTELLATION_UNSPECIFIED - Unspecified. */
|
|
619
|
+
GNSS_CONSTELLATION_UNSPECIFIED = 0,
|
|
620
|
+
/** GNSS_CONSTELLATION_GPS - GPS. */
|
|
621
|
+
GNSS_CONSTELLATION_GPS = 1,
|
|
622
|
+
/** GNSS_CONSTELLATION_GLONASS - GLONASS. */
|
|
623
|
+
GNSS_CONSTELLATION_GLONASS = 2,
|
|
624
|
+
/** GNSS_CONSTELLATION_GALILEO - Galileo. */
|
|
625
|
+
GNSS_CONSTELLATION_GALILEO = 3,
|
|
626
|
+
/** GNSS_CONSTELLATION_BEIDOU - BeiDou. */
|
|
627
|
+
GNSS_CONSTELLATION_BEIDOU = 4,
|
|
628
|
+
UNRECOGNIZED = -1
|
|
629
|
+
}
|
|
630
|
+
export declare function gnssConstellationFromJSON(object: any): GnssConstellation;
|
|
631
|
+
export declare function gnssConstellationToJSON(object: GnssConstellation): string;
|
|
555
632
|
/** Status for guest port devices that can be attached and detached. */
|
|
556
633
|
export declare enum GuestPortDetachStatus {
|
|
557
634
|
/** GUEST_PORT_DETACH_STATUS_UNSPECIFIED - Unspecified (Default for non-detachable devices). */
|
|
@@ -752,7 +829,7 @@ export interface MotionInput {
|
|
|
752
829
|
roll: number;
|
|
753
830
|
/** Pitch down (negative) or up (positive). (-1..1). */
|
|
754
831
|
pitch: number;
|
|
755
|
-
/**
|
|
832
|
+
/** Clockwise (positive) and counter-clockwise (negative) rotation (-1..1). */
|
|
756
833
|
yaw: number;
|
|
757
834
|
/** Modifier used to reduce the speed of the motion (0..1). */
|
|
758
835
|
slow: number;
|
|
@@ -967,6 +1044,167 @@ export interface GripperVelocities {
|
|
|
967
1044
|
/** The rotating velocity (-1.0..1.0). */
|
|
968
1045
|
rotateVelocity: number;
|
|
969
1046
|
}
|
|
1047
|
+
/**
|
|
1048
|
+
* Cartesian velocity of the end of a manipulator arm, in the drone body frame.
|
|
1049
|
+
*
|
|
1050
|
+
* Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
|
|
1051
|
+
*/
|
|
1052
|
+
export interface CartesianManipulatorInput {
|
|
1053
|
+
/** Forward (positive) and backward (negative). */
|
|
1054
|
+
x: number;
|
|
1055
|
+
/** Right (positive) and left (negative). */
|
|
1056
|
+
y: number;
|
|
1057
|
+
/** Down (positive) and up (negative). */
|
|
1058
|
+
z: number;
|
|
1059
|
+
}
|
|
1060
|
+
/**
|
|
1061
|
+
* Cylindrical velocity of the end of a manipulator arm, about the axis of the arm's base joint.
|
|
1062
|
+
*
|
|
1063
|
+
* Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
|
|
1064
|
+
*/
|
|
1065
|
+
export interface CylindricalManipulatorInput {
|
|
1066
|
+
/** Out from the base axis (positive) and in towards it (negative). */
|
|
1067
|
+
radial: number;
|
|
1068
|
+
/** Along the base axis: down (positive) and up (negative), as in the drone body frame. */
|
|
1069
|
+
vertical: number;
|
|
1070
|
+
/** Swing about the base axis: clockwise seen from above (positive). */
|
|
1071
|
+
azimuth: number;
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Movement of a manipulator arm towards a named pose, along a path the drone chooses.
|
|
1075
|
+
*
|
|
1076
|
+
* Hold-to-run: the arm moves only while the velocity is above zero, and resumes from wherever it
|
|
1077
|
+
* stopped.
|
|
1078
|
+
*/
|
|
1079
|
+
export interface KnownPoseManipulatorInput {
|
|
1080
|
+
/** The pose to move towards. */
|
|
1081
|
+
pose: ManipulatorPose;
|
|
1082
|
+
/** Speed along the path (0.0..1.0): 0 holds the arm where it is. */
|
|
1083
|
+
velocity: number;
|
|
1084
|
+
}
|
|
1085
|
+
/** Gripper state: of its arm too, when the gripper is a manipulator arm. */
|
|
1086
|
+
export interface Gripper {
|
|
1087
|
+
/** How the arm input of the last command was read. */
|
|
1088
|
+
mode: ManipulatorControlMode;
|
|
1089
|
+
/** Joint positions from the jaws to the base: jaws opening (m), then joint angles (rad). */
|
|
1090
|
+
jointPositions: number[];
|
|
1091
|
+
/** Position of the base of the jaws in the drone body frame (m). */
|
|
1092
|
+
endPosition: Vector3 | undefined;
|
|
1093
|
+
/** A joint at the end of its range keeps the arm from going further. */
|
|
1094
|
+
atLimit: boolean;
|
|
1095
|
+
/** The arm stopped itself short of an obstacle or of itself. */
|
|
1096
|
+
collision: boolean;
|
|
1097
|
+
/** The jaws closed on something. */
|
|
1098
|
+
holding: boolean;
|
|
1099
|
+
/** A joint reports a hardware fault. */
|
|
1100
|
+
fault: boolean;
|
|
1101
|
+
/** Named pose the arm is moving towards, if any. */
|
|
1102
|
+
movingTo: ManipulatorPose;
|
|
1103
|
+
}
|
|
1104
|
+
/**
|
|
1105
|
+
* Hardware status flags a device of a Reach Robotics gripper raises about itself, named as Reach names them.
|
|
1106
|
+
* A gripper of another make would need flags of its own.
|
|
1107
|
+
*/
|
|
1108
|
+
export interface ReachHardwareStatus {
|
|
1109
|
+
/** Reading the device's flash memory failed. */
|
|
1110
|
+
flashFailedRead: boolean;
|
|
1111
|
+
/** Humidity in the housing is too high: water may have got in. */
|
|
1112
|
+
overHumidity: boolean;
|
|
1113
|
+
/** The housing is too hot. */
|
|
1114
|
+
overTemperature: boolean;
|
|
1115
|
+
/** Error on the serial line. */
|
|
1116
|
+
commsSerialError: boolean;
|
|
1117
|
+
/** A packet failed its checksum. */
|
|
1118
|
+
commsCrcError: boolean;
|
|
1119
|
+
/** The motor driver reports a fault. */
|
|
1120
|
+
motorDriverFault: boolean;
|
|
1121
|
+
/** The position encoder reads an invalid position. */
|
|
1122
|
+
encoderPositionError: boolean;
|
|
1123
|
+
/** The position encoder is not detected. */
|
|
1124
|
+
encoderNotDetected: boolean;
|
|
1125
|
+
/** Another device has the same axis. */
|
|
1126
|
+
deviceAxisConflict: boolean;
|
|
1127
|
+
/** The motor is not connected. */
|
|
1128
|
+
motorNotConnected: boolean;
|
|
1129
|
+
/** The motor draws too much current. */
|
|
1130
|
+
motorOverCurrent: boolean;
|
|
1131
|
+
/** The input encoder reads an invalid position. */
|
|
1132
|
+
inputEncoderPositionError: boolean;
|
|
1133
|
+
/** Another device has the same ID. */
|
|
1134
|
+
deviceIdConflict: boolean;
|
|
1135
|
+
/** Pressure in the housing is too high: the seal may have failed. */
|
|
1136
|
+
overPressure: boolean;
|
|
1137
|
+
/** Over current or under voltage in the motor driver. */
|
|
1138
|
+
motorDriverOverCurrentAndUnderVoltage: boolean;
|
|
1139
|
+
/** The motor driver is too hot. */
|
|
1140
|
+
motorDriverOverTemperature: boolean;
|
|
1141
|
+
/** The device is due for service. */
|
|
1142
|
+
jointServiceDue: boolean;
|
|
1143
|
+
/** The position encoder reports a fault. */
|
|
1144
|
+
encoderFault: boolean;
|
|
1145
|
+
/** The supply voltage is too low. */
|
|
1146
|
+
lowSupplyVoltage: boolean;
|
|
1147
|
+
/** A position report the device waits for has not arrived. */
|
|
1148
|
+
positionReportNotReceived: boolean;
|
|
1149
|
+
}
|
|
1150
|
+
/**
|
|
1151
|
+
* Health of one device of a gripper: a joint, or a device of its own.
|
|
1152
|
+
*
|
|
1153
|
+
* A value the device did not report is 0, with its is_*_valid false.
|
|
1154
|
+
*/
|
|
1155
|
+
export interface GripperDeviceDiagnostics {
|
|
1156
|
+
/** Address of the device on the gripper's bus. On a Reach Robotics arm, 1 is the jaws. */
|
|
1157
|
+
address: number;
|
|
1158
|
+
/** Supply voltage (V). */
|
|
1159
|
+
supplyVoltage: number;
|
|
1160
|
+
/** True when the device reported its supply voltage. */
|
|
1161
|
+
isSupplyVoltageValid: boolean;
|
|
1162
|
+
/** Temperature in the housing (°C). */
|
|
1163
|
+
temperature: number;
|
|
1164
|
+
/** True when the device reported the temperature in its housing. */
|
|
1165
|
+
isTemperatureValid: boolean;
|
|
1166
|
+
/** Relative humidity in the housing (%). */
|
|
1167
|
+
humidity: number;
|
|
1168
|
+
/** True when the device reported the humidity in its housing. */
|
|
1169
|
+
isHumidityValid: boolean;
|
|
1170
|
+
/** Absolute pressure in the housing (bar), a partial vacuum: a rise can mean a leak. */
|
|
1171
|
+
internalPressure: number;
|
|
1172
|
+
/** True when the device reported the pressure in its housing. */
|
|
1173
|
+
isInternalPressureValid: boolean;
|
|
1174
|
+
/** Motor current (A). */
|
|
1175
|
+
current: number;
|
|
1176
|
+
/** True when the device reported its motor current. */
|
|
1177
|
+
isCurrentValid: boolean;
|
|
1178
|
+
/**
|
|
1179
|
+
* Flags the device reported, and those it raised since the last report.
|
|
1180
|
+
* Not set if the device sent no hardware status.
|
|
1181
|
+
*/
|
|
1182
|
+
hardwareStatus: ReachHardwareStatus | undefined;
|
|
1183
|
+
}
|
|
1184
|
+
/**
|
|
1185
|
+
* Identity of a gripper: what it is, and what it reports of itself.
|
|
1186
|
+
*
|
|
1187
|
+
* A value the gripper does not report is empty.
|
|
1188
|
+
*/
|
|
1189
|
+
export interface GripperInfo {
|
|
1190
|
+
/** Guest port the gripper is on. */
|
|
1191
|
+
guestPortNumber: GuestPortNumber;
|
|
1192
|
+
/** What the gripper is, as its guest-port connector names it. */
|
|
1193
|
+
deviceId: GuestPortDeviceID;
|
|
1194
|
+
/** Serial number of the gripper, such as 5854. */
|
|
1195
|
+
serialNumber: string;
|
|
1196
|
+
/** Model number of the gripper, such as 5001 for a Reach Alpha 5 or 2130 for a Reach Alpha 2. */
|
|
1197
|
+
modelNumber: string;
|
|
1198
|
+
/** Firmware version of the gripper, such as 5.2.0. */
|
|
1199
|
+
firmwareVersion: string;
|
|
1200
|
+
}
|
|
1201
|
+
/** Health of a gripper and its devices, for diagnostics. */
|
|
1202
|
+
export interface GripperDiagnostics {
|
|
1203
|
+
/** One for each device of the gripper that answered. */
|
|
1204
|
+
devices: GripperDeviceDiagnostics[];
|
|
1205
|
+
/** Guest port the gripper is on. */
|
|
1206
|
+
guestPortNumber: GuestPortNumber;
|
|
1207
|
+
}
|
|
970
1208
|
/** Information about a remote client. */
|
|
971
1209
|
export interface ClientInfo {
|
|
972
1210
|
/** The type of client (such as Blueye App, Observer App, SDK, etc). */
|
|
@@ -1085,6 +1323,20 @@ export interface CanisterHumidity {
|
|
|
1085
1323
|
/** Air humidity (%). */
|
|
1086
1324
|
humidity: number;
|
|
1087
1325
|
}
|
|
1326
|
+
/** Sensor readings inside the X7 power canister. */
|
|
1327
|
+
export interface PowerCanister {
|
|
1328
|
+
/** Front ESC board; absent when no recent reading is available. */
|
|
1329
|
+
frontEsc: PowerCanister_Sensors | undefined;
|
|
1330
|
+
/** Rear ESC board; absent when no recent reading is available. */
|
|
1331
|
+
rearEsc: PowerCanister_Sensors | undefined;
|
|
1332
|
+
}
|
|
1333
|
+
/** Sensor readings from an ESC board. */
|
|
1334
|
+
export interface PowerCanister_Sensors {
|
|
1335
|
+
/** Temperature (°C). */
|
|
1336
|
+
temperature: number;
|
|
1337
|
+
/** Relative humidity (%). */
|
|
1338
|
+
humidity: number;
|
|
1339
|
+
}
|
|
1088
1340
|
/** Essential battery information. */
|
|
1089
1341
|
export interface Battery {
|
|
1090
1342
|
/** Battery voltage (V). */
|
|
@@ -1902,12 +2154,22 @@ export interface ErrorFlags {
|
|
|
1902
2154
|
dvlThermalProtectionMode: boolean;
|
|
1903
2155
|
/** GP protection has been triggered at boot or faulty DVL. */
|
|
1904
2156
|
dvlNoPower: boolean;
|
|
2157
|
+
/** DVL firmware speaks a protocol version Blunux does not support. */
|
|
2158
|
+
dvlProtocolUnsupported: boolean;
|
|
1905
2159
|
/** USB disconnect. */
|
|
1906
2160
|
usbDisconnect: boolean;
|
|
1907
2161
|
/** Video URB error. */
|
|
1908
2162
|
videoUrbError: boolean;
|
|
1909
2163
|
/** Hardware not supported on current blunux version. */
|
|
1910
2164
|
hardwareNotSupported: boolean;
|
|
2165
|
+
/** MPU 1 unavailable at observer startup. */
|
|
2166
|
+
imu1: boolean;
|
|
2167
|
+
/** MPU 2 unavailable at observer startup. */
|
|
2168
|
+
imu2: boolean;
|
|
2169
|
+
/** HP IMU unavailable on X3 Ultra or X7. */
|
|
2170
|
+
imuHp: boolean;
|
|
2171
|
+
/** No attitude source: manual body-frame control only. */
|
|
2172
|
+
imuAttitude: boolean;
|
|
1911
2173
|
}
|
|
1912
2174
|
/** Camera parameters. */
|
|
1913
2175
|
export interface CameraParameters {
|
|
@@ -2007,11 +2269,14 @@ export interface OverlayParameters {
|
|
|
2007
2269
|
thicknessUnit: ThicknessUnit;
|
|
2008
2270
|
/** Timezone offset from UTC (min). */
|
|
2009
2271
|
timezoneOffset: number;
|
|
2010
|
-
/** Horizontal margins of text elements (px). */
|
|
2272
|
+
/** Horizontal margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
|
|
2011
2273
|
marginWidth: number;
|
|
2012
|
-
/** Vertical margins of text elements (px). */
|
|
2274
|
+
/** Vertical margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
|
|
2013
2275
|
marginHeight: number;
|
|
2014
|
-
/**
|
|
2276
|
+
/**
|
|
2277
|
+
* Font size of text elements. FONT_SIZE_UNSPECIFIED derives font size and margins from the
|
|
2278
|
+
* recording resolution (Blunux >= 5.2). Older firmware defaults to 25px.
|
|
2279
|
+
*/
|
|
2015
2280
|
fontSize: FontSize;
|
|
2016
2281
|
/** Optional title. */
|
|
2017
2282
|
title: string;
|
|
@@ -2041,6 +2306,86 @@ export interface NavigationSensorStatus {
|
|
|
2041
2306
|
/** Global position from sensor. */
|
|
2042
2307
|
globalPosition: LatLongPosition | undefined;
|
|
2043
2308
|
}
|
|
2309
|
+
/** Satellite tracked by the Blueye GNSS receiver. */
|
|
2310
|
+
export interface GnssSatellite {
|
|
2311
|
+
/** Constellation the satellite belongs to. */
|
|
2312
|
+
constellation: GnssConstellation;
|
|
2313
|
+
/** Satellite id within the constellation. */
|
|
2314
|
+
satelliteId: number;
|
|
2315
|
+
/** Carrier to noise ratio (dB-Hz). */
|
|
2316
|
+
snr: number;
|
|
2317
|
+
/** Elevation above the horizon (°, 0..90), or -1 when the receiver did not report it. */
|
|
2318
|
+
elevation: number;
|
|
2319
|
+
/** Azimuth clockwise from true north (°, 0..359), or -1 when the receiver did not report it. */
|
|
2320
|
+
azimuth: number;
|
|
2321
|
+
/** Whether GSA lists the satellite as used in the fix. Only meaningful if is_used_in_fix_valid. */
|
|
2322
|
+
usedInFix: boolean;
|
|
2323
|
+
}
|
|
2324
|
+
/** Status of the onboard Blueye GNSS receiver and its driver. */
|
|
2325
|
+
export interface GnssStatus {
|
|
2326
|
+
/** True when the receiver is connected and producing NMEA sentences. */
|
|
2327
|
+
receiverConnected: boolean;
|
|
2328
|
+
/** NMEA GGA fix quality indicator (0 = no fix). */
|
|
2329
|
+
fixQuality: number;
|
|
2330
|
+
/** True when the receiver reports a usable position fix. */
|
|
2331
|
+
isValid: boolean;
|
|
2332
|
+
/** Number of satellites used in the position fix. */
|
|
2333
|
+
satellitesUsed: number;
|
|
2334
|
+
/** Satellites in the satellites list: those with a signal in the latest GSV burst. */
|
|
2335
|
+
satellitesTracked: number;
|
|
2336
|
+
/** Satellites predicted above the horizon, over all constellations; needs no signal. */
|
|
2337
|
+
satellitesInView: number;
|
|
2338
|
+
/** True when GSA could be attributed to a constellation, making used_in_fix usable. */
|
|
2339
|
+
isUsedInFixValid: boolean;
|
|
2340
|
+
/** Fix mode from GSA (2D/3D). */
|
|
2341
|
+
fixMode: GnssFixMode;
|
|
2342
|
+
/** Horizontal dilution of precision. */
|
|
2343
|
+
hdop: number;
|
|
2344
|
+
/** Position (3D) dilution of precision, from GSA. */
|
|
2345
|
+
pdop: number;
|
|
2346
|
+
/** Vertical dilution of precision, from GSA. */
|
|
2347
|
+
vdop: number;
|
|
2348
|
+
/** Reported global position. */
|
|
2349
|
+
globalPosition: LatLongPosition | undefined;
|
|
2350
|
+
/** Altitude above mean sea level (m), from GGA. */
|
|
2351
|
+
altitude: number;
|
|
2352
|
+
/** Standard deviation of the latitude (m). Meaningless unless is_accuracy_valid. */
|
|
2353
|
+
stddevLatitude: number;
|
|
2354
|
+
/** Standard deviation of the longitude (m). Meaningless unless is_accuracy_valid. */
|
|
2355
|
+
stddevLongitude: number;
|
|
2356
|
+
/** Standard deviation of the altitude (m). Meaningless unless is_accuracy_valid. */
|
|
2357
|
+
stddevAltitude: number;
|
|
2358
|
+
/** Semi-major axis of the horizontal error ellipse (m). */
|
|
2359
|
+
stddevSemiMajor: number;
|
|
2360
|
+
/** Semi-minor axis of the horizontal error ellipse (m). */
|
|
2361
|
+
stddevSemiMinor: number;
|
|
2362
|
+
/** Orientation of the semi-major axis, clockwise from true north (°). */
|
|
2363
|
+
errorEllipseOrientation: number;
|
|
2364
|
+
/** RMS of the range residuals (m), from GST. */
|
|
2365
|
+
rangeRms: number;
|
|
2366
|
+
/** True once the receiver has reported a GST sentence to derive the deviations from. */
|
|
2367
|
+
isAccuracyValid: boolean;
|
|
2368
|
+
/** Course over ground (°). Meaningless unless is_course_valid. */
|
|
2369
|
+
courseOverGround: number;
|
|
2370
|
+
/** True when the fix is valid and the receiver actually reported a course. */
|
|
2371
|
+
isCourseValid: boolean;
|
|
2372
|
+
/** Speed over ground (m/s). */
|
|
2373
|
+
speedOverGround: number;
|
|
2374
|
+
/** Age of the differential corrections (s), or -1 without DGPS/RTK. */
|
|
2375
|
+
differentialAge: number;
|
|
2376
|
+
/** Id of the station supplying the differential corrections, or -1 when absent. */
|
|
2377
|
+
differentialStation: number;
|
|
2378
|
+
/** Serial baud rate in use (bit/s). */
|
|
2379
|
+
baudRate: number;
|
|
2380
|
+
/** Times the driver has reconnected to the receiver since boot. */
|
|
2381
|
+
reconnectCount: number;
|
|
2382
|
+
/** Receive errors seen by the driver since boot. */
|
|
2383
|
+
receiveErrorCount: number;
|
|
2384
|
+
/** Time since the last NMEA sentence was received (s). */
|
|
2385
|
+
timeSinceLastSentence: number;
|
|
2386
|
+
/** Satellites currently tracked with signal strength. */
|
|
2387
|
+
satellites: GnssSatellite[];
|
|
2388
|
+
}
|
|
2044
2389
|
/** Information about a device connected to one of the guest ports. */
|
|
2045
2390
|
export interface GuestPortDevice {
|
|
2046
2391
|
/** Blueye device identifier. */
|
|
@@ -2337,6 +2682,17 @@ export interface MultibeamDiscovery {
|
|
|
2337
2682
|
/** Error flags specific for the connected multibeam device. */
|
|
2338
2683
|
errorFlags: MultibeamErrorFlags | undefined;
|
|
2339
2684
|
}
|
|
2685
|
+
/**
|
|
2686
|
+
* Color filter used to render the multibeam sonar fan.
|
|
2687
|
+
*
|
|
2688
|
+
* The fan renderer maps each echo intensity (0..255) to a color through this
|
|
2689
|
+
* lookup table. The drone keeps the last filter received in memory and applies
|
|
2690
|
+
* it to the sonar RTSP stream; grayscale is used until one is set.
|
|
2691
|
+
*/
|
|
2692
|
+
export interface MultibeamColorFilter {
|
|
2693
|
+
/** 768 bytes: 256 consecutive R,G,B triplets, indexed by echo intensity. */
|
|
2694
|
+
rgb: Uint8Array;
|
|
2695
|
+
}
|
|
2340
2696
|
/** Error flags for multibeam sonar devices. */
|
|
2341
2697
|
export interface MultibeamErrorFlags {
|
|
2342
2698
|
/**
|
|
@@ -2632,12 +2988,19 @@ export interface BoundingBox {
|
|
|
2632
2988
|
height: number;
|
|
2633
2989
|
}
|
|
2634
2990
|
/**
|
|
2635
|
-
* RLE-encoded binary segmentation mask
|
|
2991
|
+
* RLE-encoded binary segmentation mask with its own anchor box.
|
|
2636
2992
|
*
|
|
2637
2993
|
* The mask bitmap has dimensions (mask_width x mask_height) covering the
|
|
2638
|
-
*
|
|
2639
|
-
* data as packed uint16 little-endian: alternating
|
|
2640
|
-
* pixel runs starting with background.
|
|
2994
|
+
* mask_box region of the camera image. The counts field stores run-length
|
|
2995
|
+
* encoded data as packed uint16 little-endian: alternating
|
|
2996
|
+
* background/foreground pixel runs starting with background. Runs longer
|
|
2997
|
+
* than 65535 pixels are split by inserting a zero-length run of the
|
|
2998
|
+
* opposite class (e.g. 70000 becomes 65535, 0, 4465), so decoders need no
|
|
2999
|
+
* special handling — a zero-length run just toggles the class.
|
|
3000
|
+
*
|
|
3001
|
+
* Scale the mask to mask_box, not to the detection's bounding_box: the
|
|
3002
|
+
* bounding box may be smoothed by tracking, while mask_box is pinned to the
|
|
3003
|
+
* raw detection position, so the mask stays on the actual object pixels.
|
|
2641
3004
|
*/
|
|
2642
3005
|
export interface SegmentationMask {
|
|
2643
3006
|
/** Width of the RLE bitmap. */
|
|
@@ -2646,10 +3009,12 @@ export interface SegmentationMask {
|
|
|
2646
3009
|
maskHeight: number;
|
|
2647
3010
|
/** RLE counts as packed uint16 little-endian. */
|
|
2648
3011
|
counts: Uint8Array;
|
|
3012
|
+
/** Image region the mask bitmap covers (raw detection position, never smoothed). */
|
|
3013
|
+
maskBox: BoundingBox | undefined;
|
|
2649
3014
|
}
|
|
2650
3015
|
/** A single object detection from a computer vision model. */
|
|
2651
3016
|
export interface ObjectDetection {
|
|
2652
|
-
/** Bounding box of the detected object. */
|
|
3017
|
+
/** Bounding box of the detected object (may be smoothed by tracking). */
|
|
2653
3018
|
boundingBox: BoundingBox | undefined;
|
|
2654
3019
|
/** Detection confidence score (0..1). */
|
|
2655
3020
|
confidence: number;
|
|
@@ -2682,6 +3047,13 @@ export interface FilterMessage {
|
|
|
2682
3047
|
/** Intensity of the filter (0..1). */
|
|
2683
3048
|
intensity: number;
|
|
2684
3049
|
}
|
|
3050
|
+
/** Frames that the marine snow filter compares each frame with. */
|
|
3051
|
+
export interface MarineSnowFilterFrames {
|
|
3052
|
+
/** Past frames to compare with (1..4). */
|
|
3053
|
+
pastFrames: number;
|
|
3054
|
+
/** Future frames to compare with (0..2). Each one delays the video by 33 to 40 ms. */
|
|
3055
|
+
futureFrames: number;
|
|
3056
|
+
}
|
|
2685
3057
|
/**
|
|
2686
3058
|
* Digital pan, tilt, and zoom state for the main camera.
|
|
2687
3059
|
*
|
|
@@ -2804,6 +3176,14 @@ export declare const ControlMode: MessageFns<ControlMode>;
|
|
|
2804
3176
|
export declare const TiltStabilizationState: MessageFns<TiltStabilizationState>;
|
|
2805
3177
|
export declare const SystemTime: MessageFns<SystemTime>;
|
|
2806
3178
|
export declare const GripperVelocities: MessageFns<GripperVelocities>;
|
|
3179
|
+
export declare const CartesianManipulatorInput: MessageFns<CartesianManipulatorInput>;
|
|
3180
|
+
export declare const CylindricalManipulatorInput: MessageFns<CylindricalManipulatorInput>;
|
|
3181
|
+
export declare const KnownPoseManipulatorInput: MessageFns<KnownPoseManipulatorInput>;
|
|
3182
|
+
export declare const Gripper: MessageFns<Gripper>;
|
|
3183
|
+
export declare const ReachHardwareStatus: MessageFns<ReachHardwareStatus>;
|
|
3184
|
+
export declare const GripperDeviceDiagnostics: MessageFns<GripperDeviceDiagnostics>;
|
|
3185
|
+
export declare const GripperInfo: MessageFns<GripperInfo>;
|
|
3186
|
+
export declare const GripperDiagnostics: MessageFns<GripperDiagnostics>;
|
|
2807
3187
|
export declare const ClientInfo: MessageFns<ClientInfo>;
|
|
2808
3188
|
export declare const ConnectedClient: MessageFns<ConnectedClient>;
|
|
2809
3189
|
export declare const RecordState: MessageFns<RecordState>;
|
|
@@ -2814,6 +3194,8 @@ export declare const WaterTemperature: MessageFns<WaterTemperature>;
|
|
|
2814
3194
|
export declare const CPUTemperature: MessageFns<CPUTemperature>;
|
|
2815
3195
|
export declare const CanisterTemperature: MessageFns<CanisterTemperature>;
|
|
2816
3196
|
export declare const CanisterHumidity: MessageFns<CanisterHumidity>;
|
|
3197
|
+
export declare const PowerCanister: MessageFns<PowerCanister>;
|
|
3198
|
+
export declare const PowerCanister_Sensors: MessageFns<PowerCanister_Sensors>;
|
|
2817
3199
|
export declare const Battery: MessageFns<Battery>;
|
|
2818
3200
|
export declare const BatteryBQ40Z50: MessageFns<BatteryBQ40Z50>;
|
|
2819
3201
|
export declare const BatteryBQ40Z50_Voltage: MessageFns<BatteryBQ40Z50_Voltage>;
|
|
@@ -2854,6 +3236,8 @@ export declare const ErrorFlags: MessageFns<ErrorFlags>;
|
|
|
2854
3236
|
export declare const CameraParameters: MessageFns<CameraParameters>;
|
|
2855
3237
|
export declare const OverlayParameters: MessageFns<OverlayParameters>;
|
|
2856
3238
|
export declare const NavigationSensorStatus: MessageFns<NavigationSensorStatus>;
|
|
3239
|
+
export declare const GnssSatellite: MessageFns<GnssSatellite>;
|
|
3240
|
+
export declare const GnssStatus: MessageFns<GnssStatus>;
|
|
2857
3241
|
export declare const GuestPortDevice: MessageFns<GuestPortDevice>;
|
|
2858
3242
|
export declare const GuestPortDeviceList: MessageFns<GuestPortDeviceList>;
|
|
2859
3243
|
export declare const GuestPortConnectorInfo: MessageFns<GuestPortConnectorInfo>;
|
|
@@ -2870,6 +3254,7 @@ export declare const MedusaSpectrometerData: MessageFns<MedusaSpectrometerData>;
|
|
|
2870
3254
|
export declare const MultibeamPing: MessageFns<MultibeamPing>;
|
|
2871
3255
|
export declare const MultibeamConfig: MessageFns<MultibeamConfig>;
|
|
2872
3256
|
export declare const MultibeamDiscovery: MessageFns<MultibeamDiscovery>;
|
|
3257
|
+
export declare const MultibeamColorFilter: MessageFns<MultibeamColorFilter>;
|
|
2873
3258
|
export declare const MultibeamErrorFlags: MessageFns<MultibeamErrorFlags>;
|
|
2874
3259
|
export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
|
|
2875
3260
|
export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;
|
|
@@ -2890,6 +3275,7 @@ export declare const SegmentationMask: MessageFns<SegmentationMask>;
|
|
|
2890
3275
|
export declare const ObjectDetection: MessageFns<ObjectDetection>;
|
|
2891
3276
|
export declare const ModelDetections: MessageFns<ModelDetections>;
|
|
2892
3277
|
export declare const FilterMessage: MessageFns<FilterMessage>;
|
|
3278
|
+
export declare const MarineSnowFilterFrames: MessageFns<MarineSnowFilterFrames>;
|
|
2893
3279
|
export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
|
|
2894
3280
|
export declare const OperatorInfo: MessageFns<OperatorInfo>;
|
|
2895
3281
|
export declare const SotState: MessageFns<SotState>;
|