Pymodbus internals

Contents:

• NullModem
• Framer
  • pymodbus.framer.FramerAscii module
  • pymodbus.framer.FramerRTU module
  • pymodbus.framer.FramerSocket module
  • pymodbus.framer.FramerTLS module
• Constants
  • DeviceInformation.BASIC
  • DeviceInformation.REGULAR
  • DeviceInformation.EXTENDED
  • DeviceInformation.SPECIFIC
  • ModbusPlusOperation.GET_STATISTICS
  • ModbusPlusOperation.CLEAR_STATISTICS
  • ModbusStatus.WAITING
  • ModbusStatus.READY
  • ModbusStatus.ON
  • ModbusStatus.OFF
  • MoreData.NOTHING
  • MoreData.KEEP_READING
• Extra functions
  • ExceptionResponse
    • ExceptionResponse.encode()
    • ExceptionResponse.x_calculateRtuFrameSize()
    • ExceptionResponse.x_decode()
  • FramerType
    • FramerType.ASCII
    • FramerType.RTU
    • FramerType.SOCKET
    • FramerType.TLS
  • ModbusDeviceIdentification
    • ModbusDeviceIdentification.MajorMinorRevision
    • ModbusDeviceIdentification.ModelName
    • ModbusDeviceIdentification.ProductCode
    • ModbusDeviceIdentification.ProductName
    • ModbusDeviceIdentification.UserApplicationName
    • ModbusDeviceIdentification.VendorName
    • ModbusDeviceIdentification.VendorUrl
    • ModbusDeviceIdentification.stat_data
    • ModbusDeviceIdentification.summary()
    • ModbusDeviceIdentification.update()
  • ModbusException
    • ModbusException.isError()
  • pymodbus_apply_logging_config()
  • ConnectionException
  • MessageRegisterException
  • ModbusIOException
  • NoSuchIdException
  • NotImplementedException
  • ParameterException
  • TransactionManager
    • TransactionManager.callback_connected()
    • TransactionManager.callback_data()
    • TransactionManager.callback_disconnected()
    • TransactionManager.callback_new_connection()
    • TransactionManager.dummy_trace_connect()
    • TransactionManager.dummy_trace_packet()
    • TransactionManager.dummy_trace_pdu()
    • TransactionManager.execute()
    • TransactionManager.getNextTID()
    • TransactionManager.pdu_send()
    • TransactionManager.sync_execute()
    • TransactionManager.sync_get_response()
  • dict_property()
  • hexlify_packets()
