layrz-sdk 3.0.14__py3-none-any.whl → 3.1.1__py3-none-any.whl

layrz_sdk/entities/charts/timeline_serie.py

@@ -0,0 +1,12 @@
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from .timeline_serie_item import TimelineSerieItem
+
+
+class TimelineSerie(BaseModel):
+  """Chart Data Serie for Timeline charts"""
+
+  data: List[TimelineSerieItem] = Field(description='List of data points', default_factory=list)
+  label: str = Field(description='Label of the serie')

layrz_sdk/entities/charts/timeline_serie_item.py

@@ -0,0 +1,12 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class TimelineSerieItem(BaseModel):
+  """Chart Data Serie Item for Timeline Charts"""
+
+  name: str = Field(description='Name of the item')
+  start_at: datetime = Field(description='Start date of the item')
+  end_at: datetime = Field(description='End date of the item')
+  color: str = Field(description='Color of the item')

layrz_sdk/entities/checkpoint.py

@@ -0,0 +1,18 @@
+"""Checkpoints entitites"""
+
+from datetime import datetime
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from .waypoint import Waypoint
+
+
+class Checkpoint(BaseModel):
+  """Checkpoint entity definition"""
+
+  pk: int = Field(description='Checkpoint ID')
+  asset_id: int = Field(description='Asset ID')
+  waypoints: List[Waypoint] = Field(description='List of waypoints', default_factory=list)
+  start_at: datetime = Field(description='Checkpoint start date')
+  end_at: datetime = Field(description='Checkpoint end date')

layrz_sdk/entities/comment.py

