Update ProtocolDefinitions

blueye/protocol/types/message_formats.py

@@ -212,7 +212,7 @@ class Resolution(proto.Enum):
 
 
 class Framerate(proto.Enum):
-    r"""Available camera framerates."""
+    r"""Available camera frame rates."""
     FRAMERATE_UNSPECIFIED = 0
     FRAMERATE_FPS_30 = 1
     FRAMERATE_FPS_25 = 2
@@ -989,7 +989,7 @@ class BatteryStatus(proto.Message):
                 Battery error codes
         """
         class BatteryError(proto.Enum):
-            r"""Battery errror code from BQ40Z50 BMS data sheet."""
+            r"""Battery error code from BQ40Z50 BMS data sheet."""
             BATTERY_ERROR_UNSPECIFIED = 0
             BATTERY_ERROR_OK = 1
             BATTERY_ERROR_BUSY = 2
@@ -1118,35 +1118,35 @@ class BatterySafetyEvents(proto.Message):
 
         Attributes:
             cov_events_count (int):
-                Number of cell overvoltage (COV) events
+                Number of cell over voltage (COV) events
                 (events)
             cov_last_event (int):
                 Last COV event in cycle count cycles (cycles)
             cuv_events_count (int):
-                Number of cell undervoltage (CUV) events
+                Number of cell under voltage (CUV) events
                 (events)
             cuv_last_event (int):
                 Last CUV event in cycle count cycles (cycles)
             ocd1_events_count (int):
-                Number of Overcurrent in Discharge 1 (OCD1)
+                Number of over current in Discharge 1 (OCD1)
                 events (events)
             ocd1_last_event (int):
                 Last OCD1 event in cycle count cycles
                 (cycles)
             ocd2_events_count (int):
-                Number of Overcurrent in Discharge 2 (OCD2)
+                Number of over current in Discharge 2 (OCD2)
                 events (events)
             ocd2_last_event (int):
                 Last OCD2 event in cycle count cycles
                 (cycles)
             occ1_events_count (int):
-                Number of Overcurrent in Charge 1 (OCC1)
+                Number of over current in Charge 1 (OCC1)
                 events (events)
             occ1_last_event (int):
                 Last OCC1 event in cycle count cycles
                 (cycles)
             occ2_events_count (int):
-                Number of Overcurrent in Charge 2 (OCC2)
+                Number of over current in Charge 2 (OCC2)
                 events (events)
             occ2_last_event (int):
                 Last OCC2 event in cycle count cycles
@@ -1170,18 +1170,18 @@ class BatterySafetyEvents(proto.Message):
                 Last ASCC event in cycle count cycles
                 (cycles)
             otc_events_count (int):
-                Number of Overtemperature in Charge (OTC)
+                Number of over temperature in Charge (OTC)
                 events (events)
             otc_last_event (int):
                 Last OTC event in cycle count cycles (cycles)
             otd_events_count (int):
-                Number of Overtemperature in Discharge (OTD)
+                Number of over temperature in Discharge (OTD)
                 events (events)
             otd_last_event (int):
                 Last OTD event in cycle count cycles (cycles)
             otf_events_count (int):
-                Number of Overtemperature in FET (OTF) events
-                (events)
+                Number of over temperature in FET (OTF)
+                events (events)
             otf_last_event (int):
                 Last OTF event in cycle count cycles (cycles)
         """
@@ -1350,7 +1350,7 @@ class Altitude(proto.Message):
 
 
 class ForwardDistance(proto.Message):
-    r"""Distance to an object infront of the drone
+    r"""Distance to an object in front of the drone
     Typically obtained from a 1D pinger.
 
     Attributes:
@@ -2072,7 +2072,7 @@ class OverlayParameters(proto.Message):
             Feet or None
         temperature_unit (blueye.protocol.types.TemperatureUnit):
             Which unit should be used for temperature:
-            Celcius or Fahrenheit
+            Celsius or Fahrenheit
         thickness_unit (blueye.protocol.types.ThicknessUnit):
             Which unit should be used for thickness:
             Millimeters or Inches

blueye/protocol/types/mission_planning.py

@@ -130,21 +130,21 @@ class Mission(proto.Message):
             List of instructions in the mission
         path_segments (Sequence[blueye.protocol.types.PathSegment]):
             Calculated path segments from the reference
-            generator (optinal)
+            generator (optional)
         total_distance (int):
-            Total distance of the mission (m) (optinal)
+            Total distance of the mission (m) (optional)
         total_duration_time (int):
             Total duration time of the mission (s)
