Update ProtocolDefinitions

blueye/protocol/protos.py

@@ -119,6 +119,7 @@
 from .types.message_formats import MotionInput
 from .types.message_formats import MultibeamConfig
 from .types.message_formats import MultibeamDiscovery
+from .types.message_formats import MultibeamErrorFlags
 from .types.message_formats import MultibeamFrameOffset
 from .types.message_formats import MultibeamPing
 from .types.message_formats import MultibeamServo
@@ -445,6 +446,7 @@
 'MultibeamConfigTel',
 'MultibeamDiscovery',
 'MultibeamDiscoveryTel',
+'MultibeamErrorFlags',
 'MultibeamFrameOffset',
 'MultibeamFrequencyMode',
 'MultibeamPing',

blueye/protocol/types/__init__.py

@@ -123,6 +123,7 @@
     MotionInput,
     MultibeamConfig,
     MultibeamDiscovery,
+    MultibeamErrorFlags,
     MultibeamFrameOffset,
     MultibeamPing,
     MultibeamServo,
@@ -397,6 +398,7 @@
     'MotionInput',
     'MultibeamConfig',
     'MultibeamDiscovery',
+    'MultibeamErrorFlags',
     'MultibeamFrameOffset',
     'MultibeamPing',
     'MultibeamServo',

blueye/protocol/types/aquatroll.py

@@ -83,7 +83,7 @@ class Type(proto.Enum):
 
 
 class AquaTrollDevice(proto.Enum):
-    r"""Aqua Troll Device IDs
+    r"""Aqua Troll Device IDs.
 
     Attributes:
         AQUA_TROLL_DEVICE_UNSPECIFIED (0):
@@ -150,7 +150,7 @@ class AquaTrollDevice(proto.Enum):
 
 
 class AquaTrollQuality(proto.Enum):
-    r"""Aqua Troll Quality IDs
+    r"""Aqua Troll Quality IDs.
 
     Attributes:
         AQUA_TROLL_QUALITY_NORMAL (0):
@@ -181,7 +181,7 @@ class AquaTrollQuality(proto.Enum):
 
 
 class AquaTrollParameter(proto.Enum):
-    r"""Aqua Troll Parameter IDs
+    r"""Aqua Troll Parameter IDs.
 
     Attributes:
         AQUA_TROLL_PARAMETER_UNSPECIFIED (0):
@@ -362,7 +362,7 @@ class AquaTrollParameter(proto.Enum):
 
 
 class AquaTrollUnit(proto.Enum):
-    r"""Aqua Troll Unit IDs
+    r"""Aqua Troll Unit IDs.
 
     Attributes:
         AQUA_TROLL_UNIT_UNSPECIFIED (0):
@@ -621,7 +621,7 @@ class AquaTrollUnit(proto.Enum):
 
 
 class AquaTrollSensor(proto.Enum):
-    r"""Aqua Troll Sensor IDs
+    r"""Aqua Troll Sensor IDs.
 
     Attributes:
         AQUA_TROLL_SENSOR_UNSPECIFIED (0):
@@ -882,9 +882,9 @@ class AquaTrollDeviceStatus(proto.Enum):
 
 
 class AquaTrollParameterBlock(proto.Message):
-    r"""In-Situ Parameter Block
+    r"""In-Situ Parameter Block.
 
-    Up to NUMBER_OF_SENSOR_PARAMETERS blocks may be part of a sensor
+    Up to NUMBER_OF_SENSOR_PARAMETERS blocks may be part of a sensor.
 
     Attributes:
         measured_value (float):
@@ -932,12 +932,12 @@ class AquaTrollParameterBlock(proto.Message):
 
 
 class AquaTrollSensorMetadata(proto.Message):
-    r"""In-Situ AquaTroll 500 sensor metadata
+    r"""In-Situ AquaTroll 500 sensor metadata.
 
     (Mostly) static information about a connected sensor.
 
     Refer to Section 7 Sensor Common Registers in the In-Situ Modbus
-    Communication Protocol
+    Communication Protocol.
 
     Attributes:
         timestamp (google.protobuf.timestamp_pb2.Timestamp):
@@ -1304,7 +1304,7 @@ class AquaTrollSensorParametersArray(proto.Message):
 
 
 class SetAquaTrollParameterUnit(proto.Message):
-    r"""Request to set an In-Situ Aqua Troll parameter unit
+    r"""Request to set an In-Situ Aqua Troll parameter unit.
 
     Attributes:
         sensor_id (blueye.protocol.types.AquaTrollSensor):
@@ -1333,11 +1333,11 @@ class SetAquaTrollParameterUnit(proto.Message):
 
 
 class SetAquaTrollConnectionStatus(proto.Message):
