Package io.openems.edge.io.shelly.shelly25

Interface IoShelly25

All Superinterfaces:

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

All Known Implementing Classes:

IoShelly25Impl

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IoShelly25.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setRelay1(Boolean value)	Internal method to set the 'nextValue' on IoShelly25.ChannelId.RELAY_1 Channel.
default void	_setRelay2(Boolean value)	Internal method to set the 'nextValue' on IoShelly25.ChannelId.RELAY_2 Channel.
default void	_setSlaveCommunicationFailed(boolean value)	Internal method to set the 'nextValue' on IoShelly25.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.
default Value<Boolean>	getRelay1()	Gets the Relay Output 1.
default BooleanWriteChannel	getRelay1Channel()	Gets the Channel for IoShelly25.ChannelId.RELAY_1.
default Value<Boolean>	getRelay2()	Gets the Relay Output 2.
default BooleanWriteChannel	getRelay2Channel()	Gets the Channel for IoShelly25.ChannelId.RELAY_2.
default Value<Boolean>	getSlaveCommunicationFailed()	Gets the Slave Communication Failed State.
default StateChannel	getSlaveCommunicationFailedChannel()	Gets the Channel for IoShelly25.ChannelId.SLAVE_COMMUNICATION_FAILED.
default void	setRelay1(boolean value)	Sets the Relay Output 1.
default void	setRelay2(boolean value)	Sets the Relay Output 2.

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

digitalOutputChannels

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

handleEvent

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

getRelay1Channel

default BooleanWriteChannel getRelay1Channel()

Gets the Channel for IoShelly25.ChannelId.RELAY_1.

Returns:

the Channel

getRelay1

default Value<Boolean> getRelay1()

Gets the Relay Output 1. See IoShelly25.ChannelId.RELAY_1.

Returns:

the Channel Value

_setRelay1

default void _setRelay1(Boolean value)

Internal method to set the 'nextValue' on IoShelly25.ChannelId.RELAY_1 Channel.

Parameters:

value - the next value

setRelay1

default void setRelay1(boolean value)
                throws OpenemsError.OpenemsNamedException

Sets the Relay Output 1. See IoShelly25.ChannelId.RELAY_1.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getRelay2Channel

default BooleanWriteChannel getRelay2Channel()

Gets the Channel for IoShelly25.ChannelId.RELAY_2.

Returns:

the Channel

getRelay2

default Value<Boolean> getRelay2()

Gets the Relay Output 2. See IoShelly25.ChannelId.RELAY_2.

Returns:

the Channel Value

_setRelay2

default void _setRelay2(Boolean value)

Internal method to set the 'nextValue' on IoShelly25.ChannelId.RELAY_2 Channel.

Parameters:

value - the next value

setRelay2

default void setRelay2(boolean value)
                throws OpenemsError.OpenemsNamedException

Sets the Relay Output 2. See IoShelly25.ChannelId.RELAY_2.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getSlaveCommunicationFailedChannel

default StateChannel getSlaveCommunicationFailedChannel()

Gets the Channel for IoShelly25.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel

getSlaveCommunicationFailed

default Value<Boolean> getSlaveCommunicationFailed()

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

Returns:

the Channel Value

_setSlaveCommunicationFailed

default void _setSlaveCommunicationFailed(boolean value)

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

Parameters:

value - the next value