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

DLMS_SPODES/cosem_interface_classes/security_setup/ver0.py

@@ -1,68 +1,45 @@
-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 typing import Optional
+from ...types import cdt
+from ..cosem_interface_class import ICAElement, ICMElement, Classifier, ICAuto
+from ..Overview import class_id
+
+
+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(ICAuto):
+    """4.4.7 Security setup"""
+    CLASS_ID = class_id.SECURITY_SETUP
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "security_policy", SecurityPolicy, 0, 3, 0),
+                  ICAElement(3, "security_suite", SecuritySuite, 0, 0, 0),
+                  ICAElement(4, "client_system_title", cdt.OctetString, classifier=Classifier.DYNAMIC),
+                  ICAElement(5, "server_system_title", cdt.OctetString))
+
+    M_ELEMENTS = (ICMElement(1, "security_activate", SecurityPolicy),
+                  ICMElement(2, "global_key_transfer", GlobalKeyTransfer))
+    security_policy: Optional[SecurityPolicy]
+    security_suite: Optional[SecuritySuite]
+    client_system_title: Optional[cdt.OctetString]
+    server_system_title: Optional[cdt.OctetString]

DLMS_SPODES/cosem_interface_classes/security_setup/ver1.py

@@ -1,158 +1,122 @@
-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 ...types import choices
+from typing import Optional
+from ...types import cdt, ut
+from ..cosem_interface_class import ICAElement, ICMElement, Classifier
+
+
+class SecurityPolicy(cdt.Enum, cdt.IntegerFlag):
+    """ 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 = 1
+    A_ELEMENTS = (ICAElement(1, "security_policy", SecurityPolicy),
+                  ICAElement(2, "security_suite", SecuritySuite),
+                  ver0.SecuritySetup.getAElement(3).unwrap(),
+                  ver0.SecuritySetup.getAElement(4).unwrap(),
+                  ver0.SecuritySetup.getAElement(5).unwrap(),
+                  ICAElement(6, "certificates", Certificates, classifier=Classifier.DYNAMIC))
+
+    M_ELEMENTS = (ICMElement(1, "security_activate", SecurityPolicy),
+                  ICMElement(2, "key_transfer", KeyTransfer),
+                  ICMElement(3, "key_agreement", KeyAgreement),
+                  ICMElement(4, "generate_key_pair", KeyPair),
+                  ICMElement(5, "generate_certificate_request", KeyPair),
+                  ICMElement(6, "import_certificate", cdt.OctetString),
+                  ICMElement(7, "export_certificate", CertificateIdentification),
+                  ICMElement(8, "remove_certificate", CertificateIdentification))
+    security_policy: Optional[SecurityPolicy]
+    security_suite: Optional[SecuritySuite]
+    certificates: Optional[Certificates]

DLMS_SPODES/cosem_interface_classes/single_action_schedule.py

@@ -1,50 +1,34 @@
-from .__class_init__ import *
-from ..types.implementations import structs
-from .overview import VERSION_0
-
-
-class TYPE(cdt.Enum, elements=(1, 2, 3, 4, 5)):
-    """"""
-
-
-class ExecutionTimeDate(cdt.Structure):
-    """ Specifies the time and teh date when the script is executed. The two octet-string s contain time and date, in this order; time and date are
-     formatted as specified in DLMS UA 1000-1 Ed.12.0 4.1.6.1. Hundredths of second shall be zero. """
-    time: cst.OctetStringTime
-    date: cst.OctetStringDate
-
-
-class ExecutionTime(cdt.Array):
-    """ Specifies the list of execution time and date """
-    TYPE = ExecutionTimeDate
-
-
-class SingleActionSchedule(ic.COSEMInterfaceClasses):
-    """ This IC allows modelling the execution of periodic actions within a meter. Such actions are not necessarily linked to tariffication
-    (see “Activity calendar” or “Schedule”).  """
-    CLASS_ID = ClassID.SINGLE_ACTION_SCHEDULE
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("executed_script", structs.ActionItem),
-                  ic.ICAElement("type", TYPE),
-                  ic.ICAElement("execution_time", ExecutionTime))
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def executed_script(self) -> structs.ActionItem:
-        return self.get_attr(2)
-
-    @property
-    def type_(self) -> TYPE:
-        return self.get_attr(3)
-
-    @property
-    def execution_time(self) -> ExecutionTime:
-        return self.get_attr(4)
-
-
-if __name__ == '__main__':
-    a = ExecutionTimeDate(b'\x02\x02\t\x04\x12\x007\x00\t\x05\x07\xe5\x05\x1f\x01')
-    a = SingleActionSchedule('0.0.15.0.0.255')
-    print(a)
+from ..types.implementations import structs
+from ..types import cdt, cst
+from ..types.type_alias import Attr
+from .cosem_interface_class import ICAuto, ICAElement
+from .Overview import class_id
+
+
+class TYPE(cdt.Enum, elements=(1, 2, 3, 4, 5)):
+    """"""
+
+
+class ExecutionTimeDate(cdt.Structure):
+    """ Specifies the time and teh date when the script is executed. The two octet-string s contain time and date, in this order; time and date are
+     formatted as specified in DLMS UA 1000-1 Ed.12.0 4.1.6.1. Hundredths of second shall be zero. """
+    time: cst.OctetStringTime
+    date: cst.OctetStringDate
+
+
+class ExecutionTime(cdt.Array):
+    """ Specifies the list of execution time and date """
+    TYPE = ExecutionTimeDate
+
+
+class SingleActionSchedule(ICAuto):
+    """ This IC allows modelling the execution of periodic actions within a meter. Such actions are not necessarily linked to tariffication
+    (see “Activity calendar” or “Schedule”).  """
+    CLASS_ID = class_id.SINGLE_ACTION_SCHEDULE
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "executed_script", structs.ActionItem),
+                  ICAElement(3, "type", TYPE),
+                  ICAElement(4, "execution_time", ExecutionTime))
+    executed_script: Attr
+    type_: Attr
+    execution_time: Attr

DLMS_SPODES/cosem_interface_classes/special_days_table.py

@@ -1,84 +1,54 @@
-import datetime
-from .__class_init__ import *
-from .overview import VERSION_0
-
-
-class SpecDayEntry(cdt.Structure):
-    """ Specifies a special day identifier for a given date. The date may have wildcards for repeating special days like Christmas. """
-    index: cdt.LongUnsigned
-    specialday_date: cst.OctetStringDate
-    day_id: cdt.Unsigned
-
-
-class Entries(cdt.Array):
-    """ Specifies the list of spec_day_entry """
-    TYPE = SpecDayEntry
-    values: list[SpecDayEntry]
-    __getitem__: SpecDayEntry
-
-    def new_element(self) -> SpecDayEntry:
-        indexes: list[int] = [int(el.index) for el in self.values]
-        for i in range(0x1_00_00):
-            if i not in indexes:
-                return SpecDayEntry((i, None, None))  # TODO: insert first DayID from ActiveCalendar as 3 element
-        raise ValueError(F'in {self} all indexes is busy')
-
-    def __check_index(self, value):
-        """validate day_id from DayProfile"""
-        if cdt.LongUnsigned(value) in (entry.index for entry in self.values):
-            raise ValueError(F'{cdt.LongUnsigned(value)} already exist in {self}')
-        else:
-            """validate OK"""
-
-    def validate_exist_index(self, value):
-        """pass if value in indexes"""
-        if cdt.LongUnsigned(value) not in (entry.index for entry in self.values):
-            raise ValueError(F'{cdt.LongUnsigned(value)} not exist in {self}')
-        else:
-            """validate OK"""
-
-    def get_indexes(self) -> list[int]:
-        """ getter for callback Index """
-        return [int(entries_element.index) for entries_element in self.values]
-
-
-class SpecialDaysTable(ic.COSEMInterfaceClasses):
-    """ The interface class allows defining dates, which will override normal switching behaviour for special days. The interface class works in
-    conjunction with the class "Schedule" or "Activity calendar" and the linking data item is day_id """
-    CLASS_ID = ClassID.SPECIAL_DAYS_TABLE
-    VERSION = VERSION_0
-    A_ELEMENTS = ic.ICAElement("entries", Entries),
-    M_ELEMENTS = (ic.ICMElement("insert", SpecDayEntry),
-                  ic.ICMElement("delete", cdt.LongUnsigned))  # Todo: was Delete.with_cb(None, self.entries.get_indexes)
-
-    def characteristics_init(self):
-        self._cbs_attr_post_init.update({2: self.__set_delete})
-        self.set_attr(2, None)
-
-    @property
-    def entries(self) -> Entries:
-        return self.get_attr(2)
-
-    @property
-    def insert(self) -> SpecDayEntry:
-        return self.get_meth(1)
-
-    @property
-    def delete(self) -> cdt.LongUnsigned:
-        return self.get_meth(2)
-
-    def __set_delete(self):
-        try:
-            self.delete.register_cb_preset(self.entries.validate_exist_index)
-            self.insert.index.register_cb_preset(self.entries.validate_exist_index)
-        except KeyError:  # At init time
-            print('set delete NO:')
-
-    def __delete_entry(self):
-        """remove one entry by according delete method index. Call after execute"""
-        for entry in self.entries.values:
-            if entry.index == self.delete:
-                self.entries.values.remove(entry)
-                return
-        else:
-            raise ValueError(F'not found entry with index {self.delete} for remove')
+from ..types import cdt, cst
+from ..types.type_alias import Attr
+from .cosem_interface_class import ICAuto, ICAElement, ICMElement
+from .Overview import class_id
+
+
+class SpecDayEntry(cdt.Structure):
+    """ Specifies a special day identifier for a given date. The date may have wildcards for repeating special days like Christmas. """
+    index: cdt.LongUnsigned
+    specialday_date: cst.OctetStringDate
+    day_id: cdt.Unsigned
+
+
+class Entries(cdt.Array):
+    """ Specifies the list of spec_day_entry """
+    TYPE = SpecDayEntry
+    values: list[SpecDayEntry]
+    __getitem__: SpecDayEntry
+
+    def new_element(self) -> SpecDayEntry:
+        indexes: list[int] = [int(el.index) for el in self.values]
+        for i in range(0x1_00_00):
+            if i not in indexes:
+                return SpecDayEntry((i, None, None))  # TODO: insert first DayID from ActiveCalendar as 3 element
+        raise ValueError(F'in {self} all indexes is busy')
+
+    def __check_index(self, value):
+        """validate day_id from DayProfile"""
+        if cdt.LongUnsigned(value) in (entry.index for entry in self.values):
+            raise ValueError(F'{cdt.LongUnsigned(value)} already exist in {self}')
+        else:
+            """validate OK"""
+
+    def validate_exist_index(self, value):
+        """pass if value in indexes"""
+        if cdt.LongUnsigned(value) not in (entry.index for entry in self.values):
+            raise ValueError(F'{cdt.LongUnsigned(value)} not exist in {self}')
+        else:
+            """validate OK"""
+
+    def get_indexes(self) -> list[int]:
+        """ getter for callback Index """
+        return [int(entries_element.index) for entries_element in self.values]
+
+
+class SpecialDaysTable(ICAuto):
+    """ The interface class allows defining dates, which will override normal switching behaviour for special days. The interface class works in
+    conjunction with the class "Schedule" or "Activity calendar" and the linking data item is day_id """
+    CLASS_ID = class_id.SPECIAL_DAYS_TABLE
+    VERSION = 0
+    A_ELEMENTS = ICAElement(2, "entries", Entries),
+    M_ELEMENTS = (ICMElement(1, "insert", SpecDayEntry),
+                  ICMElement(2, "delete", cdt.LongUnsigned))  # Todo: was Delete.with_cb(None, self.entries.get_indexes)
+    entries: Attr