layrz-sdk 4.0.11__py3-none-any.whl → 4.1.8__py3-none-any.whl

layrz_sdk/decorators/__init__.py

@@ -0,0 +1,5 @@
+"""decorators"""
+
+from .func_timing import func_timing
+
+__all__ = ['func_timing']

layrz_sdk/decorators/func_timing.py

@@ -0,0 +1,103 @@
+"""Timing decorator"""
+
+import asyncio
+import logging
+import os
+from collections.abc import Callable, Coroutine
+from functools import wraps
+from typing import Any, ParamSpec, TypeVar, overload
+
+T = TypeVar('T')
+P = ParamSpec('P')
+
+log = logging.getLogger(__name__)
+
+SHOULD_DISPLAY = os.environ.get('LAYRZ_SDK_DISPLAY_TIMING', '1') == '1'
+if raw_depth := os.environ.get('LAYRZ_SDK_TIMING_DEPTH'):
+  try:
+    MAX_DEPTH = int(raw_depth)
+  except ValueError:
+    MAX_DEPTH = 0
+else:
+  MAX_DEPTH = 0
+
+
+@overload
+def func_timing(func: Callable[P, T]) -> Callable[P, T | Coroutine[Any, Any, T]]: ...
+
+
+@overload
+def func_timing(*, depth: int) -> Callable[[Callable[P, T]], Callable[P, T | Coroutine[Any, Any, T]]]: ...
+
+
+def func_timing(
+  func: Callable[P, T] | None = None,
+  *,
+  depth: int = 0,
+) -> Any:
+  """
+  Decorator to time a function execution.
+
+  :param depth: The depth of the function call for logging indentation.
+  :return: The wrapped function with timing functionality.
+  """
+
+  def decorator(func: Callable[P, T]) -> Callable[P, T]:
+    """Decorator to time a function"""
+    import time
+
+    prefix = '\t' * depth
+
+    @wraps(func)
+    async def async_wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
+      start_time = time.perf_counter_ns()
+      result: T = await func(*args, **kwargs)  # type: ignore
+      diff = time.perf_counter_ns() - start_time
+
+      if SHOULD_DISPLAY and depth <= MAX_DEPTH:
+        log.info(f'{prefix}{func.__name__}() took {_readable_time(diff)}')  # ty: ignore
+
+      return result
+
+    @wraps(func)
+    def sync_wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
+      start_time = time.perf_counter_ns()
+      result = func(*args, **kwargs)
+      diff = time.perf_counter_ns() - start_time
+
+      if SHOULD_DISPLAY and depth <= MAX_DEPTH:
+        log.info(f'{prefix}{func.__name__}() took {_readable_time(diff)}')  # ty: ignore
+
+      return result
+
+    if asyncio.iscoroutinefunction(func):
+      return async_wrapper  # type: ignore
+    return sync_wrapper
+
+  if func is None:
+    return decorator
+  return decorator(func)
+
+
+def _readable_time(diff: int) -> str:
+  """Convert nanoseconds to a readable format"""
+  if diff < 1_000:
+    return f'{diff} ns'
+
+  diff = diff // 1_000
+  if diff < 1_000:
+    return f'{diff} μs'
+
+  diff = diff // 1_000
+  if diff < 1_000:
+    return f'{diff} ms'
+
+  diff = diff // 1_000
+  if diff < 60:
+    return f'{diff} s'
+
+  diff = diff // 60
+  if diff < 60:
+    return f'{diff} m'
+
+  return f'{diff // 60} h'

layrz_sdk/entities/__init__.py

@@ -10,8 +10,10 @@ from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
 from .ats_entry import AtsEntry
 from .ats_exit_history import AtsExitExecutionHistory
+from .ats_operation import AtsOperation, AtsOperationMovement
 from .ats_possible_entry import AtsPossibleEntry
 from .ats_possible_exit import AtsPossibleExit
