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

DLMS_SPODES/cosem_interface_classes/gsm_diagnostic/ver1.py

@@ -1,40 +1,42 @@
-from ..__class_init__ import *
-from . import ver0
-
-
-class PSStatus(cdt.Enum, elements=tuple(range(7))):
-    """ Indicates the packet switched status of the modem. """
-
-
-class CellInfoType(cdt.Structure):
-    """ Params of element """
-    cell_ID: cdt.DoubleLongUnsigned
-    location_ID: cdt.LongUnsigned
-    signal_quality: ver0.SignalQuality
-    ber: cdt.Unsigned
-    mcc: cdt.LongUnsigned
-    mnc: cdt.LongUnsigned
-    channel_number: cdt.DoubleLongUnsigned
-
-
-class AdjacentCellInfo(cdt.Structure):
-    cell_ID: cdt.DoubleLongUnsigned
-    signal_quality: ver0.SignalQuality
-
-
-class AdjacentCells(cdt.Array):
-    TYPE = AdjacentCellInfo
-
-
-class GSMDiagnostic(ver0.GSMDiagnostic):
-    A_ELEMENTS = (ver0.GSMDiagnostic.get_attr_element(2),
-                  ver0.GSMDiagnostic.get_attr_element(3),
-                  ver0.GSMDiagnostic.get_attr_element(4),
-                  ic.ICAElement("ps_status", PSStatus, 0, 255, 0, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("cell_info", CellInfoType, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("adjacent_cell", AdjacentCells, classifier=ic.Classifier.DYNAMIC),
-                  ver0.GSMDiagnostic.get_attr_element(8))
-
-    # def __new__(cls, *args, **kwargs):
-    #     raise ValueError(F"version: {__name__[-1]} of {cls.__class__.__name__} not support framework")
-
+from . import ver0
+from typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement, Classifier
+
+
+class PSStatus(cdt.Enum, elements=tuple(range(7))):
+    """ Indicates the packet switched status of the modem. """
+
+
+class CellInfoType(cdt.Structure):
+    """ Params of element """
+    cell_ID: cdt.DoubleLongUnsigned
+    location_ID: cdt.LongUnsigned
+    signal_quality: ver0.SignalQuality
+    ber: cdt.Unsigned
+    mcc: cdt.LongUnsigned
+    mnc: cdt.LongUnsigned
+    channel_number: cdt.DoubleLongUnsigned
+
+
+class AdjacentCellInfo(cdt.Structure):
+    cell_ID: cdt.DoubleLongUnsigned
+    signal_quality: ver0.SignalQuality
+
+
+class AdjacentCells(cdt.Array):
+    TYPE = AdjacentCellInfo
+
+
+class GSMDiagnostic(ver0.GSMDiagnostic):
+    VERSION = 1
+    A_ELEMENTS = (ver0.GSMDiagnostic.getAElement(2).unwrap(),
+                  ver0.GSMDiagnostic.getAElement(3).unwrap(),
+                  ver0.GSMDiagnostic.getAElement(4).unwrap(),
+                  ICAElement(5, "ps_status", PSStatus, 0, 255, 0, classifier=Classifier.DYNAMIC),
+                  ICAElement(6, "cell_info", CellInfoType, classifier=Classifier.DYNAMIC),
+                  ICAElement(7, "adjacent_cell", AdjacentCells, classifier=Classifier.DYNAMIC),
+                  ver0.GSMDiagnostic.getAElement(8).unwrap())
+    ps_status: Optional[PSStatus]
+    cell_info: Optional[CellInfoType]
+    adjacent_cell: Optional[AdjacentCells]

DLMS_SPODES/cosem_interface_classes/gsm_diagnostic/ver2.py

@@ -1,9 +1,6 @@
-from ..__class_init__ import *
-
-
-class GSMDiagnostic(ic.COSEMInterfaceClasses):
-    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 . import ver1
+
+
+class GSMDiagnostic(ver1.GSMDiagnostic):
+    def __new__(cls, *args, **kwargs):
+        raise ValueError(F"version: {__name__[-1]} of {cls.__class__.__name__} not support framework")

DLMS_SPODES/cosem_interface_classes/iec_hdlc_setup/ver0.py

@@ -1,11 +1,11 @@
-from ..__class_init__ import *
-
-
-class IECHDLCSetup(ic.COSEMInterfaceClasses):
-    CLASS_ID = ClassID.IEC_HDLC_SETUP
-
-    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 ICAElement, Classifier, ICAuto
+from ..Overview import class_id
+
+
+class IECHDLCSetup(ICAuto):
+    CLASS_ID = class_id.IEC_HDLC_SETUP
+    A_ELEMENTS = ()
+    M_ELEMENTS = ()
+
+    def __new__(cls, *args, **kwargs):
+        raise ValueError(F"version: {__name__[-1]} of {cls.__class__.__name__} not support framework")

DLMS_SPODES/cosem_interface_classes/iec_hdlc_setup/ver1.py

@@ -1,53 +1,27 @@
-from collections import deque
-from ..__class_init__ import *
-from ...types.implementations.enums import CommSpeed
-from ..overview import VERSION_0
-
-
-class IECHDLCSetup(ic.COSEMInterfaceClasses):
-    """ This IC allows modelling and configuring communication channels according to Clause 8 of DLMS UA 1000-2 Ed. 8.0:2014. Several communication cnannels can be configured. """
-    CLASS_ID = ClassID.IEC_HDLC_SETUP
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("comm_speed", CommSpeed, 0, 9, 5),
-                  ic.ICAElement("windows_size_transmit", cdt.Unsigned, 1, 7, 1),
-                  ic.ICAElement("windows_size_receive", cdt.Unsigned, 1, 7, 1),
-                  ic.ICAElement("max_info_field_length_transmit", cdt.LongUnsigned, 128, 32, 2030),
-                  ic.ICAElement("max_info_field_length_receive", cdt.LongUnsigned, 128, 32, 2030),
-                  ic.ICAElement("inter_octet_time_out", cdt.LongUnsigned, 20, 6000, 25),
-                  ic.ICAElement("inactivity_time_out", cdt.LongUnsigned, 0, default=120),
-                  ic.ICAElement("device_address", cdt.LongUnsigned, 0x0001, 0x3ffd, default=0x10))  # TODO: not according by BlueBook: need default, minimum is other
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def comm_speed(self) -> CommSpeed:
-        return self.get_attr(2)
-
-    @property
-    def windows_size_transmit(self) -> cdt.Unsigned:
-        return self.get_attr(3)
-
-    @property
-    def windows_size_receive(self) -> cdt.Unsigned:
-        return self.get_attr(4)
-
-    @property
-    def max_info_field_length_transmit(self) -> cdt.LongUnsigned:
-        return self.get_attr(5)
-
-    @property
-    def max_info_field_length_receive(self) -> cdt.LongUnsigned:
-        return self.get_attr(6)
-
-    @property
-    def inter_octet_time_out(self) -> cdt.LongUnsigned:
-        return self.get_attr(7)
-
-    @property
-    def inactivity_time_out(self) -> cdt.LongUnsigned:
-        return self.get_attr(8)
-
-    @property
-    def device_address(self) -> cdt.LongUnsigned:
-        return self.get_attr(9)
+from typing import Optional
+from ...types import cdt
+from ...types.implementations.enums import CommSpeed
+from ..cosem_interface_class import ICAElement, ICAuto
+from ..Overview import class_id
+
+
+class IECHDLCSetup(ICAuto):
+    """4.7.2 IEC HDLC setup"""
+    CLASS_ID = class_id.IEC_HDLC_SETUP
+    VERSION = 1
+    A_ELEMENTS = (ICAElement(2, "comm_speed", CommSpeed, 0, 9, 5),
+                  ICAElement(3, "windows_size_transmit", cdt.Unsigned, 1, 7, 1),
+                  ICAElement(4, "windows_size_receive", cdt.Unsigned, 1, 7, 1),
+                  ICAElement(5, "max_info_field_length_transmit", cdt.LongUnsigned, 128, 32, 2030),
+                  ICAElement(6, "max_info_field_length_receive", cdt.LongUnsigned, 128, 32, 2030),
+                  ICAElement(7, "inter_octet_time_out", cdt.LongUnsigned, 20, 6000, 25),
+                  ICAElement(8, "inactivity_time_out", cdt.LongUnsigned, 0, default=120),
+                  ICAElement(9, "device_address", cdt.LongUnsigned, 0x0001, 0x3ffd, default=0x10))  # TODO: not according by BlueBook: need default, minimum is other
+    comm_speed: Optional[CommSpeed]
+    windows_size_transmit: Optional[cdt.Unsigned]
+    windows_size_receive: Optional[cdt.Unsigned]
+    max_info_field_length_transmit: Optional[cdt.LongUnsigned]
+    max_info_field_length_receive: Optional[cdt.LongUnsigned]
+    inter_octet_time_out: Optional[cdt.LongUnsigned]
+    inactivity_time_out: Optional[cdt.LongUnsigned]
+    device_address: Optional[cdt.LongUnsigned]

DLMS_SPODES/cosem_interface_classes/iec_local_port_setup.py

@@ -1,11 +1,9 @@
-from ..cosem_interface_classes import cosem_interface_class as ic
-from .overview import ClassID, VERSION_1
-
-
-class IECLocalPortSetup(ic.COSEMInterfaceClasses):
-    """ This IC allows modelling the configuration of communication ports using the protocols specified in IEC 62056-21:2002. Several ports can be configured. """
-    CLASS_ID = ClassID.IEC_LOCAL_PORT_SETUP
-    VERSION = VERSION_1
-
-    def characteristics_init(self) -> None:
-        """# TODO: not released ... """
+from .cosem_interface_class import ICAuto, Cardinality
+from .Overview import class_id
+
+
+class IECLocalPortSetup(ICAuto):
+    """ This IC allows modelling the configuration of communication ports using the protocols specified in IEC 62056-21:2002. Several ports can be configured. """
+    CLASS_ID = class_id.IEC_LOCAL_PORT_SETUP
+    VERSION = 1
+    CARDINALITY = Cardinality()

DLMS_SPODES/cosem_interface_classes/image_transfer/image_transfer_status.py

@@ -1,15 +1,15 @@
-from ...types import cdt
-
-
-class ImageTransferStatus(cdt.Enum, elements=tuple(range(8))):
-    """ Holds the status of the Image transfer process. """
-
-
-TRANSFER_NOT_INITIATED = ImageTransferStatus(0)
-TRANSFER_INITIATED = ImageTransferStatus(1)
-VERIFICATION_INITIATED = ImageTransferStatus(2)
-VERIFICATION_SUCCESSFUL = ImageTransferStatus(3)
-VERIFICATION_FAILED = ImageTransferStatus(4)
-ACTIVATION_INITIATED = ImageTransferStatus(5)
-ACTIVATION_SUCCESSFUL = ImageTransferStatus(6)
-ACTIVATION_FAILED = ImageTransferStatus(7)
+from ...types import cdt
+
+
+class ImageTransferStatus(cdt.Enum, elements=tuple(range(8))):
+    """ Holds the status of the Image transfer process. """
+
+
+TRANSFER_NOT_INITIATED = ImageTransferStatus(0)
+TRANSFER_INITIATED = ImageTransferStatus(1)
+VERIFICATION_INITIATED = ImageTransferStatus(2)
+VERIFICATION_SUCCESSFUL = ImageTransferStatus(3)
+VERIFICATION_FAILED = ImageTransferStatus(4)
+ACTIVATION_INITIATED = ImageTransferStatus(5)
+ACTIVATION_SUCCESSFUL = ImageTransferStatus(6)
+ACTIVATION_FAILED = ImageTransferStatus(7)

DLMS_SPODES/cosem_interface_classes/image_transfer/ver0.py

@@ -1,126 +1,54 @@
-from ..__class_init__ import *
-from ...types.implementations import integers
-from . image_transfer_status import ImageTransferStatus
-from ..overview import VERSION_0
-
-
-class ImageToActivateInfoElement(cdt.Structure):
-    image_to_activate_size: cdt.DoubleLongUnsigned
-    image_to_activate_identification: cdt.OctetString
-    image_to_activate_signature: cdt.OctetString
-
-
-class ImageToActivateInfo(cdt.Array):
-    """ Provides information on the Image(s) ready for activation. It is generated as the result of the Image verification process. Thi client may check this information before
-    activating the Images. """
-    TYPE = ImageToActivateInfoElement
-    __getitem__: ImageToActivateInfoElement
-
-
-class ImageTransferInitiate(cdt.Structure):
-    """ Initializes the Image transfer process. After a successful invocation of the method the image_transfer_status attribute is set to (1) and the
-    image_first_not_transferred_block_number is set to 0. Any subsequent invocation of the method resets the whole Image transfer process and all ImageBlocks need to be
-    transferred again. """
-    DEFAULT = (bytearray(b'default'), 0)
-    image_identifier: cdt.OctetString
-    image_size: cdt.DoubleLongUnsigned
-
-
-class ImageBlockTransfer(cdt.Structure):
-    """ Transfers one block of the Image to the server. After a successful invocation of the method the corresponding bit in the image_transferred_block_status attribute
-    is set to 1 and the image_first_bit_transferred_block_number attribute is updated """
-    image_block_number: cdt.DoubleLongUnsigned
-    image_block_value: cdt.OctetString
-
-
-class ImageTransfer(ic.COSEMInterfaceClasses):
-    """ Instance of the Image transfer IC model the process of transferring binary files, called Images to COSEM servers. """
-    CLASS_ID = ClassID.IMAGE_TRANSFER
-    VERSION = VERSION_0
-    __blocks_for_update: list[bytearray]
-    A_ELEMENTS = (ic.ICAElement("image_block_size", cdt.DoubleLongUnsigned),
-                  ic.ICAElement("image_transferred_blocks_status", cdt.BitString, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("image_first_not_transferred_block_number", cdt.DoubleLongUnsigned, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("image_transfer_enabled", cdt.Boolean),
-                  ic.ICAElement("image_transfer_status", ImageTransferStatus, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("image_to_activate_info", ImageToActivateInfo, classifier=ic.Classifier.DYNAMIC))
-    M_ELEMENTS = (ic.ICMElement("image_transfer_initiate", ImageTransferInitiate),
-                  ic.ICMElement("image_block_transfer", ImageBlockTransfer),
-                  ic.ICMElement("image_verify", integers.Only0),
-                  ic.ICMElement("image_activate", integers.Only0))
-
-    def characteristics_init(self):
-        # TODO: compare image_block_size with ServerMaxReceive
-        self.__blocks_for_update = list()
-        """ container of blocks for transfer """
-
-    @property
-    def image_block_size(self) -> cdt.DoubleLongUnsigned:
-        return self.get_attr(2)
-
-    @property
-    def image_transferred_blocks_status(self) -> cdt.BitString:
-        return self.get_attr(3)
-
-    @property
-    def image_first_not_transferred_block_number(self) -> cdt.DoubleLongUnsigned:
-        return self.get_attr(4)
-
-    @property
-    def image_transfer_enabled(self) -> cdt.Boolean:
-        return self.get_attr(5)
-
-    @property
-    def image_transfer_status(self) -> ImageTransferStatus:
-        return self.get_attr(6)
-
-    @property
-    def image_to_activate_info(self) -> ImageToActivateInfo:
-        return self.get_attr(7)
-
-    @property
-    def image_transfer_initiate(self) -> ImageTransferInitiate:
-        return self.get_meth(1)
-
-    @property
-    def image_block_transfer(self) -> ImageBlockTransfer:
-        return self.get_meth(2)
-
-    @property
-    def image_verify(self) -> integers.Only0:
-        return self.get_meth(3)
-
-    @property
-    def image_activate(self) -> integers.Only0:
-        return self.get_meth(4)
-
-    @property
-    def current_block_transfer(self) -> int:
-        return int(self.image_block_transfer.image_block_number)
-
-    def get_n_blocks(self) -> int:
-        """get sum of blocks"""
-        return len(self.__blocks_for_update)
-
-    def set_next_block(self):
-        """ set next block transfer """
-        try:
-            # TODO: USE bitstring of BlockStatus if it exist(length order by image) for pretty next block
-            self.set_block_for_transfer(self.current_block_transfer+1)
-        except IndexError:
-            raise StopIteration
-
-    def set_block_for_transfer(self, index: int):
-        """ set block transfer number. IndexError if index more when blocks size """
-        if index > (len(self.__blocks_for_update) - 1):
-            raise IndexError(F"got block {index=}, expected 0..{len(self.__blocks_for_update)-1}")
-        self.image_block_transfer.set((index, self.__blocks_for_update[index]))
-
-    @property
-    def is_image_exist(self) -> bool:
-        """ show is existing image in container """
-        return bool(len(self.__blocks_for_update))
-
-    def clear_image(self):
-        """ clear image container """
-        self.__blocks_for_update.clear()
+from ...types.implementations import integers
+from . image_transfer_status import ImageTransferStatus
+from typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement, ICMElement, ICAuto, Classifier
+from ..Overview import class_id
+
+
+class ImageToActivateInfoElement(cdt.Structure):
+    """image_to_activate_info_element"""
+    image_to_activate_size: cdt.DoubleLongUnsigned
+    image_to_activate_identification: cdt.OctetString
+    image_to_activate_signature: cdt.OctetString
+
+
+class ImageToActivateInfo(cdt.Array):
+    """image_to_activate_info attribute"""
+    TYPE = ImageToActivateInfoElement
+    __getitem__: ImageToActivateInfoElement
+
+
+class ImageTransferInitiate(cdt.Structure):
+    """image_transfer_initiate method"""
+    DEFAULT = (bytearray(b'default'), 0)
+    image_identifier: cdt.OctetString
+    image_size: cdt.DoubleLongUnsigned
+
+
+class ImageBlockTransfer(cdt.Structure):
+    """image_block_transfer method"""
+    image_block_number: cdt.DoubleLongUnsigned
+    image_block_value: cdt.OctetString
+
+
+class ImageTransfer(ICAuto):
+    """4.4.6 Image transfer"""
+    CLASS_ID = class_id.IMAGE_TRANSFER
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "image_block_size", cdt.DoubleLongUnsigned),
+                  ICAElement(3, "image_transferred_blocks_status", cdt.BitString, classifier=Classifier.DYNAMIC),
+                  ICAElement(4, "image_first_not_transferred_block_number", cdt.DoubleLongUnsigned, classifier=Classifier.DYNAMIC),
+                  ICAElement(5, "image_transfer_enabled", cdt.Boolean),
+                  ICAElement(6, "image_transfer_status", ImageTransferStatus, classifier=Classifier.DYNAMIC),
+                  ICAElement(7, "image_to_activate_info", ImageToActivateInfo, classifier=Classifier.DYNAMIC))
+    M_ELEMENTS = (ICMElement(1, "image_transfer_initiate", ImageTransferInitiate),
+                  ICMElement(2, "image_block_transfer", ImageBlockTransfer),
+                  ICMElement(3, "image_verify", integers.Only0),
+                  ICMElement(4, "image_activate", integers.Only0))
+    image_block_size: Optional[cdt.DoubleLongUnsigned]
+    image_transferred_blocks_status: Optional[cdt.BitString]
+    image_first_not_transferred_block_number: Optional[cdt.DoubleLongUnsigned]
+    image_transfer_enabled: Optional[cdt.Boolean]
+    image_transfer_status: Optional[ImageTransferStatus]
+    image_to_activate_info: Optional[ImageToActivateInfo]

DLMS_SPODES/cosem_interface_classes/implementations/__init__.py

@@ -1,3 +1,3 @@
-from . import data
-from . import arbitrator
-from . import profile_generic
+from . import data
+from . import arbitrator
+from . import profile_generic

DLMS_SPODES/cosem_interface_classes/implementations/arbitrator.py

@@ -1,19 +1,19 @@
-from ..arbitrator import Arbitrator
-from ... import settings
-
-
-match settings.get_current_language():
-    case settings.Language.ENGLISH:        from ...Values.EN import actors
-    case settings.Language.RUSSIAN:        from ...Values.RU import actors
-
-
-class SPODES3Arbitrator(Arbitrator):
-    """Cosem3 7.3.18"""
-    actors = (actors.MANUAL,
-              actors.LOCAL_1,
-              actors.LOCAL_2,
-              actors.LOCAL_3,
-              actors.LOCAL_4,
-              actors.LOCAL_5,
-              actors.LOCAL_6,
-              actors.LOCAL_7)
+from ..arbitrator import Arbitrator
+from ... import settings
+
+
+match settings.get_current_language():
+    case settings.Language.ENGLISH:        from ...Values.EN import actors
+    case settings.Language.RUSSIAN:        from ...Values.RU import actors
+
+
+class SPODES3Arbitrator(Arbitrator):
+    """Cosem3 7.3.18"""
+    actors = (actors.MANUAL,
+              actors.LOCAL_1,
+              actors.LOCAL_2,
+              actors.LOCAL_3,
+              actors.LOCAL_4,
+              actors.LOCAL_5,
+              actors.LOCAL_6,
+              actors.LOCAL_7)