Package io.openems.edge.controller.api

Interface Controller

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

ControllerApiBackend, ControllerApiMqtt, ControllerApiWebsocket, ControllerAsymmetricBalancingCosPhi, ControllerAsymmetricFixReactivePower, ControllerAsymmetricPeakShaving, ControllerAsymmetricPhaseRectification, ControllerChannelThreshold, ControllerChpSoc, ControllerDebugDetailedLog, ControllerDebugLog, ControllerEssAcIsland, ControllerEssActivePowerVoltageCharacteristic, ControllerEssBalancing, ControllerEssBalancingSchedule, ControllerEssCycle, ControllerEssDelayCharge, ControllerEssDelayedSellToGrid, ControllerEssEmergencyCapacityReserve, ControllerEssFixActivePower, ControllerEssFixReactivePower, ControllerEssGridOptimizedCharge, ControllerEssHybridSurplusFeedToGrid, ControllerEssLimitActivePower, ControllerEssLimitTotalDischarge, ControllerEssLinearPowerBand, ControllerEssMinimumDischargePower, ControllerEssPeakShaving, ControllerEssRandomPower, ControllerEssReactivePowerVoltageCharacteristic, ControllerEssSellToGridLimit, ControllerEssStandby, ControllerEssTimeslotPeakshaving, ControllerEvcsFixActivePower, ControllerGenericJsonLogic, ControllerHighLoadTimeslot, ControllerIoAlarm, ControllerIoAnalog, ControllerIoChannelSingleThreshold, ControllerIoFixDigitalOutput, ControllerMrFundamentalFrequency, ControllerMrSetBalancing, ControllerPvInverterFixPowerLimit, ControllerPvInverterSellToGridLimit, EssFeneconBydContainerWatchdogController, FixStateOfCharge, PredictorSimilardayModel, TimeOfUseTariffController

All Known Implementing Classes:

AbstractFixStateOfCharge, AbstractModbusTcpApi, AbstractRestApi, ControllerApiBackendImpl, ControllerApiModbusTcpReadOnlyImpl, ControllerApiModbusTcpReadWriteImpl, ControllerApiMqttImpl, ControllerApiRestReadOnlyImpl, ControllerApiRestReadWriteImpl, ControllerApiWebsocketImpl, ControllerAsymmetricBalancingCosPhiImpl, ControllerAsymmetricFixReactivePowerImpl, ControllerAsymmetricPeakShavingImpl, ControllerAsymmetricPhaseRectificationImpl, ControllerChannelThresholdImpl, ControllerChpSocImpl, ControllerDebugDetailedLogImpl, ControllerDebugLogImpl, ControllerEssAcIslandImpl, ControllerEssActivePowerVoltageCharacteristicImpl, ControllerEssBalancingImpl, ControllerEssBalancingScheduleImpl, ControllerEssCycleImpl, ControllerEssDelayChargeImpl, ControllerEssDelayedSellToGridImpl, ControllerEssEmergencyCapacityReserveImpl, ControllerEssFixActivePowerImpl, ControllerEssFixReactivePowerImpl, ControllerEssFixStateOfChargeImpl, ControllerEssGridOptimizedChargeImpl, ControllerEssHybridSurplusFeedToGridImpl, ControllerEssLimitActivePowerImpl, ControllerEssLimitTotalDischargeImpl, ControllerEssLinearPowerBandImpl, ControllerEssMinimumDischargePowerImpl, ControllerEssPeakShavingImpl, ControllerEssPrepareBatteryExtensionImpl, ControllerEssRandomPowerImpl, ControllerEssReactivePowerVoltageCharacteristicImpl, ControllerEssSellToGridLimitImpl, ControllerEssStandbyImpl, ControllerEssTimeslotPeakshavingImpl, ControllerEvcsFixActivePowerImpl, ControllerEvcsImpl, ControllerGenericJsonLogicImpl, ControllerHighLoadTimeslotImpl, ControllerIoAlarmImpl, ControllerIoAnalogImpl, ControllerIoChannelSingleThresholdImpl, ControllerIoFixDigitalOutputImpl, ControllerIoHeatingElementImpl, ControllerIoHeatPumpSgReadyImpl, ControllerMrFundamentalFrequencyImpl, ControllerMrSetBalancingImpl, ControllerPvInverterFixPowerLimitImpl, ControllerPvInverterSellToGridLimitImpl, DummyController, EssFeneconBydContainerWatchdogControllerImpl, EvcsClusterPeakShavingImpl, TimeOfUseTariffControllerImpl

@ProviderType
public interface Controller
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Controller.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setRunFailed(boolean value)	Internal method to set the 'nextValue' on Controller.ChannelId.RUN_FAILED Channel.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default Value<Boolean>	getRunFailed()	Gets the Run-Failed State.
default StateChannel	getRunFailedChannel()	Gets the Channel for Controller.ChannelId.RUN_FAILED.
void	run()	Executes the Controller logic.

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

run

void run()
  throws OpenemsError.OpenemsNamedException

Executes the Controller logic.

Throws:

OpenemsError.OpenemsNamedException - on error

getRunFailedChannel

default StateChannel getRunFailedChannel()

Gets the Channel for Controller.ChannelId.RUN_FAILED.

Returns:

the Channel

getRunFailed

default Value<Boolean> getRunFailed()

Gets the Run-Failed State. See Controller.ChannelId.RUN_FAILED.

Returns:

the Channel Value

_setRunFailed

default void _setRunFailed(boolean value)

Internal method to set the 'nextValue' on Controller.ChannelId.RUN_FAILED Channel.

Parameters:

value - the next 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