wizata-dsapi 2.0.0.dev5__tar.gz → 2.0.0.dev7__tar.gz

{wizata_dsapi-2.0.0.dev5/wizata_dsapi.egg-info → wizata_dsapi-2.0.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.0.0.dev5
+Version: 2.0.0.dev7
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.0.0.dev5 → wizata_dsapi-2.0.0.dev7}/wizata_dsapi/__init__.py

@@ -50,6 +50,7 @@ from .streamlit_utils import (get_streamlit_token, get_streamlit_domain, get_str
                               get_streamlit_twin_id)
 
 from .search import FilterOperator, SearchQuery, SortOption, GroupSearchQuery
-from .notification import NotificationScope, DeviceToken, AlertRule, AlertActive
+from .notification import NotificationScope, DeviceToken, AlertRule, AlertActive, MonitoredDatapoint
 from .edge_device import EdgeDevice, EdgeDeviceStatus, EdgeDeviceType
-from .dashboard import Dashboard, DashboardType
+from .dashboard import Dashboard, DashboardType
+from .mobile_asset import MobileAssetTile, MobileAssetTileType, MobileAssetConfig

wizata_dsapi-2.0.0.dev7/wizata_dsapi/mobile_asset.py

@@ -0,0 +1,220 @@
+"""
+Mobile asset DTOs for tile and config persistence.
+
+MobileAssetTileType — tile visualization type:
+  - SENSOR: single datapoint live value
+  - CHART: time-series chart
+  - TABLE: tabular data view
+  - POLAR: polar/radar chart
+  - EVENT: event timeline
+
+MobileAssetTile — individual tile configuration scoped to a template
+  or a specific twin.
+
+MobileAssetConfig — per-asset or per-template display preferences
+  (hero metrics, anomaly ref, pinned twins).
+"""
+
+import json
+from datetime import datetime, timezone
+from enum import Enum
+from typing import Optional
+
+
+class MobileAssetTileType(str, Enum):
+    SENSOR = "sensor"
+    CHART = "chart"
+    TABLE = "table"
+    POLAR = "polar"
+    EVENT = "event"
+
+
+class MobileAssetTile:
+    """
+    Tile entity stored in PostgreSQL ``"MobileAssetTile"`` table.
+
+    PK is ``id`` (UUID, server-generated).
+
+    - ``template_id``: template scope (empty GUID for non-templated assets).
+    - ``twin_id``: NULL = template-scoped, set = twin-scoped override.
+    - ``type``: tile visualization type (sensor, chart, table, polar, event).
+    - ``label``: display label.
+    - ``sort_order``: sort position (0-based).
+    - ``config``: free-form JSON with type-specific settings.
+    """
+
+    def __init__(self):
+        self.id: Optional[str] = None
+        self.template_id: Optional[str] = None
+        self.twin_id: Optional[str] = None
+        self.type: Optional[MobileAssetTileType] = None
+        self.label: Optional[str] = None
+        self.sort_order: int = 0
+        self.config: Optional[dict] = None
+        self.created_by: Optional[str] = None
+        self.updated_at: Optional[datetime] = None
+
+    # ------------------------------------------------------------------
+    # Serialisation
+    # ------------------------------------------------------------------
+
+    def to_dict(self) -> dict:
+        obj = {}
+        if self.id is not None:
+            obj["id"] = str(self.id)
+        if self.template_id is not None:
+            obj["templateId"] = str(self.template_id)
+        if self.twin_id is not None:
+            obj["twinId"] = str(self.twin_id)
+        if self.type is not None:
+            obj["type"] = (
+                self.type.value
+                if isinstance(self.type, MobileAssetTileType)
+                else self.type
+            )
+        if self.label is not None:
+            obj["label"] = self.label
+        obj["sortOrder"] = self.sort_order
+        if self.config is not None:
+            obj["config"] = self.config
+        if self.created_by is not None:
+            obj["createdBy"] = self.created_by
+        if self.updated_at is not None:
+            obj["updatedAt"] = int(self.updated_at.timestamp() * 1000)
+        return obj
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "MobileAssetTile":
+        obj = cls()
+        obj.id = data.get("id")
+        obj.template_id = data.get("templateId") or data.get("template_id")
+        obj.twin_id = data.get("twinId") or data.get("twin_id")
+
+        raw_type = data.get("type")
+        if raw_type is not None:
+            obj.type = MobileAssetTileType(raw_type.lower())
+
+        obj.label = data.get("label")
+        obj.sort_order = data.get("sortOrder", data.get("sort_order", 0))
+
+        raw_config = data.get("config")
+        if isinstance(raw_config, dict):
+            obj.config = raw_config
+        elif isinstance(raw_config, str) and raw_config:
+            try:
+                parsed = json.loads(raw_config)
+                obj.config = parsed if isinstance(parsed, dict) else None
+            except (json.JSONDecodeError, ValueError):
+                obj.config = None
+
+        obj.created_by = data.get("createdBy") or data.get("created_by")
+
+        updated_raw = data.get("updatedAt") or data.get("updated_at")
+        if updated_raw is not None:
+            if isinstance(updated_raw, (int, float)):
+                obj.updated_at = datetime.fromtimestamp(updated_raw / 1000, tz=timezone.utc)
+            elif isinstance(updated_raw, datetime):
+                obj.updated_at = updated_raw
+        return obj
+
+    # ------------------------------------------------------------------
+    # API identity helpers
+    # ------------------------------------------------------------------
+
+    def api_id(self) -> str:
+        return str(self.id) if self.id else None
+
+    def api_key(self) -> str:
+        return str(self.id) if self.id else None
+
+    def set_id(self, value):
+        self.id = str(value)
+
+    def __repr__(self) -> str:
+        return (
+            f"MobileAssetTile(id={self.id!r}, label={self.label!r}, "
+            f"type={self.type!r}, template_id={self.template_id!r}, "
+            f"twin_id={self.twin_id!r})"
+        )
+
+
+class MobileAssetConfig:
+    """
+    Asset config entity stored in PostgreSQL ``"MobileAssetConfig"`` table.
+
+    PK is ``id`` (UUID, server-generated).
+
+    - ``template_id``: template scope.
+    - ``twin_id``: NULL = template default, set = twin override.
+    - ``config``: free-form JSON (heroMetricRefs, anomalyDatapointRef, pinnedTwinIds, etc.).
+    """
+
+    def __init__(self):
+        self.id: Optional[str] = None
+        self.template_id: Optional[str] = None
+        self.twin_id: Optional[str] = None
+        self.config: Optional[dict] = None
+        self.updated_at: Optional[datetime] = None
+
+    # ------------------------------------------------------------------
+    # Serialisation
+    # ------------------------------------------------------------------
+
+    def to_dict(self) -> dict:
+        obj = {}
+        if self.id is not None:
+            obj["id"] = str(self.id)
+        if self.template_id is not None:
+            obj["templateId"] = str(self.template_id)
+        if self.twin_id is not None:
+            obj["twinId"] = str(self.twin_id)
+        if self.config is not None:
+            obj["config"] = self.config
+        if self.updated_at is not None:
+            obj["updatedAt"] = int(self.updated_at.timestamp() * 1000)
+        return obj
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "MobileAssetConfig":
+        obj = cls()
+        obj.id = data.get("id")
+        obj.template_id = data.get("templateId") or data.get("template_id")
+        obj.twin_id = data.get("twinId") or data.get("twin_id")
+
+        raw_config = data.get("config")
+        if isinstance(raw_config, dict):
+            obj.config = raw_config
+        elif isinstance(raw_config, str) and raw_config:
+            try:
+                parsed = json.loads(raw_config)
+                obj.config = parsed if isinstance(parsed, dict) else None
+            except (json.JSONDecodeError, ValueError):
+                obj.config = None
+
+        updated_raw = data.get("updatedAt") or data.get("updated_at")
+        if updated_raw is not None:
+            if isinstance(updated_raw, (int, float)):
+                obj.updated_at = datetime.fromtimestamp(updated_raw / 1000, tz=timezone.utc)
+            elif isinstance(updated_raw, datetime):
+                obj.updated_at = updated_raw
+        return obj
+
+    # ------------------------------------------------------------------
+    # API identity helpers
+    # ------------------------------------------------------------------
+
+    def api_id(self) -> str:
+        return str(self.id) if self.id else None
+
+    def api_key(self) -> str:
+        return str(self.id) if self.id else None
+
+    def set_id(self, value):
+        self.id = str(value)
+
+    def __repr__(self) -> str:
+        return (
+            f"MobileAssetConfig(id={self.id!r}, "
+            f"template_id={self.template_id!r}, "
+            f"twin_id={self.twin_id!r})"
+        )

