@blueyerobotics/protocol-definitions 3.4.0-eddb8a5e → 3.4.0-efe27311

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,7 @@
1
1
  import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
2
2
  import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll.js";
3
3
  import { Annotation, AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, CartesianManipulatorInput, ConnectionDuration, CylindricalManipulatorInput, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, KnownPoseManipulatorInput, Laser, LatLongPosition, Lights, MarineSnowFilterFrames, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, StorageLocation, SystemTime, TiltStabilizationState, TiltVelocity, VisionTrackingState, WaterDensity, WeatherVaningState } from "./message_formats.js";
4
+ import { Instruction } from "./mission_planning.js";
4
5
  /**
5
6
  * Control
6
7
  *
@@ -126,6 +127,30 @@ export interface PauseMissionCtrl {
126
127
  /** Clear the loaded mission. */
127
128
  export interface ClearMissionCtrl {
128
129
  }
130
+ /** Clears the mission rules. */
131
+ export interface ClearMissionRulesCtrl {
132
+ }
133
+ /**
134
+ * Run a single instruction right away, outside any mission.
135
+ *
136
+ * Instructions that do not move the drone (camera, tilt, lights, laser, multibeam, tilt
137
+ * stabilization, CV model, annotation, cruise speed) run in any mission state, alongside a running
138
+ * mission. Instructions that move the drone (waypoint, go to home, transect, survey, depth set
139
+ * point, relative depth, go to surface or seabed, control mode, heading) run only while no
140
+ * mission is running, one at a time, and are rejected otherwise. A wait is rejected. The outcome
141
+ * is reported in InstructionResultTel with the same request_id.
142
+ */
143
+ export interface RunInstructionCtrl {
144
+ /** Instruction to execute. */
145
+ instruction: Instruction | undefined;
146
+ /** Client-chosen id, echoed in InstructionResultTel. */
147
+ requestId: number;
148
+ }
149
+ /** Cancel an instruction started with RunInstructionCtrl. */
150
+ export interface CancelInstructionCtrl {
151
+ /** The request_id given to RunInstructionCtrl. */
152
+ requestId: number;
153
+ }
129
154
  /** Issue a command to reset the position estimate. */
130
155
  export interface ResetPositionCtrl {
131
156
  /** Reset settings. */
@@ -357,6 +382,9 @@ export declare const VisionTrackingCtrl: MessageFns<VisionTrackingCtrl>;
357
382
  export declare const RunMissionCtrl: MessageFns<RunMissionCtrl>;
358
383
  export declare const PauseMissionCtrl: MessageFns<PauseMissionCtrl>;
359
384
  export declare const ClearMissionCtrl: MessageFns<ClearMissionCtrl>;
385
+ export declare const ClearMissionRulesCtrl: MessageFns<ClearMissionRulesCtrl>;
386
+ export declare const RunInstructionCtrl: MessageFns<RunInstructionCtrl>;
387
+ export declare const CancelInstructionCtrl: MessageFns<CancelInstructionCtrl>;
360
388
  export declare const ResetPositionCtrl: MessageFns<ResetPositionCtrl>;
361
389
  export declare const ResetOdometerCtrl: MessageFns<ResetOdometerCtrl>;
362
390
  export declare const CalibrateDvlGyroCtrl: MessageFns<CalibrateDvlGyroCtrl>;
package/dist/control.js CHANGED
@@ -7,6 +7,7 @@
7
7
  import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
8
8
  import { SetAquaTrollConnectionStatus, SetAquaTrollParameterUnit } from "./aquatroll.js";
9
9
  import { Annotation, AutoAltitudeState, AutoDepthState, AutoHeadingState, AutoPilotHeaveState, AutoPilotSurgeYawState, BoundingBox, CameraPanTiltZoom, CartesianManipulatorInput, ConnectionDuration, CylindricalManipulatorInput, FilterMessage, GenericServo, GripperVelocities, GuestPortRestartInfo, KnownPoseManipulatorInput, Laser, LatLongPosition, Lights, MarineSnowFilterFrames, MotionInput, MultibeamConfig, MultibeamServo, OperatorInfo, PingerConfiguration, RecordOn, ResetPositionSettings, StationKeepingState, storageLocationFromJSON, storageLocationToJSON, SystemTime, TiltStabilizationState, TiltVelocity, VisionTrackingState, WaterDensity, WeatherVaningState, } from "./message_formats.js";
10
+ import { Instruction } from "./mission_planning.js";
10
11
  function createBaseMotionInputCtrl() {
11
12
  return { motionInput: undefined };
12
13
  }
@@ -1162,6 +1163,164 @@ export const ClearMissionCtrl = {
1162
1163
  return message;
1163
1164
  },
1164
1165
  };
