layrz-sdk 3.1.11__tar.gz → 3.1.13__tar.gz

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2020-2024 Layrz Limited
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2020-2024 Layrz Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{layrz_sdk-3.1.11/layrz_sdk.egg-info → layrz_sdk-3.1.13}/PKG-INFO

@@ -1,49 +1,49 @@
-Metadata-Version: 2.4
-Name: layrz-sdk
-Version: 3.1.11
-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>
-License: MIT License
-Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
-Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md
-Keywords: sdk,goldenm,lcl,layrz compute language,layrz
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: <3.14,>=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Requires-Dist: xlsxwriter
-Requires-Dist: tzdata
-Requires-Dist: pydantic>=2.10.6
-Requires-Dist: typing-extensions>=4.10.0
-Dynamic: license-file
-
-# Layrz SDK
-
-Managed by Golden M, Inc.
-
-## Description
-It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
-incorporate them into your own projects.
-
-## Requirements
-This library uses at least Python 3.10 or higher to work.
-
-If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
-
-## Documentation
-It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
-
-## Work with us
-Golden M is a software/hardware development company what is working on
-a new, innovative and disruptive technologies.
-
-For more information, contact us at [sales@goldenm.com](mailto:sales@goldenm.com)
-
-## License
-This project is under MIT License, for more information, check out the `LICENCE`
+Metadata-Version: 2.4
+Name: layrz-sdk
+Version: 3.1.13
+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>
+License: MIT License
+Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
+Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md
+Keywords: sdk,goldenm,lcl,layrz compute language,layrz
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: xlsxwriter
+Requires-Dist: tzdata
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: typing-extensions>=4.10.0
+Dynamic: license-file
+
+# Layrz SDK
+
+Managed by Golden M, Inc.
+
+## Description
+It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
+incorporate them into your own projects.
+
+## Requirements
+This library uses at least Python 3.10 or higher to work.
+
+If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
+
+## Documentation
+It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
+
+## Work with us
+Golden M is a software/hardware development company what is working on
+a new, innovative and disruptive technologies.
+
+For more information, contact us at [sales@goldenm.com](mailto:sales@goldenm.com)
+
+## License
+This project is under MIT License, for more information, check out the `LICENCE`

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/README.md

@@ -1,24 +1,24 @@
-# Layrz SDK
-
-Managed by Golden M, Inc.
-
-## Description
-It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
-incorporate them into your own projects.
-
-## Requirements
-This library uses at least Python 3.10 or higher to work.
-
-If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
-
-## Documentation
-It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
-
-## Work with us
-Golden M is a software/hardware development company what is working on
-a new, innovative and disruptive technologies.
-
-For more information, contact us at [sales@goldenm.com](mailto:sales@goldenm.com)
-
-## License
-This project is under MIT License, for more information, check out the `LICENCE`
+# Layrz SDK
+
+Managed by Golden M, Inc.
+
+## Description
+It's a group of tools/classes/SDKs that can be help you to implement scripts into Layrz modules, or
+incorporate them into your own projects.
+
+## Requirements
+This library uses at least Python 3.10 or higher to work.
+
+If you want to encrypt MS Excel files, you need to have the [`msoffice`](https://github.com/herumi/msoffice) utility installed in your system.
+
+## Documentation
+It's available in our documentation site [developers.layrz.com](https://developers.layrz.com/Kits/Sdk)
+
+## Work with us
+Golden M is a software/hardware development company what is working on
+a new, innovative and disruptive technologies.
+
+For more information, contact us at [sales@goldenm.com](mailto:sales@goldenm.com)
+
+## License
+This project is under MIT License, for more information, check out the `LICENCE`

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/layrz_sdk/__init__.py

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

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/layrz_sdk/constants.py

@@ -1,5 +1,5 @@
-"""Constants"""
-
-from zoneinfo import ZoneInfo
-
-UTC = ZoneInfo('UTC')
+"""Constants"""
+
+from zoneinfo import ZoneInfo
+
+UTC = ZoneInfo('UTC')

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/layrz_sdk/entities/__init__.py

@@ -1,129 +1,129 @@
-"""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 .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',
+]

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/layrz_sdk/entities/asset.py

@@ -1,60 +1,60 @@
-"""Asset Entity"""
-
-import sys
-from typing import Any, Dict, List, 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
+
+
+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

{layrz_sdk-3.1.11 → layrz_sdk-3.1.13}/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-3.1.11 → layrz_sdk-3.1.13}/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')