{wizata_dsapi-2.0.0.dev5 → wizata_dsapi-2.0.0.dev7}/wizata_dsapi/notification.py

@@ -297,4 +297,53 @@ class AlertActive:
         return (
             f"AlertActive(rule={self.alert_rule_id!r}, twin={self.twin_id!r}, "
             f"count={self.occurrence_count}, severity={self.severity})"
-        )
+        )
+
+
+class MonitoredDatapoint:
+    """
+    Registry entry for a datapoint flagged for monitoring.
+
+    Stored in PostgreSQL ``"MonitoredDatapoint"`` table.
+    PK is ``hardware_id`` (one row per datapoint).
+
+    The datapoint_monitor job reads this table and creates independent
+    AlertRule/AlertActive entries per event type (disconnected, out_of_range,
+    misconfigured).
+    """
+
+    def __init__(self, hardware_id: str = None):
+        self.hardware_id: Optional[str] = hardware_id
+        self.created_at: Optional[datetime] = None
+
+    def to_dict(self) -> dict:
+        obj = {}
+        if self.hardware_id is not None:
+            obj["hardwareId"] = self.hardware_id
+        if self.created_at is not None:
+            obj["createdAt"] = int(self.created_at.timestamp() * 1000)
+        return obj
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "MonitoredDatapoint":
+        obj = cls()
+        obj.hardware_id = data.get("hardwareId") or data.get("hardware_id")
+        raw = data.get("createdAt") or data.get("created_at")
+        if raw is not None:
+            if isinstance(raw, (int, float)):
+                obj.created_at = datetime.fromtimestamp(raw / 1000, tz=timezone.utc)
+            elif isinstance(raw, datetime):
+                obj.created_at = raw
+        return obj
+
+    def api_id(self) -> str:
+        return self.hardware_id
+
+    def api_key(self) -> str:
+        return self.hardware_id
+
+    def set_id(self, value):
+        self.hardware_id = str(value)
+
+    def __repr__(self) -> str:
+        return f"MonitoredDatapoint(hardware_id={self.hardware_id!r})"

