@blueyerobotics/protocol-definitions 3.3.0-2d41d872 → 3.3.0-2d5d3956

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/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 { Annotation, AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, ConnectionDuration, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, VisionTrackingState, WaterDensity, WeatherVaningState } from "./message_formats";
3
+ import { Annotation, AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, CartesianManipulatorInput, ConnectionDuration, CylindricalManipulatorInput, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, KnownPoseManipulatorInput, Laser, LatLongPosition, Lights, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, VisionTrackingState, WaterDensity, WeatherVaningState } from "./message_formats";
4
4
  /**
5
5
  * Control
6
6
  *
@@ -157,10 +157,26 @@ export interface SystemTimeCtrl {
157
157
  /** Message with the system time to set. */
158
158
  systemTime: SystemTime | undefined;
159
159
  }
160
- /** Issue a command to control the gripper. */
160
+ /**
161
+ * Issue a command to control the gripper.
162
+ *
163
+ * On a manipulator arm the command can also move the arm. Each command stands until the next one: the
164
+ * arm stops on a command without arm input, or when the client watchdog (WatchdogCtrl) lapses.
165
+ */
161
166
  export interface GripperCtrl {
162
167
  /** The desired gripping and rotation velocity. */
163
168
  gripperVelocities: GripperVelocities | undefined;
169
+ /** In the drone body frame. */
170
+ cartesian?: CartesianManipulatorInput | undefined;
171
+ /** About the axis of the arm's base joint. */
172
+ cylindrical?: CylindricalManipulatorInput | undefined;
173
+ /** Towards a named pose, such as stowed or deployed. */
174
+ knownPose?: KnownPoseManipulatorInput | undefined;
175
+ /**
176
+ * Speed of the arm input relative to the drone default (-1.0..1.0): negative is slower, positive is
177
+ * faster, and 0 is the default speed. Scales arm_input only, not gripper_velocities.
178
+ */
179
+ speedModifier: number;
164
180
  }
165
181
  /** Issue a command to set a generic servo value. */
166
182
  export interface GenericServoCtrl {
package/dist/control.js CHANGED
@@ -1508,13 +1508,31 @@ exports.SystemTimeCtrl = {
1508
1508
  },
1509
1509
  };
1510
1510
  function createBaseGripperCtrl() {
1511
- return { gripperVelocities: undefined };
1511
+ return {
1512
+ gripperVelocities: undefined,
1513
+ cartesian: undefined,
1514
+ cylindrical: undefined,
1515
+ knownPose: undefined,
1516
+ speedModifier: 0,
1517
+ };
1512
1518
  }
