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

layrz_sdk/__init__.py

@@ -1 +1 @@
-""" Layrz SDK Namespace """
+""" Layrz SDK Namespace """

layrz_sdk/constants.py

@@ -1,5 +1,19 @@
-"""Constants"""
-
-from zoneinfo import ZoneInfo
-
-UTC = ZoneInfo('UTC')
+"""Constants"""
+
+from zoneinfo import ZoneInfo
+
+UTC = ZoneInfo('UTC')
+""" UTC timezone constant for use in datetime fields. """
+
+
+REJECTED_KEYS = (
+  'timestamp',
+  'ident',
+  'server.timestamp',
+  'protocol.id',
+  'channel.id',
+  'device.name',
+  'device.id',
+  'device.type.id',
+)
+""" Defines the ignored raw keys from a telemetry object """

layrz_sdk/entities/__init__.py

@@ -1,129 +1,138 @@
-"""Init file"""
-
-from .asset import Asset
-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 .case import Case
-from .case_ignored_status import CaseIgnoredStatus
-from .case_status import CaseStatus
-from .charts.axis_config import AxisConfig
-from .charts.bar_chart import BarChart
-from .charts.chart_alignment import ChartAlignment
-from .charts.chart_color import ChartColor
-from .charts.chart_configuration import ChartConfiguration
-from .charts.chart_data_serie import ChartDataSerie
-from .charts.chart_data_serie_type import ChartDataSerieType
-from .charts.chart_data_type import ChartDataType
-from .charts.chart_render_technology import ChartRenderTechnology
-from .charts.column_chart import ColumnChart
-from .charts.html_chart import HTMLChart
-from .charts.line_chart import LineChart
-from .charts.map_center_type import MapCenterType
-from .charts.map_chart import MapChart
-from .charts.map_point import MapPoint
-from .charts.number_chart import NumberChart
-from .charts.pie_chart import PieChart
-from .charts.radar_chart import RadarChart
-from .charts.radial_bar_chart import RadialBarChart
-from .charts.scatter_chart import ScatterChart
-from .charts.scatter_serie import ScatterSerie
-from .charts.scatter_serie_item import ScatterSerieItem
-from .charts.table_chart import TableChart
-from .charts.table_header import TableHeader
-from .charts.table_row import TableRow
-from .charts.timeline_chart import TimelineChart
-from .charts.timeline_serie import TimelineSerie
-from .charts.timeline_serie_item import TimelineSerieItem
-from .checkpoint import Checkpoint
-from .comment import Comment
-from .custom_field import CustomField
-from .custom_report_page import CustomReportPage
-from .device import Device
-from .event import Event
-from .geofence import Geofence
-from .last_message import LastMessage
-from .message import Message
-from .outbound_service import OutboundService
-from .position import Position
-from .presence_type import PresenceType
-from .report import Report
-from .report_col import ReportCol
-from .report_configuration import ReportConfiguration
-from .report_data_type import ReportDataType
-from .report_format import ReportFormat
-from .report_header import ReportHeader
-from .report_page import ReportPage
-from .report_row import ReportRow
-from .sensor import Sensor
-from .text_alignment import TextAlignment
-from .trigger import Trigger
-from .user import User
-from .waypoint import Waypoint
-
-__all__ = [
-  'Asset',
-  'AssetOperationMode',
-  'BroadcastRequest',
-  'BroadcastResponse',
-  'BroadcastResult',
-  'BroadcastStatus',
-  'Case',
-  'CaseIgnoredStatus',
-  'CaseStatus',
-  'AxisConfig',
-  'BarChart',
-  'ChartAlignment',
-  'ChartColor',
-  'ChartConfiguration',
-  'ChartDataSerie',
-  'ChartDataSerieType',
-  'ChartDataType',
-  'ChartRenderTechnology',
-  'ColumnChart',
-  'HTMLChart',
-  'LineChart',
-  'MapCenterType',
-  'MapChart',
-  'MapPoint',
-  'NumberChart',
-  'PieChart',
-  'RadarChart',
-  'RadialBarChart',
-  'ScatterChart',
-  'ScatterSerie',
-  'ScatterSerieItem',
-  'TableChart',
-  'TableHeader',
-  'TableRow',
-  'TimelineChart',
-  'TimelineSerie',
-  'TimelineSerieItem',
-  'Checkpoint',
-  'Comment',
-  'CustomField',
-  'CustomReportPage',
-  'Device',
-  'Event',
-  'Geofence',
-  'LastMessage',
-  'Message',
-  'OutboundService',
-  'Position',
-  'PresenceType',
-  'Report',
-  'ReportCol',
-  'ReportConfiguration',
-  'ReportDataType',
-  'ReportFormat',
-  'ReportHeader',
-  'ReportPage',
-  'ReportRow',
-  'Sensor',
-  'TextAlignment',
-  'Trigger',
-  'User',
-  'Waypoint',
-]
+"""Init file"""
+
+from .asset import Asset
+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 .case import Case
+from .case_ignored_status import CaseIgnoredStatus
+from .case_status import CaseStatus
+from .charts.axis_config import AxisConfig
+from .charts.bar_chart import BarChart
+from .charts.chart_alignment import ChartAlignment
+from .charts.chart_color import ChartColor
+from .charts.chart_configuration import ChartConfiguration
+from .charts.chart_data_serie import ChartDataSerie
+from .charts.chart_data_serie_type import ChartDataSerieType
+from .charts.chart_data_type import ChartDataType
+from .charts.chart_render_technology import ChartRenderTechnology
+from .charts.column_chart import ColumnChart
+from .charts.html_chart import HTMLChart
+from .charts.line_chart import LineChart
+from .charts.map_center_type import MapCenterType
+from .charts.map_chart import MapChart
+from .charts.map_point import MapPoint
+from .charts.number_chart import NumberChart
+from .charts.pie_chart import PieChart
+from .charts.radar_chart import RadarChart
+from .charts.radial_bar_chart import RadialBarChart
+from .charts.scatter_chart import ScatterChart
+from .charts.scatter_serie import ScatterSerie
+from .charts.scatter_serie_item import ScatterSerieItem
+from .charts.table_chart import TableChart
+from .charts.table_header import TableHeader
+from .charts.table_row import TableRow
+from .charts.timeline_chart import TimelineChart
+from .charts.timeline_serie import TimelineSerie
+from .charts.timeline_serie_item import TimelineSerieItem
+from .checkpoint import Checkpoint
+from .comment import Comment
+from .custom_field import CustomField
+from .custom_report_page import CustomReportPage
+from .device import Device
+from .event import Event
+from .geofence import Geofence
+from .last_message import LastMessage
+from .message import Message
+from .modbus import ModbusConfig, ModbusParameter, ModbusSchema, ModbusStatus, ModbusWait
+from .outbound_service import OutboundService
+from .position import Position
+from .presence_type import PresenceType
+from .report import Report
+from .report_col import ReportCol
+from .report_configuration import ReportConfiguration
+from .report_data_type import ReportDataType
+from .report_format import ReportFormat
+from .report_header import ReportHeader
+from .report_page import ReportPage
+from .report_row import ReportRow
+from .sensor import Sensor
+from .telemetry import AssetMessage, DeviceMessage
+from .text_alignment import TextAlignment
+from .trigger import Trigger
+from .user import User
+from .waypoint import Waypoint
+
+__all__ = [
+  'Asset',
+  'AssetOperationMode',
+  'BroadcastRequest',
+  'BroadcastResponse',
+  'BroadcastResult',
+  'BroadcastStatus',
+  'Case',
+  'CaseIgnoredStatus',
+  'CaseStatus',
+  'AxisConfig',
+  'BarChart',
+  'ChartAlignment',
+  'ChartColor',
+  'ChartConfiguration',
+  'ChartDataSerie',
+  'ChartDataSerieType',
+  'ChartDataType',
+  'ChartRenderTechnology',
+  'ColumnChart',
+  'HTMLChart',
+  'LineChart',
+  'MapCenterType',
+  'MapChart',
+  'MapPoint',
+  'NumberChart',
+  'PieChart',
+  'RadarChart',
+  'RadialBarChart',
+  'ScatterChart',
+  'ScatterSerie',
+  'ScatterSerieItem',
+  'TableChart',
+  'TableHeader',
+  'TableRow',
+  'TimelineChart',
+  'TimelineSerie',
+  'TimelineSerieItem',
+  'Checkpoint',
+  'Comment',
+  'CustomField',
+  'CustomReportPage',
+  'Device',
+  'Event',
+  'Geofence',
+  'LastMessage',
+  'Message',
+  'OutboundService',
+  'Position',
+  'PresenceType',
+  'Report',
+  'ReportCol',
+  'ReportConfiguration',
+  'ReportDataType',
+  'ReportFormat',
+  'ReportHeader',
+  'ReportPage',
+  'ReportRow',
+  'Sensor',
+  'TextAlignment',
+  'Trigger',
+  'User',
+  'Waypoint',
+  'ModbusConfig',
+  'ModbusParameter',
+  'ModbusSchema',
+  'ModbusStatus',
+  'ModbusWait',
+  'AssetMessage',
+  'DeviceMessage',
+]

