oshconnect 0.2.0__py3-none-any.whl

oshconnect/__init__.py

@@ -0,0 +1,9 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/28
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+
+class Example:
+    pass

oshconnect/control.py

@@ -0,0 +1,65 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/7/1
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+import websockets
+from conSys4Py.comm.mqtt import MQTTCommClient
+from conSys4Py.datamodels.commands import CommandJSON
+from conSys4Py.datamodels.control_streams import ControlStreamJSONSchema
+
+from oshconnect.osh_connect_datamodels import System
+
+
+class ControlSchema:
+    schema: dict = None
+
+
+class ControlStream:
+    name: str = None
+    _parent_systems: System = None
+    _strategy: str = "mqtt"
+    _resource_endpoint = None
+    # _auth: str = None
+    _websocket: websockets.WebSocketServerProtocol = None
+    _schema: ControlStreamJSONSchema = None
+    _mqtt_client: MQTTCommClient = None
+
+    def __init__(self, parent_system: System, resource_endpoint: str, name=None, strategy="mqtt"):
+        self._parent_systems = parent_system
+        self.name = name
+        self._strategy = strategy
+        self._resource_endpoint = resource_endpoint
+
+    def set_schema(self, schema: ControlStreamJSONSchema):
+        self._schema = schema
+
+    def connect(self):
+        pass
+
+    def subscribe(self):
+        if self._strategy == "mqtt" and self._mqtt_client is not None:
+            self._mqtt_client.subscribe(f'{self._resource_endpoint}/commands')
+        elif self._strategy == "mqtt" and self._mqtt_client is None:
+            raise ValueError("No MQTT Client found.")
+        elif self._strategy == "websocket":
+            pass
+
+    def publish(self, payload: CommandJSON):
+        if self._strategy == "mqtt" and self._mqtt_client is not None:
+            self._mqtt_client.publish(f'{self._resource_endpoint}/status', payload=payload, qos=1)
+        elif self._strategy == "mqtt" and self._mqtt_client is None:
+            raise ValueError("No MQTT Client found.")
+        elif self._strategy == "websocket":
+            pass
+
+    def disconnect(self):
+        pass
+
+    def unsubscribe(self):
+        self._mqtt_client.unsubscribe(f'{self._resource_endpoint}/commands')
+
+
+class Command:
+    pass

oshconnect/core_datamodels.py