wizata_dsapi-2.0.0.dev7/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.0.0.dev7"

{wizata_dsapi-2.0.0.dev5 → wizata_dsapi-2.0.0.dev7}/wizata_dsapi/wizata_dsapi_client.py

@@ -50,6 +50,7 @@ from .pipeline_image import PipelineImage
 from .solution_component import SolutionComponent, SolutionType
 from .paged_query_result import PagedQueryResult
 from .api_interface import ApiInterface
+from .mobile_asset import MobileAssetTile, MobileAssetConfig
 from .version import __version__
 import ast
 from .api_config import _registry
@@ -1015,14 +1016,14 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
 
         - existing models are used for simulation and prediction.
         - caution this might affect data inside platform or trigger automation.
-        - if your pipeline is templated please provide a twin.
+        - if your pipeline is templated please provide a twin hardware ID.
         - please provide all variables and parameters required through properties.
         - return an execution
             - check status with "wizata_dsapi.api().get(execution).status"
             - check results in platform (dashboard/explorer) or perform queries.
 
-        :param pipeline: pipeline identified by its id (uuid or wizata_dsapi.Pipeline) or key (str).
-        :param twin: twin identified by its id (uuid or wizata_dsapi.Twin) or hardware ID (str).
+        :param pipeline: pipeline identified by key (str) .
+        :param twin: twin identified by hardware ID (str)(optional).
         :param properties: dictionary containing override for variables or additional parameters for your script.
         :param train: train machine learning model on model steps.
         :param image: pipeline image id to use.
