ModMaster Manual - Troubleshooting

Troubleshooting

Introduction

This section provides information on various errors that can occur when using ModMaster, and suggests ways of tackling them.

Entry headings in quotes are messages that are displayed in ModMaster's status bar or trace window. For other entries, the heading is a description of the symptoms.

The easiest way to find a message in this section is to click on the Error Help button in the status bar (or press the F4 key), or to click on the message in the trace window (or move to the message and press the space bar).

Communications

General

"Connection closed"

  • Click the Run button to open the connection.

  • If you have lost the connection to the slave check that the slave is still running and listening.

"Error response: ..."

ModMaster received an error response from the slave.

  • The rest of the message says what kind of error response. See the troubleshooting entry for the rest of the message for further explanation.

  • If tracing is turned on, you can view the received message in the trace window.

"Invalid data received: ..."

Data was received by ModMaster that was unexpected or not correctly formatted as a Modbus message. The received data is discarded without further processing.

  • The rest of the message says what was wrong with the received data. See the troubleshooting entry for the rest of the message for further explanation.

  • If tracing is turned on, you can view the received data in the trace window.

"Discarded: ..."

This message is displayed in the trace window when data is received by ModMaster that is unexpected or not correctly formatted as a Modbus message. The received data is discarded without further processing.

  • The rest of the message says what was wrong with the received data. See the troubleshooting entry for the rest of the message for further explanation.

  • The received data is displayed in the trace window preceding the "Discarded" message.

"PDU size (XXX bytes) exceeds maximum (XXX bytes)"

A received message exceeded the arbitrary limit on PDU size. The message is discarded without further processing.

Socket Communications

"Unknown host: XXX"

The host name that you entered could not be mapped to an IP address.

  • Check that the Host is consistent with the slave.

  • Check that your DNS server is working and reachable.

"Can't connect to host 'XXX': No route to host"

"Can't connect to host 'XXX': Connect timed out"

The host did not respond to the TCP connection request

  • Check that the Host is consistent with the slave.

  • Check that the network is working.

"Can't connect to host 'XXX' port XXX: Connection refused"

The host appears to be reachable and responding, but would not accept the TCP connection request.

  • Check that the Host and Port are consistent with the slave.

  • Check that slave is listening.

"UDP Port Unreachable"

It was not possible to deliver a UDP message.

  • Check that the Host and Port are consistent with the slave.

  • Check that slave is listening.

"Error response: No path available to target"

The server/bridge sent a response indicating that the required slave was not reachable.

  • Check that the Slave ID is consistent with the slave.

  • Check that your server/bridge is correctly configured for the slave you are trying to reach.

"Timed out"

A request was sent to the slave, but no response was received.

  • Turn on tracing to get more information.

  • Check that the Packet Type is consistent with the slave. The packet type is usually TCP for a socket connection.

  • Check that the Slave ID is consistent with the slave.

  • Check that Host and Port are consistent with the slave. You may have sent the request to the wrong slave/server!

  • If using UDP, check that the slave is running/listening.

  • If you sent a broadcast request, check that the Always responds setting is consistent with the slave.

"Error response: Target device failed to respond"

The server/bridge sent a response indicating that the required slave did not respond.

  • Check that the Slave ID is consistent with the slave.

  • Check that your server/bridge is correctly configured for the slave you are trying to reach.

Serial Communications

"Serial comms package not installed"

The Java Communications API package must be installed in order to use serial communications.

  • See the Wingpath website for information on getting and installing the comms package.

"No serial ports available"

The communications package could not find any serial ports.

  • If you are using an external serial port (e.g. a USB to serial converter), check that it is plugged in.

  • If you are using the IBM implementation of the Java Communications API, check that the javax.comm.properties file is correctly configured for your system.

  • If a port has become available since you started ModMaster you will have to restart ModMaster in order to use the port.

"Not a serial port"

"No such port"

"No such port, or you do not have permission to access it"

"Port in use, or you do not have permission to access it"

"Port isn't readable"

"Port isn't writable"

"Can't set RTS"

"Can't set serial port parameters"

The serial port that you selected could not be opened and configured correctly.

  • Check that you have selected the correct serial port. On some systems, the communications package allows you to select ports that are not genuine serial ports.

  • On Unix/Linux systems, check that you have read and write access permission to the device file ('/dev/...').

  • Check that the port is not in use by another program (you will not necessarily get the "Port in use ..." error message).

  • If the port has become available since you started ModMaster you will have to restart ModMaster in order to use the port.