-            (optinal)
+            (optional)
         default_surge_speed (float):
             Default cruise speed of the mission (m/s)
-            (optinal)
+            (optional)
         default_heave_speed (float):
             Default heave speed of the mission (m/s)
-            (optinal)
+            (optional)
         default_circle_of_acceptance (float):
             Default circle of acceptance for waypoints
-            (m) (optinal)
+            (m) (optional)
     """
 
     id = proto.Field(proto.UINT32, number=1)
@@ -171,14 +171,14 @@ class Mission(proto.Message):
 
 
 class Instruction(proto.Message):
-    r"""A mission consitst of one or multiple instructions. One
+    r"""A mission consists of one or multiple instructions. One
     instruction can be of different types.
 
     Attributes:
         id (int):
 
         group_id (int):
-            Group id used for polygoons
+            Group id used for polygons
         auto_continue (bool):
             False will pause the mission after this
             instruction
@@ -252,8 +252,8 @@ class Instruction(proto.Message):
 
 
 class DepthSetPoint(proto.Message):
-    r"""Depth set point is used to describe a depth setpoint relative
-    to the surface or the seabed.
+    r"""Depth set point is used to describe a depth set-point
+    relative to the surface or the seabed.
 
     Attributes:
         depth (float):
@@ -262,7 +262,7 @@ class DepthSetPoint(proto.Message):
             Desired speed to desired depth set point
             (m/s)
         depth_zero_reference (blueye.protocol.types.DepthZeroReference):
-            Used to destinguish desired altitude or depth
+            Used to distinguish desired altitude or depth
     """
 
     depth = proto.Field(proto.FLOAT, number=1)
@@ -285,7 +285,7 @@ class Waypoint(proto.Message):
         global_position (blueye.protocol.types.LatLongPosition):
             Position if the waypoint (decimal degrees)
         circle_of_acceptance (float):
-            Radius of the accepance circle around the
+            Radius of the acceptance circle around the
             waypoint (m)
         speed_to_target (float):
             Desired speed over ground to waypoint (m/s)
@@ -387,7 +387,7 @@ class TiltMultibeamCommand(proto.Message):
 
 
 class WaitForCommand(proto.Message):
-    r"""WaitForCommand is used to wait duringing a mission.
+    r"""WaitForCommand is used to wait during a mission.
 
     Attributes:
         wait_for_seconds (float):
@@ -465,14 +465,14 @@ class PathSegment(proto.Message):
         horizontal_length (float):
             Horizontal length of the path segment (m)
         vertical_length (float):
-            Vertical legth of the path segment (m)
+            Vertical length of the path segment (m)
         from_wp_id (int):
             Id of the starting waypoint
         to_wp_id (int):
             Id of the ending waypoint
         duration_time (float):
-            Estmated time it takes to complete given
-            legth and desired speed (s)
+            Estimated time it takes to complete given
+            length and desired speed (s)
     """
 
     id = proto.Field(proto.UINT32, number=1)

blueye/protocol/types/req_rep.py

@@ -187,7 +187,7 @@ class SetThicknessGaugeParametersReq(proto.Message):
 
 
 class SetThicknessGaugeParametersRep(proto.Message):
-    r"""Response after setting thicknes gauge parameters."""
+    r"""Response after setting thickness gauge parameters."""
 
 
 class ConnectClientReq(proto.Message):
@@ -287,7 +287,7 @@ class SetMissionReq(proto.Message):
 
     Attributes:
         mission (blueye.protocol.types.Mission):
-            requested mission isseued to the reference
+            requested mission issued to the reference
             generator
     """
 

blueye/protocol/types/telemetry.py

@@ -370,7 +370,7 @@ class DroneTimeTel(proto.Message):
 
 
 class WaterTemperatureTel(proto.Message):
-    r"""Water temerature from the depth sensor.
+    r"""Water temperature from the depth sensor.
 
     Attributes:
         temperature (blueye.protocol.types.WaterTemperature):
@@ -474,7 +474,7 @@ class DataStorageSpaceTel(proto.Message):
 
 
 class CalibrationStateTel(proto.Message):
-    r"""Calibration state used for calibration rotine.
+    r"""Calibration state used for calibration routine.
 
     Attributes:
         calibration_state (blueye.protocol.types.CalibrationState):
@@ -584,7 +584,7 @@ class ThicknessGaugeTel(proto.Message):
 
     Attributes:
         thickness_gauge (blueye.protocol.types.ThicknessGauge):
-            Tickness measurement with a cygnus gauge.
+            Thickness measurement with a cygnus gauge.
     """
 
     thickness_gauge = proto.Field(proto.MESSAGE, number=1,