@@ -0,0 +1,160 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/6/26
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+from __future__ import annotations
+
+from typing import List
+
+from conSys4Py.datamodels.swe_components import Geometry
+from conSys4Py.datamodels.datastreams import DatastreamSchema
+from conSys4Py.datamodels.api_utils import Link
+from pydantic import BaseModel, ConfigDict, Field, SerializeAsAny
+from shapely import Point
+
+from oshconnect.timemanagement import DateTimeSchema, TimePeriod
+
+
+class BoundingBox(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    lower_left_corner: Point = Field(..., description="The lower left corner of the bounding box.")
+    upper_right_corner: Point = Field(..., description="The upper right corner of the bounding box.")
+    min_value: float = Field(None, description="The minimum value of the bounding box.")
+    max_value: float = Field(None, description="The maximum value of the bounding box.")
+
+    # @model_validator(mode='before')
+    # def validate_minmax(self) -> Self:
+    #     if self.min_value > self.max_value:
+    #         raise ValueError("min_value must be less than max_value")
+    #     return self
+
+
+class SecurityConstraints:
+    constraints: list
+
+
+class LegalConstraints:
+    constraints: list
+
+
+class Characteristics:
+    characteristics: list
+
+
+class Capabilities:
+    capabilities: list
+
+
+class Contact:
+    contact: list
+
+
+class Documentation:
+    documentation: list
+
+
+class HistoryEvent:
+    history_event: list
+
+
+class ConfigurationSettings:
+    settings: list
+
+
+class FeatureOfInterest:
+    feature: list
+
+
+class Input:
+    input: list
+
+
+class Output:
+    output: list
+
+
+class Parameter:
+    parameter: list
+
+
+class Mode:
+    mode: list
+
+
+class ProcessMethod:
+    method: list
+
+
+class SystemResource(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    feature_type: str = Field(None, serialization_alias="type")
+    system_id: str = Field(None, serialization_alias="id")
+    properties: dict = Field(None)
+    geometry: Geometry | None = Field(None)
+    bbox: BoundingBox = Field(None)
+    links: List[Link] = Field(None)
+    description: str = Field(None)
+    uid: str = Field(None, serialization_alias="uniqueId")
+    label: str = Field(None)
+    lang: str = Field(None)
+    keywords: List[str] = Field(None)
+    identifiers: List[str] = Field(None)
+    classifiers: List[str] = Field(None)
+    valid_time: DateTimeSchema = Field(None, serialization_alias="validTime")
+    security_constraints: List[SecurityConstraints] = Field(None, serialization_alias="securityConstraints")
+    legal_constraints: List[LegalConstraints] = Field(None, serialization_alias="legalConstraints")
+    characteristics: List[Characteristics] = Field(None)
+    capabilities: List[Capabilities] = Field(None)
+    contacts: List[Contact] = Field(None)
+    documentation: List[Documentation] = Field(None)
+    history: List[HistoryEvent] = Field(None)
+    definition: str = Field(None)
+    type_of: str = Field(None, serialization_alias="typeOf")
+    configuration: ConfigurationSettings = Field(None)
+    features_of_interest: List[FeatureOfInterest] = Field(None, serialization_alias="featuresOfInterest")
+    inputs: List[Input] = Field(None)
+    outputs: List[Output] = Field(None)
+    parameters: List[Parameter] = Field(None)
+    modes: List[Mode] = Field(None)
+    method: ProcessMethod = Field(None)
+
+
+class DatastreamResource(BaseModel):
+    """
+    The DatastreamResource class is a Pydantic model that represents a datastream resource in the OGC SensorThings API.
+    It contains all the necessary and optional properties listed in the OGC Connected Systems API documentation. Note
+    that, depending on the format of the  request, the fields needed may differ. There may be derived models in a later
+    release that will have different sets of required fields to ease the validation process for users.
+    """
+    # model_config = ConfigDict(populate_by_name=True)
+
+    ds_id: str = Field(..., serialization_alias="id")
+    name: str = Field(...)
+    description: str = Field(None)
+    valid_time: TimePeriod = Field(..., serialization_alias="validTime")
+    output_name: str = Field(None, serialization_alias="outputName")
+    procedure_link: Link = Field(None, serialization_alias="procedureLink@link")
+    deployment_link: Link = Field(None, serialization_alias="deploymentLink@link")
+    ultimate_feature_of_interest_link: Link = Field(None, serialization_alias="ultimateFeatureOfInterest@link")
+    sampling_feature_link: Link = Field(None, serialization_alias="samplingFeature@link")
+    parameters: dict = Field(None)
+    phenomenon_time: TimePeriod = Field(None, serialization_alias="phenomenonTimeInterval")
+    result_time: TimePeriod = Field(None, serialization_alias="resultTimeInterval")
+    ds_type: str = Field(None, serialization_alias="type")
+    result_type: str = Field(None, serialization_alias="resultType")
+    links: List[Link] = Field(None)
+    record_schema: SerializeAsAny[DatastreamSchema] = Field(None, serialization_alias="schema")
+
+
+class ObservationResource(BaseModel):
+    sampling_feature_id: str = Field(None, serialization_alias="samplingFeature@Id")
+    procedure_link: Link = Field(None, serialization_alias="procedure@link")
+    phenomenon_time: DateTimeSchema = Field(None, serialization_alias="phenomenonTime")
+    result_time: DateTimeSchema = Field(..., serialization_alias="resultTime")
+    parameters: dict = Field(None)
+    result: dict = Field(...)
+    result_link: Link = Field(None, serialization_alias="result@link")