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

DLMS_SPODES/cosem_interface_classes/association_ln/ver1.py

@@ -1,133 +1,126 @@
-from . import ver0
-from ...types import choices
-from ... import exceptions as exc
-from ..__class_init__ import *
-from ...types.implementations import structs, arrays
-from . import authentication_mechanism_name
-from . import abstract
-from ..overview import VERSION_1
-
-
-class AccessMode(abstract.AccessMode, elements=tuple(range(7))):
-    """Version 0 extension"""
-    def is_writable(self) -> bool:
-        return True if int(self) in (2, 3, 5, 6) else False
-
-    def is_readable(self) -> bool:
-        return True if int(self) in (1, 3, 4, 6) else False
-
-
-class AccessModeMeth(cdt.Enum, elements=(0, 1, 2)):
-    """ Enum of access mode for methods """
-
-
-# TODO: make as subclass of ver0
-class AttributeAccessItem(abstract.AttributeAccessItem):
-    """ Implemented attribute and it access . Use in Association LN """
-    attribute_id: cdt.Integer
-    access_mode: AccessMode
-    access_selectors: choices.access_selectors
-
-    def abstract_marker(self):
-        ...
-
-
-class AttributeAccessDescriptor(abstract.AttributeAccessDescriptor):
-    """ Array of attribute_access_item """
-    TYPE = AttributeAccessItem
-
-    def set_read_access(self, attribute_id: cdt.Integer):
-        it: AttributeAccessItem
-        for it in self:
-            if it.attribute_id == attribute_id:
-                it.access_mode.set(1)
-                break
-        else:
-            self.append(AttributeAccessItem((attribute_id, AccessMode.parse("1"), None)))
-
-
-# TODO: make as subclass of ver0
-class MethodAccessItem(cdt.Structure):
-    """ Implemented method and it access . Use in Association LN """
-    method_id: cdt.Integer
-    access_mode: AccessModeMeth
-
-
-class MethodAccessDescriptor(cdt.Array):
-    """ Contain all implemented methods """
-    TYPE = MethodAccessItem
-
-
-class AccessRight(cdt.Structure):
-    """ TODO: """
-    attribute_access: AttributeAccessDescriptor
-    method_access: MethodAccessDescriptor
-
-
-class ObjectListElement(structs.ObjectListElement, access_rights=AccessRight):
-    """"""
-
-
-class ObjectListType(ver0.ObjectListType):
-    TYPE = ObjectListElement
-
-    def is_writable(self, ln: cst.LogicalName, indexes: set[int]) -> bool:
-        """ index - DLMS object attribute index.
-         True: AccessRight is WriteOnly or ReadAndWrite """
-        el: ObjectListElement = next(filter(lambda it: it.logical_name == ln, self), None)
-        if el is None:
-            raise exc.NoObject(F"not find {ln} in object_list")
-        item: AttributeAccessItem
-        for index in indexes:
-            for item in el.access_rights.attribute_access:
-                if int(item.attribute_id) == index:
-                    if int(item.access_mode) not in (2, 3, 5, 6):
-                        return False
-                    else:
-                        break
-                else:
-                    continue
-            else:
-                raise ValueError(F"not find in {ln} attribute index: {index}")
-        return True
-
-
-class ContextNameType(cdt.AXDR, ver0.ApplicationContextName):
-    """ In the COSEM environment, it is intended that an application context pre-exists and is referenced by its name during the establishment of an
-    application association. This attribute contains the name of the application context for that association."""
-    DEFAULT = b'\x09\x07\x60\x85\x74\x05\x08\x01\x01'
-
-
-class MechanismNameType(cdt.AXDR, authentication_mechanism_name.AuthenticationMechanismName):
-    """ In the COSEM environment, it is intended that an application context pre-exists and is referenced by its name during the establishment of an
-    application association. This attribute contains the name of the application context for that association."""
-    DEFAULT = b'\x09\x07\x60\x85\x74\x05\x08\x02\x00'
-
-
-class AssociationLN(ver0.AssociationLN):
-    """5.4.6 Association LN"""
-    VERSION = VERSION_1
-    A_ELEMENTS = (ic.ICAElement("object_list", ObjectListType, selective_access=ver0.SelectiveAccessDescriptor),
-                  ver0.AssociationLN.get_attr_element(3),  # associated_partners_id
-                  ic.ICAElement("application_context_name", ContextNameType),
-                  ver0.AssociationLN.get_attr_element(5),  # xDLMS_context_info
-                  ic.ICAElement("authentication_mechanism_name", MechanismNameType),
-                  ic.ICAElement("secret", ver0.LLCSecret),  # TODO: make new class Secret(LLC_Secret)
-                  ver0.AssociationLN.get_attr_element(8),  # association_status
-                  ic.ICAElement("security_setup_reference", cst.LogicalName))
-    M_ELEMENTS = (ver0.AssociationLN.get_meth_element(1),
-                  ver0.AssociationLN.get_meth_element(2),
-                  ic.ICMElement("add_object", ObjectListElement),
-                  ic.ICMElement("remove_object", ObjectListElement))
-    object_list: ObjectListType
-    application_context_name: ContextNameType
-    authentication_mechanism_name: MechanismNameType
-    security_setup_reference: cst.LogicalName
-    add_object: ObjectListElement
-    remove_object: ObjectListElement
-
-    def characteristics_init(self):
-        super(AssociationLN, self).characteristics_init()
-        # References a "Security setup" object by its logical name. The referenced object manages security for a given "Association LN" object
-        # instance.
-        self.set_attr(9, None)
+from . import ver0
+from ... import exceptions as exc
+from ...types.implementations import structs
+from . import authentication_mechanism_name
+from . import abstract
+from ...types import choices, cdt, cst
+from ..cosem_interface_class import ICAElement, ICMElement
+
+
+class AccessMode(abstract.AccessMode, elements=tuple(range(7))):
+    """Version 0 extension"""
+    def is_writable(self) -> bool:
+        return True if int(self) in (2, 3, 5, 6) else False
+
+    def is_readable(self) -> bool:
+        return True if int(self) in (1, 3, 4, 6) else False
+
+
+class AccessModeMeth(cdt.Enum, elements=(0, 1, 2)):
+    """ Enum of access mode for methods """
+
+
+# TODO: make as subclass of ver0
+class AttributeAccessItem(abstract.AttributeAccessItem):
+    """ Implemented attribute and it access . Use in Association LN """
+    attribute_id: cdt.Integer
+    access_mode: AccessMode
+    access_selectors: choices.access_selectors
+
+    def abstract_marker(self):
+        ...
+
+
+class AttributeAccessDescriptor(abstract.AttributeAccessDescriptor):
+    """ Array of attribute_access_item """
+    TYPE = AttributeAccessItem
+
+    def set_read_access(self, attribute_id: cdt.Integer):
+        it: AttributeAccessItem
+        for it in self:
+            if it.attribute_id == attribute_id:
+                it.access_mode.set(1)
+                break
+        else:
+            self.append(AttributeAccessItem((attribute_id, AccessMode.parse("1"), None)))
+
+
+# TODO: make as subclass of ver0
+class MethodAccessItem(cdt.Structure):
+    """ Implemented method and it access . Use in Association LN """
+    method_id: cdt.Integer
+    access_mode: AccessModeMeth
+
+
+class MethodAccessDescriptor(cdt.Array):
+    """ Contain all implemented methods """
+    TYPE = MethodAccessItem
+
+
+class AccessRight(cdt.Structure):
+    """ TODO: """
+    attribute_access: AttributeAccessDescriptor
+    method_access: MethodAccessDescriptor
+
+
+class ObjectListElement(structs.ObjectListElement, access_rights=AccessRight):
+    """"""
+
+
+class ObjectListType(ver0.ObjectListType):
+    TYPE = ObjectListElement
+
+    def is_writable(self, ln: cst.LogicalName, indexes: set[int]) -> bool:
+        """ index - DLMS object attribute index.
+         True: AccessRight is WriteOnly or ReadAndWrite """
+        el: ObjectListElement = next(filter(lambda it: it.logical_name == ln, self), None)
+        if el is None:
+            raise exc.NoObject(F"not find {ln} in object_list")
+        item: AttributeAccessItem
+        for index in indexes:
+            for item in el.access_rights.attribute_access:
+                if int(item.attribute_id) == index:
+                    if int(item.access_mode) not in (2, 3, 5, 6):
+                        return False
+                    else:
+                        break
+                else:
+                    continue
+            else:
+                raise ValueError(F"not find in {ln} attribute index: {index}")
+        return True
+
+
+class ContextNameType(cdt.AXDR, ver0.ApplicationContextName):
+    """ In the COSEM environment, it is intended that an application context pre-exists and is referenced by its name during the establishment of an
+    application association. This attribute contains the name of the application context for that association."""
+    DEFAULT = b'\x09\x07\x60\x85\x74\x05\x08\x01\x01'
+
+
+class MechanismNameType(cdt.AXDR, authentication_mechanism_name.AuthenticationMechanismName):
+    """ In the COSEM environment, it is intended that an application context pre-exists and is referenced by its name during the establishment of an
+    application association. This attribute contains the name of the application context for that association."""
+    DEFAULT = b'\x09\x07\x60\x85\x74\x05\x08\x02\x00'
+
+
+class AssociationLN(ver0.AssociationLN):
+    """5.4.6 Association LN"""
+    VERSION = 1
+    A_ELEMENTS = (ICAElement(2, "object_list", ObjectListType, selective_access=ver0.SelectiveAccessDescriptor),
+                  ver0.AssociationLN.getAElement(3).unwrap(),  # associated_partners_id
+                  ICAElement(4, "application_context_name", ContextNameType),
+                  ver0.AssociationLN.getAElement(5).unwrap(),  # xDLMS_context_info
+                  ICAElement(6, "authentication_mechanism_name", MechanismNameType),
+                  ICAElement(7, "secret", ver0.LLCSecret),  # TODO: make new class Secret(LLC_Secret)
+                  ver0.AssociationLN.getAElement(8).unwrap(),  # association_status
+                  ICAElement(9, "security_setup_reference", cst.LogicalName))
+    M_ELEMENTS = (ver0.AssociationLN.getMElement(1).unwrap(),
+                  ver0.AssociationLN.getMElement(2).unwrap(),
+                  ICMElement(3, "add_object", ObjectListElement),
+                  ICMElement(4, "remove_object", ObjectListElement))
+    object_list: ObjectListType
+    application_context_name: ContextNameType
+    authentication_mechanism_name: MechanismNameType
+    security_setup_reference: cst.LogicalName
+    add_object: ObjectListElement
+    remove_object: ObjectListElement