1166
+ function createBaseClearMissionRulesCtrl() {
1167
+ return {};
1168
+ }
1169
+ export const ClearMissionRulesCtrl = {
1170
+ encode(_, writer = new BinaryWriter()) {
1171
+ return writer;
1172
+ },
1173
+ decode(input, length) {
1174
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
1175
+ const end = length === undefined ? reader.len : reader.pos + length;
1176
+ const message = createBaseClearMissionRulesCtrl();
1177
+ while (reader.pos < end) {
1178
+ const tag = reader.uint32();
1179
+ switch (tag >>> 3) {
1180
+ }
1181
+ if ((tag & 7) === 4 || tag === 0) {
1182
+ break;
1183
+ }
1184
+ reader.skip(tag & 7);
1185
+ }
1186
+ return message;
1187
+ },
1188
+ fromJSON(_) {
1189
+ return {};
1190
+ },
1191
+ toJSON(_) {
1192
+ const obj = {};
1193
+ return obj;
1194
+ },
1195
+ create(base) {
1196
+ return ClearMissionRulesCtrl.fromPartial(base ?? {});
1197
+ },
1198
+ fromPartial(_) {
1199
+ const message = createBaseClearMissionRulesCtrl();
1200
+ return message;
1201
+ },
1202
+ };
1203
+ function createBaseRunInstructionCtrl() {
1204
+ return { instruction: undefined, requestId: 0 };
1205
+ }
1206
+ export const RunInstructionCtrl = {
1207
+ encode(message, writer = new BinaryWriter()) {
1208
+ if (message.instruction !== undefined) {
1209
+ Instruction.encode(message.instruction, writer.uint32(10).fork()).join();
1210
+ }
1211
+ if (message.requestId !== 0) {
1212
+ writer.uint32(16).uint32(message.requestId);
1213
+ }
1214
+ return writer;
1215
+ },
1216
+ decode(input, length) {
1217
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
1218
+ const end = length === undefined ? reader.len : reader.pos + length;
1219
+ const message = createBaseRunInstructionCtrl();
1220
+ while (reader.pos < end) {
1221
+ const tag = reader.uint32();
1222
+ switch (tag >>> 3) {
1223
+ case 1: {
1224
+ if (tag !== 10) {
1225
+ break;
1226
+ }
1227
+ message.instruction = Instruction.decode(reader, reader.uint32());
1228
+ continue;
1229
+ }
1230
+ case 2: {
1231
+ if (tag !== 16) {
1232
+ break;
1233
+ }
1234
+ message.requestId = reader.uint32();
1235
+ continue;
1236
+ }
1237
+ }
1238
+ if ((tag & 7) === 4 || tag === 0) {
1239
+ break;
1240
+ }
1241
+ reader.skip(tag & 7);
1242
+ }
1243
+ return message;
1244
+ },
1245
+ fromJSON(object) {
1246
+ return {
1247
+ instruction: isSet(object.instruction) ? Instruction.fromJSON(object.instruction) : undefined,
1248
+ requestId: isSet(object.requestId) ? gt.Number(object.requestId) : 0,
1249
+ };
1250
+ },
1251
+ toJSON(message) {
1252
+ const obj = {};
1253
+ if (message.instruction !== undefined) {
1254
+ obj.instruction = Instruction.toJSON(message.instruction);
1255
+ }
1256
+ if (message.requestId !== 0) {
1257
+ obj.requestId = Math.round(message.requestId);
1258
+ }
1259
+ return obj;
1260
+ },
1261
+ create(base) {
1262
+ return RunInstructionCtrl.fromPartial(base ?? {});
1263
+ },
1264
+ fromPartial(object) {
1265
+ const message = createBaseRunInstructionCtrl();
1266
+ message.instruction = (object.instruction !== undefined && object.instruction !== null)
1267
+ ? Instruction.fromPartial(object.instruction)
1268
+ : undefined;
1269
+ message.requestId = object.requestId ?? 0;
1270
+ return message;
1271
+ },
1272
+ };
1273
+ function createBaseCancelInstructionCtrl() {
1274
+ return { requestId: 0 };
1275
+ }
1276
+ export const CancelInstructionCtrl = {
1277
+ encode(message, writer = new BinaryWriter()) {
1278
+ if (message.requestId !== 0) {
1279
+ writer.uint32(8).uint32(message.requestId);
1280
+ }
1281
+ return writer;
1282
+ },
1283
+ decode(input, length) {
1284
+ const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
1285
+ const end = length === undefined ? reader.len : reader.pos + length;
1286
+ const message = createBaseCancelInstructionCtrl();
1287
+ while (reader.pos < end) {
1288
+ const tag = reader.uint32();
1289
+ switch (tag >>> 3) {
1290
+ case 1: {
1291
+ if (tag !== 8) {
1292
+ break;
1293
+ }
1294
+ message.requestId = reader.uint32();
1295
+ continue;
1296
+ }
1297
+ }
1298
+ if ((tag & 7) === 4 || tag === 0) {
1299
+ break;
1300
+ }
1301
+ reader.skip(tag & 7);
1302
+ }
1303
+ return message;
1304
+ },
1305
+ fromJSON(object) {
1306
+ return { requestId: isSet(object.requestId) ? gt.Number(object.requestId) : 0 };
1307
+ },
1308
+ toJSON(message) {
1309
+ const obj = {};
1310
+ if (message.requestId !== 0) {
1311
+ obj.requestId = Math.round(message.requestId);
1312
+ }
1313
+ return obj;
1314
+ },
1315
+ create(base) {
1316
+ return CancelInstructionCtrl.fromPartial(base ?? {});
1317
+ },
1318
+ fromPartial(object) {
1319
+ const message = createBaseCancelInstructionCtrl();
1320
+ message.requestId = object.requestId ?? 0;
1321
+ return message;
1322
+ },
1323
+ };
1165
1324
  function createBaseResetPositionCtrl() {
1166
1325
  return { settings: undefined };
1167
1326
  }
