Interface ShellyPlug
-
- All Superinterfaces:
DigitalOutput
,org.osgi.service.event.EventHandler
,OpenemsComponent
,SymmetricMeter
- All Known Implementing Classes:
ShellyPlugImpl
public interface ShellyPlug extends DigitalOutput, SymmetricMeter, OpenemsComponent, org.osgi.service.event.EventHandler
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ShellyPlug.ChannelId
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default void
_setRelay(java.lang.Boolean value)
Internal method to set the 'nextValue' onShellyPlug.ChannelId.RELAY
Channel.default void
_setSlaveCommunicationFailed(boolean value)
Internal method to set the 'nextValue' onShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED
Channel.default Value<java.lang.Boolean>
getRelay()
Gets the Relay Output 1.default BooleanWriteChannel
getRelayChannel()
Gets the Channel forShellyPlug.ChannelId.RELAY
.default Value<java.lang.Boolean>
getSlaveCommunicationFailed()
Gets the Slave Communication Failed State.default StateChannel
getSlaveCommunicationFailedChannel()
Gets the Channel forShellyPlug.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, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid
-
Methods inherited from interface io.openems.edge.meter.api.SymmetricMeter
_setActiveConsumptionEnergy, _setActiveConsumptionEnergy, _setActivePower, _setActivePower, _setActiveProductionEnergy, _setActiveProductionEnergy, _setCurrent, _setCurrent, _setFrequency, _setFrequency, _setMaxActivePower, _setMaxActivePower, _setMinActivePower, _setMinActivePower, _setReactivePower, _setReactivePower, _setVoltage, _setVoltage, getActiveConsumptionEnergy, getActiveConsumptionEnergyChannel, getActivePower, getActivePowerChannel, getActiveProductionEnergy, getActiveProductionEnergyChannel, getCurrent, getCurrentChannel, getFrequency, getFrequencyChannel, getMaxActivePower, getMaxActivePowerChannel, getMeterType, getMinActivePower, getMinActivePowerChannel, getReactivePower, getReactivePowerChannel, getVoltage, getVoltageChannel
-
-
-
-
Method Detail
-
getRelayChannel
default BooleanWriteChannel getRelayChannel()
Gets the Channel forShellyPlug.ChannelId.RELAY
.- Returns:
- the Channel
-
getRelay
default Value<java.lang.Boolean> getRelay()
Gets the Relay Output 1. SeeShellyPlug.ChannelId.RELAY
.- Returns:
- the Channel
Value
-
_setRelay
default void _setRelay(java.lang.Boolean value)
Internal method to set the 'nextValue' onShellyPlug.ChannelId.RELAY
Channel.- Parameters:
value
- the next value
-
setRelay
default void setRelay(boolean value) throws OpenemsError.OpenemsNamedException
Sets the Relay Output. SeeShellyPlug.ChannelId.RELAY
.- Parameters:
value
- the next write value- Throws:
OpenemsError.OpenemsNamedException
- on error
-
getSlaveCommunicationFailedChannel
default StateChannel getSlaveCommunicationFailedChannel()
Gets the Channel forShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED
.- Returns:
- the Channel
-
getSlaveCommunicationFailed
default Value<java.lang.Boolean> getSlaveCommunicationFailed()
Gets the Slave Communication Failed State. SeeShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED
.- Returns:
- the Channel
Value
-
_setSlaveCommunicationFailed
default void _setSlaveCommunicationFailed(boolean value)
Internal method to set the 'nextValue' onShellyPlug.ChannelId.SLAVE_COMMUNICATION_FAILED
Channel.- Parameters:
value
- the next value
-
-