layrz-sdk 3.1.14__py3-none-any.whl → 3.1.16__py3-none-any.whl

layrz_sdk/entities/report_configuration.py

@@ -1,8 +1,8 @@
-from pydantic import BaseModel, Field
-
-
-class ReportConfiguration(BaseModel):
-  """Report configuration entity"""
-
-  title: str = Field(description='Report title')
-  pages_count: int = Field(description='Number of pages in the report')
+from pydantic import BaseModel, Field
+
+
+class ReportConfiguration(BaseModel):
+  """Report configuration entity"""
+
+  title: str = Field(description='Report title')
+  pages_count: int = Field(description='Number of pages in the report')

layrz_sdk/entities/report_data_type.py

@@ -1,28 +1,28 @@
-import sys
-from enum import Enum
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class ReportDataType(Enum):
-  """
-  Report date type
-  """
-
-  STR = 'str'
-  INT = 'int'
-  FLOAT = 'float'
-  DATETIME = 'datetime'
-  BOOL = 'bool'
-  CURRENCY = 'currency'
-
-  def __str__(self: Self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self: Self) -> str:
-    """Readable property"""
-    return f'ReportDataType.{self.value}'
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ReportDataType(Enum):
+  """
+  Report date type
+  """
+
+  STR = 'str'
+  INT = 'int'
+  FLOAT = 'float'
+  DATETIME = 'datetime'
+  BOOL = 'bool'
+  CURRENCY = 'currency'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ReportDataType.{self.value}'

layrz_sdk/entities/report_format.py

