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

Class BitsWordElement

java.lang.Object

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

io.openems.edge.bridge.modbus.api.element.AbstractModbusElement<SELF,com.ghgande.j2mod.modbus.procimg.Register[],T>

io.openems.edge.bridge.modbus.api.element.ModbusRegisterElement<SELF,T>

io.openems.edge.bridge.modbus.api.element.AbstractSingleWordElement<BitsWordElement,Boolean[]>

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

public class BitsWordElement
extends AbstractSingleWordElement<BitsWordElement,Boolean[]>

A BitsWordElement is an UnsignedWordElement where every bit represents a Boolean value.

Field Summary

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

nextWriteValue, type

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

length, startAddress

Constructor Summary

Constructors

Constructor	Description
BitsWordElement(int address, AbstractOpenemsModbusComponent component)

Method Summary

Modifier and Type	Method	Description
BitsWordElement	bit(int bitIndex, ChannelId channelId)	Adds a mapping for a given bit.
BitsWordElement	bit(int bitIndex, ChannelId channelId, AbstractOpenemsModbusComponent.BitConverter converter)	Adds a mapping for a given bit.
BitsWordElement	bit(int bitIndex, ChannelId channelId, AbstractOpenemsModbusComponent.BitConverter converter, ChannelMetaInfoBit channelMetaInfoBit)	Adds a mapping for a given bit.
BitsWordElement	bit(int bitIndex, ChannelId channelId, ChannelMetaInfoBit channelMetaInfoBit)	Adds a mapping for a given bit.
protected Boolean[]	byteBufferToValue(ByteBuffer buff)
protected void	onNextWriteValueReset()
protected Boolean[]	registersToValue(com.ghgande.j2mod.modbus.procimg.Register[] registers)	Length of registers array is guaranteed to be 1 here.
protected BitsWordElement	self()	Gets an instance of the correct subclass of myself.
protected void	valueToByteBuffer(ByteBuffer buff, Boolean[] value)
protected com.ghgande.j2mod.modbus.procimg.Register[]	valueToRaw(Boolean[] values)

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

byteOrder, commonRegistersToValue, getByteOrder, rawToValue, valueToRaw

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

deactivate, debug, getNextWriteValueAndReset, invalidate, isDebug, onSetNextWrite, onUpdateCallback, setInputValue, setNextWriteValue, setNextWriteValueFromObject, toString

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

getModbusTask, setModbusTask

Methods inherited from class java.lang.Object

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

Constructor Details

BitsWordElement

public BitsWordElement(int address,
 AbstractOpenemsModbusComponent component)

Method Details

self

protected BitsWordElement self()

Description copied from class: AbstractModbusElement

Gets an instance of the correct subclass of myself.

Specified by:

self in class AbstractModbusElement<BitsWordElement,com.ghgande.j2mod.modbus.procimg.Register[],Boolean[]>

Returns:

myself

bit

public BitsWordElement bit(int bitIndex,
 ChannelId channelId,
 AbstractOpenemsModbusComponent.BitConverter converter)

Adds a mapping for a given bit.

Parameters:

bitIndex - the index of the bit; a number between 0 and 15

channelId - the Channel-ID

converter - the Bit-Converter

Returns:

myself for builder pattern

bit

public BitsWordElement bit(int bitIndex,
 ChannelId channelId,
 ChannelMetaInfoBit channelMetaInfoBit)

Adds a mapping for a given bit.

Parameters:

bitIndex - the index of the bit; a number between 0 and 15

channelId - the Channel-ID

channelMetaInfoBit - an object that holds meta information about the Channel

Returns:

myself for builder pattern

bit

public BitsWordElement bit(int bitIndex,
 ChannelId channelId,
 AbstractOpenemsModbusComponent.BitConverter converter,
 ChannelMetaInfoBit channelMetaInfoBit)

Adds a mapping for a given bit.

Parameters:

bitIndex - the index of the bit; a number between 0 and 15

channelId - the Channel-ID

converter - the Bit-Converter

channelMetaInfoBit - an object that holds meta information about the Channel

Returns:

myself for builder pattern

bit

public BitsWordElement bit(int bitIndex,
 ChannelId channelId)

Adds a mapping for a given bit.

Parameters:

bitIndex - the index of the bit; a number between 0 and 15

channelId - the Channel-ID

Returns:

myself for builder pattern

valueToRaw

protected com.ghgande.j2mod.modbus.procimg.Register[] valueToRaw(Boolean[] values)

Overrides:

valueToRaw in class AbstractSingleWordElement<BitsWordElement,Boolean[]>

registersToValue

protected Boolean[] registersToValue(com.ghgande.j2mod.modbus.procimg.Register[] registers)

Length of registers array is guaranteed to be 1 here.

Overrides:

registersToValue in class AbstractSingleWordElement<BitsWordElement,Boolean[]>

Parameters:

registers - the Registers

Returns:

the typed/converted value

onNextWriteValueReset

protected void onNextWriteValueReset()

Overrides:

onNextWriteValueReset in class AbstractModbusElement<BitsWordElement,com.ghgande.j2mod.modbus.procimg.Register[],Boolean[]>

byteBufferToValue

protected Boolean[] byteBufferToValue(ByteBuffer buff)

Specified by:

byteBufferToValue in class ModbusRegisterElement<BitsWordElement,Boolean[]>

valueToByteBuffer

protected void valueToByteBuffer(ByteBuffer buff,
 Boolean[] value)

Specified by:

valueToByteBuffer in class ModbusRegisterElement<BitsWordElement,Boolean[]>