Pymodbus internals

Contents:

• NullModem
• Datastore
  • Datastore classes
    • ModbusSparseDataBlock
      • ModbusSparseDataBlock.create()
      • ModbusSparseDataBlock.reset()
      • ModbusSparseDataBlock.validate()
      • ModbusSparseDataBlock.getValues()
      • ModbusSparseDataBlock.setValues()
    • ModbusSlaveContext
      • ModbusSlaveContext.reset()
      • ModbusSlaveContext.validate()
      • ModbusSlaveContext.getValues()
      • ModbusSlaveContext.setValues()
      • ModbusSlaveContext.register()
    • ModbusServerContext
      • ModbusServerContext.slaves()
    • ModbusSimulatorContext
      • ModbusSimulatorContext.get_text_register()
      • ModbusSimulatorContext.build_registers_from_value()
      • ModbusSimulatorContext.build_value_from_registers()
• Framer
  • pymodbus.framer.ModbusAsciiFramer module
  • pymodbus.framer.ModbusRtuFramer module
  • pymodbus.framer.ModbusSocketFramer module
  • pymodbus.framer.ModbusTlsFramer 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
  • ExceptionResponse
    • ExceptionResponse.ExceptionOffset
    • ExceptionResponse.decode()
    • ExceptionResponse.encode()
  • FramerType
    • FramerType.ASCII
    • FramerType.RAW
    • FramerType.RTU
    • FramerType.SOCKET
    • FramerType.TLS
  • ModbusException
    • ModbusException.isError()
  • pymodbus_apply_logging_config()
  • DeviceInformationFactory
    • DeviceInformationFactory.get()
  • 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()
  • 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()
  • ConnectionException
  • InvalidMessageReceivedException
  • MessageRegisterException
  • ModbusIOException
  • NoSuchSlaveException
  • NotImplementedException
  • ParameterException
  • ClientDecoder
    • ClientDecoder.decode()
    • ClientDecoder.function_table
    • ClientDecoder.lookupPduClass()
    • ClientDecoder.register()
  • ServerDecoder
    • ServerDecoder.decode()
    • ServerDecoder.getFCdict()
    • ServerDecoder.lookupPduClass()
    • ServerDecoder.register()
  • 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()
  • ModbusAsciiFramer
    • ModbusAsciiFramer.decode_data()
    • ModbusAsciiFramer.frameProcessIncomingPacket()
    • ModbusAsciiFramer.method
  • ModbusRtuFramer
    • ModbusRtuFramer.buildPacket()
    • ModbusRtuFramer.decode_data()
    • ModbusRtuFramer.frameProcessIncomingPacket()
    • ModbusRtuFramer.method
    • ModbusRtuFramer.sendPacket()
  • ModbusSocketFramer
    • ModbusSocketFramer.decode_data()
    • ModbusSocketFramer.frameProcessIncomingPacket()
    • ModbusSocketFramer.method
  • ModbusTlsFramer
    • ModbusTlsFramer.decode_data()
    • ModbusTlsFramer.frameProcessIncomingPacket()
    • ModbusTlsFramer.method
  • ModbusTransactionManager
    • ModbusTransactionManager.addTransaction()
    • ModbusTransactionManager.delTransaction()
    • ModbusTransactionManager.execute()
    • ModbusTransactionManager.getNextTID()
    • ModbusTransactionManager.getTransaction()
    • ModbusTransactionManager.reset()
  • default()
  • pack_bitstring()
  • rtuFrameSize()
  • unpack_bitstring()
