Welcome to PyModbus’s documentation!
Contents:
- PyModbus - A Python Modbus Stack
- Client
- Client classes
ModbusBaseClient
ModbusBaseClient.connected
ModbusBaseClient.register()
ModbusBaseClient.close()
ModbusBaseClient.idle_time()
ModbusBaseClient.execute()
ModbusBaseClient.async_execute()
ModbusBaseClient.callback_data()
ModbusBaseClient.callback_disconnected()
ModbusBaseClient.connect()
ModbusBaseClient.raise_future()
AsyncModbusSerialClient
ModbusSerialClient
AsyncModbusTcpClient
ModbusTcpClient
AsyncModbusTlsClient
ModbusTlsClient
AsyncModbusUdpClient
ModbusUdpClient
- 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()
ModbusClientMixin.DATATYPE
ModbusClientMixin.convert_from_registers()
ModbusClientMixin.convert_to_registers()
- Client classes
- Server
ModbusSerialServer
ModbusSimulatorServer
ModbusSimulatorServer.action_add()
ModbusSimulatorServer.action_clear()
ModbusSimulatorServer.action_monitor()
ModbusSimulatorServer.action_reset()
ModbusSimulatorServer.action_set()
ModbusSimulatorServer.action_simulate()
ModbusSimulatorServer.action_stop()
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_html_submit()
ModbusSimulatorServer.run_forever()
ModbusSimulatorServer.server_request_tracer()
ModbusSimulatorServer.server_response_manipulator()
ModbusSimulatorServer.start_modbus_server()
ModbusSimulatorServer.stop()
ModbusSimulatorServer.stop_modbus_server()
ModbusTcpServer
ModbusTlsServer
ModbusUdpServer
ServerAsyncStop()
ServerStop()
StartAsyncSerialServer()
StartAsyncTcpServer()
StartAsyncTlsServer()
StartAsyncUdpServer()
StartSerialServer()
StartTcpServer()
StartTlsServer()
StartUdpServer()
get_simulator_commandline()
- NullModem
- Simulator
- REPL
- Dependencies
- Usage Instructions
- DEMO
- REPL client classes
CmdCompleter
Command
Result
get_commands()
CLI
CaseInsenstiveChoice
NumericChoice
bottom_toolbar()
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
- pymodbus.framer.binary_framer module
- pymodbus.framer.rtu_framer module
ModbusRtuFramer
ModbusRtuFramer.advanceFrame()
ModbusRtuFramer.buildPacket()
ModbusRtuFramer.checkFrame()
ModbusRtuFramer.decode_data()
ModbusRtuFramer.frameProcessIncomingPacket()
ModbusRtuFramer.getFrame()
ModbusRtuFramer.getFrameStart()
ModbusRtuFramer.get_expected_response_length()
ModbusRtuFramer.isFrameReady()
ModbusRtuFramer.method
ModbusRtuFramer.populateHeader()
ModbusRtuFramer.populateResult()
ModbusRtuFramer.recvPacket()
ModbusRtuFramer.resetFrame()
ModbusRtuFramer.sendPacket()
- pymodbus.framer.socket_framer module
- Constants
DeviceInformation.BASIC
DeviceInformation.REGULAR
DeviceInformation.EXTENDED
DeviceInformation.SPECIFIC
Endian.AUTO
Endian.BIG
Endian.LITTLE
ModbusPlusOperation.GET_STATISTICS
ModbusPlusOperation.CLEAR_STATISTICS
ModbusStatus.WAITING
ModbusStatus.READY
ModbusStatus.ON
ModbusStatus.OFF
ModbusStatus.SLAVE_ON
ModbusStatus.SLAVE_OFF
MoreData.NOTHING
MoreData.KEEP_READING
- Extra functions
pymodbus_apply_logging_config()
ReadBitsResponseBase
ReadCoilsRequest
ReadCoilsResponse
ReadDiscreteInputsRequest
ReadDiscreteInputsResponse
WriteMultipleCoilsRequest
WriteMultipleCoilsResponse
WriteSingleCoilRequest
WriteSingleCoilResponse
DeviceInformationFactory
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
ReturnSlaveNoResponseCountRequest
ReturnSlaveNoResponseCountResponse
CommunicationRestartEvent
EnteredListenModeEvent
ModbusEvent
RemoteReceiveEvent
RemoteSendEvent
ConnectionException
InvalidMessageReceivedException
MessageRegisterException
ModbusException
ModbusIOException
NoSuchSlaveException
NotImplementedException
ParameterException
ClientDecoder
ServerDecoder
FileRecord
ReadFifoQueueRequest
ReadFifoQueueResponse
ReadFileRecordRequest
ReadFileRecordResponse
WriteFileRecordRequest
WriteFileRecordResponse
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.encode()
BinaryPayloadBuilder.reset()
BinaryPayloadBuilder.to_coils()
BinaryPayloadBuilder.to_registers()
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
ModbusBinaryFramer
ModbusRtuFramer
ModbusRtuFramer.advanceFrame()
ModbusRtuFramer.buildPacket()
ModbusRtuFramer.checkFrame()
ModbusRtuFramer.decode_data()
ModbusRtuFramer.frameProcessIncomingPacket()
ModbusRtuFramer.getFrame()
ModbusRtuFramer.getFrameStart()
ModbusRtuFramer.get_expected_response_length()
ModbusRtuFramer.isFrameReady()
ModbusRtuFramer.method
ModbusRtuFramer.populateHeader()
ModbusRtuFramer.populateResult()
ModbusRtuFramer.recvPacket()
ModbusRtuFramer.resetFrame()
ModbusRtuFramer.sendPacket()
ModbusSocketFramer
ModbusTlsFramer
checkCRC()
checkLRC()
computeCRC()
computeLRC()
default()
pack_bitstring()
rtuFrameSize()
unpack_bitstring()
- Examples
- Ready to run examples:
- Advanced examples
- Client asynchronous calls
- Client asynchronous
- Client calls
- Client custom message
- Client payload
- Client synchronous
- Server asynchronous
- Server callback
- Server tracer
- Server payload
- Server synchronous
- Server updating
- Simulator example
- Simulator datastore example
- Message generator
- Message Parser
- Modbus forwarder
- Examples contributions
- Authors