@@ -0,0 +1,16 @@
+"""Comment entity"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .user import User
+
+
+class Comment(BaseModel):
+  """Comment entity"""
+
+  pk: int = Field(description='Comment ID')
+  content: str = Field(description='Comment content')
+  user: User = Field(description='Operator/User what commented the case')
+  submitted_at: datetime = Field(description='Date of comment submission')

layrz_sdk/entities/custom_field.py

@@ -0,0 +1,10 @@
+"""Custom Field entitiy"""
+
+from pydantic import BaseModel, Field
+
+
+class CustomField(BaseModel):
+  """Custom field definition"""
+
+  name: str = Field(description='Defines the name of the custom field')
+  value: str = Field(description='Defines the value of the custom field')

layrz_sdk/entities/custom_report_page.py

@@ -0,0 +1,16 @@
+from typing import Callable
+
+from pydantic import BaseModel, Field
+from xlsxwriter.worksheet import Worksheet
+
+
+class CustomReportPage(BaseModel):
+  """
+  Custom report page
+  Basically it's a wrapper of the `xlswriter` worksheet that uses a function to construct the page
+  """
+
+  name: str = Field(description='Name of the page. Length should be less than 60 characters')
+  builder: Callable[[Worksheet], None] = Field(
+    description='Function to build the page. The only argument is the worksheet object',
+  )

layrz_sdk/entities/device.py

@@ -0,0 +1,13 @@
+"""Device entitiy"""
+
+from pydantic import BaseModel, Field
+
+
+class Device(BaseModel):
+  """Device entity"""
+
+  pk: int = Field(description='Defines the primary key of the device')
+  name: str = Field(description='Defines the name of the device')
+  ident: str = Field(description='Defines the identifier of the device')
+  protocol: str = Field(description='Defines the protocol of the device')
+  is_primary: bool = Field(default=False, description='Defines if the device is the primary device')

layrz_sdk/entities/event.py

@@ -0,0 +1,23 @@
+"""Event entity"""
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from .geofence import Geofence
+from .message import Message
+from .presence_type import PresenceType
+from .trigger import Trigger
+
+
+class Event(BaseModel):
+  """Event entity definition"""
+
+  pk: int = Field(description='Event ID')
+  trigger: Trigger = Field(description='Event trigger')
+  asset_id: int = Field(description='Asset ID')
+  message: Message = Field(description='Message')
+  activated_at: datetime = Field(description='Event activation date')
+  geofence: Optional[Geofence] = Field(default=None, description='Geofence object')
+  presence_type: Optional[PresenceType] = Field(default=None, description='Presence type object')

layrz_sdk/entities/geofence.py

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

layrz_sdk/entities/last_message.py

@@ -0,0 +1,12 @@
+"""LastMessage entity"""
+
+from pydantic import BaseModel, Field
+
+from .asset import Asset
+from .message import Message
+
+
+class LastMessage(Message, BaseModel):
+  """LastMessage definition"""
+
+  asset: Asset = Field(description='Defines the asset of the last message')

layrz_sdk/entities/message.py

@@ -0,0 +1,23 @@
+"""Message entity"""
+
+from datetime import datetime
+from typing import Any, Dict, TypeAlias
+
+from pydantic import BaseModel, Field
+
+from layrz_sdk.constants import UTC
+
+from .position import Position
+
+PayloadType: TypeAlias = Dict[str, Any]
+
+
+class Message(BaseModel):
+  """Message definition"""
+
+  pk: int
+  asset_id: int
+  position: Position = Field(default_factory=lambda: Position())
+  payload: PayloadType = Field(default_factory=dict)
+  sensors: PayloadType = Field(default_factory=dict)
+  received_at: datetime = Field(default_factory=lambda: datetime.now(UTC))

layrz_sdk/entities/outbound_service.py

@@ -0,0 +1,10 @@
+"""Service entity"""
+
+from pydantic import BaseModel, Field
+
+
+class OutboundService(BaseModel):
+  """Outbound service definition"""
+
+  pk: int = Field(description='Service ID')
+  name: str = Field(description='Service name')

layrz_sdk/entities/position.py

@@ -0,0 +1,101 @@
+"""Position entity"""
+
+import sys
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class Position(BaseModel):
+  """Geographic position definition"""
+
+  latitude: Optional[float] = Field(default=None, description='Defines the latitude of the position')
+  longitude: Optional[float] = Field(default=None, description='Defines the longitude of the position')
+  altitude: Optional[float] = Field(default=None, description='Defines the altitude of the position')
+  hdop: Optional[float] = Field(default=None, description='Defines the horizontal dilution of precision')
+  speed: Optional[float] = Field(default=None, description='Defines the speed of the position')
+  direction: Optional[float] = Field(default=None, description='Defines the direction of the position')
+  satellites: Optional[int] = Field(
+    default=None,
+    description='Defines the number of satellites used to calculate the position',
+  )
+
+  @field_validator('latitude', mode='before')
+  def _validate_latitude(cls: Self, value: Any) -> None | float:
+    """Validate latitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, float):
+      return None
+
+    if -90 <= value <= 90:
+      return value
+
+    return None
+
+  @field_validator('longitude', mode='before')
+  def _validate_longitude(cls: Self, value: Any) -> None | float:
+    """Validate longitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, float):
+      return None
+
+    if -180 <= value <= 180:
+      return value
+
+    return None
+
+  @field_validator('altitude', mode='before')
+  def _validate_altitude(cls: Self, value: Any) -> None | float:
+    """Validate altitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    return value
+
+  @field_validator('hdop', mode='before')
+  def _validate_hdop(cls: Self, value: Any) -> None | float:
+    """Validate hdop"""
+    if value is None:
+      return None
+
+    if not isinstance(value, float):
+      return None
+
+    return value
+
+  @field_validator('speed', mode='before')
+  def _validate_speed(cls: Self, value: Any) -> None | float:
+    """Validate speed"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    return abs(value)
+
+  @field_validator('direction', mode='before')
+  def _validate_direction(cls: Self, value: Any) -> None | float:
+    """Validate direction"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    if 0 <= value <= 360:
+      return value
+
+    return None

layrz_sdk/entities/presence_type.py

@@ -0,0 +1,16 @@
+from enum import Enum
+
+
+class PresenceType(Enum):
+  """Presence type enum"""
+
+  ENTRANCE = 'ENTRANCE'
+  EXIT = 'EXIT'
+
+  def __str__(self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self) -> str:
+    """Readable property"""
+    return f'PresenceType.{self.name}'