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

DLMS_SPODES/cosem_interface_classes/modem_configuration/ver0.py

@@ -1,65 +1,51 @@
-from ..__class_init__ import *
-from ...types.implementations.enums import CommSpeed
-from ..overview import VERSION_0
-
-
-class InitializationStringElement(cdt.Structure):
-    """ Request - Response strings"""
-    request: cdt.OctetString
-    response: cdt.OctetString
-
-
-class InitializationString(cdt.Array):
-    """ This data contains all the necessary initialization commands to be sent to the modem in order to  configure it properly. This may include the configuration of special
-    modem features.
-    If the array contains more than one initialization string element, they are subsequently sent to the modem after receiving an answer matching the defined response.
-    It is assumed that the modem is pre-configured so that it accepts the initialization_string . If no initialization is needed, the initialization string is empty."""
-    TYPE=InitializationStringElement
-
-
-class ModemProfileElement(cdt.OctetString):
-    """ TODO: can be OK, CONNECT, RING, NO CARRIER, ERROR, CONNECT 1 200, NO DIAL TONE, BUSY, NO ANSWER, CONNECT 600, CONNECT 2 400, CONNECT 4 800, CONNECT 9 600, CONNECT 14 400,
-    CONNECT 28 800, CONNECT 36 600, CONNECT 56 000"""
-
-    def __init__(self, value: bytes = b'OK'.hex()):
-        super(ModemProfileElement, self).__init__(value)
-        if bytes(self) not in self.get_validate_values():  # todo: make ReportMixin
-            raise ValueError(F'Got modem profile element {bytes(self)}, expected {b", ".join(self.get_validate_values())}')
-        else:
-            pass
-
-    @staticmethod
-    def get_validate_values() -> tuple[bytes, ...]:
-        return b'OK', b'CONNECT', b'RING', b'NO CARRIER', b'ERROR', b'CONNECT 1 200', b'NO DIAL TONE', b'BUSY', b'NO ANSWER', b'CONNECT 600', b'CONNECT 2 400', b'CONNECT 4 800', \
-               b'CONNECT 9 600', b'CONNECT 14 400', b'CONNECT 28 800', b'CONNECT 36 600', b'CONNECT 56 000'
-
-
-class ModemProfile(cdt.Array):
-    """ This data defines the mapping from Hayes standard commands/responses to modem specific strings. Shall contain the corresponding stings for the modem used in following 
-    order"""
-    TYPE = ModemProfileElement
-
-
-class PSTNModemConfiguration(ic.COSEMInterfaceClasses):
-    """ An  instance of the 'PSTN modem configuration' IC stores data related to the initialization of modems, which are used for data transfer from/to a device. Several modems
-    can be configured."""
-    CLASS_ID = ClassID.MODEM_CONFIGURATION
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("comm_speed", CommSpeed, 0, 9, 5),
-                  ic.ICAElement("initialization_string", InitializationString),
-                  ic.ICAElement("modem_profile", ModemProfile))
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def comm_speed(self) -> CommSpeed:
-        return self.get_attr(2)
-
-    @property
-    def initialization_string(self) -> InitializationString:
-        return self.get_attr(3)
-
-    @property
-    def modem_profile(self) -> ModemProfile:
-        return self.get_attr(4)
+from ...types.implementations.enums import CommSpeed
+from typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement, ICAuto
+from ..Overview import class_id
+
+
+class InitializationStringElement(cdt.Structure):
+    """ initialization_string_element"""
+    request: cdt.OctetString
+    response: cdt.OctetString
+
+
+class InitializationString(cdt.Array):
+    """initialization_string attribute"""
+    TYPE = InitializationStringElement
+
+
+class ModemProfileElement(cdt.OctetString):
+    """modem_profile_element"""
+
+    def __init__(self, value: bytes = b'OK'.hex()):
+        super(ModemProfileElement, self).__init__(value)
+        if bytes(self) not in self.get_validate_values():  # todo: make ReportMixin
+            raise ValueError(F'Got modem profile element {bytes(self)}, expected {b", ".join(self.get_validate_values())}')
+        else:
+            pass
+
+    @staticmethod
+    def get_validate_values() -> tuple[bytes, ...]:
+        return b'OK', b'CONNECT', b'RING', b'NO CARRIER', b'ERROR', b'CONNECT 1 200', b'NO DIAL TONE', b'BUSY', b'NO ANSWER', b'CONNECT 600', b'CONNECT 2 400', b'CONNECT 4 800', \
+               b'CONNECT 9 600', b'CONNECT 14 400', b'CONNECT 28 800', b'CONNECT 36 600', b'CONNECT 56 000'
+
+
+class ModemProfile(cdt.Array):
+    """modem_profile attribute"""
+    TYPE = ModemProfileElement
+
+
+class PSTNModemConfiguration(ICAuto):
+    """5.7.4 PSTN modem configuration"""
+    CLASS_ID = class_id.MODEM_CONFIGURATION
+    VERSION = 0
+    A_ELEMENTS = (
+        ICAElement(2, "comm_speed", CommSpeed, 0, 9, 5),
+        ICAElement(3, "initialization_string", InitializationString),
+        ICAElement(4, "modem_profile", ModemProfile)
+    )
+    comm_speed: Optional[CommSpeed]
+    initialization_string: Optional[InitializationString]
+    modem_profile: Optional[ModemProfile]

