Package io.openems.edge.common.host

Interface Host

All Superinterfaces:

JsonApi, OpenemsComponent

All Known Implementing Classes:

DummyHost, HostImpl

public interface Host
extends OpenemsComponent, JsonApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Host.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SINGLETON_COMPONENT_ID
static final String	SINGLETON_SERVICE_PID

Method Summary

Modifier and Type	Method	Description
default void	_setDiskIsFull(boolean value)	Internal method to set the 'nextValue' on Host.ChannelId.DISK_IS_FULL Channel.
default void	_setHostname(String value)	Internal method to set the 'nextValue' on Host.ChannelId.HOSTNAME Channel.
default Value<Boolean>	getDiskIsFull()	Gets the Disk is Full Warning State.
default StateChannel	getDiskIsFullChannel()	Gets the Channel for Host.ChannelId.DISK_IS_FULL.
default Value<String>	getHostname()	Gets the Disk is Full Warning State.
default StringReadChannel	getHostnameChannel()	Gets the Channel for Host.ChannelId.HOSTNAME.

Methods inherited from interface io.openems.edge.common.jsonapi.JsonApi

handleJsonrpcRequest

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

Field Details

SINGLETON_SERVICE_PID

static final String SINGLETON_SERVICE_PID

See Also:

• Constant Field Values

SINGLETON_COMPONENT_ID

static final String SINGLETON_COMPONENT_ID

See Also:

• Constant Field Values

Method Details

getDiskIsFullChannel

default StateChannel getDiskIsFullChannel()

Gets the Channel for Host.ChannelId.DISK_IS_FULL.

Returns:

the Channel

getDiskIsFull

default Value<Boolean> getDiskIsFull()

Gets the Disk is Full Warning State. See Host.ChannelId.DISK_IS_FULL.

Returns:

the Channel Value

_setDiskIsFull

default void _setDiskIsFull(boolean value)

Internal method to set the 'nextValue' on Host.ChannelId.DISK_IS_FULL Channel.

Parameters:

value - the next value

getHostnameChannel

default StringReadChannel getHostnameChannel()

Gets the Channel for Host.ChannelId.HOSTNAME.

Returns:

the Channel

getHostname

default Value<String> getHostname()

Gets the Disk is Full Warning State. See Host.ChannelId.HOSTNAME.

Returns:

the Channel Value

_setHostname

default void _setHostname(String value)

Internal method to set the 'nextValue' on Host.ChannelId.HOSTNAME Channel.

Parameters:

value - the next value