DLMS-SPODES-client 0.19.22__py3-none-any.whl → 0.19.23__py3-none-any.whl

DLMS_SPODES_client/gurux_dlms/GXDLMSConfirmedServiceError.py

@@ -1,90 +1,90 @@
-from DLMS_SPODES.enums import ServiceError, ConfirmedServiceError
-from .enums.ApplicationReference import ApplicationReference
-from .enums.VdeStateError import VdeStateError
-from .enums.HardwareResource import HardwareResource
-from .enums.Definition import Definition
-from .enums.Access import Access
-from .enums.Service import Service
-from .enums.Initiate import Initiate
-from .enums.LoadDataSet import LoadDataSet
-from .enums.Task import Task
-
-
-class GXDLMSConfirmedServiceError(Exception):
-    """
-    DLMS specific exception class that has error description available from getDescription method.
-    """
-
-    #
-    # Constructor for Confirmed ServiceError.
-    #
-    # @param service
-    # @param type
-    # @param value
-    #
-    def __init__(self, service=None, type_=None, value=0):
-        Exception.__init__(self, "ServiceError " + self.__getConfirmedServiceError(service) + " exception. " + self.__getServiceError(type_) + " " + self.__getServiceErrorValue(type_, value))
-        self.confirmedServiceError = service
-        self.serviceError = type_
-        self.serviceErrorValue = value
-
-    @classmethod
-    def __getConfirmedServiceError(cls, stateError):
-        str_ = ""
-        if stateError == ConfirmedServiceError.INITIATE_ERROR:
-            str_ = "Initiate Error"
-        elif stateError == ConfirmedServiceError.READ:
-            str_ = "Read"
-        elif stateError == ConfirmedServiceError.WRITE:
-            str_ = "Write"
-        return str_
-
-    @classmethod
-    def __getServiceError(cls, error):
-        str_ = ""
-        if error == ServiceError.APPLICATION_REFERENCE:
-            str_ = "Application reference"
-        elif error == ServiceError.HARDWARE_RESOURCE:
-            str_ = "Hardware resource"
-        elif error == ServiceError.VDE_STATE_ERROR:
-            str_ = "Vde state error"
-        elif error == ServiceError.SERVICE:
-            str_ = "Service"
-        elif error == ServiceError.DEFINITION:
-            str_ = "Definition"
-        elif error == ServiceError.ACCESS:
-            str_ = "Access"
-        elif error == ServiceError.INITIATE:
-            str_ = "Initiate"
-        elif error == ServiceError.LOAD_DATA_SET:
-            str_ = "Load dataset"
-        elif error == ServiceError.TASK:
-            str_ = "Task"
-        elif error == ServiceError.OTHER:
-            str_ = "Other Error"
-        return str_
-
-    @classmethod
-    def __getServiceErrorValue(cls, error, value):
-        str_ = ""
-        if error == ServiceError.APPLICATION_REFERENCE:
-            str_ = str(ApplicationReference(value))
-        elif error == ServiceError.HARDWARE_RESOURCE:
-            str_ = str(HardwareResource(value))
-        elif error == ServiceError.VDE_STATE_ERROR:
-            str_ = str(VdeStateError(value))
-        elif error == ServiceError.SERVICE:
-            str_ = str(Service(value))
-        elif error == ServiceError.DEFINITION:
-            str_ = str(Definition(value))
-        elif error == ServiceError.ACCESS:
-            str_ = str(Access(value))
-        elif error == ServiceError.INITIATE:
-            str_ = str(Initiate(value))
-        elif error == ServiceError.LOAD_DATASET:
-            str_ = str(LoadDataSet(value))
-        elif error == ServiceError.TASK:
-            str_ = str(Task(value))
-        elif error == ServiceError.OTHER_ERROR:
-            str_ = str(value)
-        return str_
+from DLMS_SPODES.enums import ServiceError, ConfirmedServiceError
+from .enums.ApplicationReference import ApplicationReference
+from .enums.VdeStateError import VdeStateError
+from .enums.HardwareResource import HardwareResource
+from .enums.Definition import Definition
+from .enums.Access import Access
+from .enums.Service import Service
+from .enums.Initiate import Initiate
+from .enums.LoadDataSet import LoadDataSet
+from .enums.Task import Task
+
+
+class GXDLMSConfirmedServiceError(Exception):
+    """
+    DLMS specific exception class that has error description available from getDescription method.
+    """
+
+    #
+    # Constructor for Confirmed ServiceError.
+    #
+    # @param service
+    # @param type
+    # @param value
+    #
+    def __init__(self, service=None, type_=None, value=0):
+        Exception.__init__(self, "ServiceError " + self.__getConfirmedServiceError(service) + " exception. " + self.__getServiceError(type_) + " " + self.__getServiceErrorValue(type_, value))
+        self.confirmedServiceError = service
+        self.serviceError = type_
+        self.serviceErrorValue = value
+
+    @classmethod
+    def __getConfirmedServiceError(cls, stateError):
+        str_ = ""
+        if stateError == ConfirmedServiceError.INITIATE_ERROR:
+            str_ = "Initiate Error"
+        elif stateError == ConfirmedServiceError.READ:
+            str_ = "Read"
+        elif stateError == ConfirmedServiceError.WRITE:
+            str_ = "Write"
+        return str_
+
+    @classmethod
+    def __getServiceError(cls, error):
+        str_ = ""
+        if error == ServiceError.APPLICATION_REFERENCE:
+            str_ = "Application reference"
+        elif error == ServiceError.HARDWARE_RESOURCE:
+            str_ = "Hardware resource"
+        elif error == ServiceError.VDE_STATE_ERROR:
+            str_ = "Vde state error"
+        elif error == ServiceError.SERVICE:
+            str_ = "Service"
+        elif error == ServiceError.DEFINITION:
+            str_ = "Definition"
+        elif error == ServiceError.ACCESS:
+            str_ = "Access"
+        elif error == ServiceError.INITIATE:
+            str_ = "Initiate"
+        elif error == ServiceError.LOAD_DATA_SET:
+            str_ = "Load dataset"
+        elif error == ServiceError.TASK:
+            str_ = "Task"
+        elif error == ServiceError.OTHER:
+            str_ = "Other Error"
+        return str_
+
+    @classmethod
+    def __getServiceErrorValue(cls, error, value):
+        str_ = ""
+        if error == ServiceError.APPLICATION_REFERENCE:
+            str_ = str(ApplicationReference(value))
+        elif error == ServiceError.HARDWARE_RESOURCE:
+            str_ = str(HardwareResource(value))
+        elif error == ServiceError.VDE_STATE_ERROR:
+            str_ = str(VdeStateError(value))
+        elif error == ServiceError.SERVICE:
+            str_ = str(Service(value))
+        elif error == ServiceError.DEFINITION:
+            str_ = str(Definition(value))
+        elif error == ServiceError.ACCESS:
+            str_ = str(Access(value))
+        elif error == ServiceError.INITIATE:
+            str_ = str(Initiate(value))
+        elif error == ServiceError.LOAD_DATASET:
+            str_ = str(LoadDataSet(value))
+        elif error == ServiceError.TASK:
+            str_ = str(Task(value))
+        elif error == ServiceError.OTHER_ERROR:
+            str_ = str(value)
+        return str_