1513
1519
  exports.GripperCtrl = {
1514
1520
  encode(message, writer = new wire_1.BinaryWriter()) {
1515
1521
  if (message.gripperVelocities !== undefined) {
1516
1522
  message_formats_1.GripperVelocities.encode(message.gripperVelocities, writer.uint32(10).fork()).join();
1517
1523
  }
1524
+ if (message.cartesian !== undefined) {
1525
+ message_formats_1.CartesianManipulatorInput.encode(message.cartesian, writer.uint32(18).fork()).join();
1526
+ }
1527
+ if (message.cylindrical !== undefined) {
1528
+ message_formats_1.CylindricalManipulatorInput.encode(message.cylindrical, writer.uint32(26).fork()).join();
1529
+ }
1530
+ if (message.knownPose !== undefined) {
1531
+ message_formats_1.KnownPoseManipulatorInput.encode(message.knownPose, writer.uint32(42).fork()).join();
1532
+ }
1533
+ if (message.speedModifier !== 0) {
1534
+ writer.uint32(37).float(message.speedModifier);
1535
+ }
1518
1536
  return writer;
1519
1537
  },
1520
1538
  decode(input, length) {
@@ -1531,6 +1549,34 @@ exports.GripperCtrl = {
1531
1549
  message.gripperVelocities = message_formats_1.GripperVelocities.decode(reader, reader.uint32());
1532
1550
  continue;
1533
1551
  }
1552
+ case 2: {
1553
+ if (tag !== 18) {
1554
+ break;
1555
+ }
1556
+ message.cartesian = message_formats_1.CartesianManipulatorInput.decode(reader, reader.uint32());
1557
+ continue;
1558
+ }
1559
+ case 3: {
1560
+ if (tag !== 26) {
1561
+ break;
1562
+ }
1563
+ message.cylindrical = message_formats_1.CylindricalManipulatorInput.decode(reader, reader.uint32());
1564
+ continue;
1565
+ }
1566
+ case 5: {
1567
+ if (tag !== 42) {
1568
+ break;
1569
+ }
1570
+ message.knownPose = message_formats_1.KnownPoseManipulatorInput.decode(reader, reader.uint32());
1571
+ continue;
1572
+ }
1573
+ case 4: {
1574
+ if (tag !== 37) {
1575
+ break;
1576
+ }
1577
+ message.speedModifier = reader.float();
1578
+ continue;
1579
+ }
1534
1580
  }
1535
1581
  if ((tag & 7) === 4 || tag === 0) {
1536
1582
  break;
@@ -1544,6 +1590,10 @@ exports.GripperCtrl = {
1544
1590
  gripperVelocities: isSet(object.gripperVelocities)
1545
1591
  ? message_formats_1.GripperVelocities.fromJSON(object.gripperVelocities)
1546
1592
  : undefined,
1593
+ cartesian: isSet(object.cartesian) ? message_formats_1.CartesianManipulatorInput.fromJSON(object.cartesian) : undefined,
1594
+ cylindrical: isSet(object.cylindrical) ? message_formats_1.CylindricalManipulatorInput.fromJSON(object.cylindrical) : undefined,
1595
+ knownPose: isSet(object.knownPose) ? message_formats_1.KnownPoseManipulatorInput.fromJSON(object.knownPose) : undefined,
1596
+ speedModifier: isSet(object.speedModifier) ? gt.Number(object.speedModifier) : 0,
1547
1597
  };
1548
1598
  },
1549
1599
  toJSON(message) {
@@ -1551,6 +1601,18 @@ exports.GripperCtrl = {
1551
1601
  if (message.gripperVelocities !== undefined) {
1552
1602
  obj.gripperVelocities = message_formats_1.GripperVelocities.toJSON(message.gripperVelocities);
1553
1603
  }
1604
+ if (message.cartesian !== undefined) {
1605
+ obj.cartesian = message_formats_1.CartesianManipulatorInput.toJSON(message.cartesian);
1606
+ }
1607
+ if (message.cylindrical !== undefined) {
1608
+ obj.cylindrical = message_formats_1.CylindricalManipulatorInput.toJSON(message.cylindrical);
1609
+ }
1610
+ if (message.knownPose !== undefined) {
1611
+ obj.knownPose = message_formats_1.KnownPoseManipulatorInput.toJSON(message.knownPose);
1612
+ }
1613
+ if (message.speedModifier !== 0) {
1614
+ obj.speedModifier = message.speedModifier;
1615
+ }
1554
1616
  return obj;
1555
1617
  },
1556
1618
  create(base) {
@@ -1561,6 +1623,16 @@ exports.GripperCtrl = {
1561
1623
  message.gripperVelocities = (object.gripperVelocities !== undefined && object.gripperVelocities !== null)
1562
1624
  ? message_formats_1.GripperVelocities.fromPartial(object.gripperVelocities)
1563
1625
  : undefined;
1626
+ message.cartesian = (object.cartesian !== undefined && object.cartesian !== null)
1627
+ ? message_formats_1.CartesianManipulatorInput.fromPartial(object.cartesian)
1628
+ : undefined;
1629
+ message.cylindrical = (object.cylindrical !== undefined && object.cylindrical !== null)
1630
+ ? message_formats_1.CylindricalManipulatorInput.fromPartial(object.cylindrical)
1631
+ : undefined;
1632
+ message.knownPose = (object.knownPose !== undefined && object.knownPose !== null)
1633
+ ? message_formats_1.KnownPoseManipulatorInput.fromPartial(object.knownPose)
1634
+ : undefined;
1635
+ message.speedModifier = object.speedModifier ?? 0;
1564
1636
  return message;
1565
1637
  },
1566
1638
  };
@@ -6,6 +6,32 @@ import { Duration } from "./google/protobuf/duration";
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;
@@ -352,7 +380,10 @@ export declare function thicknessUnitFromJSON(object: any): ThicknessUnit;
352
380
  export declare function thicknessUnitToJSON(object: ThicknessUnit): string;
353
381
  /** Available font sizes for overlay text elements. */
354
382
  export declare enum FontSize {
355
- /** FONT_SIZE_UNSPECIFIED - Font size not specified. */
383
+ /**
384
+ * FONT_SIZE_UNSPECIFIED - Font size and margins derived from the recording resolution (Blunux >= 5.2).
385
+ * Older firmware defaults to 25px.
386
+ */
356
387
  FONT_SIZE_UNSPECIFIED = 0,
357
388
  /** FONT_SIZE_PX15 - 15 px. */
358
389
  FONT_SIZE_PX15 = 1,
@@ -479,6 +510,10 @@ export declare enum GuestPortDeviceID {
479
510
  GUEST_PORT_DEVICE_ID_CYGNUS_MINI_ROV_THICKNESS_GAUGE_RS232 = 49,
480
511
  /** GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 - Waterlinked DVL A100. */
481
512
  GUEST_PORT_DEVICE_ID_WATERLINKED_DVL_A100 = 50,
513
+ /** GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 - Outland Technology MP-200 Manipulator. */
514
+ GUEST_PORT_DEVICE_ID_OUTLAND_TECHNOLOGY_MP200 = 51,
515
+ /** GUEST_PORT_DEVICE_ID_REACH_ROBOTICS_REACH_ALPHA_5 - Reach Robotics Reach Alpha 5 Manipulator. */
516
+ GUEST_PORT_DEVICE_ID_REACH_ROBOTICS_REACH_ALPHA_5 = 52,
482
517
  UNRECOGNIZED = -1
483
518
  }
484
519
  export declare function guestPortDeviceIDFromJSON(object: any): GuestPortDeviceID;
@@ -997,6 +1032,63 @@ export interface GripperVelocities {
997
1032
  /** The rotating velocity (-1.0..1.0). */
998
1033
  rotateVelocity: number;
999
1034
  }
1035
+ /**
1036
+ * Cartesian velocity of the end of a manipulator arm, in the drone body frame.
1037
+ *
1038
+ * Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
1039
+ */
1040
+ export interface CartesianManipulatorInput {
1041
+ /** Forward (positive) and backward (negative). */
1042
+ x: number;
1043
+ /** Right (positive) and left (negative). */
1044
+ y: number;
1045
+ /** Down (positive) and up (negative). */
1046
+ z: number;
1047
+ }
1048
+ /**
1049
+ * Cylindrical velocity of the end of a manipulator arm, about the axis of the arm's base joint.
1050
+ *
1051
+ * Each value is normalized (-1.0..1.0) and scaled by the drone to its configured maximum speed.
1052
+ */
1053
+ export interface CylindricalManipulatorInput {
1054
+ /** Out from the base axis (positive) and in towards it (negative). */
1055
+ radial: number;
1056
+ /** Along the base axis: down (positive) and up (negative), as in the drone body frame. */
1057
+ vertical: number;
1058
+ /** Swing about the base axis: clockwise seen from above (positive). */
1059
+ azimuth: number;
1060
+ }
1061
+ /**
1062
+ * Movement of a manipulator arm towards a named pose, along a path the drone chooses.
1063
+ *
1064
+ * Hold-to-run: the arm moves only while the velocity is above zero, and resumes from wherever it
1065
+ * stopped.
1066
+ */
1067
+ export interface KnownPoseManipulatorInput {
1068
+ /** The pose to move towards. */
1069
+ pose: ManipulatorPose;
1070
+ /** Speed along the path (0.0..1.0): 0 holds the arm where it is. */
1071
+ velocity: number;
1072
+ }
1073
+ /** Gripper state: of its arm too, when the gripper is a manipulator arm. */
1074
+ export interface Gripper {
1075
+ /** How the arm input of the last command was read. */
1076
+ mode: ManipulatorControlMode;
1077
+ /** Joint positions from the jaws to the base: jaws opening (m), then joint angles (rad). */
1078
+ jointPositions: number[];
1079
+ /** Position of the base of the jaws in the drone body frame (m). */
1080
+ endPosition: Vector3 | undefined;
1081
+ /** A joint at the end of its range keeps the arm from going further. */
1082
+ atLimit: boolean;
1083
+ /** The arm stopped itself short of an obstacle or of itself. */
1084
+ collision: boolean;
1085
+ /** The jaws closed on something. */
1086
+ holding: boolean;
1087
+ /** A joint reports a hardware fault. */
1088
+ fault: boolean;
1089
+ /** Named pose the arm is moving towards, if any. */
1090
+ movingTo: ManipulatorPose;
1091
+ }
1000
1092
  /** Information about a remote client. */
1001
1093
  export interface ClientInfo {
1002
1094
  /** The type of client (such as Blueye App, Observer App, SDK, etc). */
@@ -1115,6 +1207,20 @@ export interface CanisterHumidity {
1115
1207
  /** Air humidity (%). */
1116
1208
  humidity: number;
1117
1209
  }
1210
+ /** Sensor readings inside the X7 power canister. */
1211
+ export interface PowerCanister {
1212
+ /** Front ESC board; absent when no recent reading is available. */
1213
+ frontEsc: PowerCanister_Sensors | undefined;
1214
+ /** Rear ESC board; absent when no recent reading is available. */
1215
+ rearEsc: PowerCanister_Sensors | undefined;
1216
+ }
1217
+ /** Sensor readings from an ESC board. */
1218
+ export interface PowerCanister_Sensors {
1219
+ /** Temperature (°C). */
1220
+ temperature: number;
1221
+ /** Relative humidity (%). */
1222
+ humidity: number;
1223
+ }
1118
1224
  /** Essential battery information. */
1119
1225
  export interface Battery {
1120
1226
  /** Battery voltage (V). */
@@ -1932,12 +2038,22 @@ export interface ErrorFlags {
1932
2038
  dvlThermalProtectionMode: boolean;
1933
2039
  /** GP protection has been triggered at boot or faulty DVL. */
1934
2040
  dvlNoPower: boolean;
2041
+ /** DVL firmware speaks a protocol version Blunux does not support. */
2042
+ dvlProtocolUnsupported: boolean;
1935
2043
  /** USB disconnect. */
1936
2044
  usbDisconnect: boolean;
1937
2045
  /** Video URB error. */
1938
2046
  videoUrbError: boolean;
1939
2047
  /** Hardware not supported on current blunux version. */
1940
2048
  hardwareNotSupported: boolean;
2049
+ /** MPU 1 unavailable at observer startup. */
2050
+ imu1: boolean;
2051
+ /** MPU 2 unavailable at observer startup. */
2052
+ imu2: boolean;
2053
+ /** HP IMU unavailable on X3 Ultra or X7. */
2054
+ imuHp: boolean;
2055
+ /** No attitude source: manual body-frame control only. */
2056
+ imuAttitude: boolean;
1941
2057
  }
1942
2058
  /** Camera parameters. */
1943
2059
  export interface CameraParameters {
@@ -2037,11 +2153,14 @@ export interface OverlayParameters {
2037
2153
  thicknessUnit: ThicknessUnit;
2038
2154
  /** Timezone offset from UTC (min). */
2039
2155
  timezoneOffset: number;
2040
- /** Horizontal margins of text elements (px). */
2156
+ /** Horizontal margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
2041
2157
  marginWidth: number;
2042
- /** Vertical margins of text elements (px). */
2158
+ /** Vertical margins of text elements (px). Ignored when font_size is FONT_SIZE_UNSPECIFIED (Blunux >= 5.2). */
2043
2159
  marginHeight: number;
2044
- /** Font size of text elements. */
2160
+ /**
2161
+ * Font size of text elements. FONT_SIZE_UNSPECIFIED derives font size and margins from the
2162
+ * recording resolution (Blunux >= 5.2). Older firmware defaults to 25px.
2163
+ */
2045
2164
  fontSize: FontSize;
2046
2165
  /** Optional title. */
2047
2166
  title: string;
@@ -2447,6 +2566,17 @@ export interface MultibeamDiscovery {
2447
2566
  /** Error flags specific for the connected multibeam device. */
2448
2567
  errorFlags: MultibeamErrorFlags | undefined;
2449
2568
  }
2569
+ /**
2570
+ * Color filter used to render the multibeam sonar fan.
2571
+ *
2572
+ * The fan renderer maps each echo intensity (0..255) to a color through this
2573
+ * lookup table. The drone keeps the last filter received in memory and applies
2574
+ * it to the sonar RTSP stream; grayscale is used until one is set.
2575
+ */
2576
+ export interface MultibeamColorFilter {
2577
+ /** 768 bytes: 256 consecutive R,G,B triplets, indexed by echo intensity. */
2578
+ rgb: Uint8Array;
2579
+ }
2450
2580
  /** Error flags for multibeam sonar devices. */
2451
2581
  export interface MultibeamErrorFlags {
2452
2582
  /**
@@ -2923,6 +3053,10 @@ export declare const ControlMode: MessageFns<ControlMode>;
2923
3053
  export declare const TiltStabilizationState: MessageFns<TiltStabilizationState>;
2924
3054
  export declare const SystemTime: MessageFns<SystemTime>;
2925
3055
  export declare const GripperVelocities: MessageFns<GripperVelocities>;
3056
+ export declare const CartesianManipulatorInput: MessageFns<CartesianManipulatorInput>;
3057
+ export declare const CylindricalManipulatorInput: MessageFns<CylindricalManipulatorInput>;
3058
+ export declare const KnownPoseManipulatorInput: MessageFns<KnownPoseManipulatorInput>;
3059
+ export declare const Gripper: MessageFns<Gripper>;
2926
3060
  export declare const ClientInfo: MessageFns<ClientInfo>;
2927
3061
  export declare const ConnectedClient: MessageFns<ConnectedClient>;
2928
3062
  export declare const RecordState: MessageFns<RecordState>;
@@ -2933,6 +3067,8 @@ export declare const WaterTemperature: MessageFns<WaterTemperature>;
2933
3067
  export declare const CPUTemperature: MessageFns<CPUTemperature>;
2934
3068
  export declare const CanisterTemperature: MessageFns<CanisterTemperature>;
2935
3069
  export declare const CanisterHumidity: MessageFns<CanisterHumidity>;
3070
+ export declare const PowerCanister: MessageFns<PowerCanister>;
3071
+ export declare const PowerCanister_Sensors: MessageFns<PowerCanister_Sensors>;
2936
3072
  export declare const Battery: MessageFns<Battery>;
2937
3073
  export declare const BatteryBQ40Z50: MessageFns<BatteryBQ40Z50>;
2938
3074
  export declare const BatteryBQ40Z50_Voltage: MessageFns<BatteryBQ40Z50_Voltage>;
@@ -2991,6 +3127,7 @@ export declare const MedusaSpectrometerData: MessageFns<MedusaSpectrometerData>;
2991
3127
  export declare const MultibeamPing: MessageFns<MultibeamPing>;
2992
3128
  export declare const MultibeamConfig: MessageFns<MultibeamConfig>;
2993
3129
  export declare const MultibeamDiscovery: MessageFns<MultibeamDiscovery>;
3130
+ export declare const MultibeamColorFilter: MessageFns<MultibeamColorFilter>;
2994
3131
  export declare const MultibeamErrorFlags: MessageFns<MultibeamErrorFlags>;
2995
3132
  export declare const MultibeamFrameOffset: MessageFns<MultibeamFrameOffset>;
2996
3133
  export declare const MutltibeamRecordingIndex: MessageFns<MutltibeamRecordingIndex>;