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

DLMS_SPODES/cosem_interface_classes/implementations/profile_generic.py

@@ -1,83 +1,85 @@
-from ..profile_generic import ver0, ver1
-from ...types.implementations import structs, enums
-from ...types import ut, cdt
-
-
-class SPODES3ScalesProfile(ver1.ProfileGeneric):
-    """Cosem3 Для профилей масштаба"""
-    A_ELEMENTS = (
-        ver1.ic.ICAElement(
-            NAME=ver1.ProfileGeneric.A_ELEMENTS[0].NAME,
-            DATA_TYPE=ver1.ProfileGeneric.A_ELEMENTS[0].DATA_TYPE),
-        *ver1.ProfileGeneric.A_ELEMENTS[1:])
-    """override buffer with STATIC classifier"""
-
-
-class SPODES3CurrentProfile(ver1.ProfileGeneric):
-    """Cosem3 Б.1 Текущие значения"""
-    scaler_profile_key = bytes((1, 0, 94, 7, 3, 255))
-
-
-class SPODES3MonthProfile(ver1.ProfileGeneric):
-    """СПОДЭС3 В.4 Параметры ежемесячного профиля"""
-    scaler_profile_key = bytes((1, 0, 94, 7, 1, 255))
-
-
-class SPODES3DailyProfile(ver1.ProfileGeneric):
-    """СПОДЭС3 В.3 Параметры ежесуточного профиля"""
-    scaler_profile_key = bytes((1, 0, 94, 7, 2, 255))
-
-
-class SPODES3LoadProfile(ver1.ProfileGeneric):
-    """СПОДЭС3 В.2 Параметры профиля нагрузки"""
-    scaler_profile_key = bytes((1, 0, 94, 7, 4, 255))
-
-
-class CaptureObjectsDisplayReadout(ver1.CaptureObjects):
-    """for DisplayReadout special"""
-
-
-class SPODES3DisplayReadout(ver1.ProfileGeneric):
-    """СПОДЭС3 13.12. Настройка индикации"""
-    A_ELEMENTS = (ver1.ProfileGeneric.A_ELEMENTS[0],
-                  ver1.ProfileGeneric.A_ELEMENTS[1].get_change(data_type=CaptureObjectsDisplayReadout),
-                  ver1.ProfileGeneric.A_ELEMENTS[2],
-                  ver1.ProfileGeneric.A_ELEMENTS[3],
-                  ver1.ProfileGeneric.A_ELEMENTS[4],
-                  ver1.ProfileGeneric.A_ELEMENTS[5],
-                  ver1.ProfileGeneric.A_ELEMENTS[6])
-
-    def characteristics_init(self):
-        self.set_attr(ver0.BUFFER, None)
-        self.buffer.register_cb_preset(lambda _: self.__create_buffer_struct_type())  # value not used for creating struct type
-
-        self._cbs_attr_post_init.update({ver0.CAPTURE_OBJECTS: self.__create_buffer_struct_type})
-
-        self.buffer_capture_objects = self.capture_objects
-        """ objects for buffer. Change with access_selection """
-
-    def __create_buffer_struct_type(self):
-        """ TODO: more refactoring !!! """
-        # rename CaptureObjectDefinition's and adding object if it absense in collection
-        for el_value in self.capture_objects:
-            el_value: structs.CaptureObjectDefinition
-            obj = self.collection.add_if_missing(class_id=ut.CosemClassId(el_value.class_id.contents),
-                                                 version=None,
-                                                 logical_name=el_value.logical_name)
-            el_value.set_name(self.collection.get_name_and_type(el_value)[0][-1])
-        self.buffer_capture_objects = self.capture_objects
-        buffer_elements: list[cdt.StructElement] = list()
-        for el_value in self.buffer_capture_objects:
-            names, type_ = self.collection.get_name_and_type(el_value)
-            buffer_elements.append(cdt.StructElement(NAME=". ".join(names), TYPE=cdt.Boolean))
-
-        class Entry(cdt.Structure):
-            """ The number and the order of the elements of the structure holding the entries is the same as in the definition of the capture_objects.
-                The buffer is filled by auto captures or by subsequent calls of the method (capture). The sequence of the entries within the array is ordered
-                according to the sort method specified. Default: The buffer is empty after reset.
-                REMARK 1 Reading the entire buffer delivers only those entries, which are “in use”.
-                REMARK 2 The value of a captured object may be replaced by “null-data” if it can be unambiguously recovered from the previous value
-                (e.g. for time: if it can be calculated from the previous value and capture_period; or for a value: if it is equal to the previous value). """
-            ELEMENTS = tuple(buffer_elements)
-
-        self.buffer.set_type(Entry)
+from ..cosem_interface_class import ICAElement
+from ..profile_generic import ver0, ver1
+from ...types.implementations import structs, enums
+from ...types import ut, cdt
+
+
+class SPODES3ScalesProfile(ver1.ProfileGeneric):
+    """Cosem3 Для профилей масштаба"""
+    A_ELEMENTS = (
+        ICAElement(
+            i=2,
+            NAME=ver1.ProfileGeneric.A_ELEMENTS[0].NAME,
+            DATA_TYPE=ver1.ProfileGeneric.A_ELEMENTS[0].DATA_TYPE),
+        *ver1.ProfileGeneric.A_ELEMENTS[1:])
+    """override buffer with STATIC classifier"""
+
+
+class SPODES3CurrentProfile(ver1.ProfileGeneric):
+    """Cosem3 Б.1 Текущие значения"""
+    scaler_profile_key = bytes((1, 0, 94, 7, 3, 255))
+
+
+class SPODES3MonthProfile(ver1.ProfileGeneric):
+    """СПОДЭС3 В.4 Параметры ежемесячного профиля"""
+    scaler_profile_key = bytes((1, 0, 94, 7, 1, 255))
+
+
+class SPODES3DailyProfile(ver1.ProfileGeneric):
+    """СПОДЭС3 В.3 Параметры ежесуточного профиля"""
+    scaler_profile_key = bytes((1, 0, 94, 7, 2, 255))
+
+
+class SPODES3LoadProfile(ver1.ProfileGeneric):
+    """СПОДЭС3 В.2 Параметры профиля нагрузки"""
+    scaler_profile_key = bytes((1, 0, 94, 7, 4, 255))
+
+
+class CaptureObjectsDisplayReadout(ver1.CaptureObjects):
+    """for DisplayReadout special"""
+
+
+class SPODES3DisplayReadout(ver1.ProfileGeneric):
+    """СПОДЭС3 13.12. Настройка индикации"""
+    A_ELEMENTS = (ver1.ProfileGeneric.A_ELEMENTS[0],
+                  ver1.ProfileGeneric.A_ELEMENTS[1].get_change(data_type=CaptureObjectsDisplayReadout),
+                  ver1.ProfileGeneric.A_ELEMENTS[2],
+                  ver1.ProfileGeneric.A_ELEMENTS[3],
+                  ver1.ProfileGeneric.A_ELEMENTS[4],
+                  ver1.ProfileGeneric.A_ELEMENTS[5],
+                  ver1.ProfileGeneric.A_ELEMENTS[6])
+
+    def characteristics_init(self):
+        self.set_attr(ver0.BUFFER, None)
+        self.buffer.register_cb_preset(lambda _: self.__create_buffer_struct_type())  # value not used for creating struct type
+
+        self._cbs_attr_post_init.update({ver0.CAPTURE_OBJECTS: self.__create_buffer_struct_type})
+
+        self.buffer_capture_objects = self.capture_objects
+        """ objects for buffer. Change with access_selection """
+
+    def __create_buffer_struct_type(self):
+        """ TODO: more refactoring !!! """
+        # rename CaptureObjectDefinition's and adding object if it absense in collection
+        for el_value in self.capture_objects:
+            el_value: structs.CaptureObjectDefinition
+            obj = self.collection.add_if_missing(class_id=ut.CosemClassId(el_value.class_id.contents),
+                                                 version=None,
+                                                 logical_name=el_value.logical_name)
+            el_value.set_name(self.collection.get_name_and_type(el_value)[0][-1])
+        self.buffer_capture_objects = self.capture_objects
+        buffer_elements: list[cdt.StructElement] = list()
+        for el_value in self.buffer_capture_objects:
+            names, type_ = self.collection.get_name_and_type(el_value)
+            buffer_elements.append(cdt.StructElement(NAME=". ".join(names), TYPE=cdt.Boolean))
+
+        class Entry(cdt.Structure):
+            """ The number and the order of the elements of the structure holding the entries is the same as in the definition of the capture_objects.
+                The buffer is filled by auto captures or by subsequent calls of the method (capture). The sequence of the entries within the array is ordered
+                according to the sort method specified. Default: The buffer is empty after reset.
+                REMARK 1 Reading the entire buffer delivers only those entries, which are “in use”.
+                REMARK 2 The value of a captured object may be replaced by “null-data” if it can be unambiguously recovered from the previous value
+                (e.g. for time: if it can be calculated from the previous value and capture_period; or for a value: if it is equal to the previous value). """
+            ELEMENTS = tuple(buffer_elements)
+
+        self.buffer.set_type(Entry)

