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

layrz_sdk-3.1.15/.github/workflows/checks.yml

@@ -0,0 +1,50 @@
+name: "Checks before merging"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+    branches:
+      - '*'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Lint
+        run: |
+          uv sync --only-group dev
+          uv run ruff check
+          uv run mypy .
+
+  uniitest:
+    needs: lint
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Install dependencies
+        run: |
+          uv sync
+          uv run pytest ./tests/
+

layrz_sdk-3.1.15/.github/workflows/deploy.yml

@@ -0,0 +1,32 @@
+name: "Deploy package"
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    permissions:
+      id-token: write
+      contents: read
+      repository-projects: read
+      packages: read
+
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Build and upload
+        run: |
+          uv venv --python 3.13
+          uv sync --only-group dev
+          uv run python -m build
+          uv run python -m twine upload -u ${{ secrets.LAYRZ_PYPI_USERNAME }} -p ${{ secrets.LAYRZ_PYPI_PASSWORD }} dist/*

layrz_sdk-3.1.15/.gitignore

@@ -0,0 +1,19 @@
+/dist
+/build
+/*.egg-info
+/.pypirc
+/test.py
+/**/*.pyc
+/.venv
+/site
+
+/**/*/__pycache__
+
+tests.py
+*.xlsx
+
+.ruff_cache
+.mypy_cache
+.pytest_cache
+
+.env

layrz_sdk-3.1.15/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "ms-python.python",
+    "charliermarsh.ruff",
+    "ms-python.vscode-pylance",
+    "njpwerner.autodocstring",
+    "oderwat.indent-rainbow"
+  ]
+}

layrz_sdk-3.1.15/CHANGELOG.md