layrz_sdk/entities/asset.py

@@ -1,60 +1,76 @@
-"""Asset Entity"""
-
-import sys
-from typing import Any, Optional
-
-from pydantic import BaseModel, Field, model_validator
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-from .asset_operation_mode import AssetOperationMode
-from .custom_field import CustomField
-from .device import Device
-from .sensor import Sensor
-
-
-class Asset(BaseModel):
-  """Asset entity definition"""
-
-  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(
-    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)
-  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(
-    default_factory=list, description='Defines the list of custom fields of the asset'
-  )
-  devices: list[Device] = Field(default_factory=list, description='Defines the list of devices of the asset')
-  children: list[Self] = Field(default_factory=list, description='Defines the list of children of the asset')
-
-  @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')
-    if operation_mode == AssetOperationMode.ASSETMULTIPLE.name:
-      data['devices'] = []
-
-    else:
-      data['children'] = []
-
-    return data
-
-  @property
-  def primary(self: Self) -> Optional[Device]:
-    """Get primary device"""
-    if self.operation_mode not in [AssetOperationMode.SINGLE, AssetOperationMode.MULTIPLE]:
-      return None
-
-    for device in self.devices:
-      if device.is_primary:
-        return device
-
-    return None
+"""Asset Entity"""
+
+import sys
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+from .asset_operation_mode import AssetOperationMode
+from .custom_field import CustomField
+from .device import Device
+from .sensor import Sensor
+from .static_position import StaticPosition
+
+
+class Asset(BaseModel):
+  """Asset entity definition"""
+
+  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(
+    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)
+  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(
+    default_factory=list, description='Defines the list of custom fields of the asset'
+  )
+  devices: list[Device] = Field(default_factory=list, description='Defines the list of devices of the asset')
+  children: list[Self] = Field(default_factory=list, description='Defines the list of children of the asset')
+
+  static_position: StaticPosition | None = Field(
+    default=None,
+    description='Static position of the asset',
+  )
+
+  points: list[StaticPosition] = Field(
+    default_factory=list,
+    description='List of static positions for the asset. The altitude of StaticPosition is not used in this case.',
+  )
+
+  primary_id: int | None = Field(
+    default=None,
+    description='Defines the primary device ID of the asset',
+  )
+
+  @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')
+    if operation_mode == AssetOperationMode.ASSETMULTIPLE.name:
+      data['devices'] = []
+
+    else:
+      data['children'] = []
+
+    return data
+
+  @property
+  def primary(self: Self) -> Optional[Device]:
+    """Get primary device"""
+    if self.operation_mode not in [AssetOperationMode.SINGLE, AssetOperationMode.MULTIPLE]:
+      return None
+
+    for device in self.devices:
+      if device.is_primary:
+        return device
+
+    return None

