from abc import abstractmethod
from typing import Type
from terminusgps.wialon import flags
from terminusgps.wialon.session import WialonSession
[docs]
class WialonBase:
def __init__(
self, id: str | int | None, session: WialonSession, *args, **kwargs
) -> None:
if isinstance(id, str) and not id.isdigit():
raise ValueError(f"'id' must be a digit. Got '{id}'.")
self._session = session
self._id = str(id if id else self.create(*args, **kwargs))
self.populate()
def __str__(self) -> str:
return str(self.id)
[docs]
def populate(self) -> None:
"""Retrieves and saves the latest data for the item from Wialon."""
response = self.session.wialon_api.core_search_item(
**{"id": str(self.id), "flags": 0x1}
)
if response is not None:
item = response.get("item", {})
self.name = item.get("nm")
self.hw_type = item.get("cls")
self.access_lvl = item.get("uacl")
@property
def session(self) -> WialonSession:
"""
A valid Wialon API session.
:type: :py:obj:`~terminusgps.wialon.session.WialonSession`
"""
return self._session
@property
def id(self) -> int | None:
"""
A unique Wialon ID.
:type: :py:obj:`int` | :py:obj:`None`
"""
return int(self._id) if self._id else None
[docs]
def has_access(self, other: Type["WialonBase"]) -> bool:
"""
Checks if this Wialon object has access to ``other``.
:type: :py:obj:`bool`
"""
response = self.session.wialon_api.core_check_accessors(
**{"items": [other.id], "flags": False}
)
return True if self.id in response.keys() else False
[docs]
@abstractmethod
def create(self, *args, **kwargs) -> int | None:
"""Creates a Wialon object and returns its id."""
raise NotImplementedError("Subclasses must implement this method.")
[docs]
def rename(self, new_name: str) -> None:
"""
Renames the Wialon object to the new name.
:param new_name: A new name.
:type new_name: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_name(
**{"itemId": self.id, "name": new_name}
)
[docs]
def add_afield(self, key: str, value: str) -> None:
"""
Adds an admin field to the Wialon object.
:param key: A key (name) for the admin field.
:type key: :py:obj:`str`
:param value: A value for the admin field.
:type value: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_admin_field(
**{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
)
[docs]
def update_afield(self, id: int, key: str, value: str) -> None:
"""
Updates an admin field by id.
:param id: The admin field id.
:type id: :py:obj:`int`
:param key: A key (name) for the admin field.
:type key: :py:obj:`str`
:param value: A value for the admin field.
:type value: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_admin_field(
**{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
)
[docs]
def add_cfield(self, key: str, value: str) -> None:
"""
Adds a custom field to the Wialon object.
:param key: A key (name) for the custom field.
:type key: :py:obj:`str`
:param value: A value for the custom field.
:type value: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_custom_field(
**{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
)
[docs]
def update_cfield(self, id: int, key: str, value: str) -> None:
"""
Updates a custom field by id.
:param id: The admin field id.
:type id: :py:obj:`int`
:param field: A key (name) for the custom field.
:type field: :py:obj:`str`
:param field: A value for the custom field.
:type field: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_custom_field(
**{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
)
[docs]
def add_cproperty(self, key: str, value: str) -> None:
"""
Adds a custom property to the Wialon object.
:param key: A key (name) for the custom property.
:type key: :py:obj:`str`
:param value: A value for the custom property.
:type value: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_custom_property(
**{"itemId": self.id, "name": key, "value": value}
)
[docs]
def add_profile_field(self, key: str, value: str) -> None:
"""
Adds a profile field to the Wialon object.
:param key: A key (name) for the profile field.
:type key: :py:obj:`str`
:param value: A value for the profile field.
:type value: :py:obj:`str`
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_update_profile_field(
**{"itemId": self.id, "n": key, "v": value}
)
[docs]
def delete(self) -> None:
"""
Deletes the Wialon object.
:raises WialonError: If something goes wrong with Wialon.
:returns: Nothing.
:rtype: :py:obj:`None`
"""
self.session.wialon_api.item_delete_item(**{"itemId": self.id})
@property
def cfields(self) -> dict[str, str]:
"""Custom fields for the Wialon object."""
response = self.session.wialon_api.core_search_item(
**{"id": self.id, "flags": flags.DATAFLAG_UNIT_CUSTOM_FIELDS}
)
fields = response.get("item", {}).get("flds") if response is not None else {}
return {field["n"]: field["v"] for field in fields.values()} if fields else {}
@property
def afields(self) -> dict[str, str]:
"""Admin fields for the Wialon object."""
response = self.session.wialon_api.core_search_item(
**{"id": self.id, "flags": flags.DATAFLAG_UNIT_ADMIN_FIELDS}
)
fields = response.get("item", {}).get("aflds") if response is not None else {}
return {field["n"]: field["v"] for field in fields.values()} if fields else {}