Update ProtocolDefinitions

blueye/protocol/protos.py

@@ -112,6 +112,7 @@
 from .types.message_formats import GuestPortRestartInfo
 from .types.message_formats import HeadingSource
 from .types.message_formats import Imu
+from .types.message_formats import IntervalType
 from .types.message_formats import IperfStatus
 from .types.message_formats import Laser
 from .types.message_formats import LatLongPosition
@@ -146,6 +147,7 @@
 from .types.message_formats import TiltAngle
 from .types.message_formats import TiltStabilizationState
 from .types.message_formats import TiltVelocity
+from .types.message_formats import TimeLapseState
 from .types.message_formats import Vector3
 from .types.message_formats import WaterDensity
 from .types.message_formats import WaterTemperature
@@ -248,6 +250,7 @@
 from .types.telemetry import ThicknessGaugeTel
 from .types.telemetry import TiltAngleTel
 from .types.telemetry import TiltStabilizationTel
+from .types.telemetry import TimeLapseStateTel
 from .types.telemetry import VideoStorageSpaceTel
 from .types.telemetry import WaterTemperatureTel
 
@@ -379,6 +382,7 @@
     'Imu2Tel',
     'Instruction',
     'InstructionType',
+    'IntervalType',
     'IperfStatus',
     'IperfTel',
     'Laser',
@@ -474,6 +478,8 @@
     'TiltStabilizationTel',
     'TiltVelocity',
     'TiltVelocityCtrl',
+    'TimeLapseState',
+    'TimeLapseStateTel',
     'Type',
     'Vector3',
     'VideoStorageSpaceTel',

blueye/protocol/types/__init__.py

@@ -36,6 +36,7 @@
     ClientInfo,
     ConnectedClient,
     RecordState,
+    TimeLapseState,
     WaterDensity,
     PingerConfiguration,
     WaterTemperature,
@@ -80,6 +81,7 @@
     Vector3,
     Imu,
     MedusaSpectrometerData,
+    IntervalType,
     HeadingSource,
     ResetCoordinateSource,
     NotificationType,
@@ -228,6 +230,7 @@
     LaserTel,
     PilotGPSPositionTel,
     RecordStateTel,
+    TimeLapseStateTel,
     BatteryTel,
     BatteryBQ40Z50Tel,
     DiveTimeTel,
@@ -284,6 +287,7 @@
     'ClientInfo',
     'ConnectedClient',
     'RecordState',
+    'TimeLapseState',
     'WaterDensity',
     'PingerConfiguration',
     'WaterTemperature',
@@ -328,6 +332,7 @@
     'Vector3',
     'Imu',
     'MedusaSpectrometerData',
+    'IntervalType',
     'HeadingSource',
     'ResetCoordinateSource',
     'NotificationType',
@@ -466,6 +471,7 @@
     'LaserTel',
     'PilotGPSPositionTel',
     'RecordStateTel',
+    'TimeLapseStateTel',
     'BatteryTel',
     'BatteryBQ40Z50Tel',
     'DiveTimeTel',

blueye/protocol/types/message_formats.py

@@ -25,6 +25,7 @@
 __protobuf__ = proto.module(
     package='blueye.protocol',
     manifest={
+        'IntervalType',
         'HeadingSource',
         'ResetCoordinateSource',
         'NotificationType',
@@ -64,6 +65,7 @@
         'ClientInfo',
         'ConnectedClient',
         'RecordState',
+        'TimeLapseState',
         'WaterDensity',
         'PingerConfiguration',
         'WaterTemperature',
@@ -112,6 +114,13 @@
 )
 
 
+class IntervalType(proto.Enum):
+    r"""Interval type for time-lapse photos."""
+    INTERVAL_TYPE_UNSPECIFIED = 0
+    INTERVAL_TYPE_TIME = 1
+    INTERVAL_TYPE_DISTANCE = 2
+
+
 class HeadingSource(proto.Enum):
     r"""Heading source used during reset of the position estimate."""
     HEADING_SOURCE_UNSPECIFIED = 0
@@ -677,6 +686,27 @@ class RecordState(proto.Message):
     guestport_seconds = proto.Field(proto.INT32, number=4)
 
 
+class TimeLapseState(proto.Message):
+    r"""Time-lapse state published if time-lapse mission is running.
+
+    Attributes:
+        interval (float):
+            Interval between photos
+        photos_taken (int):
+            Number of photos taken
+        interval_type (blueye.protocol.types.IntervalType):
+            Interval type for photos, distance or time
+    """
+
+    interval = proto.Field(proto.FLOAT, number=1)
+
+    photos_taken = proto.Field(proto.INT32, number=2)
+
+    interval_type = proto.Field(proto.ENUM, number=3,
+        enum='IntervalType',
+    )
+
+
 class WaterDensity(proto.Message):
     r"""Water density.
     Used to specify the water density the drone is operating in, to

blueye/protocol/types/telemetry.py

@@ -42,6 +42,7 @@
         'LaserTel',
         'PilotGPSPositionTel',
         'RecordStateTel',
+        'TimeLapseStateTel',
         'BatteryTel',
         'BatteryBQ40Z50Tel',
         'DiveTimeTel',
@@ -292,6 +293,19 @@ class RecordStateTel(proto.Message):
     )
 
 
+class TimeLapseStateTel(proto.Message):
+    r"""Time-lapse state from the drone.
+
+    Attributes:
+        time_lapse_state (blueye.protocol.types.TimeLapseState):
+
+    """
+
+    time_lapse_state = proto.Field(proto.MESSAGE, number=1,
+        message=message_formats.TimeLapseState,
+    )
+
+
 class BatteryTel(proto.Message):
     r"""Receive essential information about the battery status.