Package io.openems.edge.io.api

Interface AnalogVoltageOutput

All Superinterfaces:

AnalogOutput, OpenemsComponent

All Known Implementing Classes:

DummyAnalogVoltageOutput, IoFilipowskiMrAo1Impl

@ProviderType
public interface AnalogVoltageOutput
extends AnalogOutput

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AnalogVoltageOutput.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.io.api.AnalogOutput

AnalogOutput.Range

Field Summary

Fields inherited from interface io.openems.edge.io.api.AnalogOutput

SET_OUTPUT_ACCURACY

Method Summary

Modifier and Type	Method	Description
default Value<Integer>	getDebugSetOutputVoltage()	Gets the set voltage output value of the I/O.
default IntegerReadChannel	getDebugSetOutputVoltageChannel()	Gets the Channel for AnalogVoltageOutput.ChannelId.DEBUG_SET_OUTPUT_VOLTAGE.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default IntegerWriteChannel	getSetOutputVoltageChannel()	Gets the Channel for AnalogVoltageOutput.ChannelId.SET_OUTPUT_VOLTAGE.
default Consumer<Integer>	setOutputChannel()	Provides a consumer that sets the individual output channel of the implementation.
default void	setOutputVoltage(Integer value)	Sets the voltage output value of the AnalogOutput in mV.

Methods inherited from interface io.openems.edge.io.api.AnalogOutput

getDebugSetOutputPercent, getDebugSetOutputPercentChannel, getSetOutputPercentAsFactor, getSetOutputPercentChannel, range, setOutputPercent

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Method Details

setOutputChannel

default Consumer<Integer> setOutputChannel()

Description copied from interface: AnalogOutput

Provides a consumer that sets the individual output channel of the implementation.

Accept is called on SetNextWrite of AnalogOutput.ChannelId.SET_OUTPUT_PERCENT. The consumed value is already formatted to the current range and precision.

Setting the value in a method like setOutputChannel(int output) directly in the implementation would look like it is a common method for other controllers

Specified by:

setOutputChannel in interface AnalogOutput

Returns:

consumer, setting the individual output channel

getSetOutputVoltageChannel

default IntegerWriteChannel getSetOutputVoltageChannel()

Gets the Channel for AnalogVoltageOutput.ChannelId.SET_OUTPUT_VOLTAGE.

Returns:

the Channel

setOutputVoltage

default void setOutputVoltage(Integer value)
                       throws OpenemsError.OpenemsNamedException

Sets the voltage output value of the AnalogOutput in mV. See AnalogVoltageOutput.ChannelId.SET_OUTPUT_VOLTAGE.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getDebugSetOutputVoltageChannel

default IntegerReadChannel getDebugSetOutputVoltageChannel()

Gets the Channel for AnalogVoltageOutput.ChannelId.DEBUG_SET_OUTPUT_VOLTAGE.

Returns:

the Channel

getDebugSetOutputVoltage

default Value<Integer> getDebugSetOutputVoltage()

Gets the set voltage output value of the I/O. See AnalogVoltageOutput.ChannelId.DEBUG_SET_OUTPUT_VOLTAGE.

Returns:

the Channel Value

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

Used for Modbus/TCP Api Controller. Provides a Modbus table for the Channels of this Component.

Parameters:

accessMode - filters the Modbus-Records that should be shown

Returns:

the ModbusSlaveNatureTable