DLMS_SPODES_client/gurux_dlms/GXDLMSException.py

@@ -1,139 +1,139 @@
-from DLMS_SPODES.enums import AssociationResult, AcseServiceUser
-from .enums import StateError, ServiceError, ErrorCode
-
-
-class GXDLMSException(Exception):
-    """
-    DLMS specific exception class that has error description available from
-    GetDescription method.
-    """
-    def __init__(self, errCode, serviceErr=None):
-        if isinstance(errCode, StateError) and isinstance(serviceErr, ServiceError):
-            Exception.__init__(self, "Meter returns " + self.getStateError(errCode) + " exception. " + self.getServiceError(serviceErr))
-        elif isinstance(errCode, AssociationResult):
-            Exception.__init__(self, F'Connection is {errCode.name} with {serviceErr.name}')
-            self.result = errCode
-            self.diagnostic = serviceErr
-        else:
-            Exception.__init__(self, self.getDescription(errCode))
-        self.errorCode = errCode
-        self.stateError = None
-        self.exceptionServiceError = None
-
-    #
-    # Gets state error description.
-    #
-    # @param stateError
-    #            State error enumerator value.
-    # State error as an string.
-    #
-    @classmethod
-    def getStateError(cls, stateError):
-        if stateError == StateError.SERVICE_NOT_ALLOWED:
-            ret = "Service not allowed"
-        elif stateError == StateError.SERVICE_UNKNOWN:
-            ret = "Service unknown"
-        else:
-            ret = "Invalid error code."
-        return ret
-
-    #
-    # Gets service error description.
-    #
-    # @param serviceError
-    #            Service error enumerator value.
-    # Service error as an string.
-    #
-    @classmethod
-    def getServiceError(cls, serviceError):
-        if serviceError == ServiceError.OPERATION_NOT_POSSIBLE:
-            ret = "Operation not possible"
-        elif serviceError == ServiceError.SERVICE_NOT_SUPPORTED:
-            ret = "Service not supported"
-        elif serviceError == ServiceError.OTHER_REASON:
-            ret = "Other reason"
-        else:
-            ret = "Invalid error code."
-        return ret
-
-    #
-    # Get result as a string.
-    #
-    # @param result
-    #            Enumeration value of AssociationResult.
-    # String description of AssociationResult.
-    #
-    @classmethod
-    def getResult(cls, result):
-        if result == AssociationResult.REJECTED_PERMANENT:
-            ret = "permanently rejected"
-        elif result == AssociationResult.REJECTED_TRANSIENT:
-            ret = "transient rejected"
-        else:
-            ret = "Invalid error code."
-        return ret
-
-    #
-    # Get diagnostic as a string.
-    #
-    # @param value
-    #            Enumeration value of SourceDiagnostic.
-    # String description of SourceDiagnostic.
-    #
-    @classmethod
-    def getDiagnostic(cls, value):
-        if value == AcseServiceUser.NO_REASON_GIVEN:
-            ret = "No reason is given."
-        elif value == AcseServiceUser.APPLICATION_CONTEXT_NAME_NOT_SUPPORTED:
-            ret = "The application context name is not supported."
-        elif value == AcseServiceUser.NOT_RECOGNISED:
-            ret = "The authentication mechanism name is not recognized."
-        elif value == AcseServiceUser.MECHANISM_NAME_REGUIRED:
-            ret = "Authentication mechanism name is required."
-        elif value == AcseServiceUser.AUTHENTICATION_FAILURE:
-            ret = "Authentication failure."
-        elif value == AcseServiceUser.AUTHENTICATION_REQUIRED:
-            ret = "Authentication is required."
-        else:
-            ret = "Invalid error code."
-        return ret
-
-    @classmethod
-    def getDescription(cls, errCode):
-        if errCode == ErrorCode.REJECTED:
-            str_ = "Rejected"
-        elif errCode == ErrorCode.OK:
-            str_ = ""
-        elif errCode == ErrorCode.HARDWARE_FAULT:
-            str_ = "Access Error : Device reports a hardware fault."
-        elif errCode == ErrorCode.TEMPORARY_FAILURE:
-            str_ = "Access Error : Device reports a temporary failure."
-        elif errCode == ErrorCode.READ_WRITE_DENIED:
-            str_ = "Access Error : Device reports Read-Write denied."
-        elif errCode == ErrorCode.UNDEFINED_OBJECT:
-            str_ = "Access Error : Device reports a undefined object."
-        elif errCode == ErrorCode.INCONSISTENT_CLASS:
-            str_ = "Access Error : " + "Device reports a inconsistent Class or object."
-        elif errCode == ErrorCode.UNAVAILABLE_OBJECT:
-            str_ = "Access Error : Device reports a unavailable object."
-        elif errCode == ErrorCode.UNMATCHED_TYPE:
-            str_ = "Access Error : Device reports a unmatched type."
-        elif errCode == ErrorCode.ACCESS_VIOLATED:
-            str_ = "Access Error : Device reports scope of access violated."
-        elif errCode == ErrorCode.DATA_BLOCK_UNAVAILABLE:
-            str_ = "Access Error : Data Block Unavailable."
-        elif errCode == ErrorCode.LONG_GET_OR_READ_ABORTED:
-            str_ = "Access Error : Long Get Or Read Aborted."
-        elif errCode == ErrorCode.NO_LONG_GET_OR_READ_IN_PROGRESS:
-            str_ = "Access Error : No Long Get Or Read In Progress."
-        elif errCode == ErrorCode.LONG_SET_OR_WRITE_ABORTED:
-            str_ = "Access Error : Long Set Or Write Aborted."
-        elif errCode == ErrorCode.NO_LONG_SET_OR_WRITE_IN_PROGRESS:
-            str_ = "Access Error : No Long Set Or Write In Progress."
-        elif errCode == ErrorCode.DATA_BLOCK_NUMBER_INVALID:
-            str_ = "Access Error : Data Block Number Invalid."
-        elif errCode == ErrorCode.OTHER_REASON:
-            str_ = "Access Error : Other Reason."
-        else:
-            str_ = "Access Error : Unknown error."
-        return str_
+from DLMS_SPODES.enums import AssociationResult, AcseServiceUser
+from .enums import StateError, ServiceError, ErrorCode
+
+
+class GXDLMSException(Exception):
+    """
+    DLMS specific exception class that has error description available from
+    GetDescription method.
+    """
+    def __init__(self, errCode, serviceErr=None):
+        if isinstance(errCode, StateError) and isinstance(serviceErr, ServiceError):
+            Exception.__init__(self, "Meter returns " + self.getStateError(errCode) + " exception. " + self.getServiceError(serviceErr))
+        elif isinstance(errCode, AssociationResult):
+            Exception.__init__(self, F'Connection is {errCode.name} with {serviceErr.name}')
+            self.result = errCode
+            self.diagnostic = serviceErr
+        else:
+            Exception.__init__(self, self.getDescription(errCode))
+        self.errorCode = errCode
+        self.stateError = None
+        self.exceptionServiceError = None
+
+    #
+    # Gets state error description.
+    #
+    # @param stateError
+    #            State error enumerator value.
+    # State error as an string.
+    #
+    @classmethod
+    def getStateError(cls, stateError):
+        if stateError == StateError.SERVICE_NOT_ALLOWED:
+            ret = "Service not allowed"
+        elif stateError == StateError.SERVICE_UNKNOWN:
+            ret = "Service unknown"
+        else:
+            ret = "Invalid error code."
+        return ret
+
+    #
+    # Gets service error description.
+    #
+    # @param serviceError
+    #            Service error enumerator value.
+    # Service error as an string.
+    #
+    @classmethod
+    def getServiceError(cls, serviceError):
+        if serviceError == ServiceError.OPERATION_NOT_POSSIBLE:
+            ret = "Operation not possible"
+        elif serviceError == ServiceError.SERVICE_NOT_SUPPORTED:
+            ret = "Service not supported"
+        elif serviceError == ServiceError.OTHER_REASON:
+            ret = "Other reason"
+        else:
+            ret = "Invalid error code."
+        return ret
+
+    #
+    # Get result as a string.
+    #
+    # @param result
+    #            Enumeration value of AssociationResult.
+    # String description of AssociationResult.
+    #
+    @classmethod
+    def getResult(cls, result):
+        if result == AssociationResult.REJECTED_PERMANENT:
+            ret = "permanently rejected"
+        elif result == AssociationResult.REJECTED_TRANSIENT:
+            ret = "transient rejected"
+        else:
+            ret = "Invalid error code."
+        return ret
+
+    #
+    # Get diagnostic as a string.
+    #
+    # @param value
+    #            Enumeration value of SourceDiagnostic.
+    # String description of SourceDiagnostic.
+    #
+    @classmethod
+    def getDiagnostic(cls, value):
+        if value == AcseServiceUser.NO_REASON_GIVEN:
+            ret = "No reason is given."
+        elif value == AcseServiceUser.APPLICATION_CONTEXT_NAME_NOT_SUPPORTED:
+            ret = "The application context name is not supported."
+        elif value == AcseServiceUser.NOT_RECOGNISED:
+            ret = "The authentication mechanism name is not recognized."
+        elif value == AcseServiceUser.MECHANISM_NAME_REGUIRED:
+            ret = "Authentication mechanism name is required."
+        elif value == AcseServiceUser.AUTHENTICATION_FAILURE:
+            ret = "Authentication failure."
+        elif value == AcseServiceUser.AUTHENTICATION_REQUIRED:
+            ret = "Authentication is required."
+        else:
+            ret = "Invalid error code."
+        return ret
+
+    @classmethod
+    def getDescription(cls, errCode):
+        if errCode == ErrorCode.REJECTED:
+            str_ = "Rejected"
+        elif errCode == ErrorCode.OK:
+            str_ = ""
+        elif errCode == ErrorCode.HARDWARE_FAULT:
+            str_ = "Access Error : Device reports a hardware fault."
+        elif errCode == ErrorCode.TEMPORARY_FAILURE:
+            str_ = "Access Error : Device reports a temporary failure."
+        elif errCode == ErrorCode.READ_WRITE_DENIED:
+            str_ = "Access Error : Device reports Read-Write denied."
+        elif errCode == ErrorCode.UNDEFINED_OBJECT:
+            str_ = "Access Error : Device reports a undefined object."
+        elif errCode == ErrorCode.INCONSISTENT_CLASS:
+            str_ = "Access Error : " + "Device reports a inconsistent Class or object."
+        elif errCode == ErrorCode.UNAVAILABLE_OBJECT:
+            str_ = "Access Error : Device reports a unavailable object."
+        elif errCode == ErrorCode.UNMATCHED_TYPE:
+            str_ = "Access Error : Device reports a unmatched type."
+        elif errCode == ErrorCode.ACCESS_VIOLATED:
+            str_ = "Access Error : Device reports scope of access violated."
+        elif errCode == ErrorCode.DATA_BLOCK_UNAVAILABLE:
+            str_ = "Access Error : Data Block Unavailable."
+        elif errCode == ErrorCode.LONG_GET_OR_READ_ABORTED:
+            str_ = "Access Error : Long Get Or Read Aborted."
+        elif errCode == ErrorCode.NO_LONG_GET_OR_READ_IN_PROGRESS:
+            str_ = "Access Error : No Long Get Or Read In Progress."
+        elif errCode == ErrorCode.LONG_SET_OR_WRITE_ABORTED:
+            str_ = "Access Error : Long Set Or Write Aborted."
+        elif errCode == ErrorCode.NO_LONG_SET_OR_WRITE_IN_PROGRESS:
+            str_ = "Access Error : No Long Set Or Write In Progress."
+        elif errCode == ErrorCode.DATA_BLOCK_NUMBER_INVALID:
+            str_ = "Access Error : Data Block Number Invalid."
+        elif errCode == ErrorCode.OTHER_REASON:
+            str_ = "Access Error : Other Reason."
+        else:
+            str_ = "Access Error : Unknown error."
+        return str_

