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

DLMS_SPODES/cosem_interface_classes/push_setup/ver2.py

@@ -1,166 +1,124 @@
-from ..__class_init__ import *
-from ...types.implementations import structs, enums, integers
-from itertools import chain
-from ...types import choices
-from ..overview import VERSION_2
-
-
-class RestrictionElement(choices.StructureMixin, cdt.Structure):
-    """Override several methods of cdt.Structure. It limited Structure."""
-    restriction_type: enums.RestrictionType
-    restriction_value: choices.restriction_value
-
-
-class ColumnElement(cdt.Array):
-    """ Specifies the list of capture objects """
-    TYPE = structs.CaptureObjectDefinition
-
-
-class PushObjectDefinition(cdt.Structure):
-    class_id: cdt.LongUnsigned
-    logical_name: cst.LogicalName
-    attribute_index: cdt.Integer
-    data_index: cdt.LongUnsigned
-    restriction: RestrictionElement
-    column: ColumnElement
-
-
-class PushObjectList(cdt.Array):
-    """ Defines the list of attributes to be pushed. """
-    TYPE = PushObjectDefinition
-
-
-class TransportServiceType(cdt.Enum, elements=tuple(chain(range(9), range(200, 256)))):  # TODO: elements 200.. is manufacturer specific
-    """"""
-
-
-class MessageType(cdt.Enum, elements=tuple(chain((0, 1), range(128, 256)))):  # TODO: elements 128.. is manufacturer specific
-    """"""
-
-
-class SendDestinationAndMethod(cdt.Structure):
-    transport_service: TransportServiceType
-    destination: cdt.OctetString
-    message: MessageType
-
-
-class CommunicationWindow(cdt.Array):
-    """ Defines the time points when the communication window(s) for the push become(s) active (start_time) and inactive (end_time). """
-    TYPE = structs.WindowElement
-
-
-class RepetitionDelay(cdt.Structure):
-    repetition_delay_min: cdt.LongUnsigned
-    repetition_delay_exponent: cdt.LongUnsigned
-    repetition_delay_max: cdt.LongUnsigned
-
-
-class PushOperationMethod(cdt.Enum, elements=(0, 1, 2)):
-    """"""
-
-
-class ConfirmationParameters(cdt.Structure):
-    confirmation_start_date: cdt.DateTime
-    confirmation_interval: cdt.DoubleLongUnsigned
-
-
-class KeyInfoElement(choices.StructureMixin, cdt.Structure):
-    """Override several methods of cdt.Structure. It limited Structure."""
-    key_info_type: enums.KeyInfoType
-    key_info_options: choices.KeyInfoOptions
-
-
-class ProtectionOptions(cdt.Structure):
-    transaction_id: cdt.OctetString
-    originator_system_title: cdt.OctetString
-    recipient_system_title: cdt.OctetString
-    other_information: cdt.OctetString
-    key_info: KeyInfoElement
-
-
-class ProtectionParametersElement(cdt.Structure):
-    protection_type: enums.ProtectionType
-    protection_options: ProtectionOptions
-
-
-class PushProtectionParameters(cdt.Array):
-    TYPE = ProtectionParametersElement
-
-
-class PushSetup(ic.COSEMInterfaceClasses):
-    """ DLMS UA 1000-1 Ed. 14 4.4.8.2 Push setup"""
-    CLASS_ID = ClassID.PUSH_SETUP
-    VERSION = VERSION_2
-    A_ELEMENTS = (ic.ICAElement("push_object_list", PushObjectList),
-                  ic.ICAElement("send_destination_and_method", SendDestinationAndMethod),
-                  ic.ICAElement("communication_window", CommunicationWindow),
-                  ic.ICAElement("randomisation_start_interval", cdt.LongUnsigned),
-                  ic.ICAElement("number_of_retries", cdt.Unsigned),
-                  ic.ICAElement("repetition_delay", RepetitionDelay),
-                  ic.ICAElement("port_reference", cst.LogicalName),
-                  ic.ICAElement("push_client_sap", cdt.Integer),
-                  ic.ICAElement("push_protection_parameters", PushProtectionParameters),
-                  ic.ICAElement("push_operation_method", PushOperationMethod),
-                  ic.ICAElement("confirmation_parameters", ConfirmationParameters),
-                  ic.ICAElement("last_confirmation_date_time", cdt.DateTime, classifier=ic.Classifier.DYNAMIC))
-    M_ELEMENTS = (ic.ICMElement("push", integers.Only0),
-                  ic.ICMElement("reset", integers.Only0))
-
-    def characteristics_init(self):
-        """nothing do it"""
-
-    @property
-    def push_object_list(self) -> PushObjectList:
-        return self.get_attr(2)
-
-    @property
-    def send_destination_and_method(self) -> SendDestinationAndMethod:
-        return self.get_attr(3)
-
-    @property
-    def communication_window(self) -> CommunicationWindow:
-        return self.get_attr(4)
-
-    @property
-    def randomisation_start_interval(self) -> cdt.LongUnsigned:
-        return self.get_attr(5)
-
-    @property
-    def number_of_retries(self) -> cdt.Unsigned:
-        return self.get_attr(6)
-
-    @property
-    def repetition_delay(self) -> RepetitionDelay:
-        return self.get_attr(7)
-
-    @property
-    def port_reference(self) -> cst.LogicalName:
-        return self.get_attr(8)
-
-    @property
-    def push_client_SAP(self) -> cdt.Integer:
-        return self.get_attr(9)
-
-    @property
-    def push_protection_parameters(self) -> PushProtectionParameters:
-        return self.get_attr(10)
-
-    @property
-    def push_operation_method(self) -> PushOperationMethod:
-        return self.get_attr(11)
-
-    @property
-    def confirmation_parameters(self) -> ConfirmationParameters:
-        return self.get_attr(12)
-
-    @property
-    def last_confirmation_date_time(self) -> cdt.DateTime:
-        return self.get_attr(13)
-
-    @property
-    def push(self) -> integers.Only0:
-        return self.get_meth(1)
-
-    @property
-    def reset(self) -> integers.Only0:
-        return self.get_meth(2)
+from typing import Optional
+from ...types import cdt, cst
+from ...types.implementations import structs, enums, integers
+from itertools import chain
+from ...types import choices
+from ..cosem_interface_class import ICAElement, ICMElement, Classifier, ICAuto
+from ..Overview import class_id
+
+
+class RestrictionElement(choices.StructureMixin, cdt.Structure):
+    """restriction_element"""
+    restriction_type: enums.RestrictionType
+    restriction_value: choices.restriction_value
+
+
+class ColumnElement(cdt.Array):
+    """column_element"""
+    TYPE = structs.CaptureObjectDefinition
+
+
+class PushObjectDefinition(cdt.Structure):
+    """push_object_definition"""
+    class_id: cdt.LongUnsigned
+    logical_name: cst.LogicalName
+    attribute_index: cdt.Integer
+    data_index: cdt.LongUnsigned
+    restriction: RestrictionElement
+    column: ColumnElement
+
+
+class PushObjectList(cdt.Array):
+    """push_object_list attribute"""
+    TYPE = PushObjectDefinition
+
+
+class TransportServiceType(cdt.Enum, elements=tuple(chain(range(9), range(200, 256)))):  # TODO: elements 200.. is manufacturer specific
+    """transport_service_type"""
+
+
+class MessageType(cdt.Enum, elements=tuple(chain((0, 1), range(128, 256)))):  # TODO: elements 128.. is manufacturer specific
+    """message_type"""
+
+
+class SendDestinationAndMethod(cdt.Structure):
+    """send_destination_and_method"""
+    transport_service: TransportServiceType
+    destination: cdt.OctetString
+    message: MessageType
+
+
+class CommunicationWindow(cdt.Array):
+    """communication_window attribute"""
+    TYPE = structs.WindowElement
+
+
+class RepetitionDelay(cdt.Structure):
+    """repetition_delay"""
+    repetition_delay_min: cdt.LongUnsigned
+    repetition_delay_exponent: cdt.LongUnsigned
+    repetition_delay_max: cdt.LongUnsigned
+
+
+class PushOperationMethod(cdt.Enum, elements=(0, 1, 2)):
+    """"""
+
+
+class ConfirmationParameters(cdt.Structure):
+    confirmation_start_date: cdt.DateTime
+    confirmation_interval: cdt.DoubleLongUnsigned
+
+
+class KeyInfoElement(choices.StructureMixin, cdt.Structure):
+    """Override several methods of cdt.Structure. It limited Structure."""
+    key_info_type: enums.KeyInfoType
+    key_info_options: choices.KeyInfoOptions
+
+
+class ProtectionOptions(cdt.Structure):
+    transaction_id: cdt.OctetString
+    originator_system_title: cdt.OctetString
+    recipient_system_title: cdt.OctetString
+    other_information: cdt.OctetString
+    key_info: KeyInfoElement
+
+
+class ProtectionParametersElement(cdt.Structure):
+    protection_type: enums.ProtectionType
+    protection_options: ProtectionOptions
+
+
+class PushProtectionParameters(cdt.Array):
+    TYPE = ProtectionParametersElement
+
+
+class PushSetup(ICAuto):
+    """4.4.8.2 Push setup"""
+    CLASS_ID = class_id.PUSH_SETUP
+    VERSION = 2
+    A_ELEMENTS = (ICAElement(2, "push_object_list", PushObjectList),
+                  ICAElement(3, "send_destination_and_method", SendDestinationAndMethod),
+                  ICAElement(4, "communication_window", CommunicationWindow),
+                  ICAElement(5, "randomisation_start_interval", cdt.LongUnsigned),
+                  ICAElement(6, "number_of_retries", cdt.Unsigned),
+                  ICAElement(7, "repetition_delay", RepetitionDelay),
+                  ICAElement(8, "port_reference", cst.LogicalName),
+                  ICAElement(9, "push_client_sap", cdt.Integer),
+                  ICAElement(10, "push_protection_parameters", PushProtectionParameters),
+                  ICAElement(11, "push_operation_method", PushOperationMethod),
+                  ICAElement(12, "confirmation_parameters", ConfirmationParameters),
+                  ICAElement(13, "last_confirmation_date_time", cdt.DateTime, classifier=Classifier.DYNAMIC))
+    M_ELEMENTS = (ICMElement(1, "push", integers.Only0),
+                  ICMElement(2, "reset", integers.Only0))
+    push_object_list: Optional[PushObjectList]
+    send_destination_and_method: Optional[SendDestinationAndMethod]
+    communication_window: Optional[CommunicationWindow]
+    randomisation_start_interval: Optional[cdt.LongUnsigned]
+    number_of_retries: Optional[cdt.Unsigned]
+    repetition_delay: Optional[RepetitionDelay]
+    port_reference: Optional[cst.LogicalName]
+    push_client_SAP: Optional[cdt.Integer]
+    push_protection_parameters: Optional[PushProtectionParameters]
+    push_operation_method: Optional[PushOperationMethod]
+    confirmation_parameters: Optional[ConfirmationParameters]
+    last_confirmation_date_time: Optional[cdt.DateTime]