DLMS_SPODES/cosem_interface_classes/association_ln/ver2.py

@@ -1,36 +1,30 @@
-from ..__class_init__ import *
-from . import ver0, ver1
-from ...types.implementations import structs, arrays
-from ..overview import VERSION_2
-
-
-class AssociationLN(ver1.AssociationLN):
-    """5.4.7 Association LN"""
-    VERSION = VERSION_2
-    A_ELEMENTS = (
-        ver1.AssociationLN.get_attr_element(2),  # <object_list>
-        ver0.AssociationLN.get_attr_element(3),  # associated_partners_id
-        ver0.AssociationLN.get_attr_element(4),  # application_context_name
-        ver0.AssociationLN.get_attr_element(5),  # xDLMS_context_info
-        ver0.AssociationLN.get_attr_element(6),  # authentication_mechanism_name
-        ver1.AssociationLN.get_attr_element(7),  # secret
-        ver0.AssociationLN.get_attr_element(8),  # association_status
-        ver1.AssociationLN.get_attr_element(9),  # security_setup_reference
-        ic.ICAElement("user_list", arrays.UserList),
-        ic.ICAElement("current_user", structs.UserListEntry),
-    )
-    M_ELEMENTS = (
-        ver0.AssociationLN.get_meth_element(1),
-        ver0.AssociationLN.get_meth_element(2),
-        ver1.AssociationLN.get_meth_element(3),  # add_object
-        ver1.AssociationLN.get_meth_element(4),  # remove_object
-        ic.ICMElement("add_user", structs.UserListEntry),
-        ic.ICMElement("remove_user", structs.UserListEntry),
-    )
-    user_list: arrays.UserList
-    current_user: structs.UserListEntry
-
-    def characteristics_init(self):
-        super(AssociationLN, self).characteristics_init()
-        # TODO: more 2 attribute
-        # TODO: more 2 methods
+from . import ver0, ver1
+from ...types.implementations import arrays, structs
+from ...types.type_alias import Attr
+from ..cosem_interface_class import ICAElement, ICMElement
+
+class AssociationLN(ver1.AssociationLN):
+    """5.4.7 Association LN"""
+    VERSION = 2
+    A_ELEMENTS = (
+        ver1.AssociationLN.getAElement(2).unwrap(),  # <object_list>
+        ver0.AssociationLN.getAElement(3).unwrap(),  # associated_partners_id
+        ver0.AssociationLN.getAElement(4).unwrap(),  # application_context_name
+        ver0.AssociationLN.getAElement(5).unwrap(),  # xDLMS_context_info
+        ver0.AssociationLN.getAElement(6).unwrap(),  # authentication_mechanism_name
+        ver1.AssociationLN.getAElement(7).unwrap(),  # secret
+        ver0.AssociationLN.getAElement(8).unwrap(),  # association_status
+        ver1.AssociationLN.getAElement(9).unwrap(),  # security_setup_reference
+        ICAElement(10, "user_list", arrays.UserList),
+        ICAElement(11, "current_user", structs.UserListEntry),
+    )
+    M_ELEMENTS = (
+        ver0.AssociationLN.getMElement(1).unwrap(),
+        ver0.AssociationLN.getMElement(2).unwrap(),
+        ver1.AssociationLN.getMElement(3).unwrap(),  # add_object
+        ver1.AssociationLN.getMElement(4).unwrap(),  # remove_object
+        ICMElement(5, "add_user", structs.UserListEntry),
+        ICMElement(6, "remove_user", structs.UserListEntry),
+    )
+    user_list: Attr
+    current_user: Attr