"No port selected"

  • You must select a port before you can open the connection.

"No such port: XXX"

The configuration file that you loaded refers to serial port XXX, which does not exist. You will still be able to use the configuration, but you will have to select a different port.

"Unusable serial driver: ..."

Your Java Communications API package is not functioning correctly.

  • Ask your system administrator to install a correctly functioning Java Communications API package.

"Parity error"

A parity error occurred when receiving data via the serial port.

"Framing error"

A framing error occurred when receiving data via the serial port.

"Overrun error"

An overrun error occurred when receiving data via the serial port. In other words, data was sent faster than it could be received by the machine running ModMaster.

"Timed out"

A request was sent to the slave, but no response was received.

  • Turn on tracing to get more information.

  • Check that the Packet Type is consistent with the slave. The packet type is usually RTU or ASCII for a serial connection.

  • Check that the Slave ID is consistent with the slave.

  • If the master and slave are on same machine, check that the ports are different.

  • Check that the Speed, Parity, Data bits, Stop bits and RTS control settings are consistent with the slave.

  • Check that a cable is connecting master and slave interfaces.

  • If using RTS control: Flow control check that the cable is appropriately wired.

  • Check that no other software is using the same port.

  • If you sent a broadcast request, check that the Always responds setting is consistent with the slave.

RTU Packet Type

"Invalid CRC"

Data received by ModMaster failed the CRC check.

  • Turn on tracing to get more information.

  • If using serial communications, check that Speed, Parity, Data bits and Stop bits are all set correctly.

  • Try increasing the EOM Timeout setting - messages may be getting fragmented by long delays introduced by the comms link or the operating system.

"Message too short (XXX bytes)"

An RTU message must be at least 4 bytes long (1 byte for the slave ID, 1 byte for the function code, and 2 bytes for the CRC).

  • Turn on tracing to get more information.

  • If using serial communications, check that Speed, Parity, Data bits and Stop bits are all set correctly.

  • Try increasing the EOM Timeout setting - messages may be getting fragmented by long delays introduced by the comms link or the operating system.

"Message too long (> XXX bytes)"

A received message was too long to fit in ModMaster's input buffer.

ASCII Packet Type

"No ':' at start of message"

"':' in middle of message"

"LF terminator missing"

"Invalid message length (XXX bytes) - should be odd"

"Non-hex character in message"

"Invalid LRC"

Data received by ModMaster was not correctly formatted as an ASCII message.

"Message too short (XXX bytes)"

An ASCII message must be at least 9 bytes long.

  • Turn on tracing to get more information.

  • If using serial communications, check that Speed, Parity, Data bits and Stop bits are all set correctly.

  • Try increasing the EOM Timeout setting - messages may be getting fragmented by long delays introduced by the comms link or the operating system.

"Message too long (> XXX bytes)"

A received message was too long to fit in ModMaster's input buffer.

TCP Packet Type

"Incomplete message: only XXX bytes"

A TCP message must be at least 8 bytes long (7 bytes for the header and 1 byte for the function code).

  • Turn on tracing to get more information.

  • Try increasing the EOM Timeout setting - messages may be getting fragmented by long delays introduced by the comms link or the operating system.

"Incorrect protocol identifier: XXX"

The protocol identifier in the received message header was not zero.

"Length (XXX) too small"

The value in the length field of the received message header must be at least 2 (1 byte for the slave ID and 1 byte for the function code).

"Incomplete message: only XXX bytes when expecting XXX"

The received message was shorter than indicated by the length field of the header.

  • Turn on tracing to get more information.

  • Try increasing the EOM Timeout setting - messages may be getting fragmented by long delays introduced by the comms link or the operating system.

Sending commands

Value is read from or written to address in slave that is wrong but near to address in command

  • Check that the address mapping is consistent with the slave.

  • If you are using 32 or 64 bit registers, check that Word Registers setting is consistent with the slave.

  • Turn on tracing to get more information.

  • If you are using polling or a high-level command, try a low-level command (e.g. CommandRead Holding Registers) to get more information.

