Package io.openems.edge.bridge.modbus.api.element

Class CoilElement

java.lang.Object

io.openems.edge.bridge.modbus.api.element.AbstractModbusElement<Boolean>

io.openems.edge.bridge.modbus.api.element.CoilElement

All Implemented Interfaces:

ModbusCoilElement, ModbusElement<Boolean>

public class CoilElement
extends AbstractModbusElement<Boolean>
implements ModbusCoilElement

A CoilElement has a size of one Modbus Coil or 1 bit.

Field Summary

Fields inherited from class io.openems.edge.bridge.modbus.api.element.AbstractModbusElement

abstractTask

Constructor Summary

Constructors

Constructor	Description
CoilElement(int startAddress)

Method Summary

Modifier and Type	Method	Description
void	_setNextWriteValue(Optional<Boolean> valueOpt)	Sets a value that should be written to the Modbus device.
int	getLength()	Number of Registers or Coils.
Optional<Boolean>	getNextWriteValue()	Gets the next write value.
void	setInputCoil(Boolean coil)	Sets the boolean value of this Element from Modbus Coil.

Methods inherited from class io.openems.edge.bridge.modbus.api.element.AbstractModbusElement

deactivate, debug, getModbusTask, getStartAddress, getType, invalidate, isDebug, isIgnored, onSetNextWrite, onUpdateCallback, setModbusTask, setValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.bridge.modbus.api.element.ModbusCoilElement

getNextWriteValueAndReset, setNextWriteValue

Methods inherited from interface io.openems.edge.bridge.modbus.api.element.ModbusElement

deactivate, getStartAddress, getType, invalidate, isIgnored, onSetNextWrite, setModbusTask

Constructor Details

CoilElement

public CoilElement(int startAddress)

Method Details

getNextWriteValue

public Optional<Boolean> getNextWriteValue()

Description copied from interface: ModbusCoilElement

Gets the next write value.

Specified by:

getNextWriteValue in interface ModbusCoilElement

Returns:

the Optional next write value

getLength

public int getLength()

Description copied from interface: ModbusElement

Number of Registers or Coils.

Specified by:

getLength in interface ModbusElement<Boolean>

Returns:

the number of Registers or Coils

_setNextWriteValue

public void _setNextWriteValue(Optional<Boolean> valueOpt)
                        throws OpenemsException

Description copied from interface: ModbusElement

Sets a value that should be written to the Modbus device.

Specified by:

_setNextWriteValue in interface ModbusElement<Boolean>

Parameters:

valueOpt - the Optional value

Throws:

OpenemsException - on error

setInputCoil

public void setInputCoil(Boolean coil)
                  throws OpenemsException

Description copied from interface: ModbusCoilElement

Sets the boolean value of this Element from Modbus Coil.

Specified by:

setInputCoil in interface ModbusCoilElement

Parameters:

coil - the value

Throws:

OpenemsException - on error