blueye.protocol 3.2.0__tar.gz → 3.3.0__tar.gz

{blueye_protocol-3.2.0 → blueye_protocol-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blueye.protocol
-Version: 3.2.0
+Version: 3.3.0
 Summary: Python protocol definition for the Blueye drones
 Author-email: Blueye Robotics <contact@blueye.no>
 License:                    GNU LESSER GENERAL PUBLIC LICENSE

{blueye_protocol-3.2.0 → blueye_protocol-3.3.0}/blueye/protocol/protos.py

@@ -38,6 +38,7 @@ from .types.control import AutoHeadingCtrl
 from .types.control import AutoPilotHeaveCtrl
 from .types.control import AutoPilotSurgeYawCtrl
 from .types.control import CalibrateDvlGyroCtrl
+from .types.control import CameraPanTiltZoomCtrl
 from .types.control import CancelCalibrationCtrl
 from .types.control import ClearMissionCtrl
 from .types.control import DeactivateGuestPortsCtrl
@@ -63,9 +64,12 @@ from .types.control import RunMissionCtrl
 from .types.control import SetAquaTrollConnectionStatusCtrl
 from .types.control import SetAquaTrollParameterUnitCtrl
 from .types.control import SetMultibeamConfigCtrl
+from .types.control import SetTurbidityFilterCtrl
 from .types.control import StartCalibrationCtrl
 from .types.control import StartDiveCtrl
+from .types.control import StartLogStreamingCtrl
 from .types.control import StationKeepingCtrl
+from .types.control import StopLogStreamingCtrl
 from .types.control import SystemTimeCtrl
 from .types.control import TakePictureCtrl
 from .types.control import TiltStabilizationCtrl
@@ -83,7 +87,9 @@ from .types.message_formats import AutoPilotSurgeYawState
 from .types.message_formats import Battery
 from .types.message_formats import BatteryBQ40Z50
 from .types.message_formats import BinlogRecord
+from .types.message_formats import BoundingBox
 from .types.message_formats import CalibrationState
+from .types.message_formats import CameraPanTiltZoom
 from .types.message_formats import CameraParameters
 from .types.message_formats import CanisterHumidity
 from .types.message_formats import CanisterTemperature
@@ -94,16 +100,20 @@ from .types.message_formats import ControlForce
 from .types.message_formats import ControllerHealth
 from .types.message_formats import ControlMode
 from .types.message_formats import CpProbe
+from .types.message_formats import CpuCoreLoad
 from .types.message_formats import CPUInfo
 from .types.message_formats import CPUTemperature
 from .types.message_formats import Depth
 from .types.message_formats import DiveTime
+from .types.message_formats import DlaInfo
 from .types.message_formats import DroneInfo
 from .types.message_formats import DvlTransducer
 from .types.message_formats import DvlVelocity
 from .types.message_formats import ErrorFlags
+from .types.message_formats import FilterMessage
 from .types.message_formats import ForwardDistance
 from .types.message_formats import GenericServo
+from .types.message_formats import GpuInfo
 from .types.message_formats import GripperVelocities
 from .types.message_formats import GuestPortConnectorInfo
 from .types.message_formats import GuestPortCurrent
@@ -120,6 +130,8 @@ from .types.message_formats import Lights
 from .types.message_formats import LogEntry
 from .types.message_formats import MagneticDeclination
 from .types.message_formats import MedusaSpectrometerData
+from .types.message_formats import MemoryInfo
+from .types.message_formats import ModelDetections
 from .types.message_formats import MotionInput
 from .types.message_formats import MultibeamConfig
 from .types.message_formats import MultibeamDiscovery
@@ -131,6 +143,8 @@ from .types.message_formats import MutltibeamRecordingIndex
 from .types.message_formats import NavigationSensorStatus
 from .types.message_formats import Notification
 from .types.message_formats import NStreamers
+from .types.message_formats import ObjectDetection
+from .types.message_formats import OperatorInfo
 from .types.message_formats import OverlayParameters
 from .types.message_formats import PersistentStorageSettings
 from .types.message_formats import PingerConfiguration
@@ -146,13 +160,16 @@ from .types.message_formats import StoragePartition
 from .types.message_formats import StorageSpace
 from .types.message_formats import SurfaceUnitBatteryInfo
 from .types.message_formats import SurfaceUnitVersionInfo
+from .types.message_formats import SystemPerformanceInfo
 from .types.message_formats import SystemTime
+from .types.message_formats import ThermalZone
 from .types.message_formats import ThicknessGauge
 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 VideoCodecInfo
 from .types.message_formats import WaterDensity
 from .types.message_formats import WaterTemperature
 from .types.message_formats import WeatherVaningState
@@ -175,11 +192,13 @@ from .types.message_formats import NavigationSensorID
 from .types.message_formats import NotificationLevel
 from .types.message_formats import NotificationType
 from .types.message_formats import PressureSensorType
+from .types.message_formats import RecordingCodec
 from .types.message_formats import ResetCoordinateSource
 from .types.message_formats import Resolution
 from .types.message_formats import StorageLocation
 from .types.message_formats import StreamingProtocol
 from .types.message_formats import TemperatureUnit
+from .types.message_formats import ThermalZoneId
 from .types.message_formats import ThicknessUnit
 from .types.mission_planning import CameraCommand
 from .types.mission_planning import ControlModeCommand
@@ -193,6 +212,7 @@ from .types.mission_planning import Mission
 from .types.mission_planning import MissionStatus
 from .types.mission_planning import PathSegment
 from .types.mission_planning import ReferenceAutoPilot
+from .types.mission_planning import SurveyCommand
 from .types.mission_planning import TiltMainCameraCommand
 from .types.mission_planning import TiltMultibeamCommand
 from .types.mission_planning import WaitForCommand
@@ -216,6 +236,8 @@ from .types.req_rep import GetCameraParametersRep
 from .types.req_rep import GetCameraParametersReq
 from .types.req_rep import GetIperfStatusRep
 from .types.req_rep import GetIperfStatusReq
+from .types.req_rep import GetLogStreamingStatusRep
+from .types.req_rep import GetLogStreamingStatusReq
 from .types.req_rep import GetMissionRep
 from .types.req_rep import GetMissionReq
 from .types.req_rep import GetOverlayParametersRep
@@ -256,6 +278,7 @@ from .types.telemetry import BatteryTel
 from .types.telemetry import CalibratedImuHpTel
 from .types.telemetry import CalibratedImuTel
 from .types.telemetry import CalibrationStateTel
+from .types.telemetry import CameraPanTiltZoomTel
 from .types.telemetry import CanisterBottomHumidityTel
 from .types.telemetry import CanisterBottomTemperatureTel
 from .types.telemetry import ConnectedClientsTel
@@ -292,6 +315,7 @@ from .types.telemetry import MultibeamPingTel
 from .types.telemetry import MultibeamServoTel
 from .types.telemetry import NotificationTel
 from .types.telemetry import NStreamersTel
+from .types.telemetry import ObjectDetectionsTel
 from .types.telemetry import PilotGPSPositionTel
 from .types.telemetry import PositionEstimateTel
 from .types.telemetry import RecordStateTel
@@ -299,10 +323,12 @@ from .types.telemetry import ReferenceAutoPilotTel
 from .types.telemetry import ReferenceTel
 from .types.telemetry import RemovableStorageTel
 from .types.telemetry import SurfaceUnitTel
+from .types.telemetry import SystemPerformanceInfoTel
 from .types.telemetry import ThicknessGaugeTel
 from .types.telemetry import TiltAngleTel
 from .types.telemetry import TiltStabilizationTel
 from .types.telemetry import TimeLapseStateTel
+from .types.telemetry import TurbidityFilterTel
 from .types.telemetry import VideoStorageSpaceTel
 from .types.telemetry import WaterTemperatureTel
 
@@ -344,6 +370,7 @@ __all__ = (
 'BatteryBQ40Z50Tel',
 'BatteryTel',
 'BinlogRecord',
+'BoundingBox',
 'CPUInfo',
 'CPUInfoTel',
 'CPUTemperature',
@@ -356,6 +383,9 @@ __all__ = (
 'Camera',
 'CameraAction',
 'CameraCommand',
+'CameraPanTiltZoom',
+'CameraPanTiltZoomCtrl',
+'CameraPanTiltZoomTel',
 'CameraParameters',
 'CancelCalibrationCtrl',
 'CanisterBottomHumidityTel',
@@ -380,6 +410,7 @@ __all__ = (
 'ControllerHealthTel',
 'CpProbe',
 'CpProbeTel',
+'CpuCoreLoad',
 'DataStorageSpaceTel',
 'DeactivateGuestPortsCtrl',
 'DeactivateMultibeamCtrl',
@@ -393,6 +424,7 @@ __all__ = (
 'DisconnectClientReq',
 'DiveTime',
 'DiveTimeTel',
+'DlaInfo',
 'DroneInfo',
 'DroneInfoTel',
 'DroneTimeTel',
@@ -402,6 +434,7 @@ __all__ = (
 'EndDiveCtrl',
 'ErrorFlags',
 'ErrorFlagsTel',
+'FilterMessage',
 'FinishCalibrationCtrl',
 'FlashEscSettingsRep',
 'FlashEscSettingsReq',
@@ -419,6 +452,8 @@ __all__ = (
 'GetCameraParametersReq',
 'GetIperfStatusRep',
 'GetIperfStatusReq',
+'GetLogStreamingStatusRep',
+'GetLogStreamingStatusReq',
 'GetMissionRep',
 'GetMissionReq',
 'GetOverlayParametersRep',
@@ -430,6 +465,7 @@ __all__ = (
 'GoToHomeCommand',
 'GoToSeabedCommand',
 'GoToSurfaceCommand',
+'GpuInfo',
 'GripperCtrl',
 'GripperVelocities',
 'GuestPortConnectorInfo',
@@ -472,11 +508,13 @@ __all__ = (
 'MagneticDeclinationTel',
 'MedusaSpectrometerData',
 'MedusaSpectrometerDataTel',
+'MemoryInfo',
 'Mission',
 'MissionState',
 'MissionStatus',
 'MissionStatusTel',
 'Model',
+'ModelDetections',
 'MotionInput',
 'MotionInputCtrl',
 'MultibeamConfig',
@@ -500,6 +538,9 @@ __all__ = (
 'NotificationLevel',
 'NotificationTel',
 'NotificationType',
+'ObjectDetection',
+'ObjectDetectionsTel',
+'OperatorInfo',
 'OverlayParameters',
 'PathSegment',
 'PauseMissionCtrl',
@@ -517,6 +558,7 @@ __all__ = (
 'RecordOn',
 'RecordState',
 'RecordStateTel',
+'RecordingCodec',
 'Reference',
 'ReferenceAutoPilot',
 'ReferenceAutoPilotTel',
@@ -554,10 +596,13 @@ __all__ = (
 'SetPubFrequencyReq',
 'SetThicknessGaugeParametersRep',
 'SetThicknessGaugeParametersReq',
+'SetTurbidityFilterCtrl',
 'StartCalibrationCtrl',
 'StartDiveCtrl',
+'StartLogStreamingCtrl',
 'StationKeepingCtrl',
 'StationKeepingState',
+'StopLogStreamingCtrl',
 'StorageLocation',
 'StoragePartition',
 'StorageSpace',
@@ -565,12 +610,17 @@ __all__ = (
 'SurfaceUnitBatteryInfo',
 'SurfaceUnitTel',
 'SurfaceUnitVersionInfo',
+'SurveyCommand',
 'SyncTimeRep',
 'SyncTimeReq',
+'SystemPerformanceInfo',
+'SystemPerformanceInfoTel',
 'SystemTime',
 'SystemTimeCtrl',
 'TakePictureCtrl',
 'TemperatureUnit',
+'ThermalZone',
+'ThermalZoneId',
 'ThicknessGauge',
 'ThicknessGaugeTel',
 'ThicknessUnit',
@@ -585,8 +635,10 @@ __all__ = (
 'TiltVelocityCtrl',
 'TimeLapseState',
 'TimeLapseStateTel',
+'TurbidityFilterTel',
 'Type',
 'Vector3',
+'VideoCodecInfo',
 'VideoStorageSpaceTel',
 'WaitForCommand',
 'WatchdogCtrl',

{blueye_protocol-3.2.0 → blueye_protocol-3.3.0}/blueye/protocol/types/__init__.py

@@ -40,6 +40,7 @@ from .control import (
     AutoPilotHeaveCtrl,
     AutoPilotSurgeYawCtrl,
     CalibrateDvlGyroCtrl,
+    CameraPanTiltZoomCtrl,
     CancelCalibrationCtrl,
     ClearMissionCtrl,
     DeactivateGuestPortsCtrl,
@@ -65,9 +66,12 @@ from .control import (
     SetAquaTrollConnectionStatusCtrl,
     SetAquaTrollParameterUnitCtrl,
     SetMultibeamConfigCtrl,
+    SetTurbidityFilterCtrl,
     StartCalibrationCtrl,
     StartDiveCtrl,
+    StartLogStreamingCtrl,
     StationKeepingCtrl,
+    StopLogStreamingCtrl,
     SystemTimeCtrl,
     TakePictureCtrl,
     TiltStabilizationCtrl,
@@ -87,7 +91,9 @@ from .message_formats import (
     Battery,
     BatteryBQ40Z50,
     BinlogRecord,
+    BoundingBox,
     CalibrationState,
+    CameraPanTiltZoom,
     CameraParameters,
     CanisterHumidity,
     CanisterTemperature,
@@ -98,16 +104,20 @@ from .message_formats import (
     ControllerHealth,
     ControlMode,
     CpProbe,
+    CpuCoreLoad,
     CPUInfo,
     CPUTemperature,
     Depth,
     DiveTime,
+    DlaInfo,
     DroneInfo,
     DvlTransducer,
     DvlVelocity,
     ErrorFlags,
+    FilterMessage,
     ForwardDistance,
     GenericServo,
+    GpuInfo,
     GripperVelocities,
     GuestPortConnectorInfo,
     GuestPortCurrent,
@@ -124,6 +134,8 @@ from .message_formats import (
     LogEntry,
     MagneticDeclination,
     MedusaSpectrometerData,
+    MemoryInfo,
+    ModelDetections,
     MotionInput,
     MultibeamConfig,
     MultibeamDiscovery,
@@ -135,6 +147,8 @@ from .message_formats import (
     NavigationSensorStatus,
     Notification,
     NStreamers,
+    ObjectDetection,
+    OperatorInfo,
     OverlayParameters,
     PersistentStorageSettings,
     PingerConfiguration,
@@ -150,13 +164,16 @@ from .message_formats import (
     StorageSpace,
     SurfaceUnitBatteryInfo,
     SurfaceUnitVersionInfo,
+    SystemPerformanceInfo,
     SystemTime,
+    ThermalZone,
     ThicknessGauge,
     TiltAngle,
     TiltStabilizationState,
     TiltVelocity,
     TimeLapseState,
     Vector3,
+    VideoCodecInfo,
     WaterDensity,
     WaterTemperature,
     WeatherVaningState,
@@ -179,11 +196,13 @@ from .message_formats import (
     NotificationLevel,
     NotificationType,
     PressureSensorType,
+    RecordingCodec,
     ResetCoordinateSource,
     Resolution,
     StorageLocation,
     StreamingProtocol,
     TemperatureUnit,
+    ThermalZoneId,
     ThicknessUnit,
 )
 from .mission_planning import (
@@ -199,6 +218,7 @@ from .mission_planning import (
     MissionStatus,
     PathSegment,
     ReferenceAutoPilot,
+    SurveyCommand,
     TiltMainCameraCommand,
     TiltMultibeamCommand,
     WaitForCommand,
@@ -224,6 +244,8 @@ from .req_rep import (
     GetCameraParametersReq,
     GetIperfStatusRep,
     GetIperfStatusReq,
+    GetLogStreamingStatusRep,
+    GetLogStreamingStatusReq,
     GetMissionRep,
     GetMissionReq,
     GetOverlayParametersRep,
@@ -266,6 +288,7 @@ from .telemetry import (
     CalibratedImuHpTel,
     CalibratedImuTel,
     CalibrationStateTel,
+    CameraPanTiltZoomTel,
     CanisterBottomHumidityTel,
     CanisterBottomTemperatureTel,
     ConnectedClientsTel,
@@ -302,6 +325,7 @@ from .telemetry import (
     MultibeamServoTel,
     NotificationTel,
     NStreamersTel,
+    ObjectDetectionsTel,
     PilotGPSPositionTel,
     PositionEstimateTel,
     RecordStateTel,
@@ -309,10 +333,12 @@ from .telemetry import (
     ReferenceTel,
     RemovableStorageTel,
     SurfaceUnitTel,
+    SystemPerformanceInfoTel,
     ThicknessGaugeTel,
     TiltAngleTel,
     TiltStabilizationTel,
     TimeLapseStateTel,
+    TurbidityFilterTel,
     VideoStorageSpaceTel,
     WaterTemperatureTel,
 )
@@ -342,6 +368,7 @@ __all__ = (
     'AutoPilotHeaveCtrl',
     'AutoPilotSurgeYawCtrl',
     'CalibrateDvlGyroCtrl',
+    'CameraPanTiltZoomCtrl',
     'CancelCalibrationCtrl',
     'ClearMissionCtrl',
     'DeactivateGuestPortsCtrl',
@@ -367,9 +394,12 @@ __all__ = (
     'SetAquaTrollConnectionStatusCtrl',
     'SetAquaTrollParameterUnitCtrl',
     'SetMultibeamConfigCtrl',
+    'SetTurbidityFilterCtrl',
     'StartCalibrationCtrl',
     'StartDiveCtrl',
+    'StartLogStreamingCtrl',
     'StationKeepingCtrl',
+    'StopLogStreamingCtrl',
     'SystemTimeCtrl',
     'TakePictureCtrl',
     'TiltStabilizationCtrl',
@@ -387,7 +417,9 @@ __all__ = (
     'Battery',
     'BatteryBQ40Z50',
     'BinlogRecord',
+    'BoundingBox',
     'CalibrationState',
+    'CameraPanTiltZoom',
     'CameraParameters',
     'CanisterHumidity',
     'CanisterTemperature',
@@ -398,16 +430,20 @@ __all__ = (
     'ControllerHealth',
     'ControlMode',
     'CpProbe',
+    'CpuCoreLoad',
     'CPUInfo',
     'CPUTemperature',
     'Depth',
     'DiveTime',
+    'DlaInfo',
     'DroneInfo',
     'DvlTransducer',
     'DvlVelocity',
     'ErrorFlags',
+    'FilterMessage',
     'ForwardDistance',
     'GenericServo',
+    'GpuInfo',
     'GripperVelocities',
     'GuestPortConnectorInfo',
     'GuestPortCurrent',
@@ -424,6 +460,8 @@ __all__ = (
     'LogEntry',
     'MagneticDeclination',
     'MedusaSpectrometerData',
+    'MemoryInfo',
+    'ModelDetections',
     'MotionInput',
     'MultibeamConfig',
     'MultibeamDiscovery',
@@ -435,6 +473,8 @@ __all__ = (
     'NavigationSensorStatus',
     'Notification',
     'NStreamers',
+    'ObjectDetection',
+    'OperatorInfo',
     'OverlayParameters',
     'PersistentStorageSettings',
     'PingerConfiguration',
@@ -450,13 +490,16 @@ __all__ = (
     'StorageSpace',
     'SurfaceUnitBatteryInfo',
     'SurfaceUnitVersionInfo',
+    'SystemPerformanceInfo',
     'SystemTime',
+    'ThermalZone',
     'ThicknessGauge',
     'TiltAngle',
     'TiltStabilizationState',
     'TiltVelocity',
     'TimeLapseState',
     'Vector3',
+    'VideoCodecInfo',
     'WaterDensity',
     'WaterTemperature',
     'WeatherVaningState',
@@ -479,11 +522,13 @@ __all__ = (
     'NotificationLevel',
     'NotificationType',
     'PressureSensorType',
+    'RecordingCodec',
     'ResetCoordinateSource',
     'Resolution',
     'StorageLocation',
     'StreamingProtocol',
     'TemperatureUnit',
+    'ThermalZoneId',
     'ThicknessUnit',
     'CameraCommand',
     'ControlModeCommand',
@@ -497,6 +542,7 @@ __all__ = (
     'MissionStatus',
     'PathSegment',
     'ReferenceAutoPilot',
+    'SurveyCommand',
     'TiltMainCameraCommand',
     'TiltMultibeamCommand',
     'WaitForCommand',
@@ -520,6 +566,8 @@ __all__ = (
     'GetCameraParametersReq',
     'GetIperfStatusRep',
     'GetIperfStatusReq',
+    'GetLogStreamingStatusRep',
+    'GetLogStreamingStatusReq',
     'GetMissionRep',
     'GetMissionReq',
     'GetOverlayParametersRep',
@@ -560,6 +608,7 @@ __all__ = (
     'CalibratedImuHpTel',
     'CalibratedImuTel',
     'CalibrationStateTel',
+    'CameraPanTiltZoomTel',
     'CanisterBottomHumidityTel',
     'CanisterBottomTemperatureTel',
     'ConnectedClientsTel',
@@ -596,6 +645,7 @@ __all__ = (
     'MultibeamServoTel',
     'NotificationTel',
     'NStreamersTel',
+    'ObjectDetectionsTel',
     'PilotGPSPositionTel',
     'PositionEstimateTel',
     'RecordStateTel',
@@ -603,10 +653,12 @@ __all__ = (
     'ReferenceTel',
     'RemovableStorageTel',
     'SurfaceUnitTel',
+    'SystemPerformanceInfoTel',
     'ThicknessGaugeTel',
     'TiltAngleTel',
     'TiltStabilizationTel',
     'TimeLapseStateTel',
+    'TurbidityFilterTel',
     'VideoStorageSpaceTel',
     'WaterTemperatureTel',
 )

{blueye_protocol-3.2.0 → blueye_protocol-3.3.0}/blueye/protocol/types/control.py

@@ -69,6 +69,10 @@ __protobuf__ = proto.module(
         'StartDiveCtrl',
         'EndDiveCtrl',
         'FormatRemovableStorageDeviceCtrl',
+        'SetTurbidityFilterCtrl',
+        'CameraPanTiltZoomCtrl',
+        'StartLogStreamingCtrl',
+        'StopLogStreamingCtrl',
     },
 )
 
@@ -601,8 +605,18 @@ class StartDiveCtrl(proto.Message):
     files so we can see at which point the user entered the dive
     view.
 
+    Attributes:
+        operator_info (blueye.protocol.types.OperatorInfo):
+            Optional information about the operator who
+            started the dive.
     """
 
+    operator_info: message_formats.OperatorInfo = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        message=message_formats.OperatorInfo,
+    )
+
 
 class EndDiveCtrl(proto.Message):
     r"""Message sent when the user hits the end dive button in the
@@ -627,4 +641,48 @@ class FormatRemovableStorageDeviceCtrl(proto.Message):
     """
 
 
+class SetTurbidityFilterCtrl(proto.Message):
+    r"""Message sent when the user wants to set turbidity filter
+    settings.
+
+    Attributes:
+        turbidity_filter (blueye.protocol.types.FilterMessage):
+            Message with the turbidity filter settings to
+            set.
+    """
+
+    turbidity_filter: message_formats.FilterMessage = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        message=message_formats.FilterMessage,
+    )
+
+
+class CameraPanTiltZoomCtrl(proto.Message):
+    r"""Issue a command to set the digital pan, tilt, and zoom of the
+    main camera.
+    Only supported on X3 Ultra.
+
+    Attributes:
+        camera_pan_tilt_zoom (blueye.protocol.types.CameraPanTiltZoom):
+            The desired pan, tilt, and zoom state.
+    """
+
+    camera_pan_tilt_zoom: message_formats.CameraPanTiltZoom = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        message=message_formats.CameraPanTiltZoom,
+    )
+
+
+class StartLogStreamingCtrl(proto.Message):
+    r"""Message sent to start streaming log entries to the client.
+    """
+
+
+class StopLogStreamingCtrl(proto.Message):
+    r"""Message sent to stop streaming log entries to the client.
+    """
+
+
 __all__ = tuple(sorted(__protobuf__.manifest))