DLMS-SPODES 0.87.17__py3-none-any.whl → 0.88.1__py3-none-any.whl

DLMS_SPODES/cosem_interface_classes/arbitrator.py

@@ -1,105 +1,78 @@
-from .__class_init__ import *
-from ..types.implementations import structs, integers
-from .overview import VERSION_0
-
-
-class Actions(cdt.Array):
-    """ Array of key_data """
-    TYPE = structs.ActionItem
-
-
-class ActorPermissions(cdt.BitString):
-    """TODO: """
-
-
-class PermissionsTable(cdt.Array):
-    TYPE = ActorPermissions
-    __iter__: ActorPermissions
-    __get_item__: ActorPermissions
-
-
-class ActorActionWeight(cdt.LongUnsigned):
-    """TODO: make any thing"""
-
-
-class ActorWeightingList(cdt.Array):
-    TYPE = ActorActionWeight
-
-
-class WeightingsTable(cdt.Array):
-    TYPE = ActorWeightingList
-
-
-class MostRecentRequest(cdt.BitString):
-    """TODO: """
-
-
-class MostRecentRequestTable(cdt.Array):
-    TYPE = MostRecentRequest
-
-
-class RequestAction(cdt.Structure):
-    """Defines the actions that are requested by an actorDefines the actions that are requested by an actor"""
-    request_actor: cdt.Unsigned
-    request_action_list: cdt.BitString
-
-
-class Arbitrator(ic.COSEMInterfaceClasses):
-    """DLMS UA 1000-1 Ed. 14 4.5.12 Arbitrator"""
-    CLASS_ID = ClassID.ARBITRATOR
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("actions", Actions),
-                  ic.ICAElement("permission_table", PermissionsTable),
-                  ic.ICAElement("weightings_table", WeightingsTable),
-                  ic.ICAElement("most_recent_requests_table", MostRecentRequestTable, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("last_outcome", cdt.Unsigned, min=0, default=0, classifier=ic.Classifier.DYNAMIC))  # TODO: max = n what it?
-    M_ELEMENTS = (ic.ICMElement("request_action", RequestAction),
-                  ic.ICMElement("reset", integers.Only0))
-    actors: tuple[str] = tuple()
-    """name actors container"""
-
-    def characteristics_init(self):
-        self.set_attr(2, None)
-        self.actions.register_cb_post_set(self.__check_permission_table)
-        self.set_attr(3, None)
-        self.set_attr(4, None)
-        self.set_attr(5, None)
-
-    @property
-    def actions(self) -> Actions:
-        return self.get_attr(2)
-
-    @property
-    def permissions_table(self) -> PermissionsTable:
-        return self.get_attr(3)
-
-    @property
-    def weightings_table(self) -> WeightingsTable:
-        return self.get_attr(4)
-
-    @property
-    def most_recent_request_table(self) -> MostRecentRequestTable:
-        return self.get_attr(5)
-
-    @property
-    def last_outcome(self) -> cdt.Unsigned:
-        return self.get_attr(6)
-
-    @property
-    def request_action(self) -> RequestAction:
-        return self .get_meth(1)
-
-    @property
-    def reset(self) -> integers.Only0:
-        return self .get_meth(2)
-
-    def __check_permission_table(self):
-        """set length actor_permission be same as action array size if it not valid"""
-        if len(self.permissions_table) > 0:
-            for actor in self.permissions_table:
-                if len(actor) != len(self.actions):
-                    actor.set(ActorPermissions('0'*len(self.actions)))
-                else:
-                    """lenght is correct, change is not required """
-        else:
-            """not was loaded"""
+from ..types.implementations import structs
+from ..types.implementations import integers
+from typing import Optional
+from ..types import cdt
+from .cosem_interface_class import ICAElement, ICMElement, Classifier, ICAuto
+from .Overview import class_id
+
+
+class Actions(cdt.Array):
+    """ Array of key_data """
+    TYPE = structs.ActionItem
+
+
+class ActorPermissions(cdt.BitString):
+    """TODO: """
+
+
+class PermissionsTable(cdt.Array):
+    TYPE = ActorPermissions
+    __iter__: ActorPermissions
+    __get_item__: ActorPermissions
+
+
+class ActorActionWeight(cdt.LongUnsigned):
+    """TODO: make any thing"""
+
+
+class ActorWeightingList(cdt.Array):
+    TYPE = ActorActionWeight
+
+
+class WeightingsTable(cdt.Array):
+    TYPE = ActorWeightingList
+
+
+class MostRecentRequest(cdt.BitString):
+    """TODO: """
+
+
+class MostRecentRequestTable(cdt.Array):
+    TYPE = MostRecentRequest
+
+
+class RequestAction(cdt.Structure):
+    """Defines the actions that are requested by an actorDefines the actions that are requested by an actor"""
+    request_actor: cdt.Unsigned
+    request_action_list: cdt.BitString
+
+
+class Arbitrator(ICAuto):
+    """4.5.12 Arbitrator"""
+    CLASS_ID = class_id.ARBITRATOR
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "actions", Actions),
+                  ICAElement(3, "permission_table", PermissionsTable),
+                  ICAElement(4, "weightings_table", WeightingsTable),
+                  ICAElement(5, "most_recent_requests_table", MostRecentRequestTable, classifier=Classifier.DYNAMIC),
+                  ICAElement(6, "last_outcome", cdt.Unsigned, min=0, default=0, classifier=Classifier.DYNAMIC))  # TODO: max = n what it?
+    M_ELEMENTS = (ICMElement(1, "request_action", RequestAction),
+                  ICMElement(2, "reset", integers.INTEGER_0))
+    actors: tuple[str] = tuple()
+    """name actors container"""
+    actions: Optional[Actions]
+    permissions_table: Optional[PermissionsTable]
+    weightings_table: Optional[WeightingsTable]
+    most_recent_request_table: Optional[MostRecentRequestTable]
+    last_outcome: Optional[cdt.Unsigned]
+
+    def __check_permission_table(self):
+        """set length actor_permission be same as action array size if it not valid"""
+        if len(self.permissions_table) > 0:
+            for actor in self.permissions_table:
+                if len(actor) != len(self.actions):
+                    actor.set(ActorPermissions('0'*len(self.actions)))
+                else:
+                    """lenght is correct, change is not required """
+        else:
+            """not was loaded"""