• PDU classes
  • ReadBitsResponseBase
    • ReadBitsResponseBase.bits
    • ReadBitsResponseBase.decode()
    • ReadBitsResponseBase.encode()
    • ReadBitsResponseBase.getBit()
    • ReadBitsResponseBase.resetBit()
    • ReadBitsResponseBase.setBit()
  • ReadCoilsRequest
    • ReadCoilsRequest.execute()
    • ReadCoilsRequest.function_code
    • ReadCoilsRequest.function_code_name
  • ReadCoilsResponse
    • ReadCoilsResponse.function_code
  • ReadDiscreteInputsRequest
    • ReadDiscreteInputsRequest.execute()
    • ReadDiscreteInputsRequest.function_code
    • ReadDiscreteInputsRequest.function_code_name
  • ReadDiscreteInputsResponse
    • ReadDiscreteInputsResponse.function_code
  • WriteMultipleCoilsRequest
    • WriteMultipleCoilsRequest.decode()
    • WriteMultipleCoilsRequest.encode()
    • WriteMultipleCoilsRequest.execute()
    • WriteMultipleCoilsRequest.function_code
    • WriteMultipleCoilsRequest.function_code_name
    • WriteMultipleCoilsRequest.get_response_pdu_size()
  • WriteMultipleCoilsResponse
    • WriteMultipleCoilsResponse.decode()
    • WriteMultipleCoilsResponse.encode()
    • WriteMultipleCoilsResponse.function_code
  • WriteSingleCoilRequest
    • WriteSingleCoilRequest.decode()
    • WriteSingleCoilRequest.encode()
    • WriteSingleCoilRequest.execute()
    • WriteSingleCoilRequest.function_code
    • WriteSingleCoilRequest.function_code_name
    • WriteSingleCoilRequest.get_response_pdu_size()
  • WriteSingleCoilResponse
    • WriteSingleCoilResponse.decode()
    • WriteSingleCoilResponse.encode()
    • WriteSingleCoilResponse.function_code
  • 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.function_code_name
    • 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
  • ReturnSlaveNoResponseCountRequest
    • ReturnSlaveNoResponseCountRequest.execute()
    • ReturnSlaveNoResponseCountRequest.sub_function_code
  • ReturnSlaveNoResponseCountResponse
    • ReturnSlaveNoResponseCountResponse.sub_function_code
  • FileRecord
  • ReadFifoQueueRequest
    • ReadFifoQueueRequest.decode()
    • ReadFifoQueueRequest.encode()
    • ReadFifoQueueRequest.execute()
    • ReadFifoQueueRequest.function_code
    • ReadFifoQueueRequest.function_code_name
  • ReadFifoQueueResponse
    • ReadFifoQueueResponse.calculateRtuFrameSize()
    • ReadFifoQueueResponse.decode()
    • ReadFifoQueueResponse.encode()
    • ReadFifoQueueResponse.function_code
  • ReadFileRecordRequest
    • ReadFileRecordRequest.decode()
    • ReadFileRecordRequest.encode()
    • ReadFileRecordRequest.execute()
    • ReadFileRecordRequest.function_code
    • ReadFileRecordRequest.function_code_name
  • ReadFileRecordResponse
    • ReadFileRecordResponse.decode()
    • ReadFileRecordResponse.encode()
    • ReadFileRecordResponse.function_code
  • WriteFileRecordRequest
    • WriteFileRecordRequest.decode()
    • WriteFileRecordRequest.encode()
    • WriteFileRecordRequest.execute()
    • WriteFileRecordRequest.function_code
    • WriteFileRecordRequest.function_code_name
  • WriteFileRecordResponse
    • WriteFileRecordResponse.decode()
    • WriteFileRecordResponse.encode()
    • WriteFileRecordResponse.function_code
  • ReadDeviceInformationRequest
    • ReadDeviceInformationRequest.decode()
    • ReadDeviceInformationRequest.encode()
    • ReadDeviceInformationRequest.execute()
    • ReadDeviceInformationRequest.function_code
    • ReadDeviceInformationRequest.function_code_name
    • ReadDeviceInformationRequest.sub_function_code
  • ReadDeviceInformationResponse
    • ReadDeviceInformationResponse.calculateRtuFrameSize()
    • ReadDeviceInformationResponse.decode()
    • ReadDeviceInformationResponse.encode()
    • ReadDeviceInformationResponse.function_code
    • ReadDeviceInformationResponse.sub_function_code
  • GetCommEventCounterRequest
    • GetCommEventCounterRequest.decode()
    • GetCommEventCounterRequest.encode()
    • GetCommEventCounterRequest.execute()
    • GetCommEventCounterRequest.function_code
    • GetCommEventCounterRequest.function_code_name
  • GetCommEventCounterResponse
    • GetCommEventCounterResponse.decode()
    • GetCommEventCounterResponse.encode()
    • GetCommEventCounterResponse.function_code
  • GetCommEventLogRequest
    • GetCommEventLogRequest.decode()
    • GetCommEventLogRequest.encode()
    • GetCommEventLogRequest.execute()
    • GetCommEventLogRequest.function_code
    • GetCommEventLogRequest.function_code_name
  • GetCommEventLogResponse
    • GetCommEventLogResponse.decode()
    • GetCommEventLogResponse.encode()
    • GetCommEventLogResponse.function_code
  • ReadExceptionStatusRequest
    • ReadExceptionStatusRequest.decode()
    • ReadExceptionStatusRequest.encode()
    • ReadExceptionStatusRequest.execute()
    • ReadExceptionStatusRequest.function_code
    • ReadExceptionStatusRequest.function_code_name
  • ReadExceptionStatusResponse
    • ReadExceptionStatusResponse.decode()
    • ReadExceptionStatusResponse.encode()
    • ReadExceptionStatusResponse.function_code
  • ReportSlaveIdRequest
    • ReportSlaveIdRequest.decode()
    • ReportSlaveIdRequest.encode()
    • ReportSlaveIdRequest.execute()
    • ReportSlaveIdRequest.function_code
    • ReportSlaveIdRequest.function_code_name
  • ReportSlaveIdResponse
    • ReportSlaveIdResponse.decode()
    • ReportSlaveIdResponse.encode()
    • ReportSlaveIdResponse.function_code
  • ModbusResponse.should_respond
  • ModbusResponse._rtu_frame_size
  • ReadHoldingRegistersRequest
    • ReadHoldingRegistersRequest.execute()
    • ReadHoldingRegistersRequest.function_code
    • ReadHoldingRegistersRequest.function_code_name
  • ReadHoldingRegistersResponse
    • ReadHoldingRegistersResponse.function_code
  • ReadInputRegistersRequest
    • ReadInputRegistersRequest.execute()
    • ReadInputRegistersRequest.function_code
    • ReadInputRegistersRequest.function_code_name
  • ReadInputRegistersResponse
    • ReadInputRegistersResponse.function_code
  • ReadRegistersResponseBase
    • ReadRegistersResponseBase.decode()
    • ReadRegistersResponseBase.encode()
    • ReadRegistersResponseBase.getRegister()
    • ReadRegistersResponseBase.registers
  • ReadWriteMultipleRegistersRequest
    • ReadWriteMultipleRegistersRequest.decode()
    • ReadWriteMultipleRegistersRequest.encode()
    • ReadWriteMultipleRegistersRequest.execute()
    • ReadWriteMultipleRegistersRequest.function_code
    • ReadWriteMultipleRegistersRequest.function_code_name
    • ReadWriteMultipleRegistersRequest.get_response_pdu_size()
  • ReadWriteMultipleRegistersResponse
    • ReadWriteMultipleRegistersResponse.decode()
    • ReadWriteMultipleRegistersResponse.encode()
    • ReadWriteMultipleRegistersResponse.function_code
  • MaskWriteRegisterRequest
    • MaskWriteRegisterRequest.decode()
    • MaskWriteRegisterRequest.encode()
    • MaskWriteRegisterRequest.execute()
    • MaskWriteRegisterRequest.function_code
    • MaskWriteRegisterRequest.function_code_name
  • MaskWriteRegisterResponse
    • MaskWriteRegisterResponse.decode()
    • MaskWriteRegisterResponse.encode()
    • MaskWriteRegisterResponse.function_code
  • WriteMultipleRegistersRequest
    • WriteMultipleRegistersRequest.decode()
    • WriteMultipleRegistersRequest.encode()
    • WriteMultipleRegistersRequest.execute()
    • WriteMultipleRegistersRequest.function_code
    • WriteMultipleRegistersRequest.function_code_name
    • WriteMultipleRegistersRequest.get_response_pdu_size()
  • WriteMultipleRegistersResponse
    • WriteMultipleRegistersResponse.decode()
    • WriteMultipleRegistersResponse.encode()
    • WriteMultipleRegistersResponse.function_code
  • WriteSingleRegisterRequest
    • WriteSingleRegisterRequest.decode()
    • WriteSingleRegisterRequest.encode()
    • WriteSingleRegisterRequest.execute()
    • WriteSingleRegisterRequest.function_code
    • WriteSingleRegisterRequest.function_code_name
    • WriteSingleRegisterRequest.get_response_pdu_size()
  • WriteSingleRegisterResponse
    • WriteSingleRegisterResponse.decode()
    • WriteSingleRegisterResponse.encode()
    • WriteSingleRegisterResponse.function_code
    • WriteSingleRegisterResponse.get_response_pdu_size()
• Architecture