default to new sml model on system resources by default.

Author: tipatterson-dev

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oshconnect"
-version = "0.5.1a13"
+version = "0.5.1a17"
 description = "Library for interfacing with OSH, helping guide visualization efforts, and providing a place to store configurations. Implements OGC CS API Part 3 (Pub/Sub) MQTT topic conventions including :data topics and resource event topics."
 readme = "README.md"
 authors = [

src/oshconnect/__init__.py

@@ -42,6 +42,9 @@
     AnyCommandSchema,
 )
 
+# SensorML structured fields (carried by SystemResource)
+from .sensorml import Term, Characteristics, Capabilities
+
 # Event system
 from .events import EventHandler, IEventListener, CallbackListener, DefaultEventTypes, AtomicEventTypes, Event, EventBuilder
 
@@ -88,6 +91,10 @@
     "JSONCommandSchema",
     "AnyDatastreamRecordSchema",
     "AnyCommandSchema",
+    # SensorML structured fields
+    "Term",
+    "Characteristics",
+    "Capabilities",
     # Event system
     "EventHandler",
     "IEventListener",

src/oshconnect/resource_datamodels.py

@@ -15,6 +15,7 @@
 from .api_utils import Link
 from .geometry import Geometry
 from .schema_datamodels import AnyCommandSchema, AnyDatastreamRecordSchema
+from .sensorml import Capabilities, Characteristics, Term
 from .timemanagement import TimeInstant, TimePeriod
 
 if TYPE_CHECKING:
@@ -36,60 +37,14 @@ class BoundingBox(BaseModel):
     #     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
+# SensorML structured fields below (identifiers, characteristics,
+# capabilities, contacts, etc.) carry rich SWE Common / SensorML Term
+# trees on the wire. They were previously typed against bare-class
+# placeholders here, which made every SML+JSON server response fail to
+# parse (`dict is not instance of Characteristics`). Until we model
+# these properly as pydantic types, we accept them as raw `dict` /
+# `list[dict]` so cross-node sync round-trips them losslessly. See
+# ROADMAP.md.
 
 
 class BaseResource(BaseModel):
