net.solarnetwork.io.modbus

Enum ModbusErrorCode

java.lang.Object

java.lang.Enum<ModbusErrorCode>

net.solarnetwork.io.modbus.ModbusErrorCode

All Implemented Interfaces:

Serializable, Comparable<ModbusErrorCode>, ModbusError

public enum ModbusErrorCode
extends Enum<ModbusErrorCode>
implements ModbusError

Modbus error codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Acknowledge Server has accepted request and is processing it, but a long duration of time is required.
GatewayPathUnavailable Specialized for Modbus gateways.
GatewayTimeout Specialized for Modbus gateways.
IllegalDataAddress Data address of some or all the required entities are not allowed or do not exist in server.
IllegalDataValue Value is not accepted by server.
IllegalFunction Function code received in the query is not recognized or allowed by server.
MemoryParityError Server detected a parity error in memory.
NegativeAcknowledge Server cannot perform the programming functions.
ServerDeviceBusy Server is engaged in processing a long-duration command.
ServerDeviceFailure Unrecoverable error occurred while server was attempting to perform requested action.

Method Summary

Modifier and Type	Method and Description
ModbusErrorCode	errorCode() Get this error as a ModbusErrorCode.
static ModbusErrorCode	forCode(byte code) Get an enum instance for a code value.
byte	getCode() Get the error code value.
static ModbusError	valueOf(byte code)
static ModbusErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModbusErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.solarnetwork.io.modbus.ModbusError

equals, hashCode

Enum Constant Detail

IllegalFunction

public static final ModbusErrorCode IllegalFunction

Function code received in the query is not recognized or allowed by server.

IllegalDataAddress

public static final ModbusErrorCode IllegalDataAddress

Data address of some or all the required entities are not allowed or do not exist in server.

IllegalDataValue

public static final ModbusErrorCode IllegalDataValue

Value is not accepted by server.

ServerDeviceFailure

public static final ModbusErrorCode ServerDeviceFailure

Unrecoverable error occurred while server was attempting to perform requested action.

Acknowledge

public static final ModbusErrorCode Acknowledge

Server has accepted request and is processing it, but a long duration of time is required. This response is returned to prevent a timeout error from occurring in the client. Client can next issue a Poll Program Complete message to determine whether processing is completed.

ServerDeviceBusy

public static final ModbusErrorCode ServerDeviceBusy

Server is engaged in processing a long-duration command. client should retry later.

NegativeAcknowledge

public static final ModbusErrorCode NegativeAcknowledge

Server cannot perform the programming functions. Client should request diagnostic or error information from server.

MemoryParityError

public static final ModbusErrorCode MemoryParityError

Server detected a parity error in memory. Client can retry the request, but service may be required on the server device.

GatewayPathUnavailable

public static final ModbusErrorCode GatewayPathUnavailable

Specialized for Modbus gateways. Indicates a misconfigured gateway.

GatewayTimeout

public static final ModbusErrorCode GatewayTimeout

Specialized for Modbus gateways. Sent when server fails to respond.

Method Detail

values

public static ModbusErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModbusErrorCode c : ModbusErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModbusErrorCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public byte getCode()

Description copied from interface: ModbusError

Get the error code value.

Specified by:

getCode in interface ModbusError

Returns:

the code value

errorCode

public ModbusErrorCode errorCode()

Description copied from interface: ModbusError

Get this error as a ModbusErrorCode.

Specified by:

errorCode in interface ModbusError

Returns:

the error code enumeration value, or null if cannot be represented as one

valueOf

public static ModbusError valueOf(byte code)

forCode

public static ModbusErrorCode forCode(byte code)

Get an enum instance for a code value.

Parameters:

code - the code

Returns:

the enum

Throws:

IllegalArgumentException - if code is not a valid value