DLMS_SPODES/cosem_interface_classes/ipv4_setup.py

@@ -1,72 +1,42 @@
-from .__class_init__ import *
-from ..types.implementations import double_long_usingneds, arrays
-from .overview import VERSION_0
-
-
-class IPOptionsElement(cdt.Structure):
-    IP_Option_Type: cdt.Unsigned
-    IP_Option_Length: cdt.Unsigned
-    IP_Option_Data: cdt.OctetString
-
-
-class IPOptions(cdt.Array):
-    TYPE = IPOptionsElement
-
-
-class IPv4Setup(ic.COSEMInterfaceClasses):
-    """ This IC allows modelling the setup of teh IPv4 layer, handling all information related to the IP Address settings associated to a given device adn to a lower layer
-    connection on which these settings are used. There shall be and instance of this IC in a device for each different network interface implemented. For example, if a device has
-    two interfaces (using the TCP-UDP/ITv4 profile on both of them), there shall be two instances of the IPc4 setup IC in that device: one for each of these interfaces."""
-    CLASS_ID = ClassID.IPV4_SETUP
-    VERSION = VERSION_0
-    # TODO: more 7 attr and 3 methods
-    A_ELEMENTS = (ic.ICAElement("DL_reference", cst.LogicalName),
-                  ic.ICAElement("IP_address", double_long_usingneds.IPAddress),
-                  ic.ICAElement("multicast_IP_address", arrays.MulticastIPAddress),
-                  ic.ICAElement("IP_options", IPOptions),
-                  ic.ICAElement("subnet_mask", double_long_usingneds.IPAddress),
-                  ic.ICAElement("gateway_IP_address", double_long_usingneds.IPAddress),
-                  ic.ICAElement("use_DHCP_flag", cdt.Boolean),
-                  ic.ICAElement("primary_DNS_address", double_long_usingneds.IPAddress),
-                  ic.ICAElement("secondary_DNS_address", double_long_usingneds.IPAddress),
-                  # TODO: more 3 methods
-                  )
-
-    def characteristics_init(self):
-        self.set_attr(3, 3232235521)
-
-    @property
-    def DL_reference(self) -> cdt.OctetString:
-        return self.get_attr(2)
-
-    @property
-    def IP_address(self) -> double_long_usingneds.IPAddress:
-        return self.get_attr(3)
-
-    @property
-    def multicast_IP_address(self) -> arrays.MulticastIPAddress:
-        return self.get_attr(4)
-
-    @property
-    def IP_options(self) -> IPOptions:
-        return self.get_attr(5)
-
-    @property
-    def subnet_mask(self) -> double_long_usingneds.IPAddress:
-        return self.get_attr(6)
-
-    @property
-    def gateway_IP_address(self) -> double_long_usingneds.IPAddress:
-        return self.get_attr(7)
-
-    @property
-    def use_DHCP_flag(self) -> cdt.Boolean:
-        return self.get_attr(8)
-
-    @property
-    def primary_DNS_address(self) -> double_long_usingneds.IPAddress:
-        return self.get_attr(9)
-
-    @property
-    def secondary_DNS_address(self) -> double_long_usingneds.IPAddress:
-        return self.get_attr(10)
+from ..types.implementations import double_long_usingneds, arrays
+from typing import Optional
+from ..types import cdt, cst
+from .cosem_interface_class import ICAElement, ICAuto
+from .Overview import class_id
+
+
+class IPOptionsElement(cdt.Structure):
+    IP_Option_Type: cdt.Unsigned
+    IP_Option_Length: cdt.Unsigned
+    IP_Option_Data: cdt.OctetString
+
+
+class IPOptions(cdt.Array):
+    TYPE = IPOptionsElement
+
+
+class IPv4Setup(ICAuto):
+    """4.9.2 IPv4 setup"""
+    CLASS_ID = class_id.IPV4_SETUP
+    VERSION = 0
+    # TODO: more 3 methods
+    A_ELEMENTS = (ICAElement(2, "DL_reference", cst.LogicalName),
+                  ICAElement(3, "IP_address", double_long_usingneds.IPAddress),
+                  ICAElement(4, "multicast_IP_address", arrays.MulticastIPAddress),
+                  ICAElement(5, "IP_options", IPOptions),
+                  ICAElement(6, "subnet_mask", double_long_usingneds.IPAddress),
+                  ICAElement(7, "gateway_IP_address", double_long_usingneds.IPAddress),
+                  ICAElement(8, "use_DHCP_flag", cdt.Boolean),
+                  ICAElement(9, "primary_DNS_address", double_long_usingneds.IPAddress),
+                  ICAElement(10, "secondary_DNS_address", double_long_usingneds.IPAddress),
+                  # TODO: more 3 methods
+                  )
+    DL_reference: Optional[cdt.OctetString]
+    IP_address: Optional[double_long_usingneds.IPAddress]
+    multicast_IP_address: Optional[arrays.MulticastIPAddress]
+    IP_options: Optional[IPOptions]
+    subnet_mask: Optional[double_long_usingneds.IPAddress]
+    gateway_IP_address: Optional[double_long_usingneds.IPAddress]
+    use_DHCP_flag: Optional[cdt.Boolean]
+    primary_DNS_address: Optional[double_long_usingneds.IPAddress]
+    secondary_DNS_address: Optional[double_long_usingneds.IPAddress]

