Package io.openems.edge.common.startstop

Interface StartStoppable

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

Battery, BatteryFeneconCommercial, BatteryFeneconHome, BatteryInverterKacoBlueplanetGridsave, BatteryInverterRefuStore88k, BatteryInverterSinexcel, BatterySoltaroClusterVersionB, BatterySoltaroClusterVersionC, BatterySoltaroSingleRackVersionA, BatterySoltaroSingleRackVersionB, BatterySoltaroSingleRackVersionC, BydBatteryBoxCommercialC130, EssCluster, EssGenericManagedSymmetric, EssGenericOffGrid, GenericManagedEss, GoodWeBatteryInverter, HybridManagedSymmetricBatteryInverter, ManagedSymmetricBatteryInverter, OffGridBatteryInverter, SimulatorBattery, SimulatorEssSymmetricReacting, SoltaroBatteryVersionC, SoltaroCluster

All Known Implementing Classes:

AbstractDummyBattery, AbstractDummyManagedSymmetricEss, AbstractGenericManagedEss, AbstractSunSpecBatteryInverter, BatteryFeneconCommercialImpl, BatteryFeneconHomeImpl, BatteryInverterKacoBlueplanetGridsaveImpl, BatteryInverterRefuStore88kImpl, BatteryInverterSinexcelImpl, BatterySoltaroClusterVersionBImpl, BatterySoltaroClusterVersionCImpl, BatterySoltaroSingleRackVersionAImpl, BatterySoltaroSingleRackVersionBImpl, BatterySoltaroSingleRackVersionCImpl, BmwBatteryImpl, BydBatteryBoxCommercialC130Impl, DummyBattery, DummyHybridEss, DummyManagedAsymmetricEss, DummyManagedSymmetricBatteryInverter, DummyManagedSymmetricEss, DummyMetaEss, DummyOffGridBatteryInverter, EssClusterImpl, EssGenericManagedSymmetricImpl, EssGenericOffGridImpl, GoodWeBatteryInverterImpl, SimulatorBatteryImpl, SimulatorEssSymmetricReactingImpl

public interface StartStoppable
extends OpenemsComponent

Declares an OpenEMS Component as being able to get started and stopped.

A device or service inside OpenEMS that implements this OpenEMS Nature can be started or stopped.

Implementing this Nature also requires the Component to have a configuration property "startStop" of type StartStopConfig that overrides the logic of the setStartStop(StartStop) method:

        @AttributeDefinition(name = "Start/stop behaviour?", description = "Should this Component be forced to start or stop?")
        StartStopConfig startStop() default StartStopConfig.AUTO;
 

• if config is StartStopConfig.START -> always start
• if config is StartStopConfig.STOP -> always stop
• if config is StartStopConfig.AUTO -> start StartStop.UNDEFINED and wait for a call to setStartStop(StartStop)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	StartStoppable.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setStartStop(StartStop value)	Internal method to set the 'nextValue' on StartStoppable.ChannelId.START_STOP Channel.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default StartStop	getStartStop()	Gets the current StartStop state of the StartStoppable Component.
default Channel<StartStop>	getStartStopChannel()	Gets the Channel for StartStoppable.ChannelId.START_STOP.
default boolean	isStarted()	Is this device or service started?.
default boolean	isStopped()	Is this device or service stopped?.
void	setStartStop(StartStop value)	Starts or stops the device or service represented by this OpenEMS Component.
default void	start()	Starts the device or service represented by this OpenEMS Component.
default void	stop()	Stops the device or service represented by this OpenEMS Component.

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

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

getStartStopChannel

default Channel<StartStop> getStartStopChannel()

Gets the Channel for StartStoppable.ChannelId.START_STOP.

Returns:

the Channel

getStartStop

default StartStop getStartStop()

Gets the current StartStop state of the StartStoppable Component. See StartStoppable.ChannelId.START_STOP.

Returns:

the Channel Value

isStarted

default boolean isStarted()

Is this device or service started?.

• true - if (and only if) StartStoppable.ChannelId.START_STOP is StartStop.START
• false - if StartStoppable.ChannelId.START_STOP is StartStop.STOP or StartStop.UNDEFINED

Returns:

true if started

isStopped

default boolean isStopped()

Is this device or service stopped?.

• true - if (and only if) StartStoppable.ChannelId.START_STOP is StartStop.STOP
• false - if StartStoppable.ChannelId.START_STOP is StartStop.START or StartStop.UNDEFINED

Returns:

true if stopped

_setStartStop

default void _setStartStop(StartStop value)

Internal method to set the 'nextValue' on StartStoppable.ChannelId.START_STOP Channel.

Parameters:

value - the next value

setStartStop

void setStartStop(StartStop value)
           throws OpenemsError.OpenemsNamedException

Starts or stops the device or service represented by this OpenEMS Component.

Parameters:

value - target StartStop state

Throws:

OpenemsError.OpenemsNamedException - on error

start

default void start()
            throws OpenemsError.OpenemsNamedException

Starts the device or service represented by this OpenEMS Component.

This calls setStartStop(StartStop) with StartStop.START.

Throws:

OpenemsError.OpenemsNamedException - on error

stop

default void stop()
           throws OpenemsError.OpenemsNamedException

Stops the device or service represented by this OpenEMS Component.

This calls setStartStop(StartStop) with StartStop.STOP.

Throws:

OpenemsError.OpenemsNamedException - on error