io.openems.edge.io.shelly.shellyplug

Interface ShellyPlug

All Superinterfaces:

DigitalOutput, org.osgi.service.event.EventHandler, OpenemsComponent

All Known Implementing Classes:

ShellyPlugImpl

public interface ShellyPlug
extends DigitalOutput, OpenemsComponent, org.osgi.service.event.EventHandler

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ShellyPlug.ChannelId

Method Summary

Modifier and Type	Method and Description
default void	_setActivePower(int value) Internal method to set the 'nextValue' on ShellyPlug.ChannelId.ACTIVE_POWER Channel.
default void	_setActivePower(java.lang.Integer value) Internal method to set the 'nextValue' on ShellyPlug.ChannelId.ACTIVE_POWER Channel.
default void	_setRelay(boolean value) Internal method to set the 'nextValue' on ShellyPlug.ChannelId.RELAY Channel.
default void	_setSlaveCommunicationFailed(boolean value) Internal method to set the 'nextValue' on ShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.
default Value<java.lang.Integer>	getActivePower() Gets the Active Power in [W].
default IntegerReadChannel	getActivePowerChannel() Gets the Channel for ShellyPlug.ChannelId.ACTIVE_POWER.
default Value<java.lang.Boolean>	getRelay() Gets the Relay Output 1.
default BooleanWriteChannel	getRelayChannel() Gets the Channel for ShellyPlug.ChannelId.RELAY.
default Value<java.lang.Boolean>	getSlaveCommunicationFailed() Gets the Slave Communication Failed State.
default StateChannel	getSlaveCommunicationFailedChannel() Gets the Channel for ShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED.
default void	setRelay(boolean value) Sets the Relay Output.

Methods inherited from interface io.openems.edge.io.api.DigitalOutput

digitalOutputChannels

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getModbusSlaveNatureTable, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Methods inherited from interface org.osgi.service.event.EventHandler

handleEvent

Method Detail

getRelayChannel

default BooleanWriteChannel getRelayChannel()

Gets the Channel for ShellyPlug.ChannelId.RELAY.

Returns:

the Channel

getRelay

default Value<java.lang.Boolean> getRelay()

Gets the Relay Output 1. See ShellyPlug.ChannelId.RELAY.

Returns:

the Channel Value

_setRelay

default void _setRelay(boolean value)

Internal method to set the 'nextValue' on ShellyPlug.ChannelId.RELAY Channel.

Parameters:

value - the next value

setRelay

default void setRelay(boolean value)
               throws OpenemsError.OpenemsNamedException

Sets the Relay Output. See ShellyPlug.ChannelId.RELAY.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getActivePowerChannel

default IntegerReadChannel getActivePowerChannel()

Gets the Channel for ShellyPlug.ChannelId.ACTIVE_POWER.

Returns:

the Channel

getActivePower

default Value<java.lang.Integer> getActivePower()

Gets the Active Power in [W]. Negative values for Charge; positive for Discharge. See ShellyPlug.ChannelId.ACTIVE_POWER.

Returns:

the Channel Value

_setActivePower

default void _setActivePower(java.lang.Integer value)

Internal method to set the 'nextValue' on ShellyPlug.ChannelId.ACTIVE_POWER Channel.

Parameters:

value - the next value

_setActivePower

default void _setActivePower(int value)

Internal method to set the 'nextValue' on ShellyPlug.ChannelId.ACTIVE_POWER Channel.

Parameters:

value - the next value

getSlaveCommunicationFailedChannel

default StateChannel getSlaveCommunicationFailedChannel()

Gets the Channel for ShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel

getSlaveCommunicationFailed

default Value<java.lang.Boolean> getSlaveCommunicationFailed()

Gets the Slave Communication Failed State. See ShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel Value

_setSlaveCommunicationFailed

default void _setSlaveCommunicationFailed(boolean value)

Internal method to set the 'nextValue' on ShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.

Parameters:

value - the next value