DLMS_SPODES/cosem_interface_classes/limiter.py

@@ -1,111 +1,77 @@
-from .. import cosem_interface_classes
-from .. import exceptions as exc
-from .__class_init__ import *
-from ..types import choices
-from ..types.implementations import structs, long_unsigneds, double_long_usingneds
-from .overview import VERSION_0
-
-
-threshold_scaler_unit = cdt.ScalUnitType(b'\x02\x02\x0f\x00\x16\x07')
-
-
-class ValueDefinitionType(cdt.Structure):
-    """ Defines an attribute of an object to be monitored. Only attributes with simple data types are allowed. """
-    class_id: cdt.LongUnsigned
-    logical_name: cst.LogicalName
-    attribute_index: cdt.Integer
-
-
-class EmergencyProfileType(cdt.Structure):
-    """ An emergency_profile is defined by three elements: emergency_profile_id, emergency_activation_time and emergency_duration.
-    An emergency profile is activated if the emergency_profile_id element matches one of the elements on the emergency_profile _group_id_list, and time matches the
-    emergency_activation_time and emergency_duration element """
-    emergency_profile_id: cdt.LongUnsigned
-    emergency_activation_time: cst.OctetStringDateTime
-    emergency_duration: double_long_usingneds.DoubleLongUnsignedSecond
-
-
-class EmergencyProfileGroupIdList(cdt.Array):
-    """ A list of group id-s of the emergency profile. The emergency profile can be activated only if emergency_profile_id element of the emergency_profile_type matches one of the
-    elements on the emergency_profile_group_id list """
-    TYPE = cdt.LongUnsigned
-
-
-class ActionType(cdt.Structure):
-    """ Defines the scripts to be executed when the monitored value crosses the threshold for minimal duration time. """
-    action_over_threshold: structs.ActionItem
-    action_under_threshold: structs.ActionItem
-
-
-class Limiter(ic.COSEMInterfaceClasses):
-    """ Instances of the Limiter interface class allow defining a set of actions that are executed when the value of a value attribute of a monitored object “Data”, “Register”,
-    “Extended Register”, “Demand Register”, etc. crosses the threshold value for at least minimal duration time.
-        The threshold value can be normal or emergency threshold. The emergency threshold is activated via the emergency profile defined by emergency profile id, activation start
-    time, and duration. The emergency profile id element is matched to an emergency profile group id: this mechanism enables the activation of the emergency threshold only
-    for a specific emergency group. """
-    CLASS_ID = ClassID.LIMITER
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("monitored_value", structs.ValueDefinition),
-                  ic.ICAElement("threshold_active", choices.simple_dt, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("threshold_normal", choices.simple_dt),
-                  ic.ICAElement("threshold_emergency", choices.simple_dt),
-                  ic.ICAElement("min_over_threshold_duration", double_long_usingneds.DoubleLongUnsignedSecond),
-                  ic.ICAElement("min_under_threshold_duration", double_long_usingneds.DoubleLongUnsignedSecond),
-                  ic.ICAElement("emergency_profile", EmergencyProfileType),
-                  ic.ICAElement("emergency_profile_group_id_list", EmergencyProfileGroupIdList),
-                  ic.ICAElement("emergency_profile_active", cdt.Boolean, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("actions", ActionType))
-
-    def characteristics_init(self):
-        self.set_attr(6, None)
-        self.set_attr(7, None)
-        self._cbs_attr_before_init.update({
-            3: lambda value: self.__validate_threshold_scaler_unit(3, value),
-            4: lambda value: self.__validate_threshold_scaler_unit(4, value),
-            5: lambda value: self.__validate_threshold_scaler_unit(5, value)})
-
-    @property
-    def monitored_value(self) -> structs.ValueDefinition:
-        return self.get_attr(2)
-
-    @property
-    def threshold_active(self) -> choices.simple_dt:
-        return self.get_attr(3)
-
-    @property
-    def threshold_normal(self) -> choices.simple_dt:
-        return self.get_attr(4)
-
-    @property
-    def threshold_emergency(self) -> choices.simple_dt:
-        return self.get_attr(5)
-
-    @property
-    def min_over_threshold_duration(self) -> double_long_usingneds.DoubleLongUnsignedSecond:
-        return self.get_attr(6)
-
-    @property
-    def min_under_threshold_duration(self) -> double_long_usingneds.DoubleLongUnsignedSecond:
-        return self.get_attr(7)
-
-    @property
-    def emergency_profile(self) -> EmergencyProfileType:
-        return self.get_attr(8)
-
-    @property
-    def emergency_profile_group_id_list(self) -> EmergencyProfileGroupIdList:
-        return self.get_attr(9)
-
-    @property
-    def emergency_profile_active(self) -> cdt.Boolean:
-        return self.get_attr(10)
-
-    @property
-    def actions(self) -> ActionType:
-        return self.get_attr(11)
-
-    def __validate_threshold_scaler_unit(self, index: int, value: cdt.CommonDataTypes):
-        if self.monitored_value is not None:
-            """let setup"""
-        else:
-            raise exc.EmptyObj(F"don't set attribute: {index} with {value=} because {self} monitored_value is empty")
+from .. import exceptions as exc
+from ..types import choices
+from ..types.implementations import structs
+from ..types.implementations import double_long_usingneds
+from typing import Optional
+from ..types import cdt, cst
+from .cosem_interface_class import ICAElement, ICAuto, Classifier
+from .Overview import class_id
+
+
+threshold_scaler_unit = cdt.ScalUnitType(b'\x02\x02\x0f\x00\x16\x07')
+
+
+class ValueDefinitionType(cdt.Structure):
+    """ Defines an attribute of an object to be monitored. Only attributes with simple data types are allowed. """
+    class_id: cdt.LongUnsigned
+    logical_name: cst.LogicalName
+    attribute_index: cdt.Integer
+
+
+class EmergencyProfileType(cdt.Structure):
+    """ An emergency_profile is defined by three elements: emergency_profile_id, emergency_activation_time and emergency_duration.
+    An emergency profile is activated if the emergency_profile_id element matches one of the elements on the emergency_profile _group_id_list, and time matches the
+    emergency_activation_time and emergency_duration element """
+    emergency_profile_id: cdt.LongUnsigned
+    emergency_activation_time: cst.OctetStringDateTime
+    emergency_duration: double_long_usingneds.DoubleLongUnsignedSecond
+
+
+class EmergencyProfileGroupIdList(cdt.Array):
+    """ A list of group id-s of the emergency profile. The emergency profile can be activated only if emergency_profile_id element of the emergency_profile_type matches one of the
+    elements on the emergency_profile_group_id list """
+    TYPE = cdt.LongUnsigned
+
+
+class ActionType(cdt.Structure):
+    """ Defines the scripts to be executed when the monitored value crosses the threshold for minimal duration time. """
+    action_over_threshold: structs.ActionItem
+    action_under_threshold: structs.ActionItem
+
+
+class Limiter(ICAuto):
+    """4.5.9 Limiter"""
+    CLASS_ID = class_id.LIMITER
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "monitored_value", structs.ValueDefinition),
+                  ICAElement(3, "threshold_active", choices.simple_dt, classifier=Classifier.DYNAMIC),
+                  ICAElement(4, "threshold_normal", choices.simple_dt),
+                  ICAElement(5, "threshold_emergency", choices.simple_dt),
+                  ICAElement(6, "min_over_threshold_duration", double_long_usingneds.DoubleLongUnsignedSecond),
+                  ICAElement(7, "min_under_threshold_duration", double_long_usingneds.DoubleLongUnsignedSecond),
+                  ICAElement(8, "emergency_profile", EmergencyProfileType),
+                  ICAElement(9, "emergency_profile_group_id_list", EmergencyProfileGroupIdList),
+                  ICAElement(10, "emergency_profile_active", cdt.Boolean, classifier=Classifier.DYNAMIC),
+                  ICAElement(11, "actions", ActionType))
+    monitored_value: Optional[structs.ValueDefinition]
+    threshold_active: Optional[choices.simple_dt]
+    threshold_normal: Optional[choices.simple_dt]
+    threshold_emergency: Optional[choices.simple_dt]
+    min_over_threshold_duration: Optional[double_long_usingneds.DoubleLongUnsignedSecond]
+    min_under_threshold_duration: Optional[double_long_usingneds.DoubleLongUnsignedSecond]
+    emergency_profile: Optional[EmergencyProfileType]
+    emergency_profile_group_id_list: Optional[EmergencyProfileGroupIdList]
+    emergency_profile_active: Optional[cdt.Boolean]
+    actions: Optional[ActionType]
+
+    def characteristics_init(self):
+        self._cbs_attr_before_init.update({
+            3: lambda value: self.__validate_threshold_scaler_unit(3, value),
+            4: lambda value: self.__validate_threshold_scaler_unit(4, value),
+            5: lambda value: self.__validate_threshold_scaler_unit(5, value)})
+
+    def __validate_threshold_scaler_unit(self, index: int, value: cdt.CommonDataTypes):
+        if self.monitored_value is not None:
+            """let setup"""
+        else:
+            raise exc.EmptyObj(F"don't set attribute: {index} with {value=} because {self} monitored_value is empty")