DLMS_SPODES/cosem_interface_classes/association_ln/ver3.py

@@ -1,4 +1,3 @@
-class AssociationLN:
-    def __init__(self):
-        raise ValueError(F"version: {__name__[-1]} of {self.__class__.__name__} not support framework")
-
+class AssociationLN:
+    def __init__(self):
+        raise ValueError(F"version: {__name__[-1]} of {self.__class__.__name__} not support framework")

DLMS_SPODES/cosem_interface_classes/association_sn/ver0.py

@@ -1,12 +1,14 @@
-from ..__class_init__ import *
-
-
-class AssociationSN(ic.COSEMInterfaceClasses):
-    """dummy class"""
-    CLASS_ID = ClassID.ASSOCIATION_SN
-
-    def __new__(cls, *args, **kwargs):
-        raise ValueError(F"version: {__name__[-1]} of {cls.__class__.__name__} not support framework")
-
-    def characteristics_init(self):
-        """ initiate all attributes and methods of class """
+from ..cosem_interface_class import ICAuto, ICAElement, Classifier, Cardinality
+from ..Overview import class_id
+
+
+class AssociationSN(ICAuto):
+    """dummy class"""
+    VERSION = 0
+    A_ELEMENTS = ()
+    M_ELEMENTS = ()
+    CLASS_ID = class_id.ASSOCIATION_SN
+    CARDINALITY = Cardinality()
+
+    def __new__(cls, *args, **kwargs):
+        raise ValueError(F"version: {__name__[-1]} of {cls.__class__.__name__} not support framework")