Wrong value is displayed when reading from slave, or wrong value is written to slave

  • Check that the register Type is consistent with the slave.

  • If you are using 32 or 64 bit registers, check that Little-Endian and Word Registers settings are consistent with the slave.

  • Turn on tracing to get more information.

  • If you are using polling or a high-level command, try a low-level command (e.g. CommandRead Holding Registers) to get more information.

"Unexpected"

Unexpected data was received by ModMaster when it was about to send a request message.

  • The data may be a delayed response to an earlier request sent by ModMaster (this should be apparent in the trace output). You may need to increase the response timeout setting if the slave or the comms link is slow.

"Invalid read count (XXX) - response byte count (XXX) would not fit in a byte"

The read request that you are attempting to send contains a count that is too large. The response would have to contain more than 255 bytes of data, and the byte count would then not fit into the single byte reserved for it in the response message.

  • If you think you should be able to send the request and you are using 32 or 64 bit registers, check that the Word Registers and Word Count settings are consistent with the slave.

  • If your slave can handle messages containing more than 255 data bytes, and you don't mind not conforming to the current Modbus specification, you could select Allow Long Messages to enable the request to be sent.

"Invalid read count (XXX) - response would exceed max PDU size (XXX bytes)"

The read request that you are attempting to send contains a count that is too large. The response would exceed the arbitrary limit on the PDU size.

"Invalid read count (XXX) - response would exceed count limit (XXX bytes)"

The read request that you are attempting to send contains a count that is too large. The response would exceed the arbitrary count limit (interpreted as a limit on the number of data bytes) imposed by the current Modbus specification.

"Invalid write count (XXX) - byte count (XXX) would not fit in a byte"

The write request that you are attempting to send contains a count that is too large. The request would have to contain more than 255 bytes of data, and the byte count would then not fit into the single byte reserved for it in the request message.

  • If you think you should be able to send the request and you are using 32 or 64 bit registers, check that the Word Registers and Word Count settings are consistent with the slave.

  • If your slave can handle messages containing more than 255 data bytes, and you don't mind not conforming to the current Modbus specification, you could select Allow Long Messages to enable the request to be sent.

"Invalid write count (XXX) - request would exceed max PDU size (XXX bytes)"

The write request that you are attempting to send contains a count that is too large. The request would exceed the arbitrary limit on the PDU size.

"Invalid write count (XXX) - request would exceed count limit (XXX bytes)"

The write request that you are attempting to send contains a count that is too large. The response would exceed the arbitrary count limit (interpreted as a limit on the number of data bytes) imposed by the current Modbus specification.

"Count (XXX) exceeds count limit (XXX)"

The Coil/Discrete-Input request that you are attempting to send contains a count that exceeds the arbitrary count limit imposed by the current Modbus specification.

"Error response: Illegal data address"

The slave has sent an exception response indicating that the address in the command sent by ModMaster was incorrect.

If you are using polling or a high-level command:

  • Check that the slave has registers corresponding to the registers defined in ModMaster.

  • Check that the addresses of the registers defined in ModMaster are consistent with the slave.

  • Check that the address mapping is consistent with the slave.

  • Check that the slave allows the registers to be written, if you are trying to write.

  • Turn on tracing to see if the correct low-level command is being sent. If not, check that the registers defined in ModMaster are in the correct address ranges.

  • Try a low-level command (e.g. CommandRead Holding Registers) to get more information.

If you are using a low-level command:

  • Check that the address you have entered is a message address and not a model address.

  • Check that the slave has a Holding-register/Input-register/Coil/Discrete-input at the Address you have entered.

  • Check that the slave has enough consecutive addresses for the Count you have entered.

  • Check that the slave allows the registers/coils to be written, if you are trying to write.

"Error response: Illegal data value"

The slave has sent an exception response indicating that data in the command sent by ModMaster was incorrect.

  • Turn on tracing to get more information.

  • If you are using 32 or 64 bit values check that the Word Count setting is consistent with the slave. If ModMaster and the slave disagree over how to interpret the count in the Modbus message, then the number of bytes written by ModMaster may be different from what the slave is expecting.

If you are using polling or a high-level command:

  • Check that the Count you have entered does not exceed the maximum supported by the slave (not relevant if polling).

  • Check that the Types of the registers defined in ModMaster are consistent with the slave.

  • Try a low-level command (e.g. CommandWrite Multiple Holding Registers) to get more information.