@@ -103,7 +58,11 @@ class BaseResource(BaseModel):
 
 
 class SystemResource(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    # `extra='allow'` lets unmodeled SensorML fields (e.g. ``position``
+    # in the SML+JSON listing) round-trip through the model rather than
+    # being silently dropped on parse — important for cross-node sync.
+    model_config = ConfigDict(arbitrary_types_allowed=True,
+                              populate_by_name=True, extra='allow')
 
     feature_type: str = Field(None, alias="type")
     system_id: str = Field(None, alias="id")
@@ -116,25 +75,28 @@ class SystemResource(BaseModel):
     label: str = Field(None)
     lang: str = Field(None)
     keywords: List[str] = Field(None)
-    identifiers: List[str] = Field(None)
-    classifiers: List[str] = Field(None)
+    # SensorML Term objects (`{definition, label, value}`).
+    identifiers: list[Term] = Field(None)
+    classifiers: list[Term] = Field(None)
     valid_time: TimePeriod = Field(None, alias="validTime")
-    security_constraints: List[SecurityConstraints] = Field(None, alias="securityConstraints")
-    legal_constraints: List[LegalConstraints] = Field(None, 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)
+    security_constraints: list[dict] = Field(None, alias="securityConstraints")
+    legal_constraints: list[dict] = Field(None, alias="legalConstraints")
+    # SensorML CharacteristicList / CapabilityList — each carries inner
+    # SWE Common components routed via `AnyComponent`'s `type` discriminator.
+    characteristics: list[Characteristics] = Field(None)
+    capabilities: list[Capabilities] = Field(None)
+    contacts: list[dict] = Field(None)
+    documentation: list[dict] = Field(None)
+    history: list[dict] = Field(None)
     definition: str = Field(None)
     type_of: str = Field(None, alias="typeOf")
-    configuration: ConfigurationSettings = Field(None)
-    features_of_interest: List[FeatureOfInterest] = Field(None, 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)
+    configuration: dict = Field(None)
+    features_of_interest: list[dict] = Field(None, alias="featuresOfInterest")
+    inputs: list[dict] = Field(None)
+    outputs: list[dict] = Field(None)
+    parameters: list[dict] = Field(None)
+    modes: list[dict] = Field(None)
+    method: dict = Field(None)
 
     def to_smljson_dict(self) -> dict:
         """Render this system as an `application/sml+json` dict (SensorML JSON encoding).

src/oshconnect/sensorml.py

@@ -0,0 +1,127 @@
+#  =============================================================================
+#  Copyright (c) 2026 Botts Innovative Research Inc.
+#  Author: Ian Patterson
+#  =============================================================================
+
+"""SensorML 2.0 JSON-encoding structured-field models.
+
+Three types are modeled here:
+
+- `Term` — backs `SystemResource.identifiers` and `.classifiers`. Carries
+  ``{definition, label?, value, codeSpace?, name?}`` per the SensorML
+  IdentifierTerm / ClassifierTerm shape.
+- `Characteristics` and `Capabilities` — back the same-named fields on
+  `SystemResource`. Each carries ``{definition?, label?, name?,
+  description?, id?, <bucket>: [SWE Common component]}`` where
+  ``<bucket>`` is ``characteristics`` for the former and ``capabilities``
+  for the latter. Inner components are typed against ``AnyComponent``
+  (the SWE Common discriminated union) and validated to carry a
+  ``name`` per the SoftNamedProperty binding rule.
+
+Models are permissive on optional metadata (label, name, description,
+id, codeSpace) because OSH and other servers vary in what they include
+on the wire. They are strict on the fields the spec marks required:
+``Term.definition`` / ``Term.value``, and the inner ``AnyComponent``
+discriminator/name. ``model_rebuild(force=True)`` runs at the bottom so
+the recursive forward-ref machinery (each ``AnyComponent`` arm carries
+``list["AnyComponent"]``) doesn't leave a `MockValSer` on the
+serializer side — same `model_dump_json` regression the schema models
+needed."""
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+
+from .swe_components import AnyComponent, check_named
+
+
+class Term(BaseModel):
+    """SensorML `IdentifierTerm` / `ClassifierTerm` (SensorML 2.0 §7.2.5).
+
+    Used by ``SystemResource.identifiers`` and ``SystemResource.classifiers``.
+    The wire shape OSH emits:
+
+    .. code-block:: json
+
+        {"definition": "http://.../SerialNumber",
+         "label": "Serial Number",
+         "value": "0123456879"}
+    """
+    model_config = ConfigDict(populate_by_name=True, extra='allow')
+
+    definition: str = Field(..., description="URI naming the term's semantics.")
+    value: str = Field(..., description="The identifier/classifier value as a string.")
+    label: str = Field(None, description="Optional display label.")
+    name: str = Field(None, description="Optional NameToken — the field name in the containing object.")
+    code_space: str = Field(None, alias='codeSpace',
+                            description="Optional URI naming the codelist `value` belongs to.")
+
+
+class Characteristics(BaseModel):
+    """SensorML `CharacteristicList` (SensorML 2.0 §7.2.7).
+
+    Used by ``SystemResource.characteristics``. The wire shape carries a
+    list of inner SWE Common components under the ``characteristics``
+    key, where each inner component is bound via SoftNamedProperty and
+    must therefore carry a ``name``::
+
+        {"definition": "http://.../OperatingRange",
+         "label": "Operating Characteristics",
+         "characteristics": [
+            {"type": "QuantityRange", "name": "voltage", …},
+            {"type": "QuantityRange", "name": "temperature", …}
+         ]}
+    """
+    model_config = ConfigDict(populate_by_name=True, extra='allow')
+
+    definition: str = Field(None,
+                            description="URI naming the semantics of the list.")
+    label: str = Field(None)
+    description: str = Field(None)
+    id: str = Field(None)
+    name: str = Field(None)
+    # Inner SWE Common components — typed against `AnyComponent` so the
+    # discriminator on `type` routes to the right concrete subclass.
+    characteristics: list[AnyComponent] = Field(...,
+                                                description="Inner SWE Common components.")
+
+    @model_validator(mode="after")
+    def _characteristics_require_name(self):
+        for i, c in enumerate(self.characteristics):
+            check_named(c, f"Characteristics.characteristics[{i}]")
+        return self
+
+
+class Capabilities(BaseModel):
+    """SensorML `CapabilityList` (SensorML 2.0 §7.2.8).
+
+    Used by ``SystemResource.capabilities``. Isomorphic to
+    `Characteristics` but with the inner-array bucket named
+    ``capabilities`` instead of ``characteristics``."""
+    model_config = ConfigDict(populate_by_name=True, extra='allow')
+
+    definition: str = Field(None,
+                            description="URI naming the semantics of the list.")
+    label: str = Field(None)
+    description: str = Field(None)
+    id: str = Field(None)
+    name: str = Field(None)
+    capabilities: list[AnyComponent] = Field(...,
+                                             description="Inner SWE Common components.")
+
+    @model_validator(mode="after")
+    def _capabilities_require_name(self):
+        for i, c in enumerate(self.capabilities):
+            check_named(c, f"Capabilities.capabilities[{i}]")
+        return self
+
+
+# Defense-in-depth: same `MockValSer` rationale as the swe_components.py
+# and schema_datamodels.py rebuilds — the recursive forward-ref pattern
+# (`list[AnyComponent]` inside Characteristics/Capabilities) needs an
+# explicit force-rebuild to fully realize the serializer.
+Term.model_rebuild(force=True)
+Characteristics.model_rebuild(force=True)
+Capabilities.model_rebuild(force=True)
+
+
+__all__ = ["Term", "Characteristics", "Capabilities"]