@blueyerobotics/protocol-definitions 3.4.0-8187f91a → 3.4.0-sonar3d-slam.4e329580
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/message_formats.d.ts +402 -2
- package/dist/message_formats.js +2044 -2
- package/dist/req_rep.d.ts +120 -1
- package/dist/req_rep.js +791 -1
- package/dist/telemetry.d.ts +60 -1
- package/dist/telemetry.js +309 -1
- package/package.json +1 -1
package/dist/req_rep.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
2
|
import { Any } from "./google/protobuf/any.js";
|
|
3
|
-
import { Battery, Camera, CameraParameters, ClientInfo, ConnectedClient, CvModelInfo, HeadingMode, MultibeamColorFilter, OverlayParameters, PersistentStorageSettings, SystemTime } from "./message_formats.js";
|
|
3
|
+
import { Battery, Camera, CameraParameters, ClientInfo, ConnectedClient, CvModelInfo, HeadingMode, MultibeamColorFilter, OverlayParameters, PersistentStorageSettings, SlamRecordingState, SlamSensorSettings, StorageLocation, SystemTime } from "./message_formats.js";
|
|
4
4
|
import { Instruction, Mission } from "./mission_planning.js";
|
|
5
5
|
/**
|
|
6
6
|
* Request reply
|
|
@@ -191,6 +191,26 @@ export interface SetLogFrequencyRep {
|
|
|
191
191
|
/** True if message name valid and frequency successfully updated. */
|
|
192
192
|
success: boolean;
|
|
193
193
|
}
|
|
194
|
+
/** Request to reset the publishing frequency of a message to the drone's default. */
|
|
195
|
+
export interface ResetPubFrequencyReq {
|
|
196
|
+
/** Message name, f. ex. "AttitudeTel"; empty resets every message. */
|
|
197
|
+
messageType: string;
|
|
198
|
+
}
|
|
199
|
+
/** Response after resetting the publishing frequency. */
|
|
200
|
+
export interface ResetPubFrequencyRep {
|
|
201
|
+
/** True if the message name was valid and its frequency reset. */
|
|
202
|
+
success: boolean;
|
|
203
|
+
}
|
|
204
|
+
/** Request to reset the logging frequency of a message to the drone's default. */
|
|
205
|
+
export interface ResetLogFrequencyReq {
|
|
206
|
+
/** Message name, f. ex. "AttitudeTel"; empty resets every message. */
|
|
207
|
+
messageType: string;
|
|
208
|
+
}
|
|
209
|
+
/** Response after resetting the logging frequency. */
|
|
210
|
+
export interface ResetLogFrequencyRep {
|
|
211
|
+
/** True if the message name was valid and its frequency reset. */
|
|
212
|
+
success: boolean;
|
|
213
|
+
}
|
|
194
214
|
/** Request to get latest telemetry data */
|
|
195
215
|
export interface GetTelemetryReq {
|
|
196
216
|
/** Message name, f. ex. "AttitudeTel". */
|
|
@@ -297,6 +317,91 @@ export interface GetMultibeamColorFilterRep {
|
|
|
297
317
|
/** The current color filter. Empty rgb means none is set (grayscale). */
|
|
298
318
|
colorFilter: MultibeamColorFilter | undefined;
|
|
299
319
|
}
|
|
320
|
+
/**
|
|
321
|
+
* Request the whole SLAM map.
|
|
322
|
+
*
|
|
323
|
+
* The map is large, so it is not the reply: the SLAM publishes it on its own
|
|
324
|
+
* publisher (SlamMapTel), to the clients subscribed there.
|
|
325
|
+
*/
|
|
326
|
+
export interface GetSlamMapReq {
|
|
327
|
+
}
|
|
328
|
+
/** Response after requesting the SLAM map. */
|
|
329
|
+
export interface GetSlamMapRep {
|
|
330
|
+
/** True if the SLAM is running and publishes the map. */
|
|
331
|
+
available: boolean;
|
|
332
|
+
}
|
|
333
|
+
/** Request to discard the SLAM map and start a new one from the current pose. */
|
|
334
|
+
export interface ResetSlamReq {
|
|
335
|
+
}
|
|
336
|
+
/** Response after resetting the SLAM map. */
|
|
337
|
+
export interface ResetSlamRep {
|
|
338
|
+
/** Identifier of the new map, 0 if the SLAM is not running. */
|
|
339
|
+
mapId: number;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Request to start or stop the SLAM.
|
|
343
|
+
*
|
|
344
|
+
* Starting switches the sensor on (for a sonar, its acoustics) and begins a new
|
|
345
|
+
* map from the current pose. Stopping switches the sensor off and keeps the map,
|
|
346
|
+
* so it can still be viewed. Asking for the state the SLAM is in already changes
|
|
347
|
+
* nothing (ResetSlamReq begins a new map). The SLAM reports its state in
|
|
348
|
+
* SlamStatusTel.
|
|
349
|
+
*/
|
|
350
|
+
export interface SetSlamActiveReq {
|
|
351
|
+
/** True to start the SLAM, false to stop it. */
|
|
352
|
+
active: boolean;
|
|
353
|
+
}
|
|
354
|
+
/** Response after starting or stopping the SLAM. */
|
|
355
|
+
export interface SetSlamActiveRep {
|
|
356
|
+
/** True if the SLAM is running and answered. */
|
|
357
|
+
available: boolean;
|
|
358
|
+
/** True if the SLAM is now mapping (false if its sensor did not switch on). */
|
|
359
|
+
active: boolean;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
362
|
+
* Request to start or stop recording the SLAM.
|
|
363
|
+
*
|
|
364
|
+
* A recording needs the SLAM to be mapping, and stopping the SLAM stops it. It is
|
|
365
|
+
* stored with the drone's other media (picture, video and multibeam recordings).
|
|
366
|
+
* Like a multibeam recording it holds the drone's DroneInfoTel, at its start and
|
|
367
|
+
* when it changes, which names the dive log it belongs with (log_name).
|
|
368
|
+
* Asking for the state the recording is in already changes nothing.
|
|
369
|
+
*/
|
|
370
|
+
export interface SetSlamRecordingReq {
|
|
371
|
+
/** True to start recording, false to stop. */
|
|
372
|
+
record: boolean;
|
|
373
|
+
/** Also the sensor's raw data, and the dive log faster, for running the SLAM offline. */
|
|
374
|
+
sensorData: boolean;
|
|
375
|
+
/** Where to store the recording. */
|
|
376
|
+
storageLocation: StorageLocation;
|
|
377
|
+
}
|
|
378
|
+
/** Response after starting or stopping a SLAM recording. */
|
|
379
|
+
export interface SetSlamRecordingRep {
|
|
380
|
+
/** True if the SLAM is running and answered. */
|
|
381
|
+
available: boolean;
|
|
382
|
+
/** The recording after the request. */
|
|
383
|
+
recording: SlamRecordingState | undefined;
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Request to change the settings of a SLAM sensor.
|
|
387
|
+
*
|
|
388
|
+
* The settings go to the SLAM's sensor of their kind, and those left
|
|
389
|
+
* unspecified stay as they are. A change of a sonar's mode or range begins a new
|
|
390
|
+
* map, as the map's resolution follows the sensor's range.
|
|
391
|
+
*/
|
|
392
|
+
export interface SetSlamSensorSettingsReq {
|
|
393
|
+
/** The settings to change. */
|
|
394
|
+
settings: SlamSensorSettings | undefined;
|
|
395
|
+
}
|
|
396
|
+
/** Response after changing the settings of a SLAM sensor. */
|
|
397
|
+
export interface SetSlamSensorSettingsRep {
|
|
398
|
+
/** True if the SLAM is running and answered. */
|
|
399
|
+
available: boolean;
|
|
400
|
+
/** True if the sensor took the settings. */
|
|
401
|
+
applied: boolean;
|
|
402
|
+
/** The sensor's settings after the request. */
|
|
403
|
+
settings: SlamSensorSettings | undefined;
|
|
404
|
+
}
|
|
300
405
|
export declare const SetOverlayParametersReq: MessageFns<SetOverlayParametersReq>;
|
|
301
406
|
export declare const SetOverlayParametersRep: MessageFns<SetOverlayParametersRep>;
|
|
302
407
|
export declare const GetOverlayParametersReq: MessageFns<GetOverlayParametersReq>;
|
|
@@ -329,6 +434,10 @@ export declare const SetPubFrequencyReq: MessageFns<SetPubFrequencyReq>;
|
|
|
329
434
|
export declare const SetPubFrequencyRep: MessageFns<SetPubFrequencyRep>;
|
|
330
435
|
export declare const SetLogFrequencyReq: MessageFns<SetLogFrequencyReq>;
|
|
331
436
|
export declare const SetLogFrequencyRep: MessageFns<SetLogFrequencyRep>;
|
|
437
|
+
export declare const ResetPubFrequencyReq: MessageFns<ResetPubFrequencyReq>;
|
|
438
|
+
export declare const ResetPubFrequencyRep: MessageFns<ResetPubFrequencyRep>;
|
|
439
|
+
export declare const ResetLogFrequencyReq: MessageFns<ResetLogFrequencyReq>;
|
|
440
|
+
export declare const ResetLogFrequencyRep: MessageFns<ResetLogFrequencyRep>;
|
|
332
441
|
export declare const GetTelemetryReq: MessageFns<GetTelemetryReq>;
|
|
333
442
|
export declare const GetTelemetryRep: MessageFns<GetTelemetryRep>;
|
|
334
443
|
export declare const SetPersistentStorageSettingsReq: MessageFns<SetPersistentStorageSettingsReq>;
|
|
@@ -351,6 +460,16 @@ export declare const SetMultibeamColorFilterReq: MessageFns<SetMultibeamColorFil
|
|
|
351
460
|
export declare const SetMultibeamColorFilterRep: MessageFns<SetMultibeamColorFilterRep>;
|
|
352
461
|
export declare const GetMultibeamColorFilterReq: MessageFns<GetMultibeamColorFilterReq>;
|
|
353
462
|
export declare const GetMultibeamColorFilterRep: MessageFns<GetMultibeamColorFilterRep>;
|
|
463
|
+
export declare const GetSlamMapReq: MessageFns<GetSlamMapReq>;
|
|
464
|
+
export declare const GetSlamMapRep: MessageFns<GetSlamMapRep>;
|
|
465
|
+
export declare const ResetSlamReq: MessageFns<ResetSlamReq>;
|
|
466
|
+
export declare const ResetSlamRep: MessageFns<ResetSlamRep>;
|
|
467
|
+
export declare const SetSlamActiveReq: MessageFns<SetSlamActiveReq>;
|
|
468
|
+
export declare const SetSlamActiveRep: MessageFns<SetSlamActiveRep>;
|
|
469
|
+
export declare const SetSlamRecordingReq: MessageFns<SetSlamRecordingReq>;
|
|
470
|
+
export declare const SetSlamRecordingRep: MessageFns<SetSlamRecordingRep>;
|
|
471
|
+
export declare const SetSlamSensorSettingsReq: MessageFns<SetSlamSensorSettingsReq>;
|
|
472
|
+
export declare const SetSlamSensorSettingsRep: MessageFns<SetSlamSensorSettingsRep>;
|
|
354
473
|
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
355
474
|
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 {} ? {
|
|
356
475
|
[K in keyof T]?: DeepPartial<T[K]>;
|