@@ -1,27 +1,27 @@
-"""Report formats"""
-
-import sys
-from enum import Enum
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class ReportFormat(Enum):
-  """
-  Report format definition.
-  """
-
-  MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
-  JSON = 'JSON'
-  PDF = 'PDF'
-
-  def __str__(self: Self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self: Self) -> str:
-    """Readable property"""
-    return f'ReportFormat.{self.value}'
+"""Report formats"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ReportFormat(Enum):
+  """
+  Report format definition.
+  """
+
+  MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
+  JSON = 'JSON'
+  PDF = 'PDF'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ReportFormat.{self.value}'

layrz_sdk/entities/report_header.py

@@ -1,43 +1,43 @@
-"""Report header"""
-
-import warnings
-from typing import Any, Optional
-
-from pydantic import BaseModel, Field, field_validator
-
-from .text_alignment import TextAlignment
-
-
-class ReportHeader(BaseModel):
-  """Report header entity"""
-
-  content: Any = Field(description='Header content')
-  color: str = Field(description='Header color', default='#ffffff')
-  text_color: Optional[str] = Field(description='Header text color', default=None)
-  align: TextAlignment = Field(description='Header text alignment', default=TextAlignment.CENTER)
-  bold: bool = Field(description='Bold text', default=False)
-  width: Optional[float] = Field(description='Header width', default=None)
-
-  @field_validator('text_color', mode='before')
-  def _validate_text_color(cls, value: Any) -> Any:
-    """Validate text color"""
-    if value is not None:
-      warnings.warn(
-        'text_color is deprecated, the algorithm will calculate the rigth text color instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value
-
-  @field_validator('width', mode='before')
-  def _validate_width(cls, value: Any) -> Any:
-    """Validate width"""
-    if value is not None:
-      warnings.warn(
-        'width is deprecated, the algorithm will calculate the rigth width instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value
+"""Report header"""
+
+import warnings
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+from .text_alignment import TextAlignment
+
+
+class ReportHeader(BaseModel):
+  """Report header entity"""
+
+  content: Any = Field(description='Header content')
+  color: str = Field(description='Header color', default='#ffffff')
+  text_color: Optional[str] = Field(description='Header text color', default=None)
+  align: TextAlignment = Field(description='Header text alignment', default=TextAlignment.CENTER)
+  bold: bool = Field(description='Bold text', default=False)
+  width: Optional[float] = Field(description='Header width', default=None)
+
+  @field_validator('text_color', mode='before')
+  def _validate_text_color(cls, value: Any) -> Any:
+    """Validate text color"""
+    if value is not None:
+      warnings.warn(
+        'text_color is deprecated, the algorithm will calculate the rigth text color instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value
+
+  @field_validator('width', mode='before')
+  def _validate_width(cls, value: Any) -> Any:
+    """Validate width"""
+    if value is not None:
+      warnings.warn(
+        'width is deprecated, the algorithm will calculate the rigth width instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value

layrz_sdk/entities/report_page.py

@@ -1,15 +1,15 @@
-"""Report page"""
-
-from pydantic import BaseModel, Field
-
-from .report_header import ReportHeader
-from .report_row import ReportRow
-
-
-class ReportPage(BaseModel):
-  """Report page definition"""
-
-  name: str = Field(description='Name of the page. Length should be less than 60 characters')
-  headers: list[ReportHeader] = Field(description='List of report headers', default_factory=list)
-  rows: list[ReportRow] = Field(description='List of report rows', default_factory=list)
-  freeze_header: bool = Field(description='Freeze header', default=False)
+"""Report page"""
+
+from pydantic import BaseModel, Field
+
+from .report_header import ReportHeader
+from .report_row import ReportRow
+
+
+class ReportPage(BaseModel):
+  """Report page definition"""
+
+  name: str = Field(description='Name of the page. Length should be less than 60 characters')
+  headers: list[ReportHeader] = Field(description='List of report headers', default_factory=list)
+  rows: list[ReportRow] = Field(description='List of report rows', default_factory=list)
+  freeze_header: bool = Field(description='Freeze header', default=False)

layrz_sdk/entities/report_row.py

@@ -1,28 +1,28 @@
-"""Report row"""
-
-import warnings
-from typing import Any, Optional
-
-from pydantic import BaseModel, Field, field_validator
-
-from .report_col import ReportCol
-
-
-class ReportRow(BaseModel):
-  """Report row definition"""
-
-  content: list[ReportCol] = Field(description='List of report columns', default_factory=list)
-  height: Optional[float] = Field(description='Row height', default=None)
-  compact: bool = Field(description='Compact mode', default=False)
-
-  @field_validator('height', mode='before')
-  def _validate_height(cls, value: Any) -> Any:
-    """Validate height"""
-    if value is not None:
-      warnings.warn(
-        'height is deprecated, the algorithm will calculate the rigth text color instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value
+"""Report row"""
+
+import warnings
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+from .report_col import ReportCol
+
+
+class ReportRow(BaseModel):
+  """Report row definition"""
+
+  content: list[ReportCol] = Field(description='List of report columns', default_factory=list)
+  height: Optional[float] = Field(description='Row height', default=None)
+  compact: bool = Field(description='Compact mode', default=False)
+
+  @field_validator('height', mode='before')
+  def _validate_height(cls, value: Any) -> Any:
+    """Validate height"""
+    if value is not None:
+      warnings.warn(
+        'height is deprecated, the algorithm will calculate the rigth text color instead',
+        DeprecationWarning,
+        stacklevel=2,
+      )
+
+    return value

layrz_sdk/entities/sensor.py

@@ -1,11 +1,11 @@
-"""Sensor entity"""
-
-from pydantic import BaseModel, Field
-
-
-class Sensor(BaseModel):
-  """Sensor entity"""
-
-  pk: int = Field(description='Defines the primary key of the sensor')
-  name: str = Field(description='Defines the name of the sensor')
-  slug: str = Field(description='Defines the slug of the sensor')
+"""Sensor entity"""
+
+from pydantic import BaseModel, Field
+
+
+class Sensor(BaseModel):
+  """Sensor entity"""
+
+  pk: int = Field(description='Defines the primary key of the sensor')
+  name: str = Field(description='Defines the name of the sensor')
+  slug: str = Field(description='Defines the slug of the sensor')

layrz_sdk/entities/static_position.py

@@ -0,0 +1,17 @@
+from pydantic import BaseModel, Field
+
+
+class StaticPosition(BaseModel):
+  latitude: float = Field(
+    ...,
+    description='Latitude of the static position',
+  )
+  longitude: float = Field(
+    ...,
+    description='Longitude of the static position',
+  )
+
+  altitude: float | None = Field(
+    default=None,
+    description='Altitude of the static position',
+  )

layrz_sdk/entities/telemetry/__init__.py

@@ -0,0 +1,6 @@
+"""Telemetry models"""
+
+from .assetmessage import AssetMessage
+from .devicemessage import DeviceMessage
+
+__all__ = ['AssetMessage', 'DeviceMessage']

layrz_sdk/entities/telemetry/assetmessage.py

@@ -0,0 +1,159 @@
+"""Asset message"""
+
+from __future__ import annotations
+
+import json
+import sys
+from datetime import datetime, timedelta
+from typing import Any, cast
+
+from layrz_sdk.entities.position import Position
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+from geopy.distance import geodesic
+from pydantic import BaseModel, Field
+from shapely.geometry import MultiPoint
+
+from layrz_sdk.constants import UTC
+from layrz_sdk.entities.asset import Asset
+from layrz_sdk.entities.asset_operation_mode import AssetOperationMode
+from layrz_sdk.entities.message import Message
+from layrz_sdk.entities.telemetry.devicemessage import DeviceMessage
+
+
+class AssetMessage(BaseModel):
+  """Asset message model"""
+
+  pk: int | None = Field(
+    default=None,
+    description='Message ID',
+    alias='id',
+  )
+
+  asset_id: int = Field(
+    ...,
+    description='Asset ID',
+  )
+
+  position: dict[str, float | int] = Field(
+    default_factory=dict,
+    description='Current position of the device',
+  )
+
+  payload: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Payload data of the device message',
+  )
+
+  sensors: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Sensor data of the device message',
+  )
+
+  geofences_ids: list[int] = Field(
+    default_factory=list,
+    description='List of geofence IDs associated with the message',
+  )
+
+  distance_traveled: float = Field(
+    default=0.0,
+    description='Distance traveled since the last message',
+  )
+
+  received_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Timestamp when the message was received',
+  )
+
+  elapsed_time: timedelta = Field(
+    default_factory=lambda: timedelta(seconds=0),
+    description='Elapsed time since the last message',
+  )
+
+  @property
+  def datum_gis(self: Self) -> int:
+    """Get the GIS datum of the message."""
+    return 4326
+
+  @property
+  def point_gis(self: Self) -> str | None:
+    """Get the GIS point of the message on WKT (Well-Known Text) format for OGC (Open Geospatial Consortium)."""
+    latitude = self.position.get('latitude')
+    longitude = self.position.get('longitude')
+
+    if latitude is not None and longitude is not None:
+      return f'POINT({longitude} {latitude})'
+
+    return None
+
+  @property
+  def has_point(self: Self) -> bool:
+    """Check if the message has a point."""
+    latitude = self.position.get('latitude')
+    longitude = self.position.get('longitude')
+
+    return latitude is not None and longitude is not None
+
+  @classmethod
+  def parse_from_devicemessage(cls, *, device_message: DeviceMessage, asset: Asset) -> AssetMessage:
+    obj = cls(
+      asset_id=asset.pk,
+      position={},
+      payload={},
+      sensors={},
+      received_at=device_message.received_at,
+    )
+
+    match asset.operation_mode:
+      case AssetOperationMode.DISCONNECTED:
+        obj.position = {}
+      case AssetOperationMode.STATIC:
+        obj.position = asset.static_position.model_dump(exclude_none=True) if asset.static_position else {}
+      case AssetOperationMode.ZONE:
+        points = MultiPoint([(p.longitude, p.latitude) for p in asset.points])
+        obj.position = {'latitude': points.centroid.y, 'longitude': points.centroid.x}
+      case _:
+        obj.position = device_message.position
+
+    for key, value in device_message.payload.items():
+      obj.payload[f'{device_message.ident}.{key}'] = value
+
+    return obj
+
+  def compute_distance_traveled(self: Self, *, previous_message: AssetMessage | None = None) -> float:
+    """Compute the distance traveled since the last message."""
+    if not self.has_point or not previous_message or not previous_message.has_point:
+      return 0.0
+
+    return cast(
+      float,
+      geodesic(
+        (self.position['latitude'], self.position['longitude']),
+        (previous_message.position['latitude'], previous_message.position['longitude']),
+      ).meters,
+    )
+
+  def compute_elapsed_time(self: Self, *, previous_message: AssetMessage | None = None) -> timedelta:
+    """Compute the elapsed time since the last message."""
+    if not previous_message:
+      return timedelta(seconds=0)
+
+    if self.received_at < previous_message.received_at:
+      return timedelta(seconds=0)
+
+    return self.received_at - previous_message.received_at
+
+  def to_message(self: Self) -> Message:
+    """Convert the asset message to a Message object."""
+    return Message(
+      pk=self.pk if self.pk is not None else 0,
+      asset_id=self.asset_id,
+      position=Position.model_validate(self.position),
+      payload=self.payload,
+      sensors=self.sensors,
+      received_at=self.received_at,
+    )

layrz_sdk/entities/telemetry/devicemessage.py

@@ -0,0 +1,122 @@
+"""Device message"""
+
+from __future__ import annotations
+
+import json
+import sys
+from datetime import datetime
+from typing import Any
+
+from layrz_sdk.entities.message import Message
+from layrz_sdk.entities.position import Position
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+from pydantic import BaseModel, Field
+
+from layrz_sdk.constants import REJECTED_KEYS, UTC
+from layrz_sdk.entities.device import Device
+
+
+class DeviceMessage(BaseModel):
+  """Device message model"""
+
+  pk: int | None = Field(
+    default=None,
+    description='Device message ID',
+    alias='id',
+  )
+
+  ident: str = Field(
+    ...,
+    description='Device identifier',
+  )
+  device_id: int = Field(
+    ...,
+    description='Device ID',
+  )
+
+  protocol_id: int = Field(
+    ...,
+    description='Protocol ID',
+  )
+
+  position: dict[str, float | int] = Field(
+    default_factory=dict,
+    description='Current position of the device',
+  )
+
+  payload: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Payload data of the device message',
+  )
+
+  received_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Timestamp when the message was received',
+  )
+
+  @property
+  def datum_gis(self: Self) -> int:
+    """Get the GIS datum of the message."""
+    return 4326
+
+  @property
+  def point_gis(self: Self) -> str | None:
+    """Get the GIS point of the message on WKT (Well-Known Text) format for OGC (Open Geospatial Consortium)."""
+    latitude = self.position.get('latitude')
+    longitude = self.position.get('longitude')
+
+    if latitude is not None and longitude is not None:
+      return f'POINT({longitude} {latitude})'
+
+    return None
+
+  @property
+  def has_point(self: Self) -> bool:
+    """Check if the message has a point."""
+    latitude = self.position.get('latitude')
+    longitude = self.position.get('longitude')
+
+    return latitude is not None and longitude is not None
+
+  @classmethod
+  def parse_from_dict(cls, *, raw_payload: dict[str, Any], device: Device) -> DeviceMessage:
+    """Format a DeviceMessage from a dictionary."""
+    received_at: datetime
+    position: dict[str, float | int] = {}
+    payload: dict[str, Any] = {}
+
+    if 'timestamp' in raw_payload:
+      received_at = datetime.fromtimestamp(raw_payload['timestamp'], tz=UTC)
+    else:
+      received_at = datetime.now(UTC)
+
+    for key, value in raw_payload.items():
+      if key.startswith('position.'):
+        position[key[9:]] = value
+
+      if key not in REJECTED_KEYS:
+        payload[key] = value
+
+    return cls(
+      ident=device.ident,
+      device_id=device.pk,
+      protocol_id=device.protocol_id,
+      position=position,
+      payload=payload,
+      received_at=received_at,
+    )
+
+  def to_message(self: Self) -> Message:
+    """Convert the asset message to a Message object."""
+    return Message(
+      pk=self.pk if self.pk is not None else 0,
+      asset_id=self.device_id if self.device_id is not None else 0,
+      position=Position.model_validate(self.position),
+      payload=self.payload,
+      received_at=self.received_at,
+    )