DLMS_SPODES/cosem_interface_classes/register.py

@@ -1,45 +1,18 @@
-from .__class_init__ import *
-from ..types import choices
-from ..types.implementations import integers
-from .overview import VERSION_0
-
-
-class Register(ic.COSEMInterfaceClasses):
-    """ A “Register” object stores a process value or a status value with its associated unit. The register object knows
-    the nature of the process value or of the status value. The nature of the value is described by the attribute
-    “logical name” using the OBIS identification system. """
-    CLASS_ID = ClassID.REGISTER
-    VERSION = VERSION_0
-    scaler_unit_not_settable: bool
-    A_ELEMENTS = (
-        ic.ICAElement("value", choices.register, classifier=ic.Classifier.NOT_SPECIFIC),
-        ic.ICAElement("scaler_unit", cdt.ScalUnitType))
-    M_ELEMENTS = (
-        ic.ICMElement("reset", integers.Only0),)
-
-    def characteristics_init(self):
-        self._cbs_attr_post_init.update({2: self.__set_value_data_type})
-
-        self.scaler_unit_not_settable = False
-        """ usability scaler unit flag. if True then it not used"""
-
-    @property
-    def value(self) -> choices.RegisterValues:
-        return self.get_attr(2)
-
-    @property
-    def scaler_unit(self) -> cdt.ScalUnitType:
-        return self.get_attr(3)
-
-    @property
-    def reset(self) -> integers.Only0:
-        return self.get_meth(1)
-
-    def __set_value_data_type(self):
-        """ When instead of a “Data” object a “Register” object is used, (with the scaler_unit attribute not used or with scaler = 0, unit = 255) then the data types allowed for
-        the value attribute of the “Data” interface class are allowed. """
-        match self.value:
-            case cdt.Array() | cdt.CompactArray() | cdt.Structure():
-                self.set_attr(3, cdt.ScalUnitType(b'\x02\x02\x0f\x00\x16\xff'))
-            case _:
-                """ nothing do it """
+from ..types.implementations import integers
+from typing import Optional
+from ..types import choices, cdt
+from .cosem_interface_class import ICAuto, ICAElement, ICMElement, Classifier, Cardinality
+from .Overview import class_id
+
+
+class Register(ICAuto):
+    """4.3.2 Register"""
+    CLASS_ID = class_id.REGISTER
+    VERSION = 0
+    CARDINALITY = Cardinality()
+    A_ELEMENTS = (
+        ICAElement(2, "value", choices.register, classifier=Classifier.NOT_SPECIFIC),
+        ICAElement(3, "scaler_unit", cdt.ScalUnitType))
+    M_ELEMENTS = ICMElement(1, "reset", integers.Only0),
+    value: Optional[choices.RegisterValues]
+    scaler_unit: Optional[cdt.ScalUnitType]

