layrz-sdk 3.1.27__tar.gz → 3.1.29__tar.gz

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.28
+
+- Added `BroadcastPayload` and `BroadcastService` models
+
 ## 3.1.27
 
 - Fixes on `ChartDataSerieType` that can have a `None` value, removed str inheritance to avoid issues

{layrz_sdk-3.1.27/layrz_sdk.egg-info → layrz_sdk-3.1.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.27
+Version: 3.1.29
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/layrz_sdk/entities/__init__.py

@@ -3,10 +3,14 @@
 from .asset import Asset
 from .asset_constants import AssetConstants
 from .asset_operation_mode import AssetOperationMode
-from .broadcast_request import BroadcastRequest
-from .broadcast_response import BroadcastResponse
-from .broadcast_result import BroadcastResult
-from .broadcast_status import BroadcastStatus
+from .broadcast import (
+  BroadcastPayload,
+  BroadcastRequest,
+  BroadcastResponse,
+  BroadcastResult,
+  BroadcastService,
+  BroadcastStatus,
+)
 from .case import Case
 from .case_ignored_status import CaseIgnoredStatus
 from .case_status import CaseStatus
@@ -73,6 +77,8 @@ __all__ = [
   'BroadcastResponse',
   'BroadcastResult',
   'BroadcastStatus',
+  'BroadcastService',
+  'BroadcastPayload',
   'Case',
   'CaseIgnoredStatus',
   'CaseStatus',

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/layrz_sdk/entities/asset.py

@@ -1,7 +1,7 @@
 """Asset Entity"""
 
 import sys
-from typing import Any, Optional
+from typing import Any
 
 from pydantic import BaseModel, Field, model_validator
 
@@ -20,14 +20,14 @@ from .static_position import StaticPosition
 class Asset(BaseModel):
   """Asset entity definition"""
 
-  pk: int = Field(description='Defines the primary key of the asset')
+  pk: int = Field(description='Defines the primary key of the asset', serialization_alias='id')
   name: str = Field(description='Defines the name of the asset')
-  vin: Optional[str] = Field(
+  vin: str | None = Field(
     default=None,
     description='Defines the serial number of the asset, may be an VIN, or any other unique identifier',
   )
-  plate: Optional[str] = Field(default=None, description='Defines the plate number of the asset')
-  asset_type: Optional[int] = Field(description='Defines the type of the asset', alias='kind_id', default=None)
+  plate: str | None = Field(default=None, description='Defines the plate number of the asset')
+  asset_type: int | None = Field(description='Defines the type of the asset', alias='kind_id', default=None)
   operation_mode: AssetOperationMode = Field(description='Defines the operation mode of the asset')
   sensors: list[Sensor] = Field(default_factory=list, description='Defines the list of sensors of the asset')
   custom_fields: list[CustomField] = Field(
@@ -54,7 +54,7 @@ class Asset(BaseModel):
   @model_validator(mode='before')
   def _validate_model(cls: Self, data: dict[str, Any]) -> dict[str, Any]:
     """Validate model"""
-    operation_mode: Optional[str] = data.get('operation_mode')
+    operation_mode: str | None = data.get('operation_mode')
     if operation_mode == AssetOperationMode.ASSETMULTIPLE.name:
       data['devices'] = []
 
@@ -64,7 +64,7 @@ class Asset(BaseModel):
     return data
 
   @property
-  def primary(self: Self) -> Optional[Device]:
+  def primary(self: Self) -> Device | None:
     """Get primary device"""
     if self.operation_mode not in [AssetOperationMode.SINGLE, AssetOperationMode.MULTIPLE]:
       return None

layrz_sdk-3.1.29/layrz_sdk/entities/broadcast/__init__.py

@@ -0,0 +1,15 @@
+from .payload import BroadcastPayload
+from .request import BroadcastRequest
+from .response import BroadcastResponse
+from .result import BroadcastResult
+from .service import BroadcastService
+from .status import BroadcastStatus
+
+__all__ = [
+  'BroadcastPayload',
+  'BroadcastRequest',
+  'BroadcastResponse',
+  'BroadcastResult',
+  'BroadcastService',
+  'BroadcastStatus',
+]

layrz_sdk-3.1.29/layrz_sdk/entities/broadcast/payload.py

@@ -0,0 +1,45 @@
+"""Broadcast Payload data"""
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from layrz_sdk.constants import UTC
+from layrz_sdk.entities.asset import Asset
+from layrz_sdk.entities.device import Device
+from layrz_sdk.entities.trigger import Trigger
+
+from .service import BroadcastService
+
+
+class BroadcastPayload(BaseModel):
+  """Broadcast payload data, structure that is sent to the Outbound MQTT and other services"""
+
+  model_config = {
+    'loc_by_alias': True,
+    'json_encoders': {
+      datetime: lambda v: v.timestamp(),
+    },
+  }
+
+  asset: Asset = Field(..., description='Asset object')
+  primary_device: Device | None = Field(
+    default=None,
+    description='Primary device object',
+    serialization_alias='primaryDevice',
+  )
+  trigger: Trigger | None = Field(
+    default=None,
+    description='Trigger object, if available',
+  )
+  message_id: int | str = Field(..., description='Message ID', serialization_alias='message.id')
+  service: BroadcastService | None = Field(default=None, description='Broadcast service object')
+  position: dict[str, Any] = Field(default_factory=dict, description='Position data, if available')
+  sensors: dict[str, Any] = Field(default_factory=dict, description='Sensors data, if available')
+  payload: dict[str, Any] = Field(default_factory=dict, description='Payload data, if available')
+  received_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Broadcast payload received date',
+    serialization_alias='receivedAt',
+  )

layrz_sdk-3.1.27/layrz_sdk/entities/broadcast_result.py → layrz_sdk-3.1.29/layrz_sdk/entities/broadcast/result.py

@@ -4,9 +4,9 @@ from datetime import datetime
 
 from pydantic import BaseModel, Field
 
-from .broadcast_request import BroadcastRequest
-from .broadcast_response import BroadcastResponse
-from .broadcast_status import BroadcastStatus
+from .request import BroadcastRequest
+from .response import BroadcastResponse
+from .status import BroadcastStatus
 
 
 class BroadcastResult(BaseModel):

layrz_sdk-3.1.29/layrz_sdk/entities/broadcast/service.py

@@ -0,0 +1,13 @@
+"""Broadcast Service object"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class BroadcastService(BaseModel):
+  """Broadcast Service object"""
+
+  pk: int = Field(..., description='Service ID', serialization_alias='id')
+  name: str = Field(..., description='Service name')
+  credentials: dict[str, Any] = Field(default_factory=dict, description='Service credentials')

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/layrz_sdk/entities/device.py

@@ -8,7 +8,7 @@ from .modbus import ModbusConfig
 class Device(BaseModel):
   """Device entity"""
 
-  pk: int = Field(description='Defines the primary key of the device')
+  pk: int = Field(description='Defines the primary key of the device', serialization_alias='id')
   name: str = Field(description='Defines the name of the device')
   ident: str = Field(description='Defines the identifier of the device')
   protocol_id: int | None = Field(

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/layrz_sdk/entities/trigger.py

@@ -6,6 +6,6 @@ from pydantic import BaseModel, Field
 class Trigger(BaseModel):
   """Trigger entity"""
 
-  pk: int = Field(description='Defines the primary key of the trigger')
+  pk: int = Field(description='Defines the primary key of the trigger', serialization_alias='id')
   name: str = Field(description='Defines the name of the trigger')
   code: str = Field(description='Defines the code of the trigger')

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.27
+Version: 3.1.29
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/layrz_sdk.egg-info/SOURCES.txt

@@ -23,10 +23,6 @@ layrz_sdk/entities/__init__.py
 layrz_sdk/entities/asset.py
 layrz_sdk/entities/asset_constants.py
 layrz_sdk/entities/asset_operation_mode.py
-layrz_sdk/entities/broadcast_request.py
-layrz_sdk/entities/broadcast_response.py
-layrz_sdk/entities/broadcast_result.py
-layrz_sdk/entities/broadcast_status.py
 layrz_sdk/entities/case.py
 layrz_sdk/entities/case_ignored_status.py
 layrz_sdk/entities/case_status.py
@@ -56,6 +52,13 @@ layrz_sdk/entities/text_alignment.py
 layrz_sdk/entities/trigger.py
 layrz_sdk/entities/user.py
 layrz_sdk/entities/waypoint.py
+layrz_sdk/entities/broadcast/__init__.py
+layrz_sdk/entities/broadcast/payload.py
+layrz_sdk/entities/broadcast/request.py
+layrz_sdk/entities/broadcast/response.py
+layrz_sdk/entities/broadcast/result.py
+layrz_sdk/entities/broadcast/service.py
+layrz_sdk/entities/broadcast/status.py
 layrz_sdk/entities/charts/axis_config.py
 layrz_sdk/entities/charts/bar_chart.py
 layrz_sdk/entities/charts/chart_alignment.py

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.27"
+version = "3.1.29"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}

{layrz_sdk-3.1.27 → layrz_sdk-3.1.29}/uv.lock

@@ -343,7 +343,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "3.1.27"
+version = "3.1.29"
 source = { editable = "." }
 dependencies = [
     { name = "geopy" },