PySide6.QtSerialBus.QModbusReply¶

class QModbusReply¶

The QModbusReply class contains the data for a request sent with a QModbusClient derived class. More…

Synopsis¶

Methods¶

def __init__()
def addIntermediateError()
def error()
def errorString()
def intermediateErrors()
def isFinished()
def rawResult()
def result()
def serverAddress()
def setError()
def setFinished()
def setRawResult()
def setResult()
def type()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

class ReplyType¶

This enum describes the possible reply type.

Constant

Description

QModbusReply.Raw

The reply originates from a raw Modbus request. See sendRawRequest

QModbusReply.Common

The reply originates from a common read, write or read/write request. See sendReadRequest , sendWriteRequest and sendReadWriteRequest

QModbusReply.Broadcast

The reply originates from a Modbus broadcast request. The serverAddress() will return 0 and the finished() signal will be emitted immediately.

Constant	Description
QModbusReply.Raw	The reply originates from a raw Modbus request. See `sendRawRequest`
QModbusReply.Common	The reply originates from a common read, write or read/write request. See `sendReadRequest` , `sendWriteRequest` and `sendReadWriteRequest`
QModbusReply.Broadcast	The reply originates from a Modbus broadcast request. The `serverAddress()` will return `0` and the `finished()` signal will be emitted immediately.

__init__(type, serverAddress[, parent=None])¶

Parameters:

type – ReplyType
serverAddress – int
parent – QObject

Constructs a QModbusReply object with a given type and the specified parent.

The reply will be sent to the Modbus client represented by serverAddress.

addIntermediateError(error)¶

Parameters:: error – IntermediateError

error()¶

Return type:: Error

Returns the error state of this reply.

See also

errorString() errorOccurred()

errorOccurred(error)¶

Parameters:: error – Error

This signal is emitted when an error has been detected in the processing of this reply. The finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error. In case of a ProtocolError the rawResult() function can be used to obtain the original Modbus exception response to get the exception code.

Note: Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

See also

error() errorString()

errorString()¶

Return type:: str

Returns the textual representation of the error state of this reply.

If no error has occurred this will return an empty string. It is possible that an error occurred which has no associated textual representation, in which case this will also return an empty string.

See also

error() errorOccurred()

finished()¶

This signal is emitted when the reply has finished processing. The reply may still have returned with an error.

After this signal is emitted, there will be no more updates to the reply’s data.

Note

Do not delete the object in the slot connected to this signal. Use deleteLater().

You can also use isFinished() to check if a QNetworkReply has finished even before you receive the finished() signal.

See also

isFinished() error()

intermediateErrorOccurred(error)¶

Parameters:: error – IntermediateError

intermediateErrors()¶

Return type:: .list of QModbusDevice.IntermediateError

Returns the list of intermediate errors that might have happened during the send-receive cycle of a Modbus request until the QModbusReply reports to be finished.

isFinished()¶

Return type:: bool

Returns true when the reply has finished or was aborted.

See also

finished() error()

rawResult()¶

Return type:: QModbusResponse

Returns the raw response of a Modbus request.

If the request has not finished then the returned QModbusResponse instance is invalid.

See also

type() result()

result()¶

Return type:: QModbusDataUnit

Returns the preprocessed result of a Modbus request.

For read requests as well as combined read/write requests send via sendReadWriteRequest() it contains the values read from the server instance.

If the request has not finished, has failed with an error or was a write request then the returned QModbusDataUnit instance is invalid.

Note

If the type() of the reply is Broadcast , the return value will always be invalid. If the type() of the reply is Raw , the return value might be invalid depending on the implementation of processPrivateResponse() .