If you are using a low-level command:

  • Check that the Type is consistent with the slave.

  • Check that the Count you have entered does not exceed the maximum supported by the slave.

"Error response: Illegal function"

The slave has sent an exception response indicating that the function code in the command sent by ModMaster is not supported.

"Error response: Server failure"

"Error response: Acknowledge"

"Error response: Server busy"

"Error response: Memory parity error"

"Error response: Error code XXX"

The slave/bridge/server sent an unexpected error response.

  • Check that your slave/bridge/server is functioning correctly.

"Wrong transaction ID in response: XXX instead of XXX"

The slave sent a response containing a transaction ID that was different from the transaction ID that ModMaster sent in the request. This may have occurred because the slave responded late to an earlier request.

  • Turn on tracing to get more information.

  • Increase the Response Timeout in General settings if necessary.

  • Check that your slave is functioning correctly.

"Wrong function code in response: XXX instead of XXX"

The slave sent a response containing a function code that was different from the function code that ModMaster sent in the request. This may have occurred because the slave responded late to an earlier request.

  • Turn on tracing to get more information.

  • Increase the Response Timeout in General settings if necessary.

  • Check that your slave is functioning correctly.

"Wrong slave ID in response: XXX instead of XXX"

"Wrong address in response: XXX instead of XXX"

"Wrong count in response: XXX instead of XXX"

"Wrong value in response"

"Wrong masks in response"

"Wrong subfunction in response: XXX instead of XXX"

"Wrong 'MEI Type' in response: XXX instead of 14"

"Wrong 'Read Device ID Code' in response: XXX instead of XXX"

The slave sent a response that did not correctly echo the data that ModMaster sent in the request.

  • Turn on tracing to get more information.

  • If you want ModMaster to accept the response even though it is incorrect, you could deselect Strict Checking.

  • Check that your slave is functioning correctly.

"Invalid 'Conformity Level' in response: XXX"

The slave sent a 'Read Device Identification' response containing an invalid 'Conformity Level' value. The only valid values are 01, 02, 03, 81, 82 and 83 (in hex).

  • Turn on tracing to get more information.

  • If you want ModMaster to accept the response even though it is incorrect, you could deselect Strict Checking.

  • Check that your slave is functioning correctly.

"Invalid 'More Follows' in response: XXX"

The slave sent a 'Read Device Identification' response containing an invalid 'More Follows' value. The only valid values are 00 and FF (in hex). 'More Follows' must be 00 if the 'Read Device ID Code' is 04 (individual access).

  • Turn on tracing to get more information.

  • If you want ModMaster to accept the response even though it is incorrect, you could deselect Strict Checking.

  • Check that your slave is functioning correctly.

"Invalid 'Next Object ID' in response: XXX instead of 0"

The slave sent a 'Read Device Identification' response containing an invalid 'Next Object ID' value. The 'Next Object ID' value must be zero if 'More Follows' is zero.

  • Turn on tracing to get more information.

  • If you want ModMaster to accept the response even though it is incorrect, you could deselect Strict Checking.

  • Check that your slave is functioning correctly.

"Invalid 'Number of Objects' in response: XXX instead of 1"

The slave sent a 'Read Device Identification' response containing an invalid 'Number of Objects' value. The 'Number of Objects' value must be 1 if the 'Read Device ID Code' is 04 (individual access).

  • Turn on tracing to get more information.

  • Check that your slave is functioning correctly.

"Response PDU size incorrect: XXX instead of XXX"

The PDU size of a received response was not correct for the function code specified in the response. If the response included a byte count (e.g. a Read Holding Registers response) then the PDU size is inconsistent with the byte count. If the response did not include a byte count (e.g. a Write Multiple Holding Registers response), then the PDU size was not the expected fixed size.

  • Turn on tracing to get more information.

  • Check that your slave is functioning correctly.

"Response PDU too short: XXX when it should be at least XXX"

The PDU size of a received response was not big enough to contain all the fields required for the function code specified in the response.

  • Turn on tracing to get more information.

  • Check that your slave is functioning correctly.

"Wrong byte count in response: XXX when expecting XXX"

The byte count in the response sent by the slave is not what was expected for the count that ModMaster sent in the request.

  • Turn on tracing to get more information.

  • If you want ModMaster to accept the response even though it is incorrect, you could deselect Strict Checking.

  • Check that your slave is functioning correctly.