DLMS_SPODES/cosem_interface_classes/modem_configuration/ver1.py

@@ -1,39 +1,27 @@
-from ..__class_init__ import *
-from . import ver0
-from ..overview import VERSION_1
-
-
-class InitializationStringElement(cdt.Structure):
-    """ Request - Response strings"""
-    request: cdt.OctetString
-    response: cdt.OctetString
-    delay_after_response: cdt.LongUnsigned
-
-
-class InitializationString(cdt.Array):
-    """ Contains all the necessary initialization commands to be sent to the modem in order to configure it properly. This may include the configuration of special modem
-    features. If the array contains more than one initialization_string_element, the requests are set in a sequence.The next request is sent after the expected response matching
-    the previous request and waiting a delay-after-response time [ms], to allow the modem toe execute teh request.
-    It is assumed that the modem is per-configured so that it accepts the initialization-string. If no initialization is needed, the initialization string is empty. """
-    TYPE = InitializationStringElement
-
-
-class ModemConfigurationVer1(ic.COSEMInterfaceClasses):
-    """ This IC allow modelling the configuration and initialisation of modems used for data transfer from/to a device. Several modems can be configured."""
-    ClassID = ut.CosemClassId(27)
-    VERSION = VERSION_1
-    A_ELEMENTS = (ver0.PSTNModemConfiguration.get_attr_element(2),
-                  ic.ICAElement("initialization_string", InitializationString),
-                  ver0.PSTNModemConfiguration.get_attr_element(4))
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def initialization_string(self) -> InitializationString:
-        return self.get_attr(3)
-
-
-if __name__ == '__main__':
-    a = ModemConfigurationVer1('0.0.2.0.0.255')
-    print(a)
+from . import ver0
+from typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement
+from ..Overview import class_id
+
+
+class InitializationStringElement(cdt.Structure):
+    """initialization_string_element"""
+    request: cdt.OctetString
+    response: cdt.OctetString
+    delay_after_response: cdt.LongUnsigned
+
+
+class InitializationString(cdt.Array):
+    """initialization_string attribute"""
+    TYPE = InitializationStringElement
+
+
+class ModemConfigurationVer1(ver0.PSTNModemConfiguration):
+    """4.7.4 Modem configuration"""
+    ClassID = class_id.MODEM_CONFIGURATION
+    VERSION = 1
+    A_ELEMENTS = (ver0.PSTNModemConfiguration.getAElement(2).unwrap(),
+                  ICAElement(3, "initialization_string", InitializationString),
+                  ver0.PSTNModemConfiguration.getAElement(4).unwrap())
+    initialization_string: Optional[InitializationString]

DLMS_SPODES/cosem_interface_classes/ntp_setup/ver0.py

