lookout-config 1.23.0__py3-none-any.whl → 1.24.0__py3-none-any.whl

lookout_config/launch_parameters.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import List, Optional
+from typing import Any, List, Optional
 
 from pydantic import BaseModel, Field
 
@@ -108,27 +108,12 @@ class DiagnosticUpdater(BaseModel):
     use_fqn: Optional[bool] = Field(None, description="")
 
 
-class DataPlayerParameters(BaseModel):
-    bag_directory: Optional[str] = Field(None, description="")
-    diagnostic_updater: Optional[DiagnosticUpdater] = None
-    storage_id: Optional[str] = Field(None, description="")
-
-
-class DataRecorderParameters(BaseModel):
-    bag_directory: Optional[str] = Field(None, description="")
-    diagnostic_updater: Optional[DiagnosticUpdater] = None
-    storage_id: Optional[str] = Field(None, description="")
-    storage_preset_profile: Optional[str] = Field(None, description="")
-    topic_exclude_regexs: Optional[List[str]] = Field(None, description="")
-    topic_include_regexs: Optional[List[str]] = Field(None, description="")
-    trigger_topic_active: Optional[bool] = Field(None, description="")
+class Storage(BaseModel):
+    directory: Optional[str] = Field(None, description="Directory containing recording bag files.")
 
 
-class TypeEnum(Enum):
-    aws_s3 = "aws_s3"
-    azure_blob = "azure_blob"
-    microsoft_onedrive = "microsoft_onedrive"
-    sftp = "sftp"
+class UploadQueue(BaseModel):
+    size: Optional[int] = Field(None, description="Max number of items in the upload queue.")
 
 
 class Config(BaseModel):
@@ -185,7 +170,7 @@ class Sftp(BaseModel):
 
 class UploadDestination(BaseModel):
     name: Optional[str] = Field(None, description="Identifying name of the upload destination.")
-    type: Optional[List[TypeEnum]] = Field(None, description="Type of upload destination")
+    type: Optional[Any] = Field(None, description="Type of upload destination")
     upload_path: Optional[str] = Field(
         None, description="Path at the destination to upload files to."
     )
@@ -197,14 +182,87 @@ class UploadDestination(BaseModel):
 
 class DataHubParameters(BaseModel):
     port: Optional[int] = Field(None, description="Port for the HTTP server.")
