Update ProtocolDefinitions

BluEye-Robotics · Mar 8, 2024 · d28287f · d28287f
1 parent 8a30a32
commit d28287f
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 136 deletions.
diff --git a/ProtocolDefinitions b/ProtocolDefinitions
diff --git a/blueye/protocol/types/__init__.py b/blueye/protocol/types/__init__.py
@@ -120,44 +120,6 @@
     GuestPortDetachStatus,
     GuestPortError,
 )
-from .control import (
-    MotionInputCtrl,
-    TiltVelocityCtrl,
-    LightsCtrl,
-    GuestportLightsCtrl,
-    LaserCtrl,
-    PilotGPSPositionCtrl,
-    WatchdogCtrl,
-    RecordCtrl,
-    TakePictureCtrl,
-    StartCalibrationCtrl,
-    CancelCalibrationCtrl,
-    FinishCalibrationCtrl,
-    AutoHeadingCtrl,
-    AutoDepthCtrl,
-    AutoAltitudeCtrl,
-    StationKeepingCtrl,
-    WeatherVaningCtrl,
-    AutoPilotSurgeYawCtrl,
-    AutoPilotHeaveCtrl,
-    RunMissionCtrl,
-    PauseMissionCtrl,
-    ClearMissionCtrl,
-    ResetPositionCtrl,
-    ResetOdometerCtrl,
-    TiltStabilizationCtrl,
-    WaterDensityCtrl,
-    PingerConfigurationCtrl,
-    SystemTimeCtrl,
-    GripperCtrl,
-    GenericServoCtrl,
-    MultibeamServoCtrl,
-    DeactivateGuestPortsCtrl,
-    ActivateGuestPortsCtrl,
-    RestartGuestPortsCtrl,
-    SetAquaTrollParameterUnitCtrl,
-    SetAquaTrollConnectionStatusCtrl,
-)
 from .mission_planning import (
     Mission,
     Instruction,
@@ -183,6 +145,38 @@
     InstructionType,
     MissionState,
 )
+from .req_rep import (
+    SetOverlayParametersReq,
+    SetOverlayParametersRep,
+    GetOverlayParametersReq,
+    GetOverlayParametersRep,
+    SetCameraParametersReq,
+    SetCameraParametersRep,
+    GetCameraParametersReq,
+    GetCameraParametersRep,
+    SyncTimeReq,
+    SyncTimeRep,
+    PingReq,
+    PingRep,
+    SetThicknessGaugeParametersReq,
+    SetThicknessGaugeParametersRep,
+    ConnectClientReq,
+    ConnectClientRep,
+    DisconnectClientReq,
+    DisconnectClientRep,
+    GetBatteryReq,
+    GetBatteryRep,
+    SetMissionReq,
+    SetMissionRep,
+    GetMissionReq,
+    GetMissionRep,
+    SetInstructionUpdateReq,
+    SetInstructionUpdateRep,
+    SetPubFrequencyReq,
+    SetPubFrequencyRep,
+    GetTelemetryReq,
+    GetTelemetryRep,
+)
 from .telemetry import (
     AttitudeTel,
     AltitudeTel,
@@ -235,37 +229,43 @@
     Imu2Tel,
     MedusaSpectrometerDataTel,
 )
