Pymodbus

• pymodbus package
  • Subpackages
    • pymodbus.client
      • Client setup.
      • Client device calls.
    • pymodbus.constants package
      • Defaults.Port
      • Defaults.TLSPort
      • Defaults.Backoff
      • Defaults.Retries
      • Defaults.RetryOnEmpty
      • Defaults.RetryOnInvalid
      • Defaults.Timeout
      • Defaults.Reconnects
      • Defaults.TransactionId
      • Defaults.ProtocolId
      • Defaults.Slave
      • Defaults.Baudrate
      • Defaults.Parity
      • Defaults.Bytesize
      • Defaults.Stopbits
      • Defaults.ZeroMode
      • Defaults.IgnoreMissingSlaves
      • Defaults.broadcast_enable
      • DeviceInformation.Basic
      • DeviceInformation.Regular
      • DeviceInformation.Extended
      • DeviceInformation.Specific
      • Endian.Auto
      • Endian.Big
      • Endian.Little
      • ModbusPlusOperation.GetStatistics
      • ModbusPlusOperation.ClearStatistics
      • ModbusStatus.Waiting
      • ModbusStatus.Ready
      • ModbusStatus.On
      • ModbusStatus.Off
      • ModbusStatus.SlaveOn
      • ModbusStatus.SlaveOff
      • MoreData.Nothing
      • MoreData.KeepReading
      • Submodules
    • pymodbus.datastore package
      • ModbusSequentialDataBlock
      • ModbusServerContext
      • ModbusSlaveContext
      • ModbusSparseDataBlock
      • Subpackages
      • Submodules
      • pymodbus.datastore.context module
      • pymodbus.datastore.remote module
      • pymodbus.datastore.store module
    • pymodbus.framer package
      • Submodules
      • pymodbus.framer.ascii_framer module
      • pymodbus.framer.binary_framer module
      • pymodbus.framer.rtu_framer module
      • pymodbus.framer.socket_framer module
      • Module contents
    • pymodbus.server
      • pymodbus.server package
    • pymodbus.repl package
      • Subpackages
  • Submodules
  • pymodbus.bit_read_message module
    • ReadBitsResponseBase
      • ReadBitsResponseBase.bits
      • ReadBitsResponseBase.decode()
      • ReadBitsResponseBase.encode()
      • ReadBitsResponseBase.getBit()
      • ReadBitsResponseBase.resetBit()
      • ReadBitsResponseBase.setBit()
    • ReadCoilsRequest
      • ReadCoilsRequest.execute()
      • ReadCoilsRequest.function_code
    • ReadCoilsResponse
      • ReadCoilsResponse.function_code
    • ReadDiscreteInputsRequest
      • ReadDiscreteInputsRequest.execute()
      • ReadDiscreteInputsRequest.function_code
    • ReadDiscreteInputsResponse
      • ReadDiscreteInputsResponse.function_code
  • pymodbus.bit_write_message module
    • WriteMultipleCoilsRequest
      • WriteMultipleCoilsRequest.decode()
      • WriteMultipleCoilsRequest.encode()
      • WriteMultipleCoilsRequest.execute()
      • WriteMultipleCoilsRequest.function_code
      • WriteMultipleCoilsRequest.get_response_pdu_size()
    • WriteMultipleCoilsResponse
      • WriteMultipleCoilsResponse.decode()
      • WriteMultipleCoilsResponse.encode()
      • WriteMultipleCoilsResponse.function_code
    • WriteSingleCoilRequest
      • WriteSingleCoilRequest.decode()
      • WriteSingleCoilRequest.encode()
      • WriteSingleCoilRequest.execute()
      • WriteSingleCoilRequest.function_code
      • WriteSingleCoilRequest.get_response_pdu_size()
    • WriteSingleCoilResponse
      • WriteSingleCoilResponse.decode()
      • WriteSingleCoilResponse.encode()
      • WriteSingleCoilResponse.function_code
  • pymodbus.device module
    • DeviceInformationFactory
      • DeviceInformationFactory.get()
    • ModbusControlBlock
      • ModbusControlBlock.Counter
      • ModbusControlBlock.Delimiter
      • ModbusControlBlock.Events
      • ModbusControlBlock.Identity
      • ModbusControlBlock.ListenOnly
      • ModbusControlBlock.Mode
      • ModbusControlBlock.Plus
      • ModbusControlBlock.addEvent()
      • ModbusControlBlock.clearEvents()
      • ModbusControlBlock.getDiagnostic()
      • ModbusControlBlock.getDiagnosticRegister()
      • ModbusControlBlock.getEvents()
      • ModbusControlBlock.reset()
      • ModbusControlBlock.setDiagnostic()
    • ModbusDeviceIdentification
      • ModbusDeviceIdentification.MajorMinorRevision
      • ModbusDeviceIdentification.ModelName
      • ModbusDeviceIdentification.ProductCode
      • ModbusDeviceIdentification.ProductName
      • ModbusDeviceIdentification.UserApplicationName
      • ModbusDeviceIdentification.VendorName
      • ModbusDeviceIdentification.VendorUrl
      • ModbusDeviceIdentification.summary()
      • ModbusDeviceIdentification.update()
    • ModbusPlusStatistics
      • ModbusPlusStatistics.encode()
      • ModbusPlusStatistics.reset()
      • ModbusPlusStatistics.summary()
  • pymodbus.diag_message module
    • ChangeAsciiInputDelimiterRequest
      • ChangeAsciiInputDelimiterRequest.execute()
      • ChangeAsciiInputDelimiterRequest.sub_function_code
    • ChangeAsciiInputDelimiterResponse
      • ChangeAsciiInputDelimiterResponse.sub_function_code
    • ClearCountersRequest
      • ClearCountersRequest.execute()
      • ClearCountersRequest.sub_function_code
    • ClearCountersResponse
      • ClearCountersResponse.sub_function_code
    • ClearOverrunCountRequest
      • ClearOverrunCountRequest.execute()
      • ClearOverrunCountRequest.sub_function_code
    • ClearOverrunCountResponse
      • ClearOverrunCountResponse.sub_function_code
    • DiagnosticStatusRequest
      • DiagnosticStatusRequest.decode()
      • DiagnosticStatusRequest.encode()
      • DiagnosticStatusRequest.function_code
      • DiagnosticStatusRequest.get_response_pdu_size()
    • DiagnosticStatusResponse
      • DiagnosticStatusResponse.decode()
      • DiagnosticStatusResponse.encode()
      • DiagnosticStatusResponse.function_code
    • ForceListenOnlyModeRequest
      • ForceListenOnlyModeRequest.execute()
      • ForceListenOnlyModeRequest.sub_function_code
    • ForceListenOnlyModeResponse
      • ForceListenOnlyModeResponse.should_respond
      • ForceListenOnlyModeResponse.sub_function_code
    • GetClearModbusPlusRequest
      • GetClearModbusPlusRequest.encode()
      • GetClearModbusPlusRequest.execute()
      • GetClearModbusPlusRequest.get_response_pdu_size()
      • GetClearModbusPlusRequest.sub_function_code
    • GetClearModbusPlusResponse
      • GetClearModbusPlusResponse.sub_function_code
    • RestartCommunicationsOptionRequest
      • RestartCommunicationsOptionRequest.execute()
      • RestartCommunicationsOptionRequest.sub_function_code
    • RestartCommunicationsOptionResponse
      • RestartCommunicationsOptionResponse.sub_function_code
    • ReturnBusCommunicationErrorCountRequest
      • ReturnBusCommunicationErrorCountRequest.execute()
      • ReturnBusCommunicationErrorCountRequest.sub_function_code
    • ReturnBusCommunicationErrorCountResponse
      • ReturnBusCommunicationErrorCountResponse.sub_function_code
    • ReturnBusExceptionErrorCountRequest
      • ReturnBusExceptionErrorCountRequest.execute()
      • ReturnBusExceptionErrorCountRequest.sub_function_code
    • ReturnBusExceptionErrorCountResponse
      • ReturnBusExceptionErrorCountResponse.sub_function_code
    • ReturnBusMessageCountRequest
      • ReturnBusMessageCountRequest.execute()
      • ReturnBusMessageCountRequest.sub_function_code
    • ReturnBusMessageCountResponse
      • ReturnBusMessageCountResponse.sub_function_code
    • ReturnDiagnosticRegisterRequest
      • ReturnDiagnosticRegisterRequest.execute()
      • ReturnDiagnosticRegisterRequest.sub_function_code
    • ReturnDiagnosticRegisterResponse
      • ReturnDiagnosticRegisterResponse.sub_function_code
    • ReturnIopOverrunCountRequest
      • ReturnIopOverrunCountRequest.execute()
      • ReturnIopOverrunCountRequest.sub_function_code
    • ReturnIopOverrunCountResponse
      • ReturnIopOverrunCountResponse.sub_function_code
    • ReturnQueryDataRequest
      • ReturnQueryDataRequest.execute()
      • ReturnQueryDataRequest.sub_function_code
    • ReturnQueryDataResponse
      • ReturnQueryDataResponse.sub_function_code
    • ReturnSlaveBusCharacterOverrunCountRequest
      • ReturnSlaveBusCharacterOverrunCountRequest.execute()
      • ReturnSlaveBusCharacterOverrunCountRequest.sub_function_code
    • ReturnSlaveBusCharacterOverrunCountResponse
      • ReturnSlaveBusCharacterOverrunCountResponse.sub_function_code
    • ReturnSlaveBusyCountRequest
      • ReturnSlaveBusyCountRequest.execute()
      • ReturnSlaveBusyCountRequest.sub_function_code
    • ReturnSlaveBusyCountResponse
      • ReturnSlaveBusyCountResponse.sub_function_code
    • ReturnSlaveMessageCountRequest
      • ReturnSlaveMessageCountRequest.execute()
      • ReturnSlaveMessageCountRequest.sub_function_code
    • ReturnSlaveMessageCountResponse
      • ReturnSlaveMessageCountResponse.sub_function_code
    • ReturnSlaveNAKCountRequest
      • ReturnSlaveNAKCountRequest.execute()
      • ReturnSlaveNAKCountRequest.sub_function_code
    • ReturnSlaveNAKCountResponse
      • ReturnSlaveNAKCountResponse.sub_function_code
    • ReturnSlaveNoReponseCountResponse
      • ReturnSlaveNoReponseCountResponse.sub_function_code
    • ReturnSlaveNoResponseCountRequest
      • ReturnSlaveNoResponseCountRequest.execute()
      • ReturnSlaveNoResponseCountRequest.sub_function_code
  • pymodbus.events module
    • CommunicationRestartEvent
      • CommunicationRestartEvent.decode()
      • CommunicationRestartEvent.encode()
      • CommunicationRestartEvent.value
    • EnteredListenModeEvent
      • EnteredListenModeEvent.decode()
      • EnteredListenModeEvent.encode()
      • EnteredListenModeEvent.value
    • ModbusEvent
      • ModbusEvent.decode()
      • ModbusEvent.encode()
    • RemoteReceiveEvent
      • RemoteReceiveEvent.decode()
      • RemoteReceiveEvent.encode()
    • RemoteSendEvent
      • RemoteSendEvent.decode()
      • RemoteSendEvent.encode()
  • pymodbus.exceptions module
    • ConnectionException
    • InvalidMessageReceivedException
    • MessageRegisterException
    • ModbusException
      • ModbusException.isError()
    • ModbusIOException
    • NoSuchSlaveException
    • NotImplementedException
    • ParameterException
  • pymodbus.factory module
    • ClientDecoder
      • ClientDecoder.decode()
      • ClientDecoder.lookupPduClass()
      • ClientDecoder.register()
    • ServerDecoder
      • ServerDecoder.decode()
      • ServerDecoder.lookupPduClass()
      • ServerDecoder.register()
  • pymodbus.file_message module
    • FileRecord
    • ReadFifoQueueRequest
      • ReadFifoQueueRequest.decode()
      • ReadFifoQueueRequest.encode()
      • ReadFifoQueueRequest.execute()
      • ReadFifoQueueRequest.function_code
    • ReadFifoQueueResponse
      • ReadFifoQueueResponse.calculateRtuFrameSize()
      • ReadFifoQueueResponse.decode()
      • ReadFifoQueueResponse.encode()
      • ReadFifoQueueResponse.function_code
    • ReadFileRecordRequest
      • ReadFileRecordRequest.decode()
      • ReadFileRecordRequest.encode()
      • ReadFileRecordRequest.execute()
      • ReadFileRecordRequest.function_code
    • ReadFileRecordResponse
      • ReadFileRecordResponse.decode()
      • ReadFileRecordResponse.encode()
      • ReadFileRecordResponse.function_code
    • WriteFileRecordRequest
      • WriteFileRecordRequest.decode()
      • WriteFileRecordRequest.encode()
      • WriteFileRecordRequest.execute()
      • WriteFileRecordRequest.function_code
    • WriteFileRecordResponse
      • WriteFileRecordResponse.decode()
      • WriteFileRecordResponse.encode()
      • WriteFileRecordResponse.function_code
  • pymodbus.interfaces module
    • IModbusDecoder
      • IModbusDecoder.decode()
      • IModbusDecoder.lookupPduClass()
      • IModbusDecoder.register()
    • IModbusFramer
      • IModbusFramer.addToFrame()
      • IModbusFramer.advanceFrame()
      • IModbusFramer.buildPacket()
      • IModbusFramer.checkFrame()
      • IModbusFramer.getFrame()
      • IModbusFramer.isFrameReady()
      • IModbusFramer.populateResult()
      • IModbusFramer.processIncomingPacket()
    • IModbusSlaveContext
      • IModbusSlaveContext.decode()
      • IModbusSlaveContext.getValues()
      • IModbusSlaveContext.reset()
      • IModbusSlaveContext.setValues()
      • IModbusSlaveContext.validate()
    • IPayloadBuilder
      • IPayloadBuilder.build()
    • Singleton
  • pymodbus.mei_message module
    • ReadDeviceInformationRequest
      • ReadDeviceInformationRequest.decode()
      • ReadDeviceInformationRequest.encode()
      • ReadDeviceInformationRequest.execute()
      • ReadDeviceInformationRequest.function_code
      • ReadDeviceInformationRequest.sub_function_code
    • ReadDeviceInformationResponse
      • ReadDeviceInformationResponse.calculateRtuFrameSize()
      • ReadDeviceInformationResponse.decode()
      • ReadDeviceInformationResponse.encode()
      • ReadDeviceInformationResponse.function_code
      • ReadDeviceInformationResponse.sub_function_code
  • pymodbus.other_message module
    • GetCommEventCounterRequest
      • GetCommEventCounterRequest.decode()
      • GetCommEventCounterRequest.encode()
      • GetCommEventCounterRequest.execute()
      • GetCommEventCounterRequest.function_code
    • GetCommEventCounterResponse
      • GetCommEventCounterResponse.decode()
      • GetCommEventCounterResponse.encode()
      • GetCommEventCounterResponse.function_code
    • GetCommEventLogRequest
      • GetCommEventLogRequest.decode()
      • GetCommEventLogRequest.encode()
      • GetCommEventLogRequest.execute()
      • GetCommEventLogRequest.function_code
    • GetCommEventLogResponse
      • GetCommEventLogResponse.decode()
      • GetCommEventLogResponse.encode()
      • GetCommEventLogResponse.function_code
    • ReadExceptionStatusRequest
      • ReadExceptionStatusRequest.decode()
      • ReadExceptionStatusRequest.encode()
      • ReadExceptionStatusRequest.execute()
      • ReadExceptionStatusRequest.function_code
    • ReadExceptionStatusResponse
      • ReadExceptionStatusResponse.decode()
      • ReadExceptionStatusResponse.encode()
      • ReadExceptionStatusResponse.function_code
    • ReportSlaveIdRequest
      • ReportSlaveIdRequest.decode()
      • ReportSlaveIdRequest.encode()
      • ReportSlaveIdRequest.execute()
      • ReportSlaveIdRequest.function_code
    • ReportSlaveIdResponse
      • ReportSlaveIdResponse.decode()
      • ReportSlaveIdResponse.encode()
      • ReportSlaveIdResponse.function_code
  • pymodbus.payload module
    • BinaryPayloadBuilder
      • BinaryPayloadBuilder.add_16bit_float()
      • BinaryPayloadBuilder.add_16bit_int()
      • BinaryPayloadBuilder.add_16bit_uint()
      • BinaryPayloadBuilder.add_32bit_float()
      • BinaryPayloadBuilder.add_32bit_int()
      • BinaryPayloadBuilder.add_32bit_uint()
      • BinaryPayloadBuilder.add_64bit_float()
      • BinaryPayloadBuilder.add_64bit_int()
      • BinaryPayloadBuilder.add_64bit_uint()
      • BinaryPayloadBuilder.add_8bit_int()
      • BinaryPayloadBuilder.add_8bit_uint()
      • BinaryPayloadBuilder.add_bits()
      • BinaryPayloadBuilder.add_string()
      • BinaryPayloadBuilder.build()
      • BinaryPayloadBuilder.reset()
      • BinaryPayloadBuilder.to_coils()
      • BinaryPayloadBuilder.to_registers()
      • BinaryPayloadBuilder.to_string()
    • BinaryPayloadDecoder
      • BinaryPayloadDecoder.bit_chunks()
      • BinaryPayloadDecoder.decode_16bit_float()
      • BinaryPayloadDecoder.decode_16bit_int()
      • BinaryPayloadDecoder.decode_16bit_uint()
      • BinaryPayloadDecoder.decode_32bit_float()
      • BinaryPayloadDecoder.decode_32bit_int()
      • BinaryPayloadDecoder.decode_32bit_uint()
      • BinaryPayloadDecoder.decode_64bit_float()
      • BinaryPayloadDecoder.decode_64bit_int()
      • BinaryPayloadDecoder.decode_64bit_uint()
      • BinaryPayloadDecoder.decode_8bit_int()
      • BinaryPayloadDecoder.decode_8bit_uint()
      • BinaryPayloadDecoder.decode_bits()
      • BinaryPayloadDecoder.decode_string()
      • BinaryPayloadDecoder.fromCoils()
      • BinaryPayloadDecoder.fromRegisters()
      • BinaryPayloadDecoder.reset()
      • BinaryPayloadDecoder.skip_bytes()
  • pymodbus.pdu module
    • ModbusResponse.should_respond
    • ModbusResponse._rtu_frame_size
  • pymodbus.register_read_message module
    • ReadHoldingRegistersRequest
      • ReadHoldingRegistersRequest.execute()
      • ReadHoldingRegistersRequest.function_code
    • ReadHoldingRegistersResponse
      • ReadHoldingRegistersResponse.function_code
    • ReadInputRegistersRequest
      • ReadInputRegistersRequest.execute()
      • ReadInputRegistersRequest.function_code
    • ReadInputRegistersResponse
      • ReadInputRegistersResponse.function_code
    • ReadRegistersResponseBase
      • ReadRegistersResponseBase.decode()
      • ReadRegistersResponseBase.encode()
      • ReadRegistersResponseBase.getRegister()
      • ReadRegistersResponseBase.registers
    • ReadWriteMultipleRegistersRequest
      • ReadWriteMultipleRegistersRequest.decode()
      • ReadWriteMultipleRegistersRequest.encode()
      • ReadWriteMultipleRegistersRequest.execute()
      • ReadWriteMultipleRegistersRequest.function_code
      • ReadWriteMultipleRegistersRequest.get_response_pdu_size()
    • ReadWriteMultipleRegistersResponse
      • ReadWriteMultipleRegistersResponse.decode()
      • ReadWriteMultipleRegistersResponse.encode()
      • ReadWriteMultipleRegistersResponse.function_code
  • pymodbus.register_write_message module
    • MaskWriteRegisterRequest
      • MaskWriteRegisterRequest.decode()
      • MaskWriteRegisterRequest.encode()
      • MaskWriteRegisterRequest.execute()
      • MaskWriteRegisterRequest.function_code
    • MaskWriteRegisterResponse
      • MaskWriteRegisterResponse.decode()
      • MaskWriteRegisterResponse.encode()
      • MaskWriteRegisterResponse.function_code
    • WriteMultipleRegistersRequest
      • WriteMultipleRegistersRequest.decode()
      • WriteMultipleRegistersRequest.encode()
      • WriteMultipleRegistersRequest.execute()
      • WriteMultipleRegistersRequest.function_code
      • WriteMultipleRegistersRequest.get_response_pdu_size()
    • WriteMultipleRegistersResponse
      • WriteMultipleRegistersResponse.decode()
      • WriteMultipleRegistersResponse.encode()
      • WriteMultipleRegistersResponse.function_code
    • WriteSingleRegisterRequest
      • WriteSingleRegisterRequest.decode()
      • WriteSingleRegisterRequest.encode()
      • WriteSingleRegisterRequest.execute()
      • WriteSingleRegisterRequest.function_code
      • WriteSingleRegisterRequest.get_response_pdu_size()
    • WriteSingleRegisterResponse
      • WriteSingleRegisterResponse.decode()
      • WriteSingleRegisterResponse.encode()
      • WriteSingleRegisterResponse.function_code
      • WriteSingleRegisterResponse.get_response_pdu_size()
  • pymodbus.transaction module
    • DictTransactionManager
      • DictTransactionManager.addTransaction()
      • DictTransactionManager.delTransaction()
      • DictTransactionManager.getTransaction()
    • FifoTransactionManager
      • FifoTransactionManager.addTransaction()
      • FifoTransactionManager.delTransaction()
      • FifoTransactionManager.getTransaction()
    • ModbusAsciiFramer
      • ModbusAsciiFramer.addToFrame()
      • ModbusAsciiFramer.advanceFrame()
      • ModbusAsciiFramer.buildPacket()
      • ModbusAsciiFramer.checkFrame()
      • ModbusAsciiFramer.decode_data()
      • ModbusAsciiFramer.getFrame()
      • ModbusAsciiFramer.isFrameReady()
      • ModbusAsciiFramer.method
      • ModbusAsciiFramer.populateResult()
      • ModbusAsciiFramer.processIncomingPacket()
      • ModbusAsciiFramer.resetFrame()
    • ModbusBinaryFramer
      • ModbusBinaryFramer.addToFrame()
      • ModbusBinaryFramer.advanceFrame()
      • ModbusBinaryFramer.buildPacket()
      • ModbusBinaryFramer.checkFrame()
      • ModbusBinaryFramer.decode_data()
      • ModbusBinaryFramer.getFrame()
      • ModbusBinaryFramer.isFrameReady()
      • ModbusBinaryFramer.method
      • ModbusBinaryFramer.populateResult()
      • ModbusBinaryFramer.processIncomingPacket()
      • ModbusBinaryFramer.resetFrame()
    • ModbusRtuFramer
      • ModbusRtuFramer.addToFrame()
      • ModbusRtuFramer.advanceFrame()
      • ModbusRtuFramer.buildPacket()
      • ModbusRtuFramer.checkFrame()
      • ModbusRtuFramer.decode_data()
      • ModbusRtuFramer.getFrame()
      • ModbusRtuFramer.getRawFrame()
      • ModbusRtuFramer.get_expected_response_length()
      • ModbusRtuFramer.isFrameReady()
      • ModbusRtuFramer.method
      • ModbusRtuFramer.populateHeader()
      • ModbusRtuFramer.populateResult()
      • ModbusRtuFramer.processIncomingPacket()
      • ModbusRtuFramer.recvPacket()
      • ModbusRtuFramer.resetFrame()
      • ModbusRtuFramer.sendPacket()
    • ModbusSocketFramer
      • ModbusSocketFramer.addToFrame()
      • ModbusSocketFramer.advanceFrame()
      • ModbusSocketFramer.buildPacket()
      • ModbusSocketFramer.checkFrame()
      • ModbusSocketFramer.decode_data()
      • ModbusSocketFramer.getFrame()
      • ModbusSocketFramer.getRawFrame()
      • ModbusSocketFramer.isFrameReady()
      • ModbusSocketFramer.method
      • ModbusSocketFramer.populateResult()
      • ModbusSocketFramer.processIncomingPacket()
      • ModbusSocketFramer.resetFrame()
    • ModbusTlsFramer
      • ModbusTlsFramer.addToFrame()
      • ModbusTlsFramer.advanceFrame()
      • ModbusTlsFramer.buildPacket()
      • ModbusTlsFramer.checkFrame()
      • ModbusTlsFramer.decode_data()
      • ModbusTlsFramer.getFrame()
      • ModbusTlsFramer.getRawFrame()
      • ModbusTlsFramer.isFrameReady()
      • ModbusTlsFramer.method
      • ModbusTlsFramer.populateResult()
      • ModbusTlsFramer.processIncomingPacket()
      • ModbusTlsFramer.resetFrame()
  • pymodbus.utilities module
    • checkCRC()
    • checkLRC()
    • computeCRC()
    • computeLRC()
    • default()
    • pack_bitstring()
    • rtuFrameSize()
    • unpack_bitstring()
  • pymodbus.version module