layrz-sdk 3.1.27__py3-none-any.whl → 3.1.28__py3-none-any.whl

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/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
 
@@ -22,12 +22,12 @@ class Asset(BaseModel):
 
   pk: int = Field(description='Defines the primary key of the asset')
   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/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/entities/broadcast/payload.py

@@ -0,0 +1,36 @@
+"""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 .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(None, description='Primary device object', serialization_alias='primaryDevice')
+  message_id: int | str = Field(..., description='Message ID', serialization_alias='message.id')
+  service: BroadcastService | None = Field(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/entities/{broadcast_result.py → 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/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.dist-info → layrz_sdk-3.1.28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.27
+Version: 3.1.28
 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.dist-info → layrz_sdk-3.1.28.dist-info}/RECORD

@@ -2,14 +2,10 @@ layrz_sdk/__init__.py,sha256=OutylN0QazaeDVIA5NRDVyzwfYnZkAwVQzT-2F6iX2M,28
 layrz_sdk/backwards.py,sha256=f_DUxvbZs-p287-wGwxx0NVUK7Gha-cNP_hHRAJWAq0,85
 layrz_sdk/constants.py,sha256=guXfIsVAcex76OEMv6DAJy1km1A_WUfWJuUO2Lo3kXE,344
 layrz_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-layrz_sdk/entities/__init__.py,sha256=eqCkarOEIfuV-XEpGBBjcsuznJFRAymmd6TmLS71pso,4027
-layrz_sdk/entities/asset.py,sha256=N3sxYdZ0EpPFg4uuNJ3PeBdwmn2uVgiWzwWRJA6Sr-k,2608
+layrz_sdk/entities/__init__.py,sha256=CrPrN6MnGkOKhQUF_ssi5U0z4wrQHXdQD7yen5APhzA,4027
+layrz_sdk/entities/asset.py,sha256=9dVnNXeBP_CnpXUU2KH7LiQxCWBXZzok13HMkN9diaI,2583
 layrz_sdk/entities/asset_constants.py,sha256=H-RY9XvSz9lzjkx9YjNT4dZEp5v8WOweQHjwHDUGw60,710
 layrz_sdk/entities/asset_operation_mode.py,sha256=1RLRpbUm6jwxivdKbB2O6wdnrhyqaccQ_moA-wrnzdQ,639
-layrz_sdk/entities/broadcast_request.py,sha256=MQb9kyDSAMXtp4_sPOamBsYyCVZ02wj8NXmi8IEmM68,260
-layrz_sdk/entities/broadcast_response.py,sha256=hK3D05pecln9wbkdGr892Kzmd7bMzjsaayPxzJPVHsw,263
-layrz_sdk/entities/broadcast_result.py,sha256=2OEd-1DVQt0T1KQR8S_wrYEplXKFVXbIouTW9wFHTh4,686
-layrz_sdk/entities/broadcast_status.py,sha256=-dGOZeQ1VclBvWTfnrPEDb8LMHSyBVnV5cVyQVyMdcU,597
 layrz_sdk/entities/case.py,sha256=0dSfZCezDuEEED42rws-zntqa_Em9oFevlXSPrIeIC8,1877
 layrz_sdk/entities/case_ignored_status.py,sha256=9nRIKJqaZ9EBXYuI4j4v2hCd0C6GtWPDKsbdE2Srt1g,517
 layrz_sdk/entities/case_status.py,sha256=4k6PeJJiCqp1LxipXTrIFuEqeK2NYwbrKA8KvI51ewU,443
@@ -39,6 +35,13 @@ layrz_sdk/entities/text_alignment.py,sha256=YqUqj07c4XzHZLdaqNw1FEUpneWoJU5UU3ei
 layrz_sdk/entities/trigger.py,sha256=fDcF72awhwk43j9heE053QneYk4rUfdm3RY2hitP91w,318
 layrz_sdk/entities/user.py,sha256=S2mJoW44xbBe-O3I_ajy5l4V9-azVLUfKvcfsuqfodQ,236
 layrz_sdk/entities/waypoint.py,sha256=Wx4uFzKVXKTuSgu8wiDpvqGFtG3c1_owk1-M9APlpj8,550
+layrz_sdk/entities/broadcast/__init__.py,sha256=Q1fIeDj1oAL63Q0JDddkW_FuP826-Im6ScwUUwAZIOM,372
+layrz_sdk/entities/broadcast/payload.py,sha256=KX6mjogSpDW_tCedioanQukcE1sFJaAv_PRqdAU50qA,1371
+layrz_sdk/entities/broadcast/request.py,sha256=MQb9kyDSAMXtp4_sPOamBsYyCVZ02wj8NXmi8IEmM68,260
+layrz_sdk/entities/broadcast/response.py,sha256=hK3D05pecln9wbkdGr892Kzmd7bMzjsaayPxzJPVHsw,263
+layrz_sdk/entities/broadcast/result.py,sha256=07P7cE6LCBpw8jlgmyVsGxBmRpO4A7Jva5hpLh-n5U0,656
+layrz_sdk/entities/broadcast/service.py,sha256=EWc3mgdewyW6rZGzwWroxidaogXYDW-w1Td1c36xBY0,388
+layrz_sdk/entities/broadcast/status.py,sha256=-dGOZeQ1VclBvWTfnrPEDb8LMHSyBVnV5cVyQVyMdcU,597
 layrz_sdk/entities/charts/axis_config.py,sha256=ZvVsjB26FMbbfM9318KaQm3XyiNAkyzz2120fM2DH50,604
 layrz_sdk/entities/charts/bar_chart.py,sha256=hBOc0iJHTpFSlZsBtxT4-xtEJLi8DPnjXvc_i2t9HcI,5017
 layrz_sdk/entities/charts/chart_alignment.py,sha256=gl8Ymfh0lq_F0uhsD2ljLpRPcrqM8eDogVa7OO571YA,467
@@ -80,8 +83,8 @@ layrz_sdk/helpers/__init__.py,sha256=5iW3z2m3jrYhvTfxX-p-QTkR9X9oTKfEsbtVOg9jFFY
 layrz_sdk/helpers/color.py,sha256=dlpMafbM-4Wd9D9hMbbnZJf4ALkpie_ZmBR2Vz_YCmM,1203
 layrz_sdk/lcl/__init__.py,sha256=U967AWANkL3u_YVxMNAYlh8jkZ6hqHfStacz7yz6sOA,89
 layrz_sdk/lcl/core.py,sha256=T80A3hL7SeqRNSfl5SrPAgwIEf-enoAVv9ldwJNzqsA,24786
-layrz_sdk-3.1.27.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-3.1.27.dist-info/METADATA,sha256=6JnslK6edKxqzhpYZw2WbibSSohIpI-crmobjhOsB8E,2084
-layrz_sdk-3.1.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-3.1.27.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-3.1.27.dist-info/RECORD,,
+layrz_sdk-3.1.28.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
+layrz_sdk-3.1.28.dist-info/METADATA,sha256=eJDUV8mlIyOiJo1lofR4pOPzgaU48sODsJNVtR7hUcw,2084
+layrz_sdk-3.1.28.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+layrz_sdk-3.1.28.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
+layrz_sdk-3.1.28.dist-info/RECORD,,