Package io.openems.edge.controller.api.rest

Interface RestApi

All Superinterfaces:

OpenemsComponent

All Known Implementing Classes:

AbstractRestApi, ControllerApiRestReadOnlyImpl, ControllerApiRestReadWriteImpl

public interface RestApi
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RestApi.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setUnableToStart(boolean value)	Internal method to set the 'nextValue' on RestApi.ChannelId.UNABLE_TO_START Channel.
default Value<Boolean>	getUnableToStart()	Gets the Unable to Start Fault State.
default StateChannel	getUnableToStartChannel()	Gets the Channel for RestApi.ChannelId.UNABLE_TO_START.

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

getUnableToStartChannel

default StateChannel getUnableToStartChannel()

Gets the Channel for RestApi.ChannelId.UNABLE_TO_START.

Returns:

the Channel

getUnableToStart

default Value<Boolean> getUnableToStart()

Gets the Unable to Start Fault State. See RestApi.ChannelId.UNABLE_TO_START.

Returns:

the Channel Value

_setUnableToStart

default void _setUnableToStart(boolean value)

Internal method to set the 'nextValue' on RestApi.ChannelId.UNABLE_TO_START Channel.

Parameters:

value - the next value