Miscellaneous

"Inconsistent sizes for coils"

Only one size of register (e.g. 1-bit, 32-bit) is allowed within the address range defined for Coils (see Address mapping). The Coil address range that you are attempting to define (or load from a file) includes registers with different sizes.

  • If the Coil address range overlays the Input or Holding Registers address range, then registers in the overlayed part are also restricted to one size.

  • If your slave device uses Coils, check that all are defined in ModMaster with the same size.

  • If your slave device does not use Coils, set Number of Addresses to 0 in the address map.

"Inconsistent size for coil"

Only one size of register (e.g. 1-bit, 32-bit) is allowed within the address range defined for Coils (see Address mapping). The register that you are attempting to add (or load from a file) has a different size from those already in the address range.

  • If the Coil address range overlays the Input or Holding Registers address range, then registers in the overlayed part are also restricted to one size.

  • If your slave device uses Coils, check that all are defined in ModMaster with the same size.

  • If your slave device does not use Coils, set Number of Addresses to 0 in the address map.

"Inconsistent sizes for discrete inputs"

Only one size of register (e.g. 1-bit, 32-bit) is allowed within the address range defined for Discrete Inputs (see Address mapping). The Discrete Inputs address range that you are attempting to define (or load from a file) includes registers with different sizes.

  • If the Discrete Input address range overlays the Input or Holding Registers address range, then registers in the overlayed part are also restricted to one size.

  • If your slave device uses Discrete Inputs, check that all are defined in ModMaster with the same size.

  • If your slave device does not use Discrete Inputs, set Number of Addresses to 0 in the address map.

"Inconsistent size for discrete input"

Only one size of register (e.g. 1-bit, 32-bit) is allowed within the address range defined for Discrete Inputs (see Address mapping). The register that you are attempting to add (or load from a file) has a different size from those already in the address range.

  • If the Discrete Input address range overlays the Input or Holding Registers address range, then registers in the overlayed part are also restricted to one size.

  • If your slave device uses Discrete Inputs, check that all are defined in ModMaster with the same size.

  • If your slave device does not use Discrete Inputs, set Number of Addresses to 0 in the address map.

"Address XXX is not in any address range"

The address of the register that you are attempting to add (or load from a file) is not within any address range (see Address mapping).

  • If the register address is correct, check that the appropriate address range includes the address.

  • You must use a "model address" when defining a register, not a "message addess".

"Addresses XXX are not in any address range"

The addresses of the registers that you are attempting to add (or load from a file) are not within any address range (see Address mapping).

  • If the register addresses are correct, check that the appropriate address range includes the addresses.

  • You must use "model addresses" when defining registers, not "message addesses".

"Registers XXX and XXX overlap"

When you select Word Registers each 32-bit and 64-bit register requires more than one address. This error occurs when an extra address required by a 32-bit or 64-bit register is used by another register.

Coils: The value appears not to have been written or has been written to the wrong byte

  • Select/deselect Swap Bytes to make the order of bytes of a 16-bit word consistent with the slave.

Coils/Discrete Inputs: bit values are in reverse order within each byte

  • Select/deselect Reverse Bits to reverse the order and make it consistent with the slave.

Coils/Discrete Inputs: byte values are in reverse order in 16-bit words

  • Select/deselect Swap Bytes to reverse the order and make it consistent with the slave.

The 16-bit words of 32 or 64-bit values are in reverse order

  • Select/deselect Little Endian to reverse the order and make it consistent with the slave.

"Not enough data in message: XXX bytes when expecting XXX"

A received message contains too little data for the count and register sizes specified in the request.

  • Turn on tracing to get more information.

  • If you are using 32 or 64 bit registers, check that the Word Registers and Word Count settings are correct.

  • Check that the Types of the registers being transferred are specified correctly.

"Excess data in message: XXX bytes when expecting XXX"

A received message contains too much data for the count and register sizes specified in the request.

  • Turn on tracing to get more information.

  • If you are using 32 or 64 bit registers, check that the Word Registers and Word Count settings are correct.

  • Check that the Types of the registers being transferred are specified correctly.

  • If you want ModMaster to accept the message even though it is incorrect, you could deselect Strict Checking.