Package io.openems.edge.common.modbusslave

Class ModbusRecordCycleValue<T extends OpenemsComponent>

java.lang.Object

io.openems.edge.common.modbusslave.ModbusRecord

io.openems.edge.common.modbusslave.ModbusRecordCycleValue<T>

Type Parameters:

T - the OpenemsComponent

public class ModbusRecordCycleValue<T extends OpenemsComponent>
extends ModbusRecord

ModbusRecordCycleValues allow to receive a ModbusRecord via a Function. The Function is executed in the 'run()' method of the Modbus-TCP-Api-Controller.

Constructor Summary

Constructors

Constructor	Description
ModbusRecordCycleValue(int offset, String name, Unit unit, String valueDescription, ModbusType type, Function<T,Object> function)

Method Summary

Modifier and Type	Method	Description
AccessMode	getAccessMode()	Gets the AccessMode.
String	getName()	Gets the name.
Unit	getUnit()
byte[]	getValue(OpenemsComponent component)	Gets the value.
String	getValueDescription()	Gets the value description.
String	toString()
void	updateValue(T component)	Update the Value of this ModbusRecord.
void	writeValue(int index, byte byte1, byte byte2)	Sets the write value.

Methods inherited from class io.openems.edge.common.modbusslave.ModbusRecord

getComponentId, getOffset, getType, setComponentId

Methods inherited from class java.lang.Object

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

Constructor Details

ModbusRecordCycleValue

public ModbusRecordCycleValue(int offset,
 String name,
 Unit unit,
 String valueDescription,
 ModbusType type,
 Function<T,Object> function)

Method Details

toString

public String toString()

Overrides:

toString in class Object

updateValue

public void updateValue(T component)

Update the Value of this ModbusRecord.

This method is called on every cycle by the run()-method of the Modbus-TCP-Api-Controller. Value is set to 'null' if provided 'component' is null.

Parameters:

component - the OpenemsComponent

getValue

public byte[] getValue(OpenemsComponent component)

Description copied from class: ModbusRecord

Gets the value.

Specified by:

getValue in class ModbusRecord

Parameters:

component - the actual OpenemsComponent

Returns:

the value as byte array

writeValue

public void writeValue(int index,
 byte byte1,
 byte byte2)

Description copied from class: ModbusRecord

Sets the write value.

Specified by:

writeValue in class ModbusRecord

Parameters:

index - the buffer index

byte1 - the first byte

byte2 - the second byte

getName

public String getName()

Description copied from class: ModbusRecord

Gets the name.

Specified by:

getName in class ModbusRecord

Returns:

the name

getUnit

public Unit getUnit()

Overrides:

getUnit in class ModbusRecord

getValueDescription

public String getValueDescription()

Description copied from class: ModbusRecord

Gets the value description.

Specified by:

getValueDescription in class ModbusRecord

Returns:

the value description

getAccessMode

public AccessMode getAccessMode()

Description copied from class: ModbusRecord

Gets the AccessMode.

Specified by:

getAccessMode in class ModbusRecord

Returns:

the AccessMode