layrz_sdk/entities/asset_operation_mode.py

@@ -1,31 +1,31 @@
-"""Asset Operation Mode"""
-
-import sys
-from enum import Enum
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class AssetOperationMode(Enum):
-  """
-  Asset Operation mode definition
-  It's an enum of the operation mode of the asset.
-  """
-
-  SINGLE = 'SINGLE'
-  MULTIPLE = 'MULTIPLE'
-  ASSETMULTIPLE = 'ASSETMULTIPLE'
-  DISCONNECTED = 'DISCONNECTED'
-  STATIC = 'STATIC'
-  ZONE = 'ZONE'
-
-  def __str__(self: Self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self: Self) -> str:
-    """Readable property"""
-    return f'AssetOperationMode.{self.name}'
+"""Asset Operation Mode"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class AssetOperationMode(Enum):
+  """
+  Asset Operation mode definition
+  It's an enum of the operation mode of the asset.
+  """
+
+  SINGLE = 'SINGLE'
+  MULTIPLE = 'MULTIPLE'
+  ASSETMULTIPLE = 'ASSETMULTIPLE'
+  DISCONNECTED = 'DISCONNECTED'
+  STATIC = 'STATIC'
+  ZONE = 'ZONE'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'AssetOperationMode.{self.name}'

layrz_sdk/entities/broadcast_request.py

@@ -1,12 +1,12 @@
-"""Broadcast Result Request data"""
-
-from typing import Any
-
-from pydantic import BaseModel, Field
-
-
-class BroadcastRequest(BaseModel):
-  """Broadcast request data"""
-
-  parsed: Any = Field(description='Parsed data')
-  raw: str = Field(description='Raw data')
+"""Broadcast Result Request data"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class BroadcastRequest(BaseModel):
+  """Broadcast request data"""
+
+  parsed: Any = Field(description='Parsed data')
+  raw: str = Field(description='Raw data')

