Package io.openems.edge.io.shelly.shellyplug

Interface IoShellyPlug

All Superinterfaces:

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

All Known Implementing Classes:

IoShellyPlugImpl

public interface IoShellyPlug
extends DigitalOutput, SinglePhaseMeter, ElectricityMeter, OpenemsComponent, org.osgi.service.event.EventHandler

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IoShellyPlug.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setRelay(Boolean value)	Internal method to set the 'nextValue' on IoShellyPlug.ChannelId.RELAY Channel.
default void	_setSlaveCommunicationFailed(boolean value)	Internal method to set the 'nextValue' on IoShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.
default Value<Boolean>	getRelay()	Gets the Relay Output 1.
default BooleanWriteChannel	getRelayChannel()	Gets the Channel for IoShellyPlug.ChannelId.RELAY.
default Value<Boolean>	getSlaveCommunicationFailed()	Gets the Slave Communication Failed State.
default StateChannel	getSlaveCommunicationFailedChannel()	Gets the Channel for IoShellyPlug.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.meter.api.ElectricityMeter

_setActiveConsumptionEnergy, _setActiveConsumptionEnergy, _setActiveConsumptionEnergyL1, _setActiveConsumptionEnergyL1, _setActiveConsumptionEnergyL2, _setActiveConsumptionEnergyL2, _setActiveConsumptionEnergyL3, _setActiveConsumptionEnergyL3, _setActivePower, _setActivePower, _setActivePowerL1, _setActivePowerL1, _setActivePowerL2, _setActivePowerL2, _setActivePowerL3, _setActivePowerL3, _setActiveProductionEnergy, _setActiveProductionEnergy, _setActiveProductionEnergyL1, _setActiveProductionEnergyL1, _setActiveProductionEnergyL2, _setActiveProductionEnergyL2, _setActiveProductionEnergyL3, _setActiveProductionEnergyL3, _setCurrent, _setCurrent, _setCurrentL1, _setCurrentL1, _setCurrentL2, _setCurrentL2, _setCurrentL3, _setCurrentL3, _setFrequency, _setFrequency, _setReactivePower, _setReactivePower, _setReactivePowerL1, _setReactivePowerL1, _setReactivePowerL2, _setReactivePowerL2, _setReactivePowerL3, _setReactivePowerL3, _setVoltage, _setVoltage, _setVoltageL1, _setVoltageL1, _setVoltageL2, _setVoltageL2, _setVoltageL3, _setVoltageL3, getActiveConsumptionEnergy, getActiveConsumptionEnergyChannel, getActiveConsumptionEnergyL1, getActiveConsumptionEnergyL1Channel, getActiveConsumptionEnergyL2, getActiveConsumptionEnergyL2Channel, getActiveConsumptionEnergyL3, getActiveConsumptionEnergyL3Channel, getActivePower, getActivePowerChannel, getActivePowerL1, getActivePowerL1Channel, getActivePowerL2, getActivePowerL2Channel, getActivePowerL3, getActivePowerL3Channel, getActiveProductionEnergy, getActiveProductionEnergyChannel, getActiveProductionEnergyL1, getActiveProductionEnergyL1Channel, getActiveProductionEnergyL2, getActiveProductionEnergyL2Channel, getActiveProductionEnergyL3, getActiveProductionEnergyL3Channel, getCurrent, getCurrentChannel, getCurrentL1, getCurrentL1Channel, getCurrentL2, getCurrentL2Channel, getCurrentL3, getCurrentL3Channel, getFrequency, getFrequencyChannel, getMeterType, getReactivePower, getReactivePowerChannel, getReactivePowerL1, getReactivePowerL1Channel, getReactivePowerL2, getReactivePowerL2Channel, getReactivePowerL3, getReactivePowerL3Channel, getVoltage, getVoltageChannel, getVoltageL1, getVoltageL1Channel, getVoltageL2, getVoltageL2Channel, getVoltageL3, getVoltageL3Channel, isManaged

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

Methods inherited from interface io.openems.edge.meter.api.SinglePhaseMeter

getPhase

Method Details

getRelayChannel

default BooleanWriteChannel getRelayChannel()

Gets the Channel for IoShellyPlug.ChannelId.RELAY.

Returns:

the Channel

getRelay

default Value<Boolean> getRelay()

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

Returns:

the Channel Value

_setRelay

default void _setRelay(Boolean value)

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

Parameters:

value - the next value

setRelay

default void setRelay(boolean value)
               throws OpenemsError.OpenemsNamedException

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

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getSlaveCommunicationFailedChannel

default StateChannel getSlaveCommunicationFailedChannel()

Gets the Channel for IoShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel

getSlaveCommunicationFailed

default Value<Boolean> getSlaveCommunicationFailed()

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

Returns:

the Channel Value

_setSlaveCommunicationFailed

default void _setSlaveCommunicationFailed(boolean value)

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

Parameters:

value - the next value