DLMS_SPODES/cosem_interface_classes/register_activation/ver0.py

@@ -1,80 +1,45 @@
-from ..__class_init__ import *
-from ...types import cst
-from ...types.implementations import long_unsigneds
-from ..overview import VERSION_0
-
-class ObjectDefinition(cdt.Structure):
-    class_id: long_unsigneds.ClassId
-    logical_name: cst.LogicalName
-
-
-class RegisterAssignment(cdt.Array):
-    TYPE = ObjectDefinition
-
-
-class IndexArray(cdt.Array):
-    TYPE = cdt.Unsigned
-
-
-class RegisterActMask(cdt.Structure):
-    mask_name: cdt.OctetString
-    index_list: IndexArray
-
-
-class MaskList(cdt.Array):
-    TYPE = RegisterActMask
-
-
-class RegisterActivation(ic.COSEMInterfaceClasses):
-    """ A “Register” object stores a process value or a status value with its associated unit. The register object knows
-    the nature of the process value or of the status value. The nature of the value is described by the attribute
-    “logical name” using the OBIS identification system. """
-    CLASS_ID = ClassID.REGISTER_ACTIVATION
-    VERSION = VERSION_0
-    A_ELEMENTS = (
-        ic.ICAElement(
-            NAME="register_assignment",
-            DATA_TYPE=RegisterAssignment),
-        ic.ICAElement(
-            NAME="mask_list",
-            DATA_TYPE=MaskList),
-        ic.ICAElement(
-            NAME="active_mask",
-            DATA_TYPE=cdt.OctetString))
-    M_ELEMENTS = (
-        ic.ICMElement(
-            NAME="add_register",
-            DATA_TYPE=ObjectDefinition),
-        ic.ICMElement(
-            NAME="add_mask",
-            DATA_TYPE=RegisterActMask),
-        ic.ICMElement(
-            NAME="delete_mask",
-            DATA_TYPE=cdt.OctetString))
-
-    def characteristics_init(self):
-        """nothing do"""
-
-    @property
-    def register_assignment(self) -> RegisterAssignment:
-        return self.get_attr(2)
-
-    @property
-    def mask_list(self) -> MaskList:
-        return self.get_attr(3)
-
-    @property
-    def active_mask(self) -> cdt.OctetString:
-        return self.get_attr(4)
-
-    @property
-    def add_register(self) -> ObjectDefinition:
-        return self.get_meth(1)
-
-    @property
-    def add_mask(self) -> RegisterActMask:
-        return self.get_meth(2)
-
-    @property
-    def delete_mask(self) -> cdt.OctetString:
-        return self.get_meth(3)
+from ..cosem_interface_class import ICAuto, ICAElement, ICMElement
+from ...types import cst
+from ...types.implementations import long_unsigneds
+from typing import Optional
+from ...types import cdt
+from ..Overview import class_id
+
+
+class ObjectDefinition(cdt.Structure):
+    class_id: long_unsigneds.ClassId
+    logical_name: cst.LogicalName
+
+
+class RegisterAssignment(cdt.Array):
+    TYPE = ObjectDefinition
+
+
+class IndexArray(cdt.Array):
+    TYPE = cdt.Unsigned
+
+
+class RegisterActMask(cdt.Structure):
+    mask_name: cdt.OctetString
+    index_list: IndexArray
+
+
+class MaskList(cdt.Array):
+    TYPE = RegisterActMask
+
+
+class RegisterActivation(ICAuto):
+    """4.3.5 Register activation"""
+    CLASS_ID = class_id.REGISTER_ACTIVATION
+    VERSION = 0
+    A_ELEMENTS = (
+        ICAElement(2, "register_assignment", RegisterAssignment),
+        ICAElement(3, "mask_list", MaskList),
+        ICAElement(4, "active_mask", cdt.OctetString))
+    M_ELEMENTS = (
+        ICMElement(1, "add_register", ObjectDefinition),
+        ICMElement(2, "add_mask", RegisterActMask),
+        ICMElement(3, "delete_mask", cdt.OctetString))
+    register_assignment: Optional[RegisterAssignment]
+    mask_list: Optional[MaskList]
+    active_mask: Optional[cdt.OctetString]

