Package org.openhab.core.io.transport.modbus

Class ModbusWriteCoilRequestBlueprint

java.lang.Object

org.openhab.core.io.transport.modbus.ModbusWriteRequestBlueprint

org.openhab.core.io.transport.modbus.ModbusWriteCoilRequestBlueprint

@NonNullByDefault
public class ModbusWriteCoilRequestBlueprint
extends ModbusWriteRequestBlueprint

Implementation for writing coils

Author:

Sami Salonen - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ModbusWriteCoilRequestBlueprint(int slaveId, int reference, boolean data, boolean writeMultiple, int maxTries)	Construct coil write request with single bit of data
ModbusWriteCoilRequestBlueprint(int slaveId, int reference, BitArray data, boolean writeMultiple, int maxTries)	Construct coil write request with many bits of data

Method Summary

Modifier and Type	Method	Description
void	accept(ModbusWriteRequestBlueprintVisitor visitor)	Accept visitor
BitArray	getCoils()
ModbusWriteFunctionCode	getFunctionCode()	Returns the function code of this ModbusMessage as int. The function code is a 1-byte non negative integer value valid in the range of 0-127. Function codes are ordered in conformance classes their values are specified in net.wimpi.modbus.Modbus.
int	getMaxTries()	Get maximum number of tries, in case errors occur.
int	getReference()	Returns the reference of the register/coil/discrete input to to start writing with this request
int	getUnitID()	Returns the unit identifier of this ModbusMessage as int. The identifier is a 1-byte non negative integer value valid in the range of 0-255.
String	toString()

Methods inherited from class org.openhab.core.io.transport.modbus.ModbusWriteRequestBlueprint

getProtocolID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ModbusWriteCoilRequestBlueprint

public ModbusWriteCoilRequestBlueprint(int slaveId,
 int reference,
 boolean data,
 boolean writeMultiple,
 int maxTries)

Construct coil write request with single bit of data

Parameters:

slaveId - slave id to write to

reference - reference address

data - bit to write

writeMultiple - whether to use ModbusWriteFunctionCode.WRITE_MULTIPLE_COILS over ModbusWriteFunctionCode.WRITE_COIL

maxTries - maximum number of tries in case of errors, should be at least 1

ModbusWriteCoilRequestBlueprint

public ModbusWriteCoilRequestBlueprint(int slaveId,
 int reference,
 BitArray data,
 boolean writeMultiple,
 int maxTries)

Construct coil write request with many bits of data

Parameters:

slaveId - slave id to write to

reference - reference address

data - bit(s) to write

writeMultiple - whether to use ModbusWriteFunctionCode.WRITE_MULTIPLE_COILS over ModbusWriteFunctionCode.WRITE_COIL. Useful with single bit of data.

maxTries - maximum number of tries in case of errors, should be at least 1

Throws:

IllegalArgumentException - in case data is empty, writeMultiple is false but there are many bits to write.

Method Details

getUnitID

public int getUnitID()

Description copied from class: ModbusWriteRequestBlueprint

Returns the unit identifier of this ModbusMessage as int.
The identifier is a 1-byte non negative integer value valid in the range of 0-255.

Specified by:

getUnitID in class ModbusWriteRequestBlueprint

Returns:

the unit identifier as int.

getReference

public int getReference()

Description copied from class: ModbusWriteRequestBlueprint

Returns the reference of the register/coil/discrete input to to start writing with this request

Specified by:

getReference in class ModbusWriteRequestBlueprint

Returns:

the reference of the register to start reading from as int.

getFunctionCode

public ModbusWriteFunctionCode getFunctionCode()

Description copied from class: ModbusWriteRequestBlueprint

Returns the function code of this ModbusMessage as int.
The function code is a 1-byte non negative integer value valid in the range of 0-127.
Function codes are ordered in conformance classes their values are specified in net.wimpi.modbus.Modbus.

Specified by:

getFunctionCode in class ModbusWriteRequestBlueprint

Returns:

the function code as int.

See Also:

• Modbus

getCoils

public BitArray getCoils()

getMaxTries

public int getMaxTries()

Description copied from class: ModbusWriteRequestBlueprint

Get maximum number of tries, in case errors occur. Should be at least 1.

Specified by:

getMaxTries in class ModbusWriteRequestBlueprint

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(ModbusWriteRequestBlueprintVisitor visitor)

Description copied from class: ModbusWriteRequestBlueprint

Accept visitor

Specified by:

accept in class ModbusWriteRequestBlueprint