DLMS_SPODES_client/gurux_dlms/GXDLMSLNParameters.py

@@ -1,33 +1,33 @@
-from dataclasses import dataclass
-from . import GXDLMSSettings, GXByteBuffer, ResponseType
-from .enums import ErrorCode
-from DLMS_SPODES.enums import SetRequest, XDLMSAPDU, ACSEAPDU
-
-
-@dataclass
-class GXDLMSLNParameters:
-    settings: GXDLMSSettings
-    invokeId: int
-    command: XDLMSAPDU | ACSEAPDU
-    requestType: ResponseType | SetRequest  # | ActionRequestType
-    attributeDescriptor: GXByteBuffer | None
-    data: GXByteBuffer | None
-    # Reply status.
-    status: ErrorCode | int
-    windowSize: int = 1
-    streaming: bool = False
-    """ Is this last block in send. """
-
-    def __post_init__(self):
-        self.blockIndex = self.settings.blockIndex
-        self.blockNumberAck = self.settings.blockNumberAck
-        self.time = None
-        """ Send date and time.  This is used in Data notification messages. """
-        self.multipleBlocks = self.settings.is_multiple_block()
-        """ Are there more data to send or more data to receive"""
-        self.lastBlock = self.settings.count == self.settings.index
-        """ Is this last block in send. """
-        if self.settings:
-            self.settings.command = self.command
-            if self.command == XDLMSAPDU.GET_REQUEST and self.requestType != ResponseType.WITH_DATABLOCK:
-                self.settings.commandType = self.requestType
+from dataclasses import dataclass
+from . import GXDLMSSettings, GXByteBuffer, ResponseType
+from .enums import ErrorCode
+from DLMS_SPODES.enums import SetRequest, XDLMSAPDU, ACSEAPDU
+
+
+@dataclass
+class GXDLMSLNParameters:
+    settings: GXDLMSSettings
+    invokeId: int
+    command: XDLMSAPDU | ACSEAPDU
+    requestType: ResponseType | SetRequest  # | ActionRequestType
+    attributeDescriptor: GXByteBuffer | None
+    data: GXByteBuffer | None
+    # Reply status.
+    status: ErrorCode | int
+    windowSize: int = 1
+    streaming: bool = False
+    """ Is this last block in send. """
+
+    def __post_init__(self):
+        self.blockIndex = self.settings.blockIndex
+        self.blockNumberAck = self.settings.blockNumberAck
+        self.time = None
+        """ Send date and time.  This is used in Data notification messages. """
+        self.multipleBlocks = self.settings.is_multiple_block()
+        """ Are there more data to send or more data to receive"""
+        self.lastBlock = self.settings.count == self.settings.index
+        """ Is this last block in send. """
+        if self.settings:
+            self.settings.command = self.command
+            if self.command == XDLMSAPDU.GET_REQUEST and self.requestType != ResponseType.WITH_DATABLOCK:
+                self.settings.commandType = self.requestType