-from .req_rep import (
-    SetOverlayParametersReq,
-    SetOverlayParametersRep,
-    GetOverlayParametersReq,
-    GetOverlayParametersRep,
-    SetCameraParametersReq,
-    SetCameraParametersRep,
-    GetCameraParametersReq,
-    GetCameraParametersRep,
-    SyncTimeReq,
-    SyncTimeRep,
-    PingReq,
-    PingRep,
-    SetThicknessGaugeParametersReq,
-    SetThicknessGaugeParametersRep,
-    ConnectClientReq,
-    ConnectClientRep,
-    DisconnectClientReq,
-    DisconnectClientRep,
-    GetBatteryReq,
-    GetBatteryRep,
-    SetMissionReq,
-    SetMissionRep,
-    GetMissionReq,
-    GetMissionRep,
-    SetInstructionUpdateReq,
-    SetInstructionUpdateRep,
-    SetPubFrequencyReq,
-    SetPubFrequencyRep,
-    GetTelemetryReq,
-    GetTelemetryRep,
+from .control import (
+    MotionInputCtrl,
+    TiltVelocityCtrl,
+    LightsCtrl,
+    GuestportLightsCtrl,
+    LaserCtrl,
+    PilotGPSPositionCtrl,
+    WatchdogCtrl,
+    RecordCtrl,
+    TakePictureCtrl,
+    StartCalibrationCtrl,
+    CancelCalibrationCtrl,
+    FinishCalibrationCtrl,
+    AutoHeadingCtrl,
+    AutoDepthCtrl,
+    AutoAltitudeCtrl,
+    StationKeepingCtrl,
+    WeatherVaningCtrl,
+    AutoPilotSurgeYawCtrl,
+    AutoPilotHeaveCtrl,
+    RunMissionCtrl,
+    PauseMissionCtrl,
+    ClearMissionCtrl,
+    ResetPositionCtrl,
+    ResetOdometerCtrl,
+    TiltStabilizationCtrl,
+    WaterDensityCtrl,
+    PingerConfigurationCtrl,
+    SystemTimeCtrl,
+    GripperCtrl,
+    GenericServoCtrl,
+    MultibeamServoCtrl,
+    DeactivateGuestPortsCtrl,
+    ActivateGuestPortsCtrl,
+    RestartGuestPortsCtrl,
+    SetAquaTrollParameterUnitCtrl,
+    SetAquaTrollConnectionStatusCtrl,
 )
 
 __all__ = (
@@ -370,42 +370,6 @@
     'NavigationSensorID',
     'GuestPortDetachStatus',
     'GuestPortError',
-    'MotionInputCtrl',
-    'TiltVelocityCtrl',
-    'LightsCtrl',
-    'GuestportLightsCtrl',
-    'LaserCtrl',
-    'PilotGPSPositionCtrl',
-    'WatchdogCtrl',
-    'RecordCtrl',
-    'TakePictureCtrl',
-    'StartCalibrationCtrl',
-    'CancelCalibrationCtrl',
-    'FinishCalibrationCtrl',
-    'AutoHeadingCtrl',
-    'AutoDepthCtrl',
-    'AutoAltitudeCtrl',
-    'StationKeepingCtrl',
-    'WeatherVaningCtrl',
-    'AutoPilotSurgeYawCtrl',
-    'AutoPilotHeaveCtrl',
-    'RunMissionCtrl',
-    'PauseMissionCtrl',
-    'ClearMissionCtrl',
-    'ResetPositionCtrl',
-    'ResetOdometerCtrl',
-    'TiltStabilizationCtrl',
-    'WaterDensityCtrl',
-    'PingerConfigurationCtrl',
-    'SystemTimeCtrl',
-    'GripperCtrl',
-    'GenericServoCtrl',
-    'MultibeamServoCtrl',
-    'DeactivateGuestPortsCtrl',
-    'ActivateGuestPortsCtrl',
-    'RestartGuestPortsCtrl',
-    'SetAquaTrollParameterUnitCtrl',
-    'SetAquaTrollConnectionStatusCtrl',
     'Mission',
     'Instruction',
     'DepthSetPoint',
@@ -429,6 +393,36 @@
     'CameraAction',
     'InstructionType',
     'MissionState',
+    'SetOverlayParametersReq',
+    'SetOverlayParametersRep',
+    'GetOverlayParametersReq',
+    'GetOverlayParametersRep',
+    'SetCameraParametersReq',
+    'SetCameraParametersRep',
+    'GetCameraParametersReq',
+    'GetCameraParametersRep',
+    'SyncTimeReq',
+    'SyncTimeRep',
+    'PingReq',
+    'PingRep',
+    'SetThicknessGaugeParametersReq',
+    'SetThicknessGaugeParametersRep',
+    'ConnectClientReq',
+    'ConnectClientRep',
+    'DisconnectClientReq',
+    'DisconnectClientRep',
+    'GetBatteryReq',
+    'GetBatteryRep',
+    'SetMissionReq',
+    'SetMissionRep',
+    'GetMissionReq',
+    'GetMissionRep',
+    'SetInstructionUpdateReq',
+    'SetInstructionUpdateRep',
+    'SetPubFrequencyReq',
+    'SetPubFrequencyRep',
+    'GetTelemetryReq',
+    'GetTelemetryRep',
     'AttitudeTel',
     'AltitudeTel',
     'ForwardDistanceTel',
@@ -479,34 +473,40 @@
     'Imu1Tel',
     'Imu2Tel',
     'MedusaSpectrometerDataTel',
-    'SetOverlayParametersReq',
-    'SetOverlayParametersRep',
-    'GetOverlayParametersReq',
-    'GetOverlayParametersRep',
-    'SetCameraParametersReq',
-    'SetCameraParametersRep',
-    'GetCameraParametersReq',
-    'GetCameraParametersRep',
-    'SyncTimeReq',
-    'SyncTimeRep',
-    'PingReq',
-    'PingRep',
-    'SetThicknessGaugeParametersReq',
-    'SetThicknessGaugeParametersRep',
-    'ConnectClientReq',
-    'ConnectClientRep',
-    'DisconnectClientReq',
-    'DisconnectClientRep',
-    'GetBatteryReq',
-    'GetBatteryRep',
-    'SetMissionReq',
-    'SetMissionRep',
-    'GetMissionReq',
-    'GetMissionRep',
-    'SetInstructionUpdateReq',
-    'SetInstructionUpdateRep',
-    'SetPubFrequencyReq',
-    'SetPubFrequencyRep',
-    'GetTelemetryReq',
-    'GetTelemetryRep',
+    'MotionInputCtrl',
+    'TiltVelocityCtrl',
+    'LightsCtrl',
+    'GuestportLightsCtrl',
+    'LaserCtrl',
+    'PilotGPSPositionCtrl',
+    'WatchdogCtrl',
+    'RecordCtrl',
+    'TakePictureCtrl',
+    'StartCalibrationCtrl',
+    'CancelCalibrationCtrl',
+    'FinishCalibrationCtrl',
+    'AutoHeadingCtrl',
+    'AutoDepthCtrl',
+    'AutoAltitudeCtrl',
+    'StationKeepingCtrl',
+    'WeatherVaningCtrl',
+    'AutoPilotSurgeYawCtrl',
+    'AutoPilotHeaveCtrl',
+    'RunMissionCtrl',
+    'PauseMissionCtrl',
+    'ClearMissionCtrl',
+    'ResetPositionCtrl',
+    'ResetOdometerCtrl',
+    'TiltStabilizationCtrl',
+    'WaterDensityCtrl',
+    'PingerConfigurationCtrl',
+    'SystemTimeCtrl',
+    'GripperCtrl',
+    'GenericServoCtrl',
+    'MultibeamServoCtrl',
+    'DeactivateGuestPortsCtrl',
+    'ActivateGuestPortsCtrl',
+    'RestartGuestPortsCtrl',
+    'SetAquaTrollParameterUnitCtrl',
+    'SetAquaTrollConnectionStatusCtrl',
 )
diff --git a/blueye/protocol/types/message_formats.py b/blueye/protocol/types/message_formats.py
@@ -645,6 +645,9 @@ class ClientInfo(proto.Message):
             Platform software version string
         name (str):
             Name of the client
+        is_observer (bool):
+            If the client should be connected as an
+            observer or not
     """
 
     type_ = proto.Field(proto.STRING, number=1)
@@ -659,6 +662,8 @@ class ClientInfo(proto.Message):
 
     name = proto.Field(proto.STRING, number=6)
 
+    is_observer = proto.Field(proto.BOOL, number=7)
+
 
 class ConnectedClient(proto.Message):
     r"""Information about a connected client with an id assigned by