wizata-dsapi 2.0.0.dev4__tar.gz → 2.0.0.dev6__tar.gz

{wizata_dsapi-2.0.0.dev4/wizata_dsapi.egg-info → wizata_dsapi-2.0.0.dev6}/PKG-INFO

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

{wizata_dsapi-2.0.0.dev4 → wizata_dsapi-2.0.0.dev6}/wizata_dsapi/__init__.py

@@ -52,4 +52,5 @@ from .streamlit_utils import (get_streamlit_token, get_streamlit_domain, get_str
 from .search import FilterOperator, SearchQuery, SortOption, GroupSearchQuery
 from .notification import NotificationScope, DeviceToken, AlertRule, AlertActive
 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.dev6/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.dev4 → wizata_dsapi-2.0.0.dev6}/wizata_dsapi/twin.py

@@ -131,6 +131,8 @@ class Twin(ApiDto):
     :ivar uuid.UUID longitude_id: technical id of a datapoint specifying dynamic longitude of twin.
     :ivar str color: hexadecimal code of the color to associate with this twin item.
     :ivar str icon: logical id of the icon or svg schema to associate with this twin item.
+    :ivar bool is_asset: whether this twin represents an asset.
+    :ivar str image: image identifier or path associated with this twin.
     :ivar uuid.UUID createdById: unique identifier of creating user.
     :ivar int createdDate: timestamp of created date.
     :ivar uuid.UUID updatedById: unique identifier of updating user.
@@ -161,7 +163,9 @@ class Twin(ApiDto):
                  latitude: float = None,
                  longitude: float = None,
                  extra_properties: dict = None,
-                 description: str = None):
+                 description: str = None,
+                 is_asset: bool = None,
+                 image: str = None):
         if twin_id is None:
             self.twin_id = uuid.uuid4()
         else:
@@ -186,6 +190,8 @@ class Twin(ApiDto):
         self.color = color
         self.icon = icon
         self.extra_properties = extra_properties
+        self.is_asset = is_asset
+        self.image = image
         self.createdById = None
         self.createdDate = None
         self.updatedById = None
@@ -231,11 +237,22 @@ class Twin(ApiDto):
             self.description = str(obj["description"])
         if "type" in obj.keys():
             self.type = TwinBlockType(str(obj["type"]))
+        if "isAsset" in obj.keys() and obj["isAsset"] is not None:
+            self.is_asset = bool(obj["isAsset"])
+        if "image" in obj.keys() and obj["image"] is not None:
+            self.image = str(obj["image"])
         if "extraProperties" in obj.keys():
-            if isinstance(obj["extraProperties"], str):
-                self.extra_properties = json.loads(obj["extraProperties"])
+            raw = obj["extraProperties"]
+            if isinstance(raw, dict):
+                self.extra_properties = raw
+            elif isinstance(raw, str) and raw:
+                try:
+                    parsed = json.loads(raw)
+                    self.extra_properties = parsed if isinstance(parsed, dict) else None
+                except (json.JSONDecodeError, ValueError):
+                    self.extra_properties = None
             else:
-                self.extra_properties = obj["extraProperties"]
+                self.extra_properties = None
         if "createdById" in obj.keys() and obj["createdById"] is not None:
             self.createdById = obj["createdById"]
         if "createdDate" in obj.keys() and obj["createdDate"] is not None:
@@ -275,9 +292,11 @@ class Twin(ApiDto):
             obj["longitudeSensorId"] = str(self.longitude_id)
         if self.icon is not None:
             obj["icon"] = str(self.icon)
-        if self.extra_properties is not None:
-            if not isinstance(self.extra_properties, dict):
-                raise ValueError('on twin extra properties must be None or a JSON serializable dict')
+        if self.is_asset is not None:
+            obj["isAsset"] = self.is_asset
+        if self.image is not None:
+            obj["image"] = str(self.image)
+        if self.extra_properties is not None and isinstance(self.extra_properties, dict):
             obj["extraProperties"] = json.dumps(self.extra_properties)
         if self.createdById is not None:
             obj["createdById"] = str(self.createdById)