• PDU classes
  • DecodePDU
    • DecodePDU.add_pdu()
    • DecodePDU.add_sub_pdu()
    • DecodePDU.calculateRtuFrameSize()
    • DecodePDU.decode()
    • DecodePDU.list_function_codes()
    • DecodePDU.pdu_sub_table
    • DecodePDU.pdu_table
    • DecodePDU.register()
  • ReadCoilsRequest
    • ReadCoilsRequest.MAX_COUNT
    • ReadCoilsRequest.datastore_update()
    • ReadCoilsRequest.encode()
    • ReadCoilsRequest.function_code
    • ReadCoilsRequest.x_calculateRtuFrameSize()
    • ReadCoilsRequest.x_decode()
  • ReadCoilsResponse
    • ReadCoilsResponse.encode()
    • ReadCoilsResponse.function_code
    • ReadCoilsResponse.x_calculateRtuFrameSize()
    • ReadCoilsResponse.x_decode()
  • ReadDiscreteInputsRequest
    • ReadDiscreteInputsRequest.function_code
  • ReadDiscreteInputsResponse
    • ReadDiscreteInputsResponse.function_code
  • WriteMultipleCoilsRequest
    • WriteMultipleCoilsRequest.MAX_COUNT
    • WriteMultipleCoilsRequest.byte_count
    • WriteMultipleCoilsRequest.count
    • WriteMultipleCoilsRequest.data_byte_count
    • WriteMultipleCoilsRequest.datastore_update()
    • WriteMultipleCoilsRequest.encode()
    • WriteMultipleCoilsRequest.function_code
    • WriteMultipleCoilsRequest.x_calculateRtuFrameSize()
    • WriteMultipleCoilsRequest.x_decode()
  • WriteMultipleCoilsResponse
    • WriteMultipleCoilsResponse.encode()
    • WriteMultipleCoilsResponse.function_code
    • WriteMultipleCoilsResponse.x_calculateRtuFrameSize()
    • WriteMultipleCoilsResponse.x_decode()
  • WriteSingleCoilRequest
    • WriteSingleCoilRequest.datastore_update()
  • WriteSingleCoilResponse
    • WriteSingleCoilResponse.encode()
    • WriteSingleCoilResponse.function_code
    • WriteSingleCoilResponse.x_calculateRtuFrameSize()
    • WriteSingleCoilResponse.x_decode()
  • ChangeAsciiInputDelimiterRequest
    • ChangeAsciiInputDelimiterRequest.datastore_update()
    • ChangeAsciiInputDelimiterRequest.sub_function_code
  • ChangeAsciiInputDelimiterResponse
    • ChangeAsciiInputDelimiterResponse.sub_function_code
  • ClearCountersRequest
    • ClearCountersRequest.datastore_update()
    • ClearCountersRequest.sub_function_code
  • ClearCountersResponse
    • ClearCountersResponse.sub_function_code
  • ClearOverrunCountRequest
    • ClearOverrunCountRequest.datastore_update()
    • ClearOverrunCountRequest.sub_function_code
  • ClearOverrunCountResponse
    • ClearOverrunCountResponse.sub_function_code
  • DiagnosticBase
    • DiagnosticBase.datastore_update()
    • DiagnosticBase.decode_sub_function_code()
    • DiagnosticBase.encode()
    • DiagnosticBase.function_code
    • DiagnosticBase.message
    • DiagnosticBase.sub_function_code
    • DiagnosticBase.x_calculateRtuFrameSize()
    • DiagnosticBase.x_decode()
  • ForceListenOnlyModeRequest
    • ForceListenOnlyModeRequest.datastore_update()
    • ForceListenOnlyModeRequest.sub_function_code
  • ForceListenOnlyModeResponse
    • ForceListenOnlyModeResponse.sub_function_code
  • GetClearModbusPlusRequest
    • GetClearModbusPlusRequest.datastore_update()
    • GetClearModbusPlusRequest.encode()
    • GetClearModbusPlusRequest.sub_function_code
  • GetClearModbusPlusResponse
    • GetClearModbusPlusResponse.sub_function_code
    • GetClearModbusPlusResponse.x_calculateRtuFrameSize()
  • RestartCommunicationsOptionRequest
    • RestartCommunicationsOptionRequest.sub_function_code
  • RestartCommunicationsOptionResponse
    • RestartCommunicationsOptionResponse.sub_function_code
  • ReturnBusCommunicationErrorCountRequest
    • ReturnBusCommunicationErrorCountRequest.datastore_update()
    • ReturnBusCommunicationErrorCountRequest.sub_function_code
  • ReturnBusCommunicationErrorCountResponse
    • ReturnBusCommunicationErrorCountResponse.sub_function_code
  • ReturnBusExceptionErrorCountRequest
    • ReturnBusExceptionErrorCountRequest.datastore_update()
    • ReturnBusExceptionErrorCountRequest.sub_function_code
  • ReturnBusExceptionErrorCountResponse
    • ReturnBusExceptionErrorCountResponse.sub_function_code
  • ReturnBusMessageCountRequest
    • ReturnBusMessageCountRequest.datastore_update()
    • ReturnBusMessageCountRequest.sub_function_code
  • ReturnBusMessageCountResponse
    • ReturnBusMessageCountResponse.sub_function_code
  • ReturnDeviceBusCharacterOverrunCountRequest
    • ReturnDeviceBusCharacterOverrunCountRequest.datastore_update()
    • ReturnDeviceBusCharacterOverrunCountRequest.sub_function_code
  • ReturnDeviceBusCharacterOverrunCountResponse
    • ReturnDeviceBusCharacterOverrunCountResponse.sub_function_code
  • ReturnDeviceBusyCountRequest
    • ReturnDeviceBusyCountRequest.datastore_update()
    • ReturnDeviceBusyCountRequest.sub_function_code
  • ReturnDeviceBusyCountResponse
    • ReturnDeviceBusyCountResponse.sub_function_code
  • ReturnDeviceMessageCountRequest
    • ReturnDeviceMessageCountRequest.datastore_update()
    • ReturnDeviceMessageCountRequest.sub_function_code
  • ReturnDeviceMessageCountResponse
    • ReturnDeviceMessageCountResponse.sub_function_code
  • ReturnDeviceNAKCountRequest
    • ReturnDeviceNAKCountRequest.datastore_update()
    • ReturnDeviceNAKCountRequest.sub_function_code
  • ReturnDeviceNAKCountResponse
    • ReturnDeviceNAKCountResponse.sub_function_code
  • ReturnDeviceNoResponseCountRequest
    • ReturnDeviceNoResponseCountRequest.datastore_update()
    • ReturnDeviceNoResponseCountRequest.sub_function_code
  • ReturnDeviceNoResponseCountResponse
    • ReturnDeviceNoResponseCountResponse.sub_function_code
  • ReturnDiagnosticRegisterRequest
    • ReturnDiagnosticRegisterRequest.datastore_update()
    • ReturnDiagnosticRegisterRequest.sub_function_code
  • ReturnDiagnosticRegisterResponse
    • ReturnDiagnosticRegisterResponse.sub_function_code
  • ReturnIopOverrunCountRequest
    • ReturnIopOverrunCountRequest.datastore_update()
    • ReturnIopOverrunCountRequest.sub_function_code
  • ReturnIopOverrunCountResponse
    • ReturnIopOverrunCountResponse.sub_function_code
  • ReturnQueryDataRequest
    • ReturnQueryDataRequest.sub_function_code
  • ReturnQueryDataResponse
    • ReturnQueryDataResponse.sub_function_code
  • FileRecord
    • FileRecord.file_number
    • FileRecord.record_data
    • FileRecord.record_length
    • FileRecord.record_number
  • ReadFifoQueueRequest
    • ReadFifoQueueRequest.datastore_update()
    • ReadFifoQueueRequest.encode()
    • ReadFifoQueueRequest.function_code
    • ReadFifoQueueRequest.x_calculateRtuFrameSize()
    • ReadFifoQueueRequest.x_decode()
  • ReadFifoQueueResponse
    • ReadFifoQueueResponse.encode()
    • ReadFifoQueueResponse.function_code
    • ReadFifoQueueResponse.x_calculateRtuFrameSize()
    • ReadFifoQueueResponse.x_decode()
  • ReadFileRecordRequest
    • ReadFileRecordRequest.datastore_update()
    • ReadFileRecordRequest.encode()
    • ReadFileRecordRequest.function_code
    • ReadFileRecordRequest.records
    • ReadFileRecordRequest.x_calculateRtuFrameSize()
    • ReadFileRecordRequest.x_decode()
  • ReadFileRecordResponse
    • ReadFileRecordResponse.encode()
    • ReadFileRecordResponse.function_code
    • ReadFileRecordResponse.records
    • ReadFileRecordResponse.x_calculateRtuFrameSize()
    • ReadFileRecordResponse.x_decode()
  • WriteFileRecordRequest
    • WriteFileRecordRequest.datastore_update()
    • WriteFileRecordRequest.encode()
    • WriteFileRecordRequest.function_code
    • WriteFileRecordRequest.records
    • WriteFileRecordRequest.x_calculateRtuFrameSize()
    • WriteFileRecordRequest.x_decode()
  • WriteFileRecordResponse
    • WriteFileRecordResponse.encode()
    • WriteFileRecordResponse.function_code
    • WriteFileRecordResponse.records
    • WriteFileRecordResponse.x_calculateRtuFrameSize()
    • WriteFileRecordResponse.x_decode()
  • ReadDeviceInformationRequest
    • ReadDeviceInformationRequest.datastore_update()
    • ReadDeviceInformationRequest.decode_sub_function_code()
    • ReadDeviceInformationRequest.encode()
    • ReadDeviceInformationRequest.function_code
    • ReadDeviceInformationRequest.sub_function_code
    • ReadDeviceInformationRequest.x_calculateRtuFrameSize()
    • ReadDeviceInformationRequest.x_decode()
  • ReadDeviceInformationResponse
    • ReadDeviceInformationResponse.decode_sub_function_code()
    • ReadDeviceInformationResponse.encode()
    • ReadDeviceInformationResponse.function_code
    • ReadDeviceInformationResponse.information
    • ReadDeviceInformationResponse.sub_function_code
    • ReadDeviceInformationResponse.x_calculateRtuFrameSize()
    • ReadDeviceInformationResponse.x_decode()
  • GetCommEventCounterRequest
    • GetCommEventCounterRequest.datastore_update()
    • GetCommEventCounterRequest.encode()
    • GetCommEventCounterRequest.function_code
    • GetCommEventCounterRequest.x_calculateRtuFrameSize()
    • GetCommEventCounterRequest.x_decode()
  • GetCommEventCounterResponse
    • GetCommEventCounterResponse.encode()
    • GetCommEventCounterResponse.function_code
    • GetCommEventCounterResponse.x_calculateRtuFrameSize()
    • GetCommEventCounterResponse.x_decode()
  • GetCommEventLogRequest
    • GetCommEventLogRequest.datastore_update()
    • GetCommEventLogRequest.encode()
    • GetCommEventLogRequest.function_code
    • GetCommEventLogRequest.x_calculateRtuFrameSize()
    • GetCommEventLogRequest.x_decode()
  • GetCommEventLogResponse
    • GetCommEventLogResponse.encode()
    • GetCommEventLogResponse.function_code
    • GetCommEventLogResponse.x_calculateRtuFrameSize()
    • GetCommEventLogResponse.x_decode()
  • ReadExceptionStatusRequest
    • ReadExceptionStatusRequest.datastore_update()
    • ReadExceptionStatusRequest.encode()
    • ReadExceptionStatusRequest.function_code
    • ReadExceptionStatusRequest.x_calculateRtuFrameSize()
    • ReadExceptionStatusRequest.x_decode()
  • ReadExceptionStatusResponse
    • ReadExceptionStatusResponse.encode()
    • ReadExceptionStatusResponse.function_code
    • ReadExceptionStatusResponse.x_calculateRtuFrameSize()
    • ReadExceptionStatusResponse.x_decode()
  • ReportDeviceIdRequest
    • ReportDeviceIdRequest.datastore_update()
    • ReportDeviceIdRequest.encode()
    • ReportDeviceIdRequest.function_code
    • ReportDeviceIdRequest.x_calculateRtuFrameSize()
    • ReportDeviceIdRequest.x_decode()
  • ReportDeviceIdResponse
    • ReportDeviceIdResponse.encode()
    • ReportDeviceIdResponse.function_code
    • ReportDeviceIdResponse.x_calculateRtuFrameSize()
    • ReportDeviceIdResponse.x_decode()
  • MaskWriteRegisterRequest
    • MaskWriteRegisterRequest.datastore_update()
    • MaskWriteRegisterRequest.encode()
    • MaskWriteRegisterRequest.function_code
    • MaskWriteRegisterRequest.x_calculateRtuFrameSize()
    • MaskWriteRegisterRequest.x_decode()
  • MaskWriteRegisterResponse
    • MaskWriteRegisterResponse.encode()
    • MaskWriteRegisterResponse.function_code
    • MaskWriteRegisterResponse.x_calculateRtuFrameSize()
    • MaskWriteRegisterResponse.x_decode()
  • ReadHoldingRegistersRequest
    • ReadHoldingRegistersRequest.MAX_COUNT
    • ReadHoldingRegistersRequest.datastore_update()
    • ReadHoldingRegistersRequest.encode()
    • ReadHoldingRegistersRequest.function_code
    • ReadHoldingRegistersRequest.x_calculateRtuFrameSize()
    • ReadHoldingRegistersRequest.x_decode()
  • ReadHoldingRegistersResponse
    • ReadHoldingRegistersResponse.encode()
    • ReadHoldingRegistersResponse.function_code
    • ReadHoldingRegistersResponse.x_calculateRtuFrameSize()
    • ReadHoldingRegistersResponse.x_decode()
  • ReadInputRegistersRequest
    • ReadInputRegistersRequest.function_code
  • ReadInputRegistersResponse
    • ReadInputRegistersResponse.function_code
  • ReadWriteMultipleRegistersRequest
    • ReadWriteMultipleRegistersRequest.MAX_READ_COUNT
    • ReadWriteMultipleRegistersRequest.MAX_WRITE_COUNT
    • ReadWriteMultipleRegistersRequest.datastore_update()
    • ReadWriteMultipleRegistersRequest.encode()
    • ReadWriteMultipleRegistersRequest.function_code
    • ReadWriteMultipleRegistersRequest.x_calculateRtuFrameSize()
    • ReadWriteMultipleRegistersRequest.x_decode()
  • ReadWriteMultipleRegistersResponse
    • ReadWriteMultipleRegistersResponse.function_code
  • WriteMultipleRegistersRequest
    • WriteMultipleRegistersRequest.byte_count
    • WriteMultipleRegistersRequest.datastore_update()
    • WriteMultipleRegistersRequest.encode()
    • WriteMultipleRegistersRequest.function_code
    • WriteMultipleRegistersRequest.x_calculateRtuFrameSize()
    • WriteMultipleRegistersRequest.x_decode()
  • WriteMultipleRegistersResponse
    • WriteMultipleRegistersResponse.encode()
    • WriteMultipleRegistersResponse.function_code
    • WriteMultipleRegistersResponse.x_calculateRtuFrameSize()
    • WriteMultipleRegistersResponse.x_decode()
  • WriteSingleRegisterRequest
    • WriteSingleRegisterRequest.datastore_update()
  • WriteSingleRegisterResponse
    • WriteSingleRegisterResponse.encode()
    • WriteSingleRegisterResponse.function_code
    • WriteSingleRegisterResponse.x_calculateRtuFrameSize()
    • WriteSingleRegisterResponse.x_decode()
  • DeviceInformationFactory
    • DeviceInformationFactory.get()
  • ModbusDeviceIdentification
    • ModbusDeviceIdentification.MajorMinorRevision
    • ModbusDeviceIdentification.ModelName
    • ModbusDeviceIdentification.ProductCode
    • ModbusDeviceIdentification.ProductName
    • ModbusDeviceIdentification.UserApplicationName
    • ModbusDeviceIdentification.VendorName
    • ModbusDeviceIdentification.VendorUrl
    • ModbusDeviceIdentification.stat_data
    • ModbusDeviceIdentification.summary()
    • ModbusDeviceIdentification.update()
  • ModbusPlusStatistics
    • ModbusPlusStatistics.encode()
    • ModbusPlusStatistics.reset()
    • ModbusPlusStatistics.stat_data
    • ModbusPlusStatistics.summary()
  • CommunicationRestartEvent
    • CommunicationRestartEvent.encode()
    • CommunicationRestartEvent.value
    • CommunicationRestartEvent.x_decode()
  • EnteredListenModeEvent
    • EnteredListenModeEvent.encode()
    • EnteredListenModeEvent.value
    • EnteredListenModeEvent.x_decode()
  • ModbusEvent
    • ModbusEvent.encode()
    • ModbusEvent.x_decode()
  • RemoteReceiveEvent
    • RemoteReceiveEvent.encode()
    • RemoteReceiveEvent.x_decode()
  • RemoteSendEvent
    • RemoteSendEvent.encode()
    • RemoteSendEvent.x_decode()
• Architecture