@@ -0,0 +1,391 @@
+# Changelog
+
+## 3.1.15
+
+- Added some parameters on `Asset` and `Device` classes
+- Added `AssetMessage` and `DeviceMessage` classes to handle messages related to assets and devices 
+
+## 3.1.14
+
+- Some changes related to the `Case` entity
+
+## 3.1.12
+
+- Adjustment of all typings
+
+## 3.1.11
+
+- Fixes on data casting in `Message` class
+
+## 3.1.10
+
+- Updated docstrings to provide more information about types and usage
+
+## 3.1.9
+
+- Changed `json` to `parsed` on `BroadcastResponse` and `BroadcastRequest` to avoid confusion with the `json` property from `pydantic.BaseModel`
+
+## 3.1.8
+
+- Replaced `str` in favor of using `Path` object to manage paths on `Report` export methods
+
+## 3.1.7
+
+- Removed validation of asset type `SINGLE`
+
+## 3.1.6
+
+- Fixes on model validate on `Asset` class
+
+## 3.1.5
+
+- Changed `width` on `ReportHeader` from `int` to `float` due to backwards compatibility
+
+## 3.1.4
+
+- Fixed iteration searching for the primary device on `Asset` class
+
+## 3.1.3
+
+- Fixes on `Asset` entity validation, found by @simonjrojas!
+
+## 3.1.2
+
+- Set as optional the `asset_type` argument in `Asset` class
+
+## 3.1.1
+
+- Small fixes on some models to backwards compatibility
+
+## 3.1.0
+
+- Migrated all models to Pydantic
+- Removed models `Transaction`.
+- Added `mypy` to the project to enforce type checking
+- Migrated from `uniitest` to `pytest` to the project to enforce unit testing
+
+## 3.0.14
+
+- Fixes on `GET_CUSTOM_FIELD` LCL function, now accepts a default value as the second argument (Fallback as '')
+
+## 3.0.13
+
+- Added `LastMessage` entity to be used in `Trigger`s
+
+## 3.0.12
+
+- Moved `Geofence` model from `checkpoints` to `general`
+- Added `PresenceType` enum to be used in `Event` model
+
+## 3.0.11
+
+- Added way to standarize the `int` and `float` arguments to `float`. Allowing comparison between `int` and `float` values in LCL formulas
+
+## 3.0.10
+
+- Removed Self type annotation from all classes
+
+## 3.0.9
+
+- Added different return data of Report when password is set
+
+## 3.0.8
+
+- New linter and formatter using ruff
+- Added typings on all classes and functions available
+- New Report export format PDF (Not implemented yet)
+- Added new way to encrypt .xslx files directly using the `Report` class
+
+## 3.0.7
+
+- Added the value of `AssetOperationMode.ZONE`
+- Added a check for `Asset.operation_mode == ASSETMULTIPLE` while savind the list of child's
+- Clarified the deprecation of `ReportRow.height`
+
+## 3.0.6
+
+- Changed print in `LineChart` to a `log.warning` and `log.fatal` in case of error
+
+## 3.0.3
+
+- Implemented new chart rendering library `syncfusion_flutter_charts` for Flutter.
+- Changed rendering method for `LineChart`, now you should provide the `technology` to select the rendering library.
+
+## 3.0.2
+
+- Fixed issue with `IF()` LCL function, now only validates the nullability of the first argument.
+- Added new `VERSION()` LCL Function to get the current version of the package
+
+## 3.0.1
+
+- Added None validation on every LCL function, when any of the arguments is None, the function will return None
+- Added unit tests for all LCL functions
+
+## 3.0.0
+
+- Removed shared namespace to improve compatibility with other packages
+
+## 2.2.4
+
+- Defined new class `ReportConfiguration` to handle the configuration of the report in Python scripts
+
+## 2.2.3
+
+- Property `text_color` deprectated in `ReportCol`, replaced by a luminance-based color using the background color
+- Property `text_color` deprectated in `ReportHeader`, replaced by a luminance-based color using the background color
+- Property `width` deprectated in `ReportHeader`, replaced by the function `autofit()` to automatically fit the header width
+- New entity `CustomReportPage` that receives a custom builder function to build the page
+- Property `export_format` deprecated in `Report`, replaced to an argument of the function `export()`
+
+## 2.2.2
+
+- Updated `AssetOperationMode` to support `STATIC` and removal of `FAILOVER` mode
+
+## 2.2.1
+
+- Bug fixes related to removing __ from all classes
+
+## 2.2.0
+
+- Removed support to Python 3.12 due to a shared namespace issue.
+- Reorganized classes to better support.
+- Added typings to all classes and functions.
+
+## 2.1.5
+
+- Added declarative typing on all LCL functions
+- Added support for timezone in `UNIX_TO_STR` LCL function
+
+## 2.1.3
+
+- Changed build mode to pyproject.toml
+- Updated `LcLCore.perform()` function to receive additional globals and locals in their arguments
+
+## v2.1.2
+
+- Add UNIX_TO_STR LCL function
+
+## v2.1.1
+
+- Added `compact` in the json return format in reports
+
+## v2.1.0
+
+- Add bold format option to Col class
+- Add freeze header option to Page class
+
+## v2.0.1
+
+- Fixes on package namespace
+
+## v2.0.0
+
+- Deprecated `lcl.core` module
+- Changed `layrzsdk` to `layrz.sdk` package (With unified Layrz namespace)
+
+## v1.4.5
+
+- Added CaseIgnoredStatus to init file
+
+## v1.4.4
+
+- Added CaseIgnoredStatus to Case entity
+
+## v1.4.3
+
+- Added new ChartType: TableChart and NumberChart
+- Starting to replace documentation format from unstructured to a structured format
+
+## v1.4.2
+
+- Fix, added SUBSTRING LCL to global functions
+
+## v1.4.1
+
+- Fixed LineChart xAxis Datetime conversion for CanvasJS, now will multiply the timestamp by 1000 to use milliseconds
+
+## v1.4.0
+
+- Added support for Flutter `graphic` library
+  - LineChart
+  - AreaChart (Replaced previous AreaChart to a temporal extend of LineChart)
+  - BarChart
+  - ColumnChart
+  - PieChart
+  - MapChart
+  - ScatterChart
+  - RadialBarChart
+
+- Future deprecations:
+  - HTMLChart
+  - TimelineChart
+  - RadarChart
+
+## v1.3.9
+
+- Internal changes related to GitLab CI automation
+
+## v1.3.8
+
+- Added SUBSTRING LCL function
+
+## v.1.3.7
+
+- Added sequence in cases
+
+## v1.3.6
+
+- Added new Map Chart
+  - Added required entity MapPoint
+  - Added required enum MapCenterType
+- Added new HTML Chart
+
+## v1.3.5
+
+- Bug fix related to formula perform, added PRIMARY_DEVICE to simulation environment
+
+## v1.3.4
+
+- Added Transaction entity for REPCOM reports
+
+## v1.3.3
+
+- Added PRIMARY_DEVICE() function to Layrz Compute Language
+
+## v1.3.2
+
+- Updated styles of charts return object to ApexCharts or CanvasJS
+- Replaced all .rst files to .md files
+
+## v1.3.1
+
+- Removed markerSize (in CanvasJS) for dashed series
+
+## v1.3.0
+
+- Added support for CanvasJS Javascript Library
+- Deprecated to_apexcharts property in charts.
+- New method render() in charts with support for multiple Javascript rendering library
+- Added color helpers in layrzsdk.helpers
+
+## v1.2.6
+
+- Removed dataLabels in almost all charts (Except Pie and RadialBar)
+
+## v1.2.5
+
+- Optimizations for Javascript renderer
+
+## v1.2.4
+
+- Added dashed attribute to ChartDataSerie
+- Added the Possibility to mix charts, only available for:
+  - LineChart
+  - AreaChart
+  - ColumnChart
+  - ScatterChart (Only as serie, not as main chart)
+
+## v1.2.3
+
+- Added new value in BroadcastStatus
+
+## v1.2.2
+
+- Updated ReportCol entity to set new default values
+- New entity ReportDataType
+- Possibility to export directly to the Report class
+- Re-organized entities/ folder
+- Added Broadcasts entities
+
+## v1.2.1
+
+- Added Report Col entity
+
+## v1.2.0
+
+- Added reports entities
+
+## v1.1.4
+
+- Bug fixes
+
+## v1.1.3
+
+- Bug fixes
+
+## v1.1.2
+
+- Bug fixes
+
+## v1.1.1
+
+- Bug fixes
+
+## v1.1.0
+
+- Reorganized files
+- Added new Charts entities
+
+## v1.0.14
+
+- Added CONTAINS, STARTS_WITH, ENDS_WITH functions to the Layrz Computed Language
+
+## v1.0.13
+
+- Fixed missing import into `layrzsdk.entities.__init__.py`
+
+## v1.0.12
+
+- Added Geofence, Comment, Waypoint and Checkpoint entities
+
+## v1.0.11
+
+- Added User, Comment and Case entities
+
+## v1.0.10
+
+- Fixes
+
+## v1.0.9
+
+- Added Event and Trigger entities
+- Renamed file `mesage.py` to `message.py`
+
+## v1.0.8
+
+- Added title getter of all charts entities
+
+## v1.0.7
+
+- Added PieChart, BarChart, and RadialBarChart entities
+
+## v1.0.6
+
+- Fixed STING to STRING bug in ChartDataType enum
+
+## v1.0.5
+
+- Bug fixes
+
+## v1.0.4
+
+- Added data_type argument of ChartDataSerie
+
+## v1.0.3
+
+- Added Chart configuration entity
+
+## v1.0.2
+
+- Added entities for Range Charts:
+  - Line Charts
+  - Area Charts
+  - Column Charts
+
+## v1.0.1
+
+- Added entities for Sensors and Triggers
+
+## v1.0.0
+
+- Initial release