-    bag_directory: Optional[str] = Field(
-        None, description="Directory containing recording bag files."
+    storage: Optional[Storage] = None
+    upload_queue: Optional[UploadQueue] = None
+    upload_destination: Optional[UploadDestination] = None
+    diagnostic_updater: Optional[DiagnosticUpdater] = None
+
+
+class Buffer(BaseModel):
+    enabled: Optional[bool] = Field(
+        None,
+        description="Enables a recording buffer to capture historical data prior to recording requests.",
     )
-    upload_queue_size: Optional[int] = Field(
-        None, description="Max number of items in the upload queue."
+    size: Optional[int] = Field(None, description="Size (in bytes) of the recording buffer.")
+
+
+class ResourceMonitor(BaseModel):
+    warning_threshold: Optional[float] = Field(
+        None, description="Storage usage threshold which triggers warning."
     )
-    upload_destination: Optional[UploadDestination] = None
+    critical_threshold: Optional[float] = Field(
+        None, description="Storage usage threshold which triggers error."
+    )
+
+
+class StateTimer(BaseModel):
+    publish_period: Optional[int] = Field(
+        None, description="Period (ms) to publish recording state updates."
+    )
+
+
+class Storage1(BaseModel):
+    directory: Optional[str] = Field(None, description="Directory where recordings will be saved.")
+    plugin_name: Optional[Any] = Field(None, description="Storage plugin to use.")
+    plugin_profile: Optional[Any] = Field(
+        None,
+        description="Storage plugin preset profile to use to determine write speed and compression ratio. Only used for mcap storage plugin.",
+    )
+
+
+class Topics(BaseModel):
+    exclude_regexs: Optional[List[str]] = Field(
+        None,
+        description="An array of regex patterns to use for topic EXCLUSION from the recording.",
+    )
+    include_regexs: Optional[List[str]] = Field(
+        None,
+        description="An array of regex patterns to use for topic INCLUSION in the recording.",
+    )
+
+
+class TriggerTopic(BaseModel):
+    enabled: Optional[bool] = Field(
+        None,
+        description="Enables a trigger topic that can be used to start/stop recordings (example_interfaces/Bool).",
+    )
+
+
+class DataRecorderParameters(BaseModel):
+    buffer: Optional[Buffer] = None
+    diagnostic_updater: Optional[DiagnosticUpdater] = None
+    resource_monitor: Optional[ResourceMonitor] = None
+    state_timer: Optional[StateTimer] = None
+    storage: Optional[Storage1] = None
+    topics: Optional[Topics] = None
+    trigger_topic: Optional[TriggerTopic] = None
+
+
+class StateTimer1(BaseModel):
+    publish_period: Optional[int] = Field(
+        None, description="Period (ms) to publish playback state updates."
+    )
+
+
+class Storage2(BaseModel):
+    directory: Optional[str] = Field(None, description="Directory to play recordings from.")
+    plugin_name: Optional[Any] = Field(None, description="Storage plugin to use.")
+
+
+class DataPlayerParameters(BaseModel):
     diagnostic_updater: Optional[DiagnosticUpdater] = None
+    state_timer: Optional[StateTimer1] = None
+    storage: Optional[Storage2] = None
 
 
 class SimulatedClockParameters(BaseModel):

{lookout_config-1.23.0.dist-info → lookout_config-1.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: lookout_config
-Version: 1.23.0
+Version: 1.24.0
 Summary: A library for reading / writing Lookout config files
 Home-page: https://github.com/Greenroom-Robotics/lookout
 Author: Greenroom Robotics
@@ -19,7 +19,7 @@ Requires-Dist: setuptools
 Requires-Dist: dacite
 Requires-Dist: PyYAML
 Requires-Dist: dc-schema
-Requires-Dist: greenstream-config==3.20.0
+Requires-Dist: greenstream-config==3.22.0
 Requires-Dist: gr-urchin
 
 # Lookout Config

{lookout_config-1.23.0.dist-info → lookout_config-1.24.0.dist-info}/RECORD

@@ -2,12 +2,12 @@ lookout_config/__init__.py,sha256=NKLSlCn7mb8HRbkOB6i6EBpvROLGRlZRcnHc5nm1zTk,17
 lookout_config/generate_schemas.py,sha256=yFNvrZ6gie1tnTM_1TO8_wBa0lFHJAABSI3ZAZqw_Wg,457
 lookout_config/generate_urdf.py,sha256=O5n0hNsRJwTgQnWdPZIg_LgpxlDQOzWv5IccjT7yDS4,2719
 lookout_config/helpers.py,sha256=3GkGRPDzQ67I5srwcWoI8PI1dgrWvTsUwA8-yRUttLM,603
-lookout_config/launch_parameters.py,sha256=Dyi6dcu2_6LB1iZ7cmobHJ-iaJcbeySNS22fpZuNTxk,25664
+lookout_config/launch_parameters.py,sha256=t1A7J2icXkYs3KeRQQd-O8S6Bxol25oGi5KxS7ldqS0,27499
 lookout_config/types.py,sha256=HMrHST658SpGVKrocsCe66E6x0aaYkBiYzTD-quY-Ys,4323
 lookout_config/schemas/lookout.schema.json,sha256=NIekpXaauGsFJthrDfLkQzXCrQrVYmRRAynLlzYuym4,10615
 lookout_config/test/lookout_config_test.py,sha256=TdOzIEWnyrckhmK7OtShtoWwSAP8QDCiKalNhvScd2U,73
-lookout_config-1.23.0.dist-info/METADATA,sha256=-ELvb5GmOtY6TphxVY8L5aeVTDds59YZK15TDEIREE4,1442
-lookout_config-1.23.0.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-lookout_config-1.23.0.dist-info/top_level.txt,sha256=IiZRgJhNrNL87uLMQm9lQRrMCqJnTOl7aYlA7zRSYyg,15
-lookout_config-1.23.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-lookout_config-1.23.0.dist-info/RECORD,,
+lookout_config-1.24.0.dist-info/METADATA,sha256=W6oZ0bptKa4J5ptET2FmNsqCRqYbp00-A7CmAddvBNY,1442
+lookout_config-1.24.0.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+lookout_config-1.24.0.dist-info/top_level.txt,sha256=IiZRgJhNrNL87uLMQm9lQRrMCqJnTOl7aYlA7zRSYyg,15
+lookout_config-1.24.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+lookout_config-1.24.0.dist-info/RECORD,,