DLMS_SPODES/cosem_interface_classes/register_monitor.py

@@ -1,46 +1,33 @@
-from .__class_init__ import *
-from ..types import choices
-from ..types.implementations import structs
-from .overview import VERSION_0
-threshold_scaler_unit = cdt.ScalUnitType(b'\x02\x02\x0f\x00\x16\x07')
-
-
-class Thresholds(cdt.Array):
-    TYPE = choices.simple_dt
-
-
-class ActionSet(cdt.Structure):
-    """TODO:"""
-    action_up: structs.ActionItem
-    action_down: structs.ActionItem
-
-
-class Actions(cdt.Array):
-    """Defines the scripts to be executed when the monitored attribute of the referenced object crosses the corresponding threshold. The attribute actions has exactly
-    the same number of elements as the attribute thresholds. The ordering of the action_items corresponds to the ordering of the thresholds (see above)."""
-    TYPE = ActionSet
-
-
-class RegisterMonitor(ic.COSEMInterfaceClasses):
-    """ DLMS UA 1000-1 Ed.14. 4.5.6. This IC allows modelling the function of monitoring of values modelled by “Data”, “Register”, “Extended register” or “Demand register” objects.
-    It allows specifying thresholds, the value monitored, and a set of scripts (see 4.5.2) that are executed when the value monitored crosses a threshold """
-    CLASS_ID = ClassID.REGISTER_MONITOR
-    VERSION = VERSION_0
-    A_ELEMENTS = (ic.ICAElement("thresholds", Thresholds),
-                  ic.ICAElement("monitored_value", structs.ValueDefinition),
-                  ic.ICAElement("actions", Actions))
-
-    def characteristics_init(self):
-        ...
-
-    @property
-    def thresholds(self) -> Thresholds:
-        return self.get_attr(2)
-
-    @property
-    def monitored_value(self) -> structs.ValueDefinition:
-        return self.get_attr(3)
-
-    @property
-    def threshold_normal(self) -> Actions:
-        return self.get_attr(4)
+from ..types.implementations import structs
+from typing import Optional
+from ..types import choices, cdt
+from .cosem_interface_class import ICAuto, ICAElement
+from .Overview import class_id
+
+
+class Thresholds(cdt.Array):
+    """thresholds attribute"""
+    TYPE = choices.simple_dt
+
+
+class ActionSet(cdt.Structure):
+    """action_set"""
+    action_up: structs.ActionItem
+    action_down: structs.ActionItem
+
+
+class Actions(cdt.Array):
+    """actions attribute"""
+    TYPE = ActionSet
+
+
+class RegisterMonitor(ICAuto):
+    """4.5.6 Register monitor"""
+    CLASS_ID = class_id.REGISTER_MONITOR
+    VERSION = 0
+    A_ELEMENTS = (ICAElement(2, "thresholds", Thresholds),
+                  ICAElement(3, "monitored_value", structs.ValueDefinition),
+                  ICAElement(4, "actions", Actions))
+    thresholds: Optional[Thresholds]
+    monitored_value: Optional[structs.ValueDefinition]
+    threshold_normal: Optional[Actions]