layrz_sdk-3.1.15/CODE_OF_CONDUCT.md

@@ -0,0 +1,29 @@
+# Code of conduct
+
+## Be friendly and patient.
+
+Our objective is contribute to community and help us together to create better code.
+
+## Be welcoming
+
+We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
+
+## Be considerate
+
+Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
+
+## Be respectful
+
+Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one.
+
+## Be careful in the words that you choose
+
+We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
+  * Violent threats or language directed against another person.
+  * Discriminatory jokes and language.
+  * Posting sexually explicit or violent material.
+  * Posting (or threatening to post) other people's personally identifying information ("doxing").
+  * Personal insults, especially those using racist or sexist terms.
+  * Unwelcome sexual attention.
+  * Advocating for, or encouraging, any of the above behavior.
+  * Repeated harassment of others. In general, if someone asks you to stop, then stop.

layrz_sdk-3.1.15/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+As an open source project, we welcomes contributions of many forms.
+
+## To request a Pull Request
+
+Please follow the next structure of your request:
+
+1. **Title**: A short description of the change.
+
+2. **Description**: A detailed description of the change, including:
+  - What is the problem you are solving?
+  - How does your change solve the problem?
+  - Any additional information that might be helpful for reviewers.
+
+3. **Code**: The code changes you are proposing, including:
+  - The files you are changing.
+  - The specific lines of code that are being added, modified, or removed.
+  - Any tests you have written to verify your changes.
+
+4. **Testing**: A description of how you tested your changes, including:
+  - The environment you tested in (e.g., local, staging).
+  - Any specific test cases you ran.
+  - The results of your tests.
+
+You can attach screenshots or other files to help illustrate your changes.