-    r"""Request to change the In-Situ Aqua Troll connection status
+    r"""Request to change the In-Situ Aqua Troll connection status.
 
     Attributes:
         connected (bool):
-            True to connect, false to disconnect
+            True to connect, false to disconnect.
     """
 
     connected: bool = proto.Field(

blueye/protocol/types/control.py

@@ -232,7 +232,7 @@ class AutoHeadingCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.AutoHeadingState):
-            State of the heading controller
+            State of the heading controller.
     """
 
     state: message_formats.AutoHeadingState = proto.Field(
@@ -247,7 +247,7 @@ class AutoDepthCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.AutoDepthState):
-            State of the depth controller
+            State of the depth controller.
     """
 
     state: message_formats.AutoDepthState = proto.Field(
@@ -262,7 +262,7 @@ class AutoAltitudeCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.AutoAltitudeState):
-            State of the altitude controller
+            State of the altitude controller.
     """
 
     state: message_formats.AutoAltitudeState = proto.Field(
@@ -277,7 +277,7 @@ class StationKeepingCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.StationKeepingState):
-            State of the station keeping controller
+            State of the station keeping controller.
     """
 
     state: message_formats.StationKeepingState = proto.Field(
@@ -293,7 +293,7 @@ class WeatherVaningCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.WeatherVaningState):
-            State of the weather vaning controller
+            State of the weather vaning controller.
     """
 
     state: message_formats.WeatherVaningState = proto.Field(
@@ -309,7 +309,7 @@ class AutoPilotSurgeYawCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.AutoPilotSurgeYawState):
-            State of the auto pilot surge yaw controller
+            State of the auto pilot surge yaw controller.
     """
 
     state: message_formats.AutoPilotSurgeYawState = proto.Field(
@@ -325,7 +325,7 @@ class AutoPilotHeaveCtrl(proto.Message):
 
     Attributes:
         state (blueye.protocol.types.AutoPilotHeaveState):
-            State of the auto pilot heave controller
+            State of the auto pilot heave controller-
     """
 
     state: message_formats.AutoPilotHeaveState = proto.Field(
@@ -482,17 +482,17 @@ class MultibeamServoCtrl(proto.Message):
 
 
 class DeactivateGuestPortsCtrl(proto.Message):
-    r"""Deactivate the guest port power
+    r"""Deactivate the guest port power.
     """
 
 
 class ActivateGuestPortsCtrl(proto.Message):
-    r"""Activated the guest port power
+    r"""Activated the guest port power.
     """
 
 
 class RestartGuestPortsCtrl(proto.Message):
-    r"""Restart the guest ports by turning power on and off
+    r"""Restart the guest ports by turning power on and off.
 
     Attributes:
         restart_info (blueye.protocol.types.GuestPortRestartInfo):
@@ -508,7 +508,7 @@ class RestartGuestPortsCtrl(proto.Message):
 
 
 class SetAquaTrollParameterUnitCtrl(proto.Message):
-    r"""Request to set an In-Situ Aqua Troll parameter unit
+    r"""Request to set an In-Situ Aqua Troll parameter unit.
 
     Attributes:
         parameter_info (blueye.protocol.types.SetAquaTrollParameterUnit):
@@ -524,7 +524,7 @@ class SetAquaTrollParameterUnitCtrl(proto.Message):
 
 
 class SetAquaTrollConnectionStatusCtrl(proto.Message):
-    r"""Request to change the In-Situ Aqua Troll connection status
+    r"""Request to change the In-Situ Aqua Troll connection status.
 
     Attributes:
         connection_status (blueye.protocol.types.SetAquaTrollConnectionStatus):
@@ -540,7 +540,7 @@ class SetAquaTrollConnectionStatusCtrl(proto.Message):
 
 
 class SetMultibeamConfigCtrl(proto.Message):
-    r"""Update multibeam settings
+    r"""Update the multibeam settings.
 
     Attributes:
         config (blueye.protocol.types.MultibeamConfig):
@@ -556,12 +556,12 @@ class SetMultibeamConfigCtrl(proto.Message):
 
 
 class ActivateMultibeamCtrl(proto.Message):
-    r"""Activate multibeam
+    r"""Activate the multibeam with specified configuration.
 
     Attributes:
         config (blueye.protocol.types.MultibeamConfig):
             Message with the multibeam ping configuration
-            to set on connect
+            to set on connect.
     """
 
     config: message_formats.MultibeamConfig = proto.Field(
@@ -572,7 +572,7 @@ class ActivateMultibeamCtrl(proto.Message):
 
 
 class DeactivateMultibeamCtrl(proto.Message):
-    r"""Deactivate multibeam
+    r"""Deactivate the multibeam.
     """