@@ -1,7 +1,7 @@
1
1
  export * from "./aquatroll.js";
2
2
  export * from "./message_formats.js";
3
- export * from "./control.js";
4
3
  export * from "./mission_planning.js";
4
+ export * from "./control.js";
5
5
  export * from "./slam.js";
6
6
  export * from "./req_rep.js";
7
7
  export * from "./telemetry.js";
@@ -5,8 +5,8 @@
5
5
  /* eslint-disable */
6
6
  export * from "./aquatroll.js";
7
7
  export * from "./message_formats.js";
8
- export * from "./control.js";
9
8
  export * from "./mission_planning.js";
9
+ export * from "./control.js";
10
10
  export * from "./slam.js";
11
11
  export * from "./req_rep.js";
12
12
  export * from "./telemetry.js";
@@ -166,6 +166,22 @@ export declare enum NotificationType {
166
166
  NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED = 33,
167
167
  /** NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED - DVL firmware speaks a protocol version Blunux does not support. */
168
168
  NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED = 34,
169
+ /** NOTIFICATION_TYPE_INSTRUCTION_STARTED - An instruction started; the value names it or is its target. */
170
+ NOTIFICATION_TYPE_INSTRUCTION_STARTED = 35,
171
+ /** NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION - Paused after the instruction whose id is the value. */
172
+ NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION = 36,
173
+ /** NOTIFICATION_TYPE_MISSION_UPDATED - The loaded mission was changed; the value says what changed. */
174
+ NOTIFICATION_TYPE_MISSION_UPDATED = 37,
175
+ /** NOTIFICATION_TYPE_MISSION_RULE_FIRED - A mission rule fired; the value is its name. */
176
+ NOTIFICATION_TYPE_MISSION_RULE_FIRED = 38,
177
+ /** NOTIFICATION_TYPE_MISSION_RULE_RELEASED - A mission rule released; the value is its name. */
178
+ NOTIFICATION_TYPE_MISSION_RULE_RELEASED = 39,
179
+ /**
180
+ * NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH - A multibeam instruction was made for a different sonar than the one the multibeam driver
181
+ * reports; the value is the instruction's id. A MultibeamConfigCommand is skipped. An
182
+ * ActivateMultibeamCommand still starts or stops the driver, but without its configuration.
183
+ */
184
+ NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH = 40,
169
185
  UNRECOGNIZED = -1
170
186
  }
171
187
  export declare function notificationTypeFromJSON(object: any): NotificationType;
@@ -387,6 +387,22 @@ export var NotificationType;
387
387
  NotificationType[NotificationType["NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED"] = 33] = "NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED";
388
388
  /** NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED - DVL firmware speaks a protocol version Blunux does not support. */
389
389
  NotificationType[NotificationType["NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED"] = 34] = "NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED";
