@blueyerobotics/protocol-definitions 3.4.0-618bf0b0 → 3.4.0-eddb8a5e

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.
@@ -2,5 +2,6 @@ export * from "./aquatroll.js";
2
2
  export * from "./message_formats.js";
3
3
  export * from "./control.js";
4
4
  export * from "./mission_planning.js";
5
+ export * from "./slam.js";
5
6
  export * from "./req_rep.js";
6
7
  export * from "./telemetry.js";
@@ -7,5 +7,6 @@ export * from "./aquatroll.js";
7
7
  export * from "./message_formats.js";
8
8
  export * from "./control.js";
9
9
  export * from "./mission_planning.js";
10
+ export * from "./slam.js";
10
11
  export * from "./req_rep.js";
11
12
  export * from "./telemetry.js";
@@ -516,6 +516,12 @@ export declare enum GuestPortDeviceID {
516
516
  GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 = 51,
517
517
  /** GUEST_PORT_DEVICE_ID_REACH_ROBOTICS_REACH_ALPHA_5 - Reach Robotics Reach Alpha 5 Manipulator. */
518
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,
519
525
  UNRECOGNIZED = -1
520
526
  }
521
527
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -563,6 +569,10 @@ export declare enum GuestPortCapability {
563
569
  GUEST_PORT_CAPABILITY_PWM = 6,
564
570
  /** GUEST_PORT_CAPABILITY_ETHERNET_1G - Gigabit Ethernet. */
565
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,
566
576
  UNRECOGNIZED = -1
567
577
  }
568
578
  export declare function guestPortCapabilityFromJSON(object: any): GuestPortCapability;
@@ -881,6 +891,11 @@ export interface LaserDetection {
881
891
  correctedPixelDistance: number;
882
892
  /** Estimated subject distance (m). */
883
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;
884
899
  }
885
900
  /** Latitude and longitude position in WGS 84 decimal degrees format. */