{layrz_sdk-3.1.13 → layrz_sdk-3.1.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.13
+Version: 3.1.15
 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>
@@ -21,6 +21,8 @@ Requires-Dist: xlsxwriter
 Requires-Dist: tzdata
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: typing-extensions>=4.10.0
+Requires-Dist: geopy>=2.4.1
+Requires-Dist: shapely>=2.1.1
 Dynamic: license-file
 
 # Layrz SDK

layrz_sdk-3.1.15/layrz_sdk/constants.py

@@ -0,0 +1,19 @@
+"""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-3.1.13 → layrz_sdk-3.1.15}/layrz_sdk/entities/__init__.py

@@ -46,6 +46,7 @@ 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
@@ -58,6 +59,7 @@ 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
@@ -126,4 +128,11 @@ __all__ = [
   'Trigger',
   'User',
   'Waypoint',
+  'ModbusConfig',
+  'ModbusParameter',
+  'ModbusSchema',
+  'ModbusStatus',
+  'ModbusWait',
+  'AssetMessage',
+  'DeviceMessage',
 ]

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

@@ -14,6 +14,7 @@ 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):
@@ -35,6 +36,16 @@ class Asset(BaseModel):
   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.',
+  )
+
   @model_validator(mode='before')
   def _validate_model(cls: Self, data: dict[str, Any]) -> dict[str, Any]:
     """Validate model"""

{layrz_sdk-3.1.13 → layrz_sdk-3.1.15}/layrz_sdk/entities/case.py

@@ -41,7 +41,11 @@ class Case(BaseModel):
     """Validate model"""
     sequence = data.get('sequence')
     if sequence is not None and isinstance(sequence, int):
-      data['sequence'] = f'{data["trigger"].code}/{sequence}'
+      trigger = data['trigger']
+      if not isinstance(trigger, Trigger):
+        data['sequence'] = f'{trigger["code"]}/{data["pk"]}'
+      else:
+        data['sequence'] = f'{trigger.code}/{sequence}'
     else:
       data['sequence'] = f'GENERIC/{data["pk"]}'
 

{layrz_sdk-3.1.13 → layrz_sdk-3.1.15}/layrz_sdk/entities/device.py

@@ -2,6 +2,8 @@
 
 from pydantic import BaseModel, Field
 
+from .modbus import ModbusConfig
+
 
 class Device(BaseModel):
   """Device entity"""
@@ -9,5 +11,8 @@ class Device(BaseModel):
   pk: int = Field(description='Defines the primary key of the device')
   name: str = Field(description='Defines the name of the device')
   ident: str = Field(description='Defines the identifier of the device')
+  protocol_id: int = Field(description='Defines the protocol ID of the device')
   protocol: str = Field(description='Defines the protocol of the device')
   is_primary: bool = Field(default=False, description='Defines if the device is the primary device')
+
+  modbus: ModbusConfig | None = Field(default=None, description='Modbus configuration')

layrz_sdk-3.1.15/layrz_sdk/entities/modbus/__init__.py

@@ -0,0 +1,9 @@
+"""Modbus Models"""
+
+from .config import ModbusConfig
+from .parameter import ModbusParameter
+from .schema import ModbusSchema
+from .status import ModbusStatus
+from .wait import ModbusWait
+
+__all__ = ['ModbusConfig', 'ModbusParameter', 'ModbusSchema', 'ModbusStatus', 'ModbusWait']