DLMS_SPODES_client/gurux_dlms/GXDLMSSNParameters.py

@@ -1,21 +1,21 @@
-from dataclasses import dataclass
-from DLMS_SPODES.enums import VariableAccessSpecification
-from . import GXDLMSSettings, GXByteBuffer
-from .enums.Command import Command
-
-
-@dataclass
-class GXDLMSSNParameters:
-    settings: GXDLMSSettings
-    command: Command
-    count: int
-    requestType: VariableAccessSpecification
-    attributeDescriptor: GXByteBuffer
-    data: GXByteBuffer | None
-
-    def __post_init__(self):
-        self.blockIndex = self.settings.blockIndex
-        self.multipleBlocks = False
-        """ Are there more data to send or more data to receive. """
-        self.time = None
-        """ Send date and time. This is used in Data notification messages. """
+from dataclasses import dataclass
+from DLMS_SPODES.enums import VariableAccessSpecification
+from . import GXDLMSSettings, GXByteBuffer
+from .enums.Command import Command
+
+
+@dataclass
+class GXDLMSSNParameters:
+    settings: GXDLMSSettings
+    command: Command
+    count: int
+    requestType: VariableAccessSpecification
+    attributeDescriptor: GXByteBuffer
+    data: GXByteBuffer | None
+
+    def __post_init__(self):
+        self.blockIndex = self.settings.blockIndex
+        self.multipleBlocks = False
+        """ Are there more data to send or more data to receive. """
+        self.time = None
+        """ Send date and time. This is used in Data notification messages. """