DLMS_SPODES/cosem_interface_classes/clock.py

@@ -1,131 +1,81 @@
-import datetime
-from .__class_init__ import *
-from ..types.implementations import integers
-from .overview import VERSION_0
-
-
-class ClockStatus(cdt.Unsigned):
-    """ interpreted as 8 bit string """
-
-    # TODO: finish write as bit_string
-    def __str__(self):
-        value = int.from_bytes(self.contents, 'big')
-        ret = ''
-        if bool(value & 0b1):
-            ret += ' invalid value'
-        if bool(value & 0b10):
-            ret += ' doubtful value'
-        if bool(value & 0b100):
-            ret += ' different clock base'
-        if bool(value & 0b1000):
-            ret += ' invalid clock status'
-        if bool(value & 0b1000000):
-            ret += ' daylight saving active'
-        if ret == '':
-            ret = 'empty'
-        return ret
-
-
-class DaylightSavingsDeviation(cdt.Integer, min=-120, max=120):
-    """Contains the number of minutes by which the deviation in generalized time must be corrected at daylight savings begin.
-    Deviation range of up to ± 120 min"""
-
-
-class ClockBase(cdt.Enum, elements=(0, 1, 2, 3, 4, 5)):
-    """ Defines where the basic timing information comes from. """
-
-
-class PresetAdjustingTime(cdt.Structure):
-    """ Presets the time to a new value (preset_time) and defines a validity_interval within which the new time can be activated """
-    DEFAULT = b'\x02\x03\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff' \
-              b'\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff'
-    preset_time: cdt.DateTime
-    validity_interval_start: cdt.DateTime
-    validity_interval_end: cdt.DateTime
-
-
-class ShiftTime(cdt.Long, min=-900, max=900):
-    """ Limited Long -900..900 """
-
-
-class TimeZone(cdt.Long):
-    """"""
-
-
-class Clock(ic.COSEMInterfaceClasses):
-    """4.5.1 Clock"""
-    CLASS_ID = ClassID.CLOCK
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("time", cst.OctetStringDateTime, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("time_zone", TimeZone, -720, 840),
-                  ic.ICAElement("status", ClockStatus, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("daylight_savings_begin", cst.OctetStringDateTime),
-                  ic.ICAElement("daylight_savings_end", cst.OctetStringDateTime),
-                  ic.ICAElement("daylight_savings_deviation", DaylightSavingsDeviation, -120, 120),
-                  ic.ICAElement("daylight_savings_enabled", cdt.Boolean),
-                  ic.ICAElement("clock_base", ClockBase))
-    M_ELEMENTS = (ic.ICMElement("adjust_to_quarter", integers.Only0),
-                  ic.ICMElement("adjust_to_measuring_period", integers.Only0),
-                  ic.ICMElement("adjust_to_minute", integers.Only0),
-                  ic.ICMElement("adjust_to_preset_time", integers.Only0),
-                  ic.ICMElement("preset_adjusting_time", PresetAdjustingTime),
-                  ic.ICMElement("shift_time", ShiftTime))
-
-    def characteristics_init(self):
-        ...
-
-    @property
-    def time(self) -> cst.OctetStringDateTime:
-        return self.get_attr(2)
-
-    @property
-    def time_zone(self) -> cdt.Long:
-        return self.get_attr(3)
-
-    @property
-    def status(self) -> ClockStatus:
-        return self.get_attr(4)
-
-    @property
-    def daylight_savings_begin(self) -> cst.OctetStringDateTime:
-        return self.get_attr(5)
-
-    @property
-    def daylight_savings_end(self) -> cst.OctetStringDateTime:
-        return self.get_attr(6)
-
-    @property
-    def daylight_savings_deviation(self) -> DaylightSavingsDeviation:
-        return self.get_attr(7)
-
-    @property
-    def daylight_savings_enabled(self) -> cdt.Boolean:
-        return self.get_attr(8)
-
-    @property
-    def clock_base(self) -> ClockBase:
-        return self.get_attr(9)
-
-    @property
-    def adjust_to_quarter(self) -> integers.Only0:
-        return self.get_meth(1)
-
-    @property
-    def adjust_to_measuring_period(self) -> integers.Only0:
-        return self.get_meth(2)
-
-    @property
-    def adjust_to_minute(self) -> integers.Only0:
-        return self.get_meth(3)
-
-    @property
-    def adjust_to_preset_time(self) -> integers.Only0:
-        return self.get_meth(4)
-
-    @property
-    def preset_adjusting_time(self) -> PresetAdjustingTime:
-        return self.get_meth(5)
-
-    @property
-    def shift_time(self) -> ShiftTime:
-        return self.get_meth(6)
+from typing import Optional
+from ..types import cdt, cst
+from ..types.implementations import integers
+from .Overview import class_id
+from .cosem_interface_class import ICAuto, ICAElement, ICMElement, Classifier
+
+
+class ClockStatus(cdt.Unsigned):
+    """ interpreted as 8 bit string """
+
+    # TODO: finish write as bit_string
+    def __str__(self) -> str:
+        value = int.from_bytes(self.contents, 'big')
+        ret = ''
+        if bool(value & 0b1):
+            ret += ' invalid value'
+        if bool(value & 0b10):
+            ret += ' doubtful value'
+        if bool(value & 0b100):
+            ret += ' different clock base'
+        if bool(value & 0b1000):
+            ret += ' invalid clock status'
+        if bool(value & 0b1000000):
+            ret += ' daylight saving active'
+        if ret == '':
+            ret = 'empty'
+        return ret
+
+
+class DaylightSavingsDeviation(cdt.Integer, min=-120, max=120):
+    """Contains the number of minutes by which the deviation in generalized time must be corrected at daylight savings begin.
+    Deviation range of up to ± 120 min"""
+
+
+class ClockBase(cdt.Enum, elements=(0, 1, 2, 3, 4, 5)):
+    """ Defines where the basic timing information comes from. """
+
+
+class PresetAdjustingTime(cdt.Structure):
+    """ Presets the time to a new value (preset_time) and defines a validity_interval within which the new time can be activated """
+    DEFAULT = b'\x02\x03\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff' \
+              b'\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff\x19\x07\xe4\x01\x01\xff\xff\xff\xff\xff\x80\x00\xff'
+    preset_time: cdt.DateTime
+    validity_interval_start: cdt.DateTime
+    validity_interval_end: cdt.DateTime
+
+
+class ShiftTime(cdt.Long, min=-900, max=900):
+    """ Limited Long -900..900 """
+
+
+class TimeZone(cdt.Long):
+    """"""
+
+
+class Clock(ICAuto):
+    """4.5.1 Clock"""
+    CLASS_ID = class_id.CLOCK
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "time", cst.OctetStringDateTime, classifier=Classifier.DYNAMIC),
+                  ICAElement(3, "time_zone", TimeZone, -720, 840),
+                  ICAElement(4, "status", ClockStatus, classifier=Classifier.DYNAMIC),
+                  ICAElement(5, "daylight_savings_begin", cst.OctetStringDateTime),
+                  ICAElement(6, "daylight_savings_end", cst.OctetStringDateTime),
+                  ICAElement(7, "daylight_savings_deviation", DaylightSavingsDeviation, -120, 120),
+                  ICAElement(8, "daylight_savings_enabled", cdt.Boolean),
+                  ICAElement(9, "clock_base", ClockBase))
+    M_ELEMENTS = (ICMElement(1, "adjust_to_quarter", integers.Only0),
+                  ICMElement(2, "adjust_to_measuring_period", integers.Only0),
+                  ICMElement(3, "adjust_to_minute", integers.Only0),
+                  ICMElement(4, "adjust_to_preset_time", integers.Only0),
+                  ICMElement(5, "preset_adjusting_time", PresetAdjustingTime),
+                  ICMElement(6, "shift_time", ShiftTime))
+    time: Optional[cst.OctetStringDateTime]
+    time_zone: Optional[TimeZone]
+    status: Optional[ClockStatus]
+    daylight_savings_begin: Optional[cst.OctetStringDateTime]
+    daylight_savings_end: Optional[cst.OctetStringDateTime]
+    daylight_savings_deviation: Optional[DaylightSavingsDeviation]
+    daylight_savings_enabled: Optional[cdt.Boolean]
+    clock_base: Optional[ClockBase]