@@ -1,67 +1,48 @@
-from ..__class_init__ import *
-from ...types.implementations import integers
-from ..overview import VERSION_0
-
-
-class ServerAddress(cdt.OctetString):
-    """"""
-
-
-class AuthenticationMethod(cdt.Enum, elements=(0, 1, 2)):
-    """Defines the authentication mode used for NTP protocol"""
-
-
-class AuthenticationKey(cdt.Structure):
-    """"""
-    key_id: cdt.DoubleLongUnsigned
-    key: cdt.OctetString
-
-
-class AuthenticationKeys(cdt.Array):
-    """Contains the necessary symmetric keys if shared secrets mode of authentication is used"""
-    TYPE = AuthenticationKey
-
-
-class NTPSetup(ic.COSEMInterfaceClasses):
-    """DLMS UA 1000-1 Ed 14, 4.9.7 NTP setup"""
-    CLASS_ID = ClassID.NTP_SETUP
-    VERSION = VERSION_0
-    A_ELEMENTS = (
-        ic.ICAElement("activated", cdt.Boolean, default=False),
-        ic.ICAElement("server_address", ServerAddress),
-        ic.ICAElement("server_port", cdt.LongUnsigned, default=123),
-        ic.ICAElement("authentication_method", AuthenticationMethod),
-        ic.ICAElement("authentication_keys", AuthenticationKeys),
-        ic.ICAElement("client_key", cdt.OctetString))
-    M_ELEMENTS = (
-        ic.ICMElement("synchronize", integers.Only0),
-        ic.ICMElement("add_authentication_key", AuthenticationKey),
-        ic.ICMElement("delete_authentication_key", cdt.DoubleLongUnsigned),
-    )
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def activated(self) -> cdt.Boolean:
-        return self.get_attr(2)
-
-    @property
-    def server_address(self) -> ServerAddress:
-        return self.get_attr(3)
-
-    @property
-    def server_port(self) -> cdt.LongUnsigned:
-        return self.get_attr(4)
-
-    @property
-    def authentication_method(self) -> AuthenticationMethod:
-        return self.get_attr(5)
-
-    @property
-    def authentication_keys(self) -> AuthenticationKeys:
-        return self.get_attr(6)
-
-    @property
-    def client_key(self) -> cdt.OctetString:
-        return self.get_attr(7)
+from ...types.implementations import integers
+from typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement, ICAuto, ICMElement
+from ..Overview import class_id
+
+
+class ServerAddress(cdt.OctetString):
+    """server_address attribute"""
+
+
+class AuthenticationMethod(cdt.Enum, elements=(0, 1, 2)):
+    """authentication_method attribute"""
+
+
+class AuthenticationKey(cdt.Structure):
+    """authentication_key"""
+    key_id: cdt.DoubleLongUnsigned
+    key: cdt.OctetString
+
+
+class AuthenticationKeys(cdt.Array):
+    """authentication_keys"""
+    TYPE = AuthenticationKey
+
+
+class NTPSetup(ICAuto):
+    """4.9.7 NTP setup"""
+    CLASS_ID = class_id.NTP_SETUP
+    VERSION = 0
+    A_ELEMENTS = (
+        ICAElement(2, "activated", cdt.Boolean, default=False),
+        ICAElement(3, "server_address", ServerAddress),
+        ICAElement(4, "server_port", cdt.LongUnsigned, default=123),
+        ICAElement(5, "authentication_method", AuthenticationMethod),
+        ICAElement(6, "authentication_keys", AuthenticationKeys),
+        ICAElement(7, "client_key", cdt.OctetString))
+    M_ELEMENTS = (
+        ICMElement(1, "synchronize", integers.Only0),
+        ICMElement(2, "add_authentication_key", AuthenticationKey),
+        ICMElement(3, "delete_authentication_key", cdt.DoubleLongUnsigned),
+    )
+    activated: Optional[cdt.Boolean]
+    server_address: Optional[ServerAddress]
+    server_port: Optional[cdt.LongUnsigned]
+    authentication_method: Optional[AuthenticationMethod]
+    authentication_keys: Optional[AuthenticationKeys]
+    client_key: Optional[cdt.OctetString]

DLMS_SPODES/cosem_interface_classes/obis.py

@@ -1,23 +1,28 @@
-class OBIS(bytes):
-    """bytes[6]"""
-
-    def validate(self):
-        if (length := len(self)) != 6:
-            return ValueError(f"got {length=}, expected 6")
-
-    def __str__(self):
-        return F"{".".join(map(str, self[:6]))}"
-
-
-class AssociationLN(OBIS):
-    def __new__(cls, e: int):
-        return super().__new__(cls, (0, 0, 40, 0, e, 255))
-
-
-CURRENT_ASSOCIATION = OBIS((0, 0, 40, 0, 0, 255))
-PUBLIC_ASSOCIATION = OBIS((0, 0, 40, 0, 1, 255))
-LDN = OBIS((0, 0, 42, 0, 0, 255))
-
-
-# SPODES_3
-SPODES3_DISPLAY_MODE = OBIS((0, 0, 96, 4, 1, 255))
+from typing_extensions import deprecated
+
+
+@deprecated("use <bytes>")
+class OBIS(bytes):
+    """bytes[6]"""
+    __slots__ = ()
+
+    def validate(self):
+        if (length := len(self)) != 6:
+            return ValueError(f"got {length=}, expected 6")
+
+    def __str__(self):
+        return F"{".".join(map(str, self[:6]))}"
+
+
+class AssociationLN(OBIS):
+    def __new__(cls, e: int):
+        return super().__new__(cls, (0, 0, 40, 0, e, 255))
+
+
+CURRENT_ASSOCIATION = OBIS((0, 0, 40, 0, 0, 255))
+PUBLIC_ASSOCIATION = OBIS((0, 0, 40, 0, 1, 255))
+LDN = OBIS((0, 0, 42, 0, 0, 255))
+
+
+# SPODES_3
+SPODES3_DISPLAY_MODE = OBIS((0, 0, 96, 4, 1, 255))