Welcome to PyModbus’s documentation!
Contents:
- PyModbus - A Python Modbus Stack
- CHANGELOGS
- version 3.1.2
- version 3.1.1
- version 3.1.0
- version 3.0.2
- version 3.0.1
- version 3.0.0
- version 3.0.0dev5
- version 3.0.0dev4
- version 3.0.0dev3
- version 3.0.0dev2
- version 3.0.0dev1
- version 3.0.0dev0
- version 2.5.3
- version 2.5.2
- version 2.5.1
- version 2.5.0
- version 2.5.0rc3
- version 2.5.0rc2
- version 2.5.0rc1
- Version 2.4.0
- Version 2.3.0
- Version 2.3.0rc1
- Version 2.2.0
- Version 2.1.0
- Version 2.0.1
- Version 2.0.0
- Version 2.0.0rc1
- Version 1.5.2
- Version 1.5.1
- Version 1.5.0
- Version 1.4.0
- Version 1.3.2
- Version 1.3.1
- Version 1.3.0.rc2
- Version 1.3.0.rc1
- Version 1.2.0
- Version 1.1.0
- Version 1.0.0
- Version 0.9.0
- Client
- Tranport classes
- Modbus calls
ModbusClientMixin
ModbusClientMixin.execute()
ModbusClientMixin.read_coils()
ModbusClientMixin.read_discrete_inputs()
ModbusClientMixin.read_holding_registers()
ModbusClientMixin.read_input_registers()
ModbusClientMixin.write_coil()
ModbusClientMixin.write_register()
ModbusClientMixin.read_exception_status()
ModbusClientMixin.diag_query_data()
ModbusClientMixin.diag_restart_communication()
ModbusClientMixin.diag_read_diagnostic_register()
ModbusClientMixin.diag_change_ascii_input_delimeter()
ModbusClientMixin.diag_force_listen_only()
ModbusClientMixin.diag_clear_counters()
ModbusClientMixin.diag_read_bus_message_count()
ModbusClientMixin.diag_read_bus_comm_error_count()
ModbusClientMixin.diag_read_bus_exception_error_count()
ModbusClientMixin.diag_read_slave_message_count()
ModbusClientMixin.diag_read_slave_no_response_count()
ModbusClientMixin.diag_read_slave_nak_count()
ModbusClientMixin.diag_read_slave_busy_count()
ModbusClientMixin.diag_read_bus_char_overrun_count()
ModbusClientMixin.diag_read_iop_overrun_count()
ModbusClientMixin.diag_clear_overrun_counter()
ModbusClientMixin.diag_getclear_modbus_response()
ModbusClientMixin.diag_get_comm_event_counter()
ModbusClientMixin.diag_get_comm_event_log()
ModbusClientMixin.write_coils()
ModbusClientMixin.write_registers()
ModbusClientMixin.report_slave_id()
ModbusClientMixin.read_file_record()
ModbusClientMixin.write_file_record()
ModbusClientMixin.mask_write_register()
ModbusClientMixin.readwrite_registers()
ModbusClientMixin.read_fifo_queue()
ModbusClientMixin.read_device_information()
- Server
ModbusSerialServer
ModbusSimulatorServer
ModbusSimulatorServer.build_html_calls()
ModbusSimulatorServer.build_html_log()
ModbusSimulatorServer.build_html_registers()
ModbusSimulatorServer.build_html_server()
ModbusSimulatorServer.build_json_calls()
ModbusSimulatorServer.build_json_log()
ModbusSimulatorServer.build_json_registers()
ModbusSimulatorServer.build_json_server()
ModbusSimulatorServer.handle_html()
ModbusSimulatorServer.handle_html_static()
ModbusSimulatorServer.handle_json()
ModbusSimulatorServer.helper_build_filter()
ModbusSimulatorServer.helper_build_html_calls_submit()
ModbusSimulatorServer.helper_build_html_calls_submit_monitor()
ModbusSimulatorServer.helper_build_html_calls_submit_set()
ModbusSimulatorServer.helper_build_html_registers_submit()
ModbusSimulatorServer.helper_list_response()
ModbusSimulatorServer.run_forever()
ModbusSimulatorServer.server_request_tracer()
ModbusSimulatorServer.server_response_manipulator()
ModbusSimulatorServer.start_modbus_server()
ModbusSimulatorServer.stop()
ModbusSimulatorServer.stop_modbus_server()
ModbusTcpServer
ModbusTlsServer
ModbusUdpServer
ModbusUnixServer
ServerAsyncStop()
ServerStop()
StartAsyncSerialServer()
StartAsyncTcpServer()
StartAsyncTlsServer()
StartAsyncUdpServer()
StartAsyncUnixServer()
StartSerialServer()
StartTcpServer()
StartTlsServer()
StartUdpServer()
- Simulator
- REPL
- Dependencies
- Usage Instructions
- DEMO
- REPL client classes
CmdCompleter
Command
Result
get_commands()
CaseInsenstiveChoice
NumericChoice
bottom_toolbar()
cli()
process_args()
ExtendedRequestSupport
ExtendedRequestSupport.change_ascii_input_delimiter()
ExtendedRequestSupport.clear_counters()
ExtendedRequestSupport.clear_overrun_count()
ExtendedRequestSupport.force_listen_only_mode()
ExtendedRequestSupport.get_clear_modbus_plus()
ExtendedRequestSupport.get_com_event_counter()
ExtendedRequestSupport.get_com_event_log()
ExtendedRequestSupport.mask_write_register()
ExtendedRequestSupport.read_coils()
ExtendedRequestSupport.read_device_information()
ExtendedRequestSupport.read_discrete_inputs()
ExtendedRequestSupport.read_exception_status()
ExtendedRequestSupport.read_holding_registers()
ExtendedRequestSupport.read_input_registers()
ExtendedRequestSupport.readwrite_registers()
ExtendedRequestSupport.report_slave_id()
ExtendedRequestSupport.restart_comm_option()
ExtendedRequestSupport.return_bus_com_error_count()
ExtendedRequestSupport.return_bus_exception_error_count()
ExtendedRequestSupport.return_bus_message_count()
ExtendedRequestSupport.return_diagnostic_register()
ExtendedRequestSupport.return_iop_overrun_count()
ExtendedRequestSupport.return_query_data()
ExtendedRequestSupport.return_slave_bus_char_overrun_count()
ExtendedRequestSupport.return_slave_busy_count()
ExtendedRequestSupport.return_slave_message_count()
ExtendedRequestSupport.return_slave_no_ack_count()
ExtendedRequestSupport.return_slave_no_response_count()
ExtendedRequestSupport.write_coil()
ExtendedRequestSupport.write_coils()
ExtendedRequestSupport.write_register()
ExtendedRequestSupport.write_registers()
ModbusSerialClient
ModbusSerialClient.get_baudrate()
ModbusSerialClient.get_bytesize()
ModbusSerialClient.get_parity()
ModbusSerialClient.get_port()
ModbusSerialClient.get_serial_settings()
ModbusSerialClient.get_stopbits()
ModbusSerialClient.get_timeout()
ModbusSerialClient.set_baudrate()
ModbusSerialClient.set_bytesize()
ModbusSerialClient.set_parity()
ModbusSerialClient.set_port()
ModbusSerialClient.set_stopbits()
ModbusSerialClient.set_timeout()
ModbusTcpClient
handle_brodcast()
make_response_dict()
- REPL server classes
- Datastore
- Framer
- pymodbus.framer.ascii_framer module
ModbusAsciiFramer
ModbusAsciiFramer.addToFrame()
ModbusAsciiFramer.advanceFrame()
ModbusAsciiFramer.buildPacket()
ModbusAsciiFramer.checkFrame()
ModbusAsciiFramer.decode_data()
ModbusAsciiFramer.getFrame()
ModbusAsciiFramer.isFrameReady()
ModbusAsciiFramer.method
ModbusAsciiFramer.populateResult()
ModbusAsciiFramer.processIncomingPacket()
ModbusAsciiFramer.resetFrame()
- pymodbus.framer.binary_framer module
ModbusBinaryFramer
ModbusBinaryFramer.addToFrame()
ModbusBinaryFramer.advanceFrame()
ModbusBinaryFramer.buildPacket()
ModbusBinaryFramer.checkFrame()
ModbusBinaryFramer.decode_data()
ModbusBinaryFramer.getFrame()
ModbusBinaryFramer.isFrameReady()
ModbusBinaryFramer.method
ModbusBinaryFramer.populateResult()
ModbusBinaryFramer.processIncomingPacket()
ModbusBinaryFramer.resetFrame()
- pymodbus.framer.rtu_framer module
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()
- pymodbus.framer.socket_framer module
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()
- Module contents
- pymodbus.framer.ascii_framer module
- Constants
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.broadcastEnable
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
- Extra functions
pymodbus_apply_logging_config()
ReadBitsResponseBase
ReadCoilsRequest
ReadCoilsResponse
ReadDiscreteInputsRequest
ReadDiscreteInputsResponse
WriteMultipleCoilsRequest
WriteMultipleCoilsResponse
WriteSingleCoilRequest
WriteSingleCoilResponse
DeviceInformationFactory
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
ChangeAsciiInputDelimiterRequest
ChangeAsciiInputDelimiterResponse
ClearCountersRequest
ClearCountersResponse
ClearOverrunCountRequest
ClearOverrunCountResponse
DiagnosticStatusRequest
DiagnosticStatusResponse
ForceListenOnlyModeRequest
ForceListenOnlyModeResponse
GetClearModbusPlusRequest
GetClearModbusPlusResponse
RestartCommunicationsOptionRequest
RestartCommunicationsOptionResponse
ReturnBusCommunicationErrorCountRequest
ReturnBusCommunicationErrorCountResponse
ReturnBusExceptionErrorCountRequest
ReturnBusExceptionErrorCountResponse
ReturnBusMessageCountRequest
ReturnBusMessageCountResponse
ReturnDiagnosticRegisterRequest
ReturnDiagnosticRegisterResponse
ReturnIopOverrunCountRequest
ReturnIopOverrunCountResponse
ReturnQueryDataRequest
ReturnQueryDataResponse
ReturnSlaveBusCharacterOverrunCountRequest
ReturnSlaveBusCharacterOverrunCountResponse
ReturnSlaveBusyCountRequest
ReturnSlaveBusyCountResponse
ReturnSlaveMessageCountRequest
ReturnSlaveMessageCountResponse
ReturnSlaveNAKCountRequest
ReturnSlaveNAKCountResponse
ReturnSlaveNoReponseCountResponse
ReturnSlaveNoResponseCountRequest
CommunicationRestartEvent
EnteredListenModeEvent
ModbusEvent
RemoteReceiveEvent
RemoteSendEvent
ConnectionException
InvalidMessageReceivedException
MessageRegisterException
ModbusException
ModbusIOException
NoSuchSlaveException
NotImplementedException
ParameterException
ClientDecoder
ServerDecoder
FileRecord
ReadFifoQueueRequest
ReadFifoQueueResponse
ReadFileRecordRequest
ReadFileRecordResponse
WriteFileRecordRequest
WriteFileRecordResponse
IModbusDecoder
IModbusFramer
IModbusSlaveContext
IPayloadBuilder
Singleton
ReadDeviceInformationRequest
ReadDeviceInformationResponse
GetCommEventCounterRequest
GetCommEventCounterResponse
GetCommEventLogRequest
GetCommEventLogResponse
ReadExceptionStatusRequest
ReadExceptionStatusResponse
ReportSlaveIdRequest
ReportSlaveIdResponse
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()
ModbusResponse.should_respond
ModbusResponse._rtu_frame_size
ReadHoldingRegistersRequest
ReadHoldingRegistersResponse
ReadInputRegistersRequest
ReadInputRegistersResponse
ReadRegistersResponseBase
ReadWriteMultipleRegistersRequest
ReadWriteMultipleRegistersResponse
MaskWriteRegisterRequest
MaskWriteRegisterResponse
WriteMultipleRegistersRequest
WriteMultipleRegistersResponse
WriteSingleRegisterRequest
WriteSingleRegisterResponse
DictTransactionManager
FifoTransactionManager
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()
checkCRC()
checkLRC()
computeCRC()
computeLRC()
default()
pack_bitstring()
rtuFrameSize()
unpack_bitstring()
- Examples
- Examples version 3.x
- Examples contributions
- Examples version 2.5.3
- Asynchronous Asyncio Modbus TLS Client example
- Bcd Payload example
- Callback Server example
- Changing Framers example
- Concurrent Client example
- Custom Datablock example
- Custom Message example
- Dbstore update Server example
- Deviceinfo showcase client example
- Deviceinfo showcase server example
- Libmodbus Client example
- Message Generator example
- Message Parser example
- Modbus Logging example
- Modbus Mapper example
- Modbus Saver example
- Modbus Tls client example
- Modicon Payload example
- performance module
- Remote Server Context example
- Thread Safe Datastore example