layrz_sdk/entities/broadcast_response.py

@@ -1,12 +1,12 @@
-"""Broadcast Result Response data"""
-
-from typing import Any
-
-from pydantic import BaseModel, Field
-
-
-class BroadcastResponse(BaseModel):
-  """Broadcast response data"""
-
-  parsed: Any = Field(description='Parsed data')
-  raw: str = Field(description='Raw data')
+"""Broadcast Result Response data"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class BroadcastResponse(BaseModel):
+  """Broadcast response data"""
+
+  parsed: Any = Field(description='Parsed data')
+  raw: str = Field(description='Raw data')

layrz_sdk/entities/broadcast_result.py

@@ -1,20 +1,20 @@
-"""Broadcast result"""
-
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-from .broadcast_request import BroadcastRequest
-from .broadcast_response import BroadcastResponse
-from .broadcast_status import BroadcastStatus
-
-
-class BroadcastResult(BaseModel):
-  """Broadcast result data"""
-
-  service_id: int = Field(description='Service ID')
-  asset_id: int = Field(description='Asset ID')
-  status: BroadcastStatus = Field(description='Broadcast status')
-  request: BroadcastRequest = Field(description='Broadcast request')
-  response: BroadcastResponse = Field(description='Broadcast response')
-  submitted_at: datetime = Field(description='Broadcast submission date')
+"""Broadcast result"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .broadcast_request import BroadcastRequest
+from .broadcast_response import BroadcastResponse
+from .broadcast_status import BroadcastStatus
+
+
+class BroadcastResult(BaseModel):
+  """Broadcast result data"""
+
+  service_id: int = Field(description='Service ID')
+  asset_id: int = Field(description='Asset ID')
+  status: BroadcastStatus = Field(description='Broadcast status')
+  request: BroadcastRequest = Field(description='Broadcast request')
+  response: BroadcastResponse = Field(description='Broadcast response')
+  submitted_at: datetime = Field(description='Broadcast submission date')

layrz_sdk/entities/broadcast_status.py

@@ -1,28 +1,28 @@
-"""Broadcast result Status"""
-
-import sys
-from enum import Enum
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class BroadcastStatus(Enum):
-  """Broadcast result status"""
-
-  OK = 'OK'
-  BADREQUEST = 'BADREQUEST'
-  INTERNALERROR = 'INTERNALERROR'
-  UNAUTHORIZED = 'UNAUTHORIZED'
-  UNPROCESSABLE = 'UNPROCESSABLE'
-  DISCONNECTED = 'DISCONNECTED'
-
-  def __str__(self: Self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self: Self) -> str:
-    """Readable property"""
-    return f'BroadcastStatus.{self.name}'
+"""Broadcast result Status"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class BroadcastStatus(Enum):
+  """Broadcast result status"""
+
+  OK = 'OK'
+  BADREQUEST = 'BADREQUEST'
+  INTERNALERROR = 'INTERNALERROR'
+  UNAUTHORIZED = 'UNAUTHORIZED'
+  UNPROCESSABLE = 'UNPROCESSABLE'
+  DISCONNECTED = 'DISCONNECTED'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'BroadcastStatus.{self.name}'