@@ -2079,6 +2080,122 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             self.__raise_error(response)
 
 
+    # ------------------------------------------------------------------
+    # Mobile Asset Tiles & Config
+    # ------------------------------------------------------------------
+
+    def get_mobile_tiles(self, template_id: str, twin_id: str = None) -> list:
+        """
+        Get merged tiles for an asset (template + twin overrides).
+
+        :param template_id: template UUID.
+        :param twin_id: optional twin UUID for twin-scoped overrides.
+        :return: list of MobileAssetTile.
+        """
+        params = {"templateId": str(template_id)}
+        if twin_id is not None:
+            params["twinId"] = str(twin_id)
+        response = requests.get(
+            self.__url() + "mobile/tiles",
+            headers=self.__header(),
+            params=params,
+        )
+        if response.status_code == 200:
+            return [MobileAssetTile.from_dict(t) for t in response.json()]
+        else:
+            raise self.__raise_error(response)
+
+    def create_mobile_tile(self, tile: MobileAssetTile) -> MobileAssetTile:
+        """
+        Create a mobile asset tile.
+
+        :param tile: MobileAssetTile to create.
+        :return: created MobileAssetTile with server-generated id.
+        """
+        response = requests.post(
+            self.__url() + "mobile/tiles",
+            headers=self.__header(),
+            data=json.dumps(tile.to_dict()),
+        )
+        if response.status_code in (200, 201):
+            return MobileAssetTile.from_dict(response.json())
+        else:
+            raise self.__raise_error(response)
+
+    def update_mobile_tile(self, tile: MobileAssetTile) -> MobileAssetTile:
+        """
+        Update an existing mobile asset tile.
+
+        :param tile: MobileAssetTile with id set.
+        :return: updated MobileAssetTile.
+        """
+        response = requests.put(
+            self.__url() + "mobile/tiles/" + str(tile.id),
+            headers=self.__header(),
+            data=json.dumps(tile.to_dict()),
+        )
+        if response.status_code == 200:
+            return MobileAssetTile.from_dict(response.json())
+        else:
+            raise self.__raise_error(response)
+
+    def delete_mobile_tile(self, tile_id: str):
+        """
+        Delete a mobile asset tile.
+
+        :param tile_id: tile UUID.
+        """
+        response = requests.delete(
+            self.__url() + "mobile/tiles/" + str(tile_id),
+            headers=self.__header(),
+        )
+        if response.status_code not in (200, 204):
+            raise self.__raise_error(response)
+
+    def get_mobile_config(self, template_id: str, twin_id: str = None) -> MobileAssetConfig:
+        """
+        Get resolved config for an asset (twin overrides template).
+
+        :param template_id: template UUID.
+        :param twin_id: optional twin UUID.
+        :return: MobileAssetConfig or None.
+        """
+        params = {"templateId": str(template_id)}
+        if twin_id is not None:
+            params["twinId"] = str(twin_id)
+        response = requests.get(
+            self.__url() + "mobile/config",
+            headers=self.__header(),
+            params=params,
+        )
+        if response.status_code == 200:
+            data = response.json()
+            if data is None:
+                return None
+            return MobileAssetConfig.from_dict(data)
+        elif response.status_code in (400, 404):
+            return None
+        else:
+            raise self.__raise_error(response)
+
+    def upsert_mobile_config(self, config: MobileAssetConfig) -> MobileAssetConfig:
+        """
+        Upsert mobile asset config by (templateId, twinId).
+
+        :param config: MobileAssetConfig to upsert.
+        :return: upserted MobileAssetConfig.
+        """
+        response = requests.put(
+            self.__url() + "mobile/config",
+            headers=self.__header(),
+            data=json.dumps(config.to_dict()),
+        )
+        if response.status_code in (200, 201):
+            return MobileAssetConfig.from_dict(response.json())
+        else:
+            raise self.__raise_error(response)
+
+
 def api() -> WizataDSAPIClient:
     """
     Create a WizataDSAPIClient from environment variables.

{wizata_dsapi-2.0.0.dev5 → wizata_dsapi-2.0.0.dev7/wizata_dsapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.0.0.dev5
+Version: 2.0.0.dev7
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.0.0.dev5 → wizata_dsapi-2.0.0.dev7}/wizata_dsapi.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ wizata_dsapi/group_system.py
 wizata_dsapi/ilogger.py
 wizata_dsapi/insight.py
 wizata_dsapi/mlmodel.py
+wizata_dsapi/mobile_asset.py
 wizata_dsapi/model_toolkit.py
 wizata_dsapi/notification.py
 wizata_dsapi/paged_query_result.py

wizata_dsapi-2.0.0.dev5/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.0.0.dev5"