886
901
  export interface LatLongPosition {
@@ -1091,6 +1106,110 @@ export interface Gripper {
1091
1106
  /** Named pose the arm is moving towards, if any. */
1092
1107
  movingTo: ManipulatorPose;
1093
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
+ }
1094
1213
  /** Information about a remote client. */
1095
1214
  export interface ClientInfo {
1096
1215
  /** The type of client (such as Blueye App, Observer App, SDK, etc). */
@@ -1547,7 +1666,7 @@ export interface DvlVelocity {
1547
1666
  deltaTime: number;
1548
1667
  /** Figure of merit, a measure of the accuracy of the velocities (m/s). */
1549
1668
  fom: number;
1550
- /** Velocity, x forward, y left, z down (m/s). */
1669
+ /** Velocity, x forward, y right, z down (m/s). */
1551
1670
  velocity: Vector3 | undefined;
1552
1671
  /** Water tracking status. */
1553
1672
  isWaterTracking: boolean;
@@ -1877,6 +1996,13 @@ export interface DroneInfo {
1877
1996
  powerSource: PowerSource;
1878
1997
  /** Intrinsic calibration of the main camera. Unset when unknown. */
1879
1998
  mainCameraCalibration: CameraCalibration | undefined;
1999
+ /** Dive number, the counter at the end of the logfile name. 0 when unknown. */
2000
+ diveNumber: number;
2001
+ /**
2002
+ * Name of the dive logfile without extension (e.g. BYEDP070012_ea9ac92e040aa9d4_00231).
2003
+ * Unlike dive_number it stays unique when the counter restarts, e.g. after the storage is replaced.
2004
+ */
2005
+ logName: string;
1880
2006
  }
1881
2007
  /** Known error states for the drone. */
1882
2008
  export interface ErrorFlags {
@@ -2913,7 +3039,26 @@ export interface ObjectDetection {
2913
3039
  /** Instance segmentation mask (absent if model has no segmentation). */
2914
3040
  mask: SegmentationMask | undefined;
2915
3041
  }
2916
- /** A list of object detections from a single model for a single video frame. */
3042
+ /**
3043
+ * A list of object detections from a single model for a single video frame.
3044
+ *
3045
+ * frame_id matches detections to the exact frame of a recording. The video pipeline on the X3 Ultra
3046
+ * assigns an id to each camera frame once, passes it to the computer vision models and the recorder,
3047
+ * and writes it into the recorded video. An id is never reused within one boot of the drone, and stays
3048
+ * below 2^53, so it is exact as a JavaScript number. The models do not process every frame, so the ids
3049
+ * of successive results can skip.
3050
+ *
3051
+ * Recorded video carries the id in a user_data_unregistered SEI message (payload type 5), one per access
3052
+ * unit, placed before the first slice: NAL unit type 6 in H.264 and PREFIX_SEI_NUT (type 39) in H.265.
3053
+ * The payload is 32 bytes, counted after the emulation prevention bytes are removed:
3054
+ *
3055
+ * - Bytes 0-15: UUID 6b1e2f0c-935d-4a8e-b17a-52d40e3c91f6, in the byte order written.
3056
+ * - Bytes 16-23: frame_id, uint64 big-endian.
3057
+ * - Bytes 24-31: capture time of the frame in CLOCK_MONOTONIC on the drone (ns), uint64 big-endian, 0 if unknown.
3058
+ *
3059
+ * A frame that the recorder repeats to keep the frame rate carries the id of the frame it repeats.
3060
+ * Re-encoding the video drops the SEI, so only the original recording carries the ids.
3061
+ */
2917
3062
  export interface ModelDetections {
2918
3063
  /** List of detections in the frame. */
2919
3064
  detections: ObjectDetection[];
@@ -2925,6 +3070,11 @@ export interface ModelDetections {
2925
3070
  imageHeight: number;
2926
3071
  /** Name of the computer vision model that produced the detections. */
2927
3072
  modelName: string;
3073
+ /**
3074
+ * Id of the camera frame the detections were computed from, 0 if unknown. Matches the frame id
3075
+ * embedded in recorded video; the message description gives the format.
3076
+ */
3077
+ frameId: number;
2928
3078
  }
2929
3079
  /** Generic filter settings. */
2930
3080
  export interface FilterMessage {
@@ -2990,6 +3140,11 @@ export interface SotState {
2990
3140
  vs: number;
2991
3141
  /** Kalman rate of change of the bounding box aspect ratio, width / height (1/s). */
2992
3142
  vr: number;
3143
+ /**
3144
+ * Id of the camera frame the state was computed from, 0 if unknown. Matches the frame id embedded
3145
+ * in recorded video; ModelDetections describes the format.
3146
+ */
3147
+ frameId: number;
2993
3148
  }
2994
3149
  /** Current state of the SOT tracker. */
2995
3150
  export declare enum SotState_State {
@@ -3036,6 +3191,39 @@ export interface Annotation {
3036
3191
  /** Origin of the annotation; the app sets APP, the drone sets DRONE for its own. */
3037
3192
  source: AnnotationSource;
3038
3193
  }
3194
+ /**
3195
+ * Unit quaternion describing a rotation (Hamilton convention: w + xi + yj + zk).
3196
+ *
3197
+ * Where it is a body's orientation, it rotates vectors from the body's frame to
3198
+ * the frame the body is placed in.
3199
+ */
3200
+ export interface Quaternion {
3201
+ /** X-component of the vector part. */
3202
+ x: number;
3203
+ /** Y-component of the vector part. */
3204
+ y: number;
3205
+ /** Z-component of the vector part. */
3206
+ z: number;
3207
+ /** Scalar part. */
3208
+ w: number;
3209
+ }
3210
+ /**
3211
+ * Points packed for use as typed arrays without decoding them one by one.
3212
+ *
3213
+ * The frame the positions are in is the one the enclosing message names.
3214
+ *
3215
+ * count says how many points the bytes hold: positions is exactly count * 12 bytes,
3216
+ * and intensities either empty or count bytes. A cloud whose bytes disagree with
3217
+ * count is malformed, and is not used.
3218
+ */
3219
+ export interface PointCloud {
3220
+ /** Number of points. */
3221
+ count: number;
3222
+ /** count x, y, z triplets of little-endian float32 (m): 12 bytes per point. */
3223
+ positions: Uint8Array;
3224
+ /** count signal strengths, one byte each (0 to 255), or empty when unknown. */
3225
+ intensities: Uint8Array;
3226
+ }
3039
3227
  export declare const BinlogRecord: MessageFns<BinlogRecord>;
3040
3228
  export declare const LogEntry: MessageFns<LogEntry>;
3041
3229
  export declare const KernelLogEntry: MessageFns<KernelLogEntry>;
@@ -3066,6 +3254,10 @@ export declare const CartesianManipulatorInput: MessageFns<CartesianManipulatorI
3066
3254
  export declare const CylindricalManipulatorInput: MessageFns<CylindricalManipulatorInput>;
3067
3255
  export declare const KnownPoseManipulatorInput: MessageFns<KnownPoseManipulatorInput>;
3068
3256
  export declare const Gripper: MessageFns<Gripper>;
3257
+ export declare const ReachHardwareStatus: MessageFns<ReachHardwareStatus>;
3258
+ export declare const GripperDeviceDiagnostics: MessageFns<GripperDeviceDiagnostics>;
3259
+ export declare const GripperInfo: MessageFns<GripperInfo>;
3260
+ export declare const GripperDiagnostics: MessageFns<GripperDiagnostics>;
3069
3261
  export declare const ClientInfo: MessageFns<ClientInfo>;
3070
3262
  export declare const ConnectedClient: MessageFns<ConnectedClient>;
3071
3263
  export declare const RecordState: MessageFns<RecordState>;
@@ -3162,6 +3354,8 @@ export declare const CameraPanTiltZoom: MessageFns<CameraPanTiltZoom>;
3162
3354
  export declare const OperatorInfo: MessageFns<OperatorInfo>;
3163
3355
  export declare const SotState: MessageFns<SotState>;
3164
3356
  export declare const Annotation: MessageFns<Annotation>;
3357
+ export declare const Quaternion: MessageFns<Quaternion>;
3358
+ export declare const PointCloud: MessageFns<PointCloud>;
3165
3359
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
3166
3360
  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 {} ? {
3167
3361
  [K in keyof T]?: DeepPartial<T[K]>;