wizata_dsapi-2.0.0.dev6/wizata_dsapi/version.py

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

{wizata_dsapi-2.0.0.dev4 → wizata_dsapi-2.0.0.dev6}/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.
@@ -1695,68 +1696,27 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         else:
             raise self.__raise_error(response)
 
-    def search_twins(self,
-                     page: int = 1,
-                     size: int = 20,
-                     sort: str = "id",
-                     direction: str = "asc",
-                     hardware_id: str = None,
-                     name: str = None,
-                     parents: list = None) -> PagedQueryResult:
+    def search_twins(self, search_query=None) -> PagedQueryResult:
         """
-        get twins with a paged query.
-        :param page: numero of the page - default 1.
-        :param size: quantity per page - default 20 max 100.
-        :param sort: column to sort results - default id.
-        :param direction: sorting direction by default asc, accept also desc.
-        :param hardware_id: filter on a specific hardware ID name or partial name.
-        :param name: name or part of twin name.
-        :param parents: list of all possible parents (Twin, UUID, or str UUID).
-        :return: PagedQueryResults, check total for number of potential results and results for the list of entity.
-        """
-        query = PagedQueryResult(
-            page=page,
-            size=size,
-            sort=sort,
-            direction=direction
-        )
+        Search twins using filters, sorting and pagination via POST.
 
-        if sort not in ["id", "hardwareId", "createdDate", "createdById", "updatedDate", "updatedById",
-                        "name", "description"]:
-            raise ValueError("invalid sort column")
-
-        parameter_str = "?page=" + str(page) + "&size=" + str(size) + "&sort=" + str(sort) + "&direction=" + str(direction)
-        if hardware_id is not None:
-            parameter_str += "&hardwareId=" + sanitize_url_parameter(hardware_id)
-        if parents is not None and len(parents) > 0:
-            list_str = []
-            for parent in parents:
-                if isinstance(parent, uuid.UUID):
-                    list_str.append(str(parent))
-                elif isinstance(parent, str):
-                    list_str.append(parent)
-                elif isinstance(parent, Twin):
-                    list_str.append(str(parent.twin_id))
-                else:
-                    raise ValueError('parent must be a Twin or a str')
-            parameter_str += "&parentIds=" + sanitize_url_parameter(",".join(list_str))
-
-        if name is not None:
-            parameter_str += "&name=" + sanitize_url_parameter(name)
+        Supported filter fields:
+            hardwareId, name, description, parentId, twinTypeId, type, isAsset, _search.
 
-        response = requests.request("GET",
-                                    self.__url() + "twins/filter" + parameter_str,
-                                    headers=self.__header()
-                                    )
+        :param search_query: SearchQuery instance or dict with filters, sort, page, size.
+        :return: PagedQueryResult with Twin results.
+        """
+        if search_query is None:
+            search_query = SearchQuery()
+        elif isinstance(search_query, dict):
+            search_query = SearchQuery.from_dict(search_query)
+        response = requests.post(
+            self.__url() + "twins/search",
+            headers=self.__header(),
+            data=json.dumps(search_query.to_dict())
+        )
         if response.status_code == 200:
-            response_obj = response.json()
-            query.total = int(response_obj["total"])
-            query.results = []
-            for obj in response_obj["results"]:
-                twin = Twin()
-                twin.from_json(obj)
-                query.results.append(twin)
-            return query
+            return PagedQueryResult.from_dict(response.json(), dto_class=Twin)
         else:
             raise self.__raise_error(response)
 
@@ -2120,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.dev4 → wizata_dsapi-2.0.0.dev6/wizata_dsapi.egg-info}/PKG-INFO

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

{wizata_dsapi-2.0.0.dev4 → wizata_dsapi-2.0.0.dev6}/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.dev4/wizata_dsapi/version.py

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