Package io.openems.edge.controller.api
Interface Controller
-
- All Superinterfaces:
OpenemsComponent
- All Known Subinterfaces:
ActivePowerVoltageCharacteristic
,BackendApi
,BalancingSchedule
,ChannelSingleThreshold
,DebugLog
,DelayedSellToGrid
,EmergencyCapacityReserve
,EssCycle
,EssFixActivePower
,EssLinearPowerBand
,EssSellToGridLimit
,GridOptimizedCharge
,LimitTotalDischargeController
,MqttApiController
,ReactivePowerVoltageCharacteristic
,SimilarDayPredictor
,StandbyController
,SurplusFeedToGridController
,TimeOfUseTariffDischarge
- All Known Implementing Classes:
AbstractModbusTcpApi
,AbstractRestApi
,AcIsland
,ActivePowerVoltageCharacteristicImpl
,AsymmetricFixActivePower
,AsymmetricFixReactivePower
,BackendApiImpl
,Balancing
,BalancingScheduleImpl
,BydContainerWatchdog
,ChannelSingleThresholdImpl
,ChannelThreshold
,ControllerChpSoc
,ControllerHeatingElementImpl
,CosPhi
,DebugDetailedLog
,DebugLogImpl
,DelayChargeController
,DelayedSellToGridImpl
,DummyController
,EmergencyCapacityReserveImpl
,EssCycleImpl
,EssFixActivePowerImpl
,EssLinearPowerBandImpl
,EssSellToGridLimitImpl
,EvcsClusterImpl
,EvcsController
,EvcsFixActivePower
,FixDigitalOutput
,FundamentalFrequency
,GridOptimizedChargeImpl
,HeatPumpImpl
,HighLoadTimeslot
,IoAlarm
,JsonLogicController
,LimitTotalDischargeControllerImpl
,MinDischargePeriod
,ModbusTcpApiReadOnlyImpl
,ModbusTcpApiReadWriteImpl
,MqttApiControllerImpl
,PeakShaving
,PeakShaving
,PhaseRectification
,PvInverterFixPowerLimit
,PvInverterSellToGridLimit
,ReactivePwrVoltChractersticImpl
,RestApiReadOnlyImpl
,RestApiReadWriteImpl
,SetBalancing
,StandbyControllerImpl
,SurplusFeedToGridControllerImpl
,SymmetricFixReactivePower
,SymmetricLimitActivePower
,SymmetricRandomPower
,TimeOfUseTariffDischargeImpl
,TimeslotPeakshaving
,WebsocketApi
@ProviderType public interface Controller extends OpenemsComponent
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Controller.ChannelId
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
_setRunFailed(boolean value)
Internal method to set the 'nextValue' onController.ChannelId.RUN_FAILED
Channel.static ModbusSlaveNatureTable
getModbusSlaveNatureTable(AccessMode accessMode)
Used for Modbus/TCP Api Controller.default Value<java.lang.Boolean>
getRunFailed()
Gets the Run-Failed State.default StateChannel
getRunFailedChannel()
Gets the Channel forController.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 Detail
-
run
void run() throws OpenemsError.OpenemsNamedException
Executes the Controller logic.- Throws:
OpenemsError.OpenemsNamedException
- on error
-
getRunFailedChannel
default StateChannel getRunFailedChannel()
Gets the Channel forController.ChannelId.RUN_FAILED
.- Returns:
- the Channel
-
getRunFailed
default Value<java.lang.Boolean> getRunFailed()
Gets the Run-Failed State. SeeController.ChannelId.RUN_FAILED
.- Returns:
- the Channel
Value
-
_setRunFailed
default void _setRunFailed(boolean value)
Internal method to set the 'nextValue' onController.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
-
-