feat: include how description

Author: wcrum

CoT/convert/ais.py

@@ -0,0 +1,35 @@
+import datetime
+from CoT.models.core import Event, Point
+
+def FromAIS(data: bytes) -> Event:
+    try:
+        import pyais
+        _pyais_available = True
+    except ImportError:
+        _pyais_available = False
+
+    if not _pyais_available:
+        raise ImportError("The 'pyais' library is required for FromAIS but is not installed. Install it with: pip install pycot[ais]")
+    
+    ais_decoded = pyais.decode(data)
+    ais_dict = ais_decoded.asdict()
+
+    now = datetime.datetime.now(datetime.timezone.utc)
+    stale = now + datetime.timedelta(minutes=2)
+
+    return Event(
+        version="2.0",
+        type="a-u-S-X-M",
+        access="Undefined",
+        uid="MMSI-{}".format(ais_dict['MetaData']['MMSI']),
+        time=now,
+        start=now,
+        stale=stale,
+        how="m-f",
+        qos="2-i-c",
+        point=Point(lat=float(ais_dict["Message"]["PositionReport"]["Latitude"]), lon=float(ais_dict["Message"]["PositionReport"]["Longitude"]), hae=9999999, ce=9999999, le=9999999),
+        detail={"contact": {"callsign": ais_dict["MetaData"]["ShipName"]}},
+    )
+
+def FromGeoJSON(dict) -> Event:
+    pass

CoT/models/core.py

@@ -3,18 +3,21 @@
 from datetime import datetime
 from typing import Optional, Any
 
-from pydantic import ConfigDict, Field, GetCoreSchemaHandler, computed_field
+from pydantic import ConfigDict, Field, GetCoreSchemaHandler, computed_field, constr
 from pydantic_core import CoreSchema, core_schema
-
 from CoT.utils import CustomModel
 from CoT.xml import unparse
-from CoT.types import CoTTypes, CoTReservations
-
+from CoT.types import CoTTypes, CoTReservations, CoTHow
+from pydantic import BaseModel
+KeywordsPattern = constr(pattern=r"^[\w\- ]+(,[\w\- ]+)*$")
 
+class Remarks(BaseModel):
+    text: str
+    
 # MITRE Definition does not have addition subschema
 class Detail(CustomModel):
-    model_config = ConfigDict(extra="allow")
-
+    model_config = ConfigDict(extras=True, populate_by_name=True)
+    remarks: Remarks = Optional[Remarks]
 
 class Point(CustomModel):
     lat: float = Field(ge=-90, le=90)
@@ -63,7 +66,17 @@ def __get_pydantic_core_schema__(
     ) -> CoreSchema:
         return core_schema.no_info_after_validator_function(cls, handler(str))
 
-    
+
+class How(str):
+    value: str
+
+    @computed_field
+    @property
+    def description(self) -> str:
+        if self.value not in CoTHow:
+            return "Unknown"
+        
+        return CoTHow[self.value]
 
 class Event(CustomModel):
     version: float = 2.0
@@ -72,7 +85,7 @@ class Event(CustomModel):
     time: datetime
     start: datetime
     stale: datetime
-    how: str = Field(pattern=r"\w-\w")
+    how: How = Field(pattern=r"\w-\w")
     opex: Optional[str] = None
     qos: Optional[str] = None
     access: Optional[str] = None

CoT/types.py

@@ -4034,3 +4034,35 @@
     "desc": "Other",
   },
 }
+
+# https://github.com/FreeTAKTeam/FreeTakServer/blob/master/FreeTAKServer/model/RestMessages/RestEnumerations.py#L199-L230
+
+CoTHow = {
+  "m-i": "mensurated",
+  "h-t": "transcribed",
+  "m-": "machine",
+  "m-g": "gps",
+  "h-g-i-g-o": "gigo",
+  "a-f-G-E-V-9-1-1": "mayday",
+  "h-e": "estimated",
+  "h-c": "calculated",
+  "h-p": "pasted",
+  "m-m": "magnetic",
+  "m-n": "ins",
+  "m-s": "simulated",
+  "m-c": "configured",
+  "m-r": "radio",
+  "m-p": "propagated",
+  "m-f": "fused",
+  "m-a": "tracker",
+  "m-g-n": "ins+gps",
+  "m-g-d": "dgps",
+  "m-r-e": "eplrs",
+  "m-r-p": "plrs",
+  "m-r-d": "doppler",
+  "m-r-v": "vhf",
+  "m-r-t": "tadil",
+  "m-r-t-a": "tadila",
+  "m-r-t-b": "tadilb",
+  "m-r-t-j": "tadilj"
+}

CoT/utils.py

@@ -12,10 +12,7 @@
 
 
 class CustomModel(BaseModel):
-    #   -W ignore::pydantic.warnings.PydanticDeprecatedSince20
-    model_config = ConfigDict(
-        populate_by_name=True,
-    )
+    model_config = ConfigDict(populate_by_name=True)
 
     @model_serializer(mode="wrap")
     def serialize(
@@ -43,15 +40,17 @@ def serialize(
     def deep_prefix_add(self, obj, prefix="@"):
         second_dict = obj.copy()
 
+
         for key, value in obj.items():
             if isinstance(value, dict):
                 second_dict[key] = CustomModel.deep_prefix_add(value)
                 continue
 
             if key == "text":
-                second_dict["#{key}"] = value
+                second_dict[f'#{key}'] = value
             else:
                 second_dict[f"{prefix}{key}"] = value
 
             del second_dict[key]
+        print(second_dict)
         return second_dict