DLMS_SPODES/cosem_interface_classes/association_ln/abstract.py

@@ -1,34 +1,50 @@
-from abc import ABC, abstractmethod
-from ...types import cdt
-
-
-class AccessMode(cdt.Enum, ABC):
-    """ TODO: """
-    @abstractmethod
-    def is_writable(self) -> bool:
-        ...
-
-    @abstractmethod
-    def is_readable(self) -> bool:
-        ...
-
-
-class AttributeAccessItem(cdt.Structure, ABC):
-    """ Implemented attribute and it access . Use in Association LN """
-    attribute_id: cdt.Integer
-    access_mode: AccessMode
-    access_selectors: cdt.NullData  # override in version
-
-    @abstractmethod
-    def abstract_marker(self):
-        """dummy abstract marker"""
-
-
-class AttributeAccessDescriptor(cdt.Array, ABC):
-    """ Array of attribute_access_item """
-    TYPE = AttributeAccessItem
-    """override this"""
-
-    @abstractmethod
-    def set_read_access(self, attribute_id: cdt.Integer):
-        """by attribute_id"""
+from abc import ABC, abstractmethod
+from typing import Protocol, runtime_checkable
+from ...types import cdt, cst, ut
+from ... import pdu_enums as pdu
+from ...types.type_alias import Obis
+
+
+class AccessMode(cdt.Enum, ABC):
+    """ TODO: """
+    @abstractmethod
+    def is_writable(self) -> bool:
+        ...
+
+    @abstractmethod
+    def is_readable(self) -> bool:
+        ...
+
+
+class AttributeAccessItem(cdt.Structure, ABC):
+    """ Implemented attribute and it access . Use in Association LN """
+    attribute_id: cdt.Integer
+    access_mode: AccessMode
+    access_selectors: cdt.NullData  # override in version
+
+    @abstractmethod
+    def abstract_marker(self):
+        """dummy abstract marker"""
+
+
+class AttributeAccessDescriptor(cdt.Array, ABC):
+    """ Array of attribute_access_item """
+    TYPE = AttributeAccessItem
+    """override this"""
+
+    @abstractmethod
+    def set_read_access(self, attribute_id: cdt.Integer):
+        """by attribute_id"""
+
+
+@runtime_checkable
+class ObjectListType(cdt._Array, Protocol):
+    """ Array of object_list_element. The range for the client_SAP is 0…0x7F. The range for the server_SAP is 0x000…0x3FFF."""
+
+    def is_writable(self, obis: Obis, indexes: set[int]) -> bool:
+        """ index - DLMS object attribute index.
+         True: AccessRight is WriteOnly or ReadAndWrite """
+
+    def get_attr_access(self, obis: Obis, index: int) -> pdu.AttributeAccess: ...
+
+    def get_meth_access(self, obis: Obis, index: int) -> pdu.MethodAccess: ...

DLMS_SPODES/cosem_interface_classes/association_ln/authentication_mechanism_name.py

