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

DLMS_SPODES/cosem_interface_classes/script_table.py

@@ -1,87 +1,87 @@
-from .__class_init__ import *
-from ..types import choices
-from .overview import VERSION_0
-
-
-class ServiceId(cdt.Enum, elements=(1, 2)):
-    """defines which action to be applied to the referenced object."""
-
-
-class ActionSpecification(cdt.Structure):
-    """ Specifies the different scripts, i.e. the lists of actions. The first attribute (logical_name) has index 1, the first specific method has
-    index 1 as well. NOTE The action_specification is limited to activate methods that do not produce any response (from the server to the client). """
-    service_id: ServiceId
-    class_id: cdt.LongUnsigned
-    logical_name: cst.LogicalName
-    index: cdt.Integer
-    parameter: choices.common_dt
-
-
-class Actions(cdt.Array):
-    """ Specifies the list of action specification """
-    TYPE = ActionSpecification
-
-
-class Script(cdt.Structure):
-    """ Specifies the different scripts. The script_identifier 0 is reserved. If specified with an execute method, it results in a null script (no actions to perform)"""
-    script_identifier: cdt.LongUnsigned
-    actions: Actions
-
-
-class Scripts(cdt.Array):
-    """ Specifies the lists of actions """
-    TYPE = Script
-    __get_item__: Script
-
-    def new_element(self) -> Script:
-        """return default Script with vacant script_identifier"""
-        # todo: make common function by ID element
-        el: Script
-        day_ids: list[int] = [int(el.script_identifier) for el in self.values]
-        for i in range(0xffff):
-            if i not in day_ids:
-                return Script((i, None))
-        raise ValueError(F"in {self} all <script_identifier> is busy")
-
-
-class ScriptTable(ic.COSEMInterfaceClasses):
-    """Script table"""
-    CLASS_ID = ClassID.SCRIPT_TABLE
-    VERSION = VERSION_0
-    A_ELEMENTS = ic.ICAElement("scripts", Scripts),
-    M_ELEMENTS = ic.ICMElement("execute", cdt.LongUnsigned),
-
-    def characteristics_init(self):
-        self.set_attr(2, None)
-        self._cbs_attr_post_init.update({2: self.__set_script_identifier_cbs})
-
-    @property
-    def scripts(self) -> Scripts:
-        return self.get_attr(2)
-
-    @property
-    def execute(self) -> cdt.LongUnsigned:
-        return self.get_meth(1)
-
-    def __set_script_identifier_cbs(self):
-        pass
-        # try:
-        #     indexes: Callable = self.entries.get_indexes
-        #     self.enable_disable.firstIndexA.set_callback(indexes)
-        #     self.enable_disable.firstIndexB.set_callback(indexes)
-        #     self.enable_disable.lastIndexA.set_callback(indexes)
-        #     self.enable_disable.lastIndexB.set_callback(indexes)
-        #     self.insert.index.set_callback(indexes)
-        #     self.delete.firstIndex.set_callback(indexes)
-        #     self.delete.lastIndex.set_callback(indexes)
-        #     print('set delete')
-        # except KeyError:  # At init time
-        #     print('set delete NO:')
-
-
-if __name__ == '__main__':
-    a = b'\x01\x04\x02\x02\x12\x00\x01\x01\x01\x02\x05\x16\x01\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x04\x16\x00\x02\x02\x12\x00\x02\x01\x01\x02\x05\x16\x02\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x01\x03\x00\x02\x02\x12\x00\x03\x01\x01\x02\x05\x16\x01\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x04\x16\x01\x02\x02\x12\x00\x04\x01\x01\x02\x05\x16\x02\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x01\x03\x01'
-    b = Scripts(a)
-    a = ScriptTable('0.0.10.0.0.255')
-    pass
-    print(a)
+from .__class_init__ import *
+from ..types import choices
+from .overview import VERSION_0
+
+
+class ServiceId(cdt.Enum, elements=(1, 2)):
+    """defines which action to be applied to the referenced object."""
+
+
+class ActionSpecification(cdt.Structure):
+    """ Specifies the different scripts, i.e. the lists of actions. The first attribute (logical_name) has index 1, the first specific method has
+    index 1 as well. NOTE The action_specification is limited to activate methods that do not produce any response (from the server to the client). """
+    service_id: ServiceId
+    class_id: cdt.LongUnsigned
+    logical_name: cst.LogicalName
+    index: cdt.Integer
+    parameter: choices.common_dt
+
+
+class Actions(cdt.Array):
+    """ Specifies the list of action specification """
+    TYPE = ActionSpecification
+
+
+class Script(cdt.Structure):
+    """ Specifies the different scripts. The script_identifier 0 is reserved. If specified with an execute method, it results in a null script (no actions to perform)"""
+    script_identifier: cdt.LongUnsigned
+    actions: Actions
+
+
+class Scripts(cdt.Array):
+    """ Specifies the lists of actions """
+    TYPE = Script
+    __get_item__: Script
+
+    def new_element(self) -> Script:
+        """return default Script with vacant script_identifier"""
+        # todo: make common function by ID element
+        el: Script
+        day_ids: list[int] = [int(el.script_identifier) for el in self.values]
+        for i in range(0xffff):
+            if i not in day_ids:
+                return Script((i, None))
+        raise ValueError(F"in {self} all <script_identifier> is busy")
+
+
+class ScriptTable(ic.COSEMInterfaceClasses):
+    """Script table"""
+    CLASS_ID = ClassID.SCRIPT_TABLE
+    VERSION = VERSION_0
+    A_ELEMENTS = ic.ICAElement("scripts", Scripts),
+    M_ELEMENTS = ic.ICMElement("execute", cdt.LongUnsigned),
+
+    def characteristics_init(self):
+        self.set_attr(2, None)
+        self._cbs_attr_post_init.update({2: self.__set_script_identifier_cbs})
+
+    @property
+    def scripts(self) -> Scripts:
+        return self.get_attr(2)
+
+    @property
+    def execute(self) -> cdt.LongUnsigned:
+        return self.get_meth(1)
+
+    def __set_script_identifier_cbs(self):
+        pass
+        # try:
+        #     indexes: Callable = self.entries.get_indexes
+        #     self.enable_disable.firstIndexA.set_callback(indexes)
+        #     self.enable_disable.firstIndexB.set_callback(indexes)
+        #     self.enable_disable.lastIndexA.set_callback(indexes)
+        #     self.enable_disable.lastIndexB.set_callback(indexes)
+        #     self.insert.index.set_callback(indexes)
+        #     self.delete.firstIndex.set_callback(indexes)
+        #     self.delete.lastIndex.set_callback(indexes)
+        #     print('set delete')
+        # except KeyError:  # At init time
+        #     print('set delete NO:')
+
+
+if __name__ == '__main__':
+    a = b'\x01\x04\x02\x02\x12\x00\x01\x01\x01\x02\x05\x16\x01\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x04\x16\x00\x02\x02\x12\x00\x02\x01\x01\x02\x05\x16\x02\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x01\x03\x00\x02\x02\x12\x00\x03\x01\x01\x02\x05\x16\x01\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x04\x16\x01\x02\x02\x12\x00\x04\x01\x01\x02\x05\x16\x02\x12\x00F\t\x06\x00\x00`\x03\n\xff\x0f\x01\x03\x01'
+    b = Scripts(a)
+    a = ScriptTable('0.0.10.0.0.255')
+    pass
+    print(a)