390
+ /** NOTIFICATION_TYPE_INSTRUCTION_STARTED - An instruction started; the value names it or is its target. */
391
+ NotificationType[NotificationType["NOTIFICATION_TYPE_INSTRUCTION_STARTED"] = 35] = "NOTIFICATION_TYPE_INSTRUCTION_STARTED";
392
+ /** NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION - Paused after the instruction whose id is the value. */
393
+ NotificationType[NotificationType["NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION"] = 36] = "NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION";
394
+ /** NOTIFICATION_TYPE_MISSION_UPDATED - The loaded mission was changed; the value says what changed. */
395
+ NotificationType[NotificationType["NOTIFICATION_TYPE_MISSION_UPDATED"] = 37] = "NOTIFICATION_TYPE_MISSION_UPDATED";
396
+ /** NOTIFICATION_TYPE_MISSION_RULE_FIRED - A mission rule fired; the value is its name. */
397
+ NotificationType[NotificationType["NOTIFICATION_TYPE_MISSION_RULE_FIRED"] = 38] = "NOTIFICATION_TYPE_MISSION_RULE_FIRED";
398
+ /** NOTIFICATION_TYPE_MISSION_RULE_RELEASED - A mission rule released; the value is its name. */
399
+ NotificationType[NotificationType["NOTIFICATION_TYPE_MISSION_RULE_RELEASED"] = 39] = "NOTIFICATION_TYPE_MISSION_RULE_RELEASED";
400
+ /**
401
+ * NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH - A multibeam instruction was made for a different sonar than the one the multibeam driver
402
+ * reports; the value is the instruction's id. A MultibeamConfigCommand is skipped. An
403
+ * ActivateMultibeamCommand still starts or stops the driver, but without its configuration.
404
+ */
405
+ NotificationType[NotificationType["NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH"] = 40] = "NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH";
390
406
  NotificationType[NotificationType["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
391
407
  })(NotificationType || (NotificationType = {}));
392
408
  export function notificationTypeFromJSON(object) {
@@ -496,6 +512,24 @@ export function notificationTypeFromJSON(object) {
496
512
  case 34:
497
513
  case "NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED":
498
514
  return NotificationType.NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED;
515
+ case 35:
516
+ case "NOTIFICATION_TYPE_INSTRUCTION_STARTED":
517
+ return NotificationType.NOTIFICATION_TYPE_INSTRUCTION_STARTED;
518
+ case 36:
519
+ case "NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION":
520
+ return NotificationType.NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION;
521
+ case 37:
522
+ case "NOTIFICATION_TYPE_MISSION_UPDATED":
523
+ return NotificationType.NOTIFICATION_TYPE_MISSION_UPDATED;
524
+ case 38:
525
+ case "NOTIFICATION_TYPE_MISSION_RULE_FIRED":
526
+ return NotificationType.NOTIFICATION_TYPE_MISSION_RULE_FIRED;
527
+ case 39:
528
+ case "NOTIFICATION_TYPE_MISSION_RULE_RELEASED":
529
+ return NotificationType.NOTIFICATION_TYPE_MISSION_RULE_RELEASED;
530
+ case 40:
531
+ case "NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH":
532
+ return NotificationType.NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH;
499
533
  case -1:
500
534
  case "UNRECOGNIZED":
501
535
  default:
@@ -574,6 +608,18 @@ export function notificationTypeToJSON(object) {
574
608
  return "NOTIFICATION_TYPE_VIDEO_PARTITION_NOT_MOUNTED";
575
609
  case NotificationType.NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED:
576
610
  return "NOTIFICATION_TYPE_DVL_PROTOCOL_UNSUPPORTED";
611
+ case NotificationType.NOTIFICATION_TYPE_INSTRUCTION_STARTED:
612
+ return "NOTIFICATION_TYPE_INSTRUCTION_STARTED";
613
+ case NotificationType.NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION:
614
+ return "NOTIFICATION_TYPE_MISSION_PAUSED_BY_INSTRUCTION";
615
+ case NotificationType.NOTIFICATION_TYPE_MISSION_UPDATED:
616
+ return "NOTIFICATION_TYPE_MISSION_UPDATED";
617
+ case NotificationType.NOTIFICATION_TYPE_MISSION_RULE_FIRED:
618
+ return "NOTIFICATION_TYPE_MISSION_RULE_FIRED";
619
+ case NotificationType.NOTIFICATION_TYPE_MISSION_RULE_RELEASED:
620
+ return "NOTIFICATION_TYPE_MISSION_RULE_RELEASED";
621
+ case NotificationType.NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH:
622
+ return "NOTIFICATION_TYPE_MULTIBEAM_SONAR_MISMATCH";
577
623
  case NotificationType.UNRECOGNIZED:
578
624
  default:
579
625
  return "UNRECOGNIZED";