@@ -1,25 +1,25 @@
-from functools import lru_cache
-from ...types import common_data_types as cdt
-from . import mechanism_id
-
-
-class AuthenticationMechanismName(cdt.Structure):
-    """ Contains the name of the authentication mechanism for the association (see IEC 62056-53). The authentication mechanism name is specified as an
-    OBJECT IDENTIFIER in 7.3.7.2 of IEC 62056-53. The authentication_mechanism_name attribute includes the arc labels of the OBJECT IDENTIFIER. """
-    DEFAULT = (2, 16, 756, 5, 8, 2, 0)
-    joint_iso_ctt_element: cdt.Unsigned
-    country_element: cdt.Unsigned
-    country_name_element: cdt.LongUnsigned
-    identified_organization_element: cdt.Unsigned
-    DLMS_UA_element: cdt.Unsigned
-    authentication_mechanism_name_element: cdt.Unsigned
-    mechanism_id_element: mechanism_id.MechanismIdElement
-
-    @classmethod
-    @lru_cache(maxsize=32)
-    def get_AARQ_mechanism_name(cls, cryptographic: int, algorithm_id: int) -> bytes:
-        """according to DLMS UA 1000-2 Ed. 10 9.4.2.2.4 Cryptographic algorithm ID-s"""
-        default = list(AuthenticationMechanismName.DEFAULT)
-        default[5] = cryptographic
-        default[6] = algorithm_id
-        return AuthenticationMechanismName(tuple(default)).get_a_xdr()
+from functools import lru_cache
+from ...types import common_data_types as cdt
+from . import mechanism_id
+
+
+class AuthenticationMechanismName(cdt.Structure):
+    """ Contains the name of the authentication mechanism for the association (see IEC 62056-53). The authentication mechanism name is specified as an
+    OBJECT IDENTIFIER in 7.3.7.2 of IEC 62056-53. The authentication_mechanism_name attribute includes the arc labels of the OBJECT IDENTIFIER. """
+    DEFAULT = (2, 16, 756, 5, 8, 2, 0)
+    joint_iso_ctt_element: cdt.Unsigned
+    country_element: cdt.Unsigned
+    country_name_element: cdt.LongUnsigned
+    identified_organization_element: cdt.Unsigned
+    DLMS_UA_element: cdt.Unsigned
+    authentication_mechanism_name_element: cdt.Unsigned
+    mechanism_id_element: mechanism_id.MechanismIdElement
+
+    @classmethod
+    @lru_cache(maxsize=32)
+    def get_AARQ_mechanism_name(cls, cryptographic: int, algorithm_id: int) -> bytes:
+        """according to DLMS UA 1000-2 Ed. 10 9.4.2.2.4 Cryptographic algorithm ID-s"""
+        default = list(AuthenticationMechanismName.DEFAULT)
+        default[5] = cryptographic
+        default[6] = algorithm_id
+        return AuthenticationMechanismName(tuple(default)).get_a_xdr()

DLMS_SPODES/cosem_interface_classes/association_ln/mechanism_id.py

@@ -1,25 +1,25 @@
-from ...types import cdt
-
-
-class MechanismIdElement(cdt.Enum, elements=tuple(range(8))):
-    TAG = b'\x11'
-
-
-class ConstantMixin:
-    """override raise for set"""
-    def set(self, *args, **kwargs):
-        raise AttributeError(F"not support <set> for {self.__class__.__name__} constant")
-
-
-class MechanismIdElementConst(ConstantMixin, MechanismIdElement):
-    """"""
-
-
-NONE = MechanismIdElementConst(0)
-LOW = MechanismIdElementConst(1)
-HIGH = MechanismIdElementConst(2)
-HIGH_MD5 = MechanismIdElementConst(3)
-HIGH_SHA1 = MechanismIdElementConst(4)
-HIGH_GMAC = MechanismIdElementConst(5)
-HIGH_SHA256 = MechanismIdElementConst(6)
-HIGH_ECDSA = MechanismIdElementConst(7)
+from ...types import cdt
+
+
+class MechanismIdElement(cdt.Enum, elements=tuple(range(8))):
+    TAG = b'\x11'
+
+
+class ConstantMixin:
+    """override raise for set"""
+    def set(self, *args, **kwargs):
+        raise AttributeError(F"not support <set> for {self.__class__.__name__} constant")
+
+
+class MechanismIdElementConst(ConstantMixin, MechanismIdElement):
+    """"""
+
+
+NONE = MechanismIdElementConst(0)
+LOW = MechanismIdElementConst(1)
+HIGH = MechanismIdElementConst(2)
+HIGH_MD5 = MechanismIdElementConst(3)
+HIGH_SHA1 = MechanismIdElementConst(4)
+HIGH_GMAC = MechanismIdElementConst(5)
+HIGH_SHA256 = MechanismIdElementConst(6)
+HIGH_ECDSA = MechanismIdElementConst(7)

DLMS_SPODES/cosem_interface_classes/association_ln/method.py

@@ -1,5 +1,5 @@
-from ...types import cdt
-
-
-class ReplyToHLSAuthentication(cdt.OctetString):
-    """"""  # todo: make validate by contents
+from ...types import cdt
+
+
+class ReplyToHLSAuthentication(cdt.OctetString):
+    """"""  # todo: make validate by contents