DLMS_SPODES/cosem_interface_classes/security_setup/ver0.py

@@ -1,68 +1,68 @@
-from ..__class_init__ import *
-from ..overview import VERSION_0
-
-
-class SecurityPolicy(cdt.Enum, elements=tuple(range(16))):
-    """ Enforces authentication and/or encrypting algorithm provided with security_suite """
-
-
-class SecuritySuite(cdt.Enum, elements=tuple(range(16))):
-    """Specifies authentication, encryption and key transport algorithm"""
-    AES_GCM_128_AUT_ENCR_AND_AES_128_KEY_WRAP = 0
-
-
-class KeyID(cdt.Enum, elements=(0, 1, 2)):
-    """Use only in KeyData structure"""
-
-
-class KeyData(cdt.Structure):
-    """ TODO: """
-    key_id: KeyID
-    key_wrapped: cdt.OctetString
-
-
-class GlobalKeyTransfer(cdt.Array):
-    """ Array of key_data """
-    TYPE = KeyData
-
-
-class SecuritySetup(ic.COSEMInterfaceClasses):
-    """ Instances of the “Security setup” IC contain the necessary information on the security suite in use and the security policy applicable between the server and a client
-    and/or third party indentify by their respective system titles. They also provide methods to increase the level of security and to manage symmetric keys, asymmetric key pairs
-     and certificates """
-    CLASS_ID = ClassID.SECURITY_SETUP
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("security_policy", SecurityPolicy, 0, 3, 0),
-                  ic.ICAElement("security_suite", SecuritySuite, 0, 0, 0),
-                  ic.ICAElement("client_system_title", cdt.OctetString, classifier=ic.Classifier.DYNAMIC),
-                  ic.ICAElement("server_system_title", cdt.OctetString))
-
-    M_ELEMENTS = (ic.ICMElement("security_activate", SecurityPolicy),
-                  ic.ICMElement("global_key_transfer", GlobalKeyTransfer))
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def security_policy(self) -> SecurityPolicy:
-        return self.get_attr(2)
-
-    @property
-    def security_suite(self) -> SecuritySuite:
-        return self.get_attr(3)
-
-    @property
-    def client_system_title(self) -> cdt.OctetString:
-        return self .get_attr(4)
-
-    @property
-    def server_system_title(self) -> cdt.OctetString:
-        return self .get_attr(5)
-
-    @property
-    def security_activate(self) -> SecurityPolicy:
-        return self .get_meth(1)
-
-    @property
-    def global_key_transfer(self) -> GlobalKeyTransfer:
-        return self .get_meth(2)
+from ..__class_init__ import *
+from ..overview import VERSION_0
+
+
+class SecurityPolicy(cdt.Enum, elements=tuple(range(16))):
+    """ Enforces authentication and/or encrypting algorithm provided with security_suite """
+
+
+class SecuritySuite(cdt.Enum, elements=tuple(range(16))):
+    """Specifies authentication, encryption and key transport algorithm"""
+    AES_GCM_128_AUT_ENCR_AND_AES_128_KEY_WRAP = 0
+
+
+class KeyID(cdt.Enum, elements=(0, 1, 2)):
+    """Use only in KeyData structure"""
+
+
+class KeyData(cdt.Structure):
+    """ TODO: """
+    key_id: KeyID
+    key_wrapped: cdt.OctetString
+
+
+class GlobalKeyTransfer(cdt.Array):
+    """ Array of key_data """
+    TYPE = KeyData
+
+
+class SecuritySetup(ic.COSEMInterfaceClasses):
+    """ Instances of the “Security setup” IC contain the necessary information on the security suite in use and the security policy applicable between the server and a client
+    and/or third party indentify by their respective system titles. They also provide methods to increase the level of security and to manage symmetric keys, asymmetric key pairs
+     and certificates """
+    CLASS_ID = ClassID.SECURITY_SETUP
+    VERSION = VERSION_0
+    A_ELEMENTS = (ic.ICAElement("security_policy", SecurityPolicy, 0, 3, 0),
+                  ic.ICAElement("security_suite", SecuritySuite, 0, 0, 0),
+                  ic.ICAElement("client_system_title", cdt.OctetString, classifier=ic.Classifier.DYNAMIC),
+                  ic.ICAElement("server_system_title", cdt.OctetString))
+
+    M_ELEMENTS = (ic.ICMElement("security_activate", SecurityPolicy),
+                  ic.ICMElement("global_key_transfer", GlobalKeyTransfer))
+
+    def characteristics_init(self):
+        """nothing do it"""
+
+    @property
+    def security_policy(self) -> SecurityPolicy:
+        return self.get_attr(2)
+
+    @property
+    def security_suite(self) -> SecuritySuite:
+        return self.get_attr(3)
+
+    @property
+    def client_system_title(self) -> cdt.OctetString:
+        return self .get_attr(4)
+
+    @property
+    def server_system_title(self) -> cdt.OctetString:
+        return self .get_attr(5)
+
+    @property
+    def security_activate(self) -> SecurityPolicy:
+        return self .get_meth(1)
+
+    @property
+    def global_key_transfer(self) -> GlobalKeyTransfer:
+        return self .get_meth(2)