+from .ats_purchaseorder import AtsPurchaseOrder, DeliveryCategories, OrderCategories, OrderStatus
 from .ats_reception import AtsReception
 from .broadcast import (
   BroadcastPayload,
@@ -20,6 +22,7 @@ from .broadcast import (
   BroadcastResult,
   BroadcastService,
   BroadcastStatus,
+  RawBroadcastResult,
 )
 from .case import Case
 from .case_ignored_status import CaseIgnoredStatus
@@ -65,6 +68,7 @@ from .function import Function
 from .geofence import Geofence
 from .geofence_category import GeofenceCategory
 from .last_message import LastMessage
+from .locator import Locator, LocatorMqttConfig
 from .message import Message
 from .modbus import ModbusConfig, ModbusParameter, ModbusSchema, ModbusStatus, ModbusWait
 from .notification_type import TwilioNotificationType
@@ -73,6 +77,7 @@ from .operation_case_payload import OperationCaseCommentPayload, OperationCasePa
 from .operation_payload import OperationPayload
 from .operation_type import OperationType
 from .outbound_service import OutboundService
+from .parameter_update import ParameterUpdate
 from .platform import Platform
 from .position import Position
 from .presence_type import PresenceType
@@ -87,7 +92,9 @@ from .report_page import ReportPage
 from .report_row import ReportRow
 from .request_type import HttpRequestType
 from .sensor import Sensor
+from .sensor_mask import SensorMask
 from .sound_effect import SoundEffect
+from .static_position import StaticPosition
 from .telemetry import AssetMessage, DeviceMessage
 from .text_alignment import TextAlignment
 from .timezone import Timezone
@@ -118,6 +125,7 @@ __all__ = [
   'BroadcastRequest',
   'BroadcastResponse',
   'BroadcastResult',
+  'RawBroadcastResult',
   'BroadcastService',
   'BroadcastStatus',
   'Case',
@@ -150,6 +158,8 @@ __all__ = [
   'HttpRequestType',
   'LastMessage',
   'LineChart',
+  'Locator',
+  'LocatorMqttConfig',
   'MapCenterType',
   'MapChart',
   'MapPoint',
@@ -185,7 +195,9 @@ __all__ = [
   'ScatterSerie',
   'ScatterSerieItem',
   'Sensor',
+  'SensorMask',
   'SoundEffect',
+  'StaticPosition',
   'TableChart',
   'TableHeader',
   'TableRow',
@@ -206,4 +218,11 @@ __all__ = [
   'WaypointKind',
   'WaypointRef',
   'Weekday',
+  'AtsPurchaseOrder',
+  'DeliveryCategories',
+  'OrderCategories',
+  'OrderStatus',
+  'AtsOperationMovement',
+  'AtsOperation',
+  'ParameterUpdate',
 ]

layrz_sdk/entities/action.py

@@ -1,8 +1,4 @@
-"""Action entity"""
-
-from datetime import timedelta
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .action_geofence_ownership import ActionGeofenceOwnership
 from .action_kind import ActionKind
@@ -13,20 +9,24 @@ from .geofence_category import GeofenceCategory
 class Action(BaseModel):
   """Action entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      ActionKind: lambda v: v.value,
-      ActionSubKind: lambda v: v.value,
-      GeofenceCategory: lambda v: v.value,
-      ActionGeofenceOwnership: lambda v: v.value,
-    },
-  }
-
-  pk: int = Field(..., description='Primary key of the action entity', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    ...,
+    description='Primary key of the action entity',
+    alias='id',
+  )
   name: str = Field(..., description='Name of the action')
   kind: ActionKind = Field(..., description='Kind of the action')
 
+  @field_serializer('kind', when_used='always')
+  def serialize_kind(self, kind: ActionKind) -> str:
+    return kind.value
+
   command_id: int | None = Field(
     default=None,
     description='Tag ID associated with the action to send commands to primary devices',
@@ -34,6 +34,10 @@ class Action(BaseModel):
 
   subkind: ActionSubKind = Field(default=ActionSubKind.UNUSED, description='Subkind of the action')
 
+  @field_serializer('subkind', when_used='always')
+  def serialize_subkind(self, subkind: ActionSubKind) -> str:
+    return subkind.value
+
   wait_for_image: bool = Field(
     default=False,
     description='Whether to wait for an image to be taken before executing the action',
@@ -45,6 +49,10 @@ class Action(BaseModel):
     description='Geofence category of the action',
   )
 
+  @field_serializer('geofence_cateogry', when_used='always')
+  def serialize_geofence_category(self, geofence_category: GeofenceCategory) -> str:
+    return geofence_category.value
+
   geofence_name_formula: str | None = Field(
     default=None,
     description='Formula to generate the geofence name',
@@ -67,4 +75,8 @@ class Action(BaseModel):
     description='Ownership of the new geofence created by the action',
   )
 
+  @field_serializer('new_geofence_ownership', when_used='always')
+  def serialize_new_geofence_ownership(self, ownership: ActionGeofenceOwnership) -> str:
+    return ownership.value
+
   owner_id: int | None = Field(default=None, description='Owner ID')

layrz_sdk/entities/action_geofence_ownership.py

@@ -1,5 +1,3 @@
-"""Action geofence ownership"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/action_kind.py

@@ -1,5 +1,3 @@
-"""Action kind"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/action_subkind.py

@@ -1,5 +1,3 @@
-"""Action sub kind"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/asset.py

@@ -1,8 +1,6 @@
-"""Asset Entity"""
-
 from typing import Any, Self
 
-from pydantic import BaseModel, Field, field_validator, model_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator, model_validator
 
 from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
@@ -15,13 +13,16 @@ from .static_position import StaticPosition
 class Asset(BaseModel):
   """Asset entity definition"""
 
-  model_config = {
-    'json_encoders': {
-      AssetOperationMode: lambda v: v.value,
-    }
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
-  pk: int = Field(description='Defines the primary key of the asset', alias='id')
+  pk: int = Field(
+    description='Defines the primary key of the asset',
+    alias='id',
+  )
   name: str = Field(description='Defines the name of the asset')
   vin: str | None = Field(
     default=None,
@@ -30,6 +31,11 @@ class Asset(BaseModel):
   plate: str | None = Field(default=None, description='Defines the plate number of the asset')
   kind_id: int | None = Field(description='Defines the type of the asset', default=None)
   operation_mode: AssetOperationMode = Field(description='Defines the operation mode of the asset')
+
+  @field_serializer('operation_mode', when_used='always')
+  def serialize_operation_mode(self, operation_mode: AssetOperationMode) -> str:
+    return operation_mode.value
+
   sensors: list[Sensor] = Field(default_factory=list, description='Defines the list of sensors of the asset')
   custom_fields: list[CustomField] = Field(
     default_factory=list, description='Defines the list of custom fields of the asset'
@@ -104,3 +110,8 @@ class Asset(BaseModel):
   def asset_type(self: Self) -> int | None:
     """Get asset type"""
     return self.kind_id
+
+  partition_number: int | None = Field(
+    default=None,
+    description='Partition number assigned for this Asset, if is None, will be auto-assigned by the system',
+  )

layrz_sdk/entities/asset_constants.py

@@ -1,22 +1,23 @@
-"""Asset constants"""
-
 from datetime import timedelta
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 
 class AssetConstants(BaseModel):
   """Asset constants"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-    },
-  }
-
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
   distance_traveled: float = Field(default=0.0, description='Total distance traveled by the asset in meters')
   primary_device: str = Field(default='N/A', description='Primary device associated with the asset')
   elapsed_time: timedelta = Field(
     default=timedelta(seconds=0),
     description='Total elapsed time for the asset in seconds',
   )
+
+  @field_serializer('elapsed_time', when_used='always')
+  def serialize_elapsed_time(self, elapsed_time: timedelta) -> float:
+    return elapsed_time.total_seconds()

layrz_sdk/entities/asset_contact.py

@@ -1,11 +1,15 @@
-"""Asset contact information"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class AssetContact(BaseModel):
   """Asset contact information"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   name: str = Field(default='', description='Name of the contact person for the asset')
   phone: str = Field(default='', description='Phone number of the contact person for the asset')
   email: str = Field(default='', description='Email address of the contact person for the asset')

layrz_sdk/entities/asset_operation_mode.py

@@ -1,5 +1,3 @@
-"""Asset Operation Mode"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/ats_entry.py

@@ -1,12 +1,19 @@
-"""Entry entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class AtsEntry(BaseModel):
   """Entry entity"""
 
-  pk: int = Field(description='Defines the primary key of the Function', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    description='Defines the primary key of the Function',
+    alias='id',
+  )
   old_tank_level: float = Field(description='Old tank level in liters', default=0.0)
   new_tank_level: float = Field(description='New tank level in liters', default=0.0)
   density: float | None = Field(description='Density of the fuel in kg/m3', default=None)

layrz_sdk/entities/ats_exit_history.py

@@ -1,30 +1,24 @@
-"""Exit Execution History"""
-
 from datetime import datetime
 from typing import Literal
 
-from pydantic import (
-  BaseModel,
-  ConfigDict,
-  Field,
-)
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 
 class AtsExitExecutionHistory(BaseModel):
-  model_config = {
-    'json_encoders': {
-      datetime: lambda v: v.timestamp(),
-    }
-  }
-  pk: int = Field(description='Primary key of the Exit Execution History', alias='id')
-
-  from_asset_id: int = Field(
-    description='ID of the asset from which the exit is initiated',
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+    from_attributes=True,
   )
-  to_asset_id: int = Field(
-    description='ID of the asset to which the exit is directed',
+  pk: int = Field(
+    description='Primary key of the Exit Execution History',
+    alias='id',
   )
 
+  from_asset_id: int = Field(description='ID of the asset from which the exit is initiated')
+  to_asset_id: int = Field(description='ID of the asset to which the exit is directed')
+
   status: Literal['PENDING', 'FAILED', 'SUCCESS'] = Field(default='PENDING')
 
   from_app: Literal['ATSWEB', 'ATSMOBILE', 'NFC'] | None = Field(
@@ -38,5 +32,13 @@ class AtsExitExecutionHistory(BaseModel):
   to_asset_mileage: float | None = Field(default=None, description='Mileage of the asset to which the exit is directed')
 
   created_at: datetime = Field(description='Timestamp when the exit was created')
+
+  @field_serializer('created_at', when_used='always')
+  def serialize_created_at(self, created_at: datetime) -> float:
+    return created_at.timestamp()
+
   updated_at: datetime = Field(description='Timestamp when the exit was last updated')
-  model_config = ConfigDict(from_attributes=True)
+
+  @field_serializer('updated_at', when_used='always')
+  def serialize_updated_at(self, updated_at: datetime) -> float:
+    return updated_at.timestamp()

layrz_sdk/entities/ats_operation.py

@@ -0,0 +1,87 @@
+"""Entry entity"""
+
+from datetime import datetime
+from enum import StrEnum
+
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
+
+from .ats_purchaseorder import AtsPurchaseOrder, DeliveryCategories, OrderCategories, OrderStatus
+
+
+class AtsOperationMovement(BaseModel):
+  """Ats operation movement entity"""
+
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int | None = Field(
+    description='Defines the primary key of the Function',
+    default=None,
+    alias='id',
+  )
+  status: OrderStatus | None = Field(description='Current status of the order', default=None)
+
+  @field_serializer('status', when_used='always')
+  def serialize_status(self, status: OrderStatus | None) -> str | None:
+    return status.value if status else None
+
+  created_at: datetime | None = Field(description='Timestamp when the operation movement was created', default=None)
+
+  @field_serializer('created_at', when_used='always')
+  def serialize_created_at(self, created_at: datetime | None) -> float | None:
+    return created_at.timestamp() if created_at else None
+
+  asset_id: int | None = Field(description='ID of the asset', default=None)
+  operation_id: int | None = Field(description='ID of the operation', default=None)
+
+
+class AtsOperation(BaseModel):
+  """Entry entity"""
+
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    description='Defines the primary key of the Function',
+    alias='id',
+  )
+  purchased_at: datetime = Field(description='Timestamp when the operation was purchased')
+
+  @field_serializer('purchased_at', when_used='always')
+  def serialize_purchased_at(self, purchased_at: datetime) -> float:
+    return purchased_at.timestamp()
+
+  order_status: OrderStatus = Field(..., description='Current status of the order')
+
+  @field_serializer('order_status', when_used='always')
+  def serialize_order_status(self, order_status: OrderStatus) -> str:
+    return order_status.value
+
+  category: OrderCategories = Field(..., description='Category of the operation')
+
+  @field_serializer('category', when_used='always')
+  def serialize_category(self, category: OrderCategories) -> str:
+    return category.value
+
+  deliver_category: DeliveryCategories = Field(..., description='Delivery category of the operation')
+
+  @field_serializer('deliver_category', when_used='always')
+  def serialize_deliver_category(self, deliver_category: DeliveryCategories) -> str:
+    return deliver_category.value
+
+  seller_asset_id: int = Field(description='ID of the seller asset')
+  transport_asset_id: int = Field(description='ID of the transport asset')
+  finished_at: datetime | None = Field(description='Timestamp when the operation was finished', default=None)
+
+  @field_serializer('finished_at', when_used='always')
+  def serialize_finished_at(self, finished_at: datetime | None) -> float | None:
+    return finished_at.timestamp() if finished_at else None
+
+  history: list[AtsOperationMovement] = Field(description='List of operation movements')
+  purchase_orders: list[AtsPurchaseOrder] = Field(description='List of purchase orders')

layrz_sdk/entities/ats_possible_entry.py

@@ -1,13 +1,17 @@
-"""Entry entity"""
-
 from datetime import datetime
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class AtsPossibleEntry(BaseModel):
   """Entry entity"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   initial_tank_level: float = Field(description='Initial tank level in liters', default=0.0)
   tank_accumulator: float = Field(description='Tank accumulator in liters', default=0.0)
   is_ready: bool = Field(description='Indicates if the entry is ready', default=False)
@@ -20,10 +24,9 @@ class AtsPossibleEntry(BaseModel):
   is_recalculated: bool = Field(description='Indicates if the entry is recalculated', default=False)
   is_blackbox: bool = Field(description='Indicates if the entry is a black box', default=False)
   is_executed_by_command: bool | None = Field(
-    description='Indicates if the entry is executed by command', default=False
+    description='Indicates if the entry is executed by command',
+    default=False,
   )
   is_ready_by_reception: bool | None = Field(description='Indicates if the entry is ready by reception', default=False)
   false_positive_count: int = Field(description='Count of false positives for the entry', default=0)
-  reception_id: int | None = Field(
-    description='Reception ID associated with the entry', default=None, alias='receptionId'
-  )
+  reception_id: int | None = Field(description='Reception ID associated with the entry', default=None)

layrz_sdk/entities/ats_possible_exit.py

@@ -1,20 +1,21 @@
-"""Ats Exit entity"""
-
 from datetime import datetime
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 
 class AtsPossibleExit(BaseModel):
   """AtsPossibleExit entity"""
 
-  model_config = {
-    'json_encoders': {
-      datetime: lambda v: v.timestamp(),
-    }
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
-  pk: int = Field(description='Defines the primary key of the AtsPossibleExit', alias='id')
+  pk: int = Field(
+    description='Defines the primary key of the AtsPossibleExit',
+    alias='id',
+  )
 
   identifier: int | None = Field(
     default=None,
@@ -54,11 +55,20 @@ class AtsPossibleExit(BaseModel):
     default_factory=datetime.now,
     description='Timestamp when the exit started',
   )
+
+  @field_serializer('start_at', when_used='always')
+  def serialize_start_at(self, start_at: datetime) -> float:
+    return start_at.timestamp()
+
   end_at: datetime | None = Field(
     default=None,
     description='Timestamp when the exit ended',
   )
 
+  @field_serializer('end_at', when_used='always')
+  def serialize_end_at(self, end_at: datetime | None) -> float | None:
+    return end_at.timestamp() if end_at else None
+
   # Derived / bookkeeping flags
   is_recalculated: bool = Field(
     default=False,