DLMS_SPODES/cosem_interface_classes/security_setup/ver1.py

@@ -1,158 +1,158 @@
-from . import ver0
-from ..__class_init__ import *
-from ..overview import VERSION_1
-from ...types import choices
-
-
-class SecurityPolicyVer1(cdt.IntegerFlag, cdt.Enum):
-    """ security_policy"""
-
-
-class CertificateEntity(cdt.Enum, elements=(0, 1, 2, 3)):
-    """TODO:"""
-
-
-class CertificateType(cdt.Enum, elements=(0, 1, 2, 3)):
-    """TODO:"""
-
-
-class SecuritySuite(ver0.SecuritySuite, elements=(0, 1, 2)):
-    """Version 0 extension"""
-    AES_GCM_128_AUT_ENCR_ECDSA_P_256_DIG_SIGN_ECDH_P_256_KEY_AGR_SHA_256_HASH_V44_COMPR_AND_AES_128_KEY_WRAP = 1
-    AES_GCM_256_AUT_ENCR_ECDSA_P_384_DIG_SIGN_ECDH_P_384_KEY_AGR_SHA_384_HASH_V44_COMPR_AND_AES_256_KEY_WRAP = 2
-
-
-class CertificateInfo(cdt.Structure):
-    """ TODO: """
-    certificate_entity: CertificateEntity
-    certificate_type: CertificateType
-    serial_number: cdt.OctetString
-    issuer: cdt.OctetString
-    subject: cdt.OctetString
-    subject_alt_name: cdt.OctetString
-
-
-class Certificates(cdt.Array):
-    """Carries information on the X.509 v3 Certificates available and stored in the server"""
-    TYPE = CertificateInfo
-
-
-class KeyID(cdt.Enum, elements=(0, 1, 2, 3)):
-    """Version 0 extension"""
-
-
-class KeyTransferData(cdt.Structure):
-    """ TODO: """
-    key_id: KeyID
-    key_wrapped: cdt.OctetString
-
-
-class KeyTransfer(cdt.Array):
-    """ Array of key_transfer_data """
-    TYPE = KeyTransferData
-
-
-class KeyAgreementData(cdt.Structure):
-    """ TODO: """
-    key_id: KeyID
-    key_data: cdt.OctetString
-
-
-class KeyAgreement(cdt.Array):
-    """ Array of key_agreement_data """
-    TYPE = KeyAgreementData
-
-
-class KeyPair(cdt.Enum, elements=(0, 1, 2)):
-    """TODO:"""
-
-
-class CertificateIdentificationByEntity(cdt.Structure):
-    """ TODO: """
-    certificate_entity: CertificateEntity
-    certificate_type: CertificateType
-    system_title: cdt.OctetString
-
-
-class CertificateIdentificationBySerial(cdt.Structure):
-    """ TODO: """
-    serial_number: cdt.OctetString
-    issuer: cdt.OctetString
-
-
-class CertificateIdentificationType(cdt.Enum, elements=(0, 1)):
-    """TODO:"""
-
-
-class CertificationIdentificationOption(ut.CHOICE):
-    TYPE = cdt.Structure
-    ELEMENTS = {0: ut.SequenceElement('by entity', CertificateIdentificationByEntity),
-                1: ut.SequenceElement('by serial', CertificateIdentificationBySerial)}
-
-
-certification_identification_option = CertificationIdentificationOption()
-
-
-class CertificateIdentification(choices.StructureMixin, cdt.Structure):
-    """Override several methods of cdt.Structure. It limited Structure."""
-    certificate_identification_type: CertificateIdentificationType
-    certification_identification_options: certification_identification_option
-
-
-class SecuritySetup(ver0.SecuritySetup):
-    VERSION = VERSION_1
-    A_ELEMENTS = (ic.ICAElement("security_policy", SecurityPolicyVer1),
-                  ic.ICAElement("security_suite", SecuritySuite),
-                  ver0.SecuritySetup.getAElement(3).unwrap(),
-                  ver0.SecuritySetup.getAElement(4).unwrap(),
-                  ver0.SecuritySetup.getAElement(5).unwrap(),
-                  ic.ICAElement("certificates", Certificates, classifier=ic.Classifier.DYNAMIC))
-
-    M_ELEMENTS = (ic.ICMElement("security_activate", SecurityPolicyVer1),
-                  ic.ICMElement("key_transfer", KeyTransfer),
-                  ic.ICMElement("key_agreement", KeyAgreement),
-                  ic.ICMElement("generate_key_pair", KeyPair),
-                  ic.ICMElement("generate_certificate_request", KeyPair),
-                  ic.ICMElement("import_certificate", cdt.OctetString),
-                  ic.ICMElement("export_certificate", CertificateIdentification),
-                  ic.ICMElement("remove_certificate", CertificateIdentification))
-
-    def characteristics_init(self):
-        self.set_attr(2, None)
-        self.set_attr(3, None)
-        self.set_attr(6, None)
-
-    @property
-    def security_policy(self) -> SecurityPolicyVer1:
-        return self.get_attr(2)
-
-    @property
-    def security_suite(self) -> SecuritySuite:
-        return self.get_attr(3)
-
-    @property
-    def certificates(self) -> Certificates:
-        return self.get_attr(6)
-
-    @property
-    def security_activate(self) -> SecurityPolicyVer1:
-        return self.get_meth(1)
-
-    @property
-    def key_transfer(self) -> KeyTransferData:
-        return self .get_meth(2)
-
-    def key_agreement(self) -> KeyAgreement:
-        return self .get_meth(3)
-
-    def generate_certificate_request(self) -> KeyPair:
-        return self .get_meth(4)
-
-    def import_certificate(self) -> cdt.OctetString:
-        return self .get_meth(5)
-
-    def export_certificate(self) -> CertificateIdentification:
-        return self .get_meth(6)
-
-    def remove_certificate(self) -> CertificateIdentification:
-        return self .get_meth(7)
+from . import ver0
+from ..__class_init__ import *
+from ..overview import VERSION_1
+from ...types import choices
+
+
+class SecurityPolicyVer1(cdt.IntegerFlag, cdt.Enum):
+    """ security_policy"""
+
+
+class CertificateEntity(cdt.Enum, elements=(0, 1, 2, 3)):
+    """TODO:"""
+
+
+class CertificateType(cdt.Enum, elements=(0, 1, 2, 3)):
+    """TODO:"""
+
+
+class SecuritySuite(ver0.SecuritySuite, elements=(0, 1, 2)):
+    """Version 0 extension"""
+    AES_GCM_128_AUT_ENCR_ECDSA_P_256_DIG_SIGN_ECDH_P_256_KEY_AGR_SHA_256_HASH_V44_COMPR_AND_AES_128_KEY_WRAP = 1
+    AES_GCM_256_AUT_ENCR_ECDSA_P_384_DIG_SIGN_ECDH_P_384_KEY_AGR_SHA_384_HASH_V44_COMPR_AND_AES_256_KEY_WRAP = 2
+
+
+class CertificateInfo(cdt.Structure):
+    """ TODO: """
+    certificate_entity: CertificateEntity
+    certificate_type: CertificateType
+    serial_number: cdt.OctetString
+    issuer: cdt.OctetString
+    subject: cdt.OctetString
+    subject_alt_name: cdt.OctetString
+
+
+class Certificates(cdt.Array):
+    """Carries information on the X.509 v3 Certificates available and stored in the server"""
+    TYPE = CertificateInfo
+
+
+class KeyID(cdt.Enum, elements=(0, 1, 2, 3)):
+    """Version 0 extension"""
+
+
+class KeyTransferData(cdt.Structure):
+    """ TODO: """
+    key_id: KeyID
+    key_wrapped: cdt.OctetString
+
+
+class KeyTransfer(cdt.Array):
+    """ Array of key_transfer_data """
+    TYPE = KeyTransferData
+
+
+class KeyAgreementData(cdt.Structure):
+    """ TODO: """
+    key_id: KeyID
+    key_data: cdt.OctetString
+
+
+class KeyAgreement(cdt.Array):
+    """ Array of key_agreement_data """
+    TYPE = KeyAgreementData
+
+
+class KeyPair(cdt.Enum, elements=(0, 1, 2)):
+    """TODO:"""
+
+
+class CertificateIdentificationByEntity(cdt.Structure):
+    """ TODO: """
+    certificate_entity: CertificateEntity
+    certificate_type: CertificateType
+    system_title: cdt.OctetString
+
+
+class CertificateIdentificationBySerial(cdt.Structure):
+    """ TODO: """
+    serial_number: cdt.OctetString
+    issuer: cdt.OctetString
+
+
+class CertificateIdentificationType(cdt.Enum, elements=(0, 1)):
+    """TODO:"""
+
+
+class CertificationIdentificationOption(ut.CHOICE):
+    TYPE = cdt.Structure
+    ELEMENTS = {0: ut.SequenceElement('by entity', CertificateIdentificationByEntity),
+                1: ut.SequenceElement('by serial', CertificateIdentificationBySerial)}
+
+
+certification_identification_option = CertificationIdentificationOption()
+
+
+class CertificateIdentification(choices.StructureMixin, cdt.Structure):
+    """Override several methods of cdt.Structure. It limited Structure."""
+    certificate_identification_type: CertificateIdentificationType
+    certification_identification_options: certification_identification_option
+
+
+class SecuritySetup(ver0.SecuritySetup):
+    VERSION = VERSION_1
+    A_ELEMENTS = (ic.ICAElement("security_policy", SecurityPolicyVer1),
+                  ic.ICAElement("security_suite", SecuritySuite),
+                  ver0.SecuritySetup.getAElement(3).unwrap(),
+                  ver0.SecuritySetup.getAElement(4).unwrap(),
+                  ver0.SecuritySetup.getAElement(5).unwrap(),
+                  ic.ICAElement("certificates", Certificates, classifier=ic.Classifier.DYNAMIC))
+
+    M_ELEMENTS = (ic.ICMElement("security_activate", SecurityPolicyVer1),
+                  ic.ICMElement("key_transfer", KeyTransfer),
+                  ic.ICMElement("key_agreement", KeyAgreement),
+                  ic.ICMElement("generate_key_pair", KeyPair),
+                  ic.ICMElement("generate_certificate_request", KeyPair),
+                  ic.ICMElement("import_certificate", cdt.OctetString),
+                  ic.ICMElement("export_certificate", CertificateIdentification),
+                  ic.ICMElement("remove_certificate", CertificateIdentification))
+
+    def characteristics_init(self):
+        self.set_attr(2, None)
+        self.set_attr(3, None)
+        self.set_attr(6, None)
+
+    @property
+    def security_policy(self) -> SecurityPolicyVer1:
+        return self.get_attr(2)
+
+    @property
+    def security_suite(self) -> SecuritySuite:
+        return self.get_attr(3)
+
+    @property
+    def certificates(self) -> Certificates:
+        return self.get_attr(6)
+
+    @property
+    def security_activate(self) -> SecurityPolicyVer1:
+        return self.get_meth(1)
+
+    @property
+    def key_transfer(self) -> KeyTransferData:
+        return self .get_meth(2)
+
+    def key_agreement(self) -> KeyAgreement:
+        return self .get_meth(3)
+
+    def generate_certificate_request(self) -> KeyPair:
+        return self .get_meth(4)
+
+    def import_certificate(self) -> cdt.OctetString:
+        return self .get_meth(5)
+
+    def export_certificate(self) -> CertificateIdentification:
+        return self .get_meth(6)
+
+    def remove_certificate(self) -> CertificateIdentification:
+        return self .get_meth(7)