Package io.openems.edge.ess.offgrid.api
Interface OffGridSwitch
- All Superinterfaces:
OpenemsComponent
- All Known Subinterfaces:
IoOffGridSwitch
- All Known Implementing Classes:
DummyOffGridSwitch
,IoOffGridSwitchImpl
Represents a device that can be used to determine the grid status (On-Grid or
Off-Grid) and actively switch connection between On-Grid and Off-Grid.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
static enum
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
_setGridMode
(GridMode value) Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.GRID_MODE
Channel.default void
_setGroundingContactor
(Boolean value) Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.GROUNDING_CONTACTOR
Channel.default void
_setMainContactor
(Boolean value) Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.MAIN_CONTACTOR
Channel.default GridMode
Gets the Channel forOffGridSwitch.ChannelId.GRID_MODE
.default Optional
<OffGridSwitch.Contactor> Gets the Grounding Contactor relay state.Gets the Channel forOffGridSwitch.ChannelId.GROUNDING_CONTACTOR
.default Optional
<OffGridSwitch.Contactor> Gets the Main Contactor relay state.Gets the Channel forOffGridSwitch.ChannelId.MAIN_CONTACTOR
.void
setGroundingContactor
(OffGridSwitch.Contactor operation) Sets the Grounding-Contactor, which connects the inverter grounding in off-grid to neutral.void
setMainContactor
(OffGridSwitch.Contactor operation) Set the Main-Contactor, which connects the inverter to the public grid.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
-
getMainContactorChannel
Gets the Channel forOffGridSwitch.ChannelId.MAIN_CONTACTOR
.- Returns:
- the Channel
-
getMainContactor
Gets the Main Contactor relay state. It is Normally-Closed.OffGridSwitch.ChannelId.MAIN_CONTACTOR
.- Returns:
- the Channel
Value
-
_setMainContactor
Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.MAIN_CONTACTOR
Channel.- Parameters:
value
- the next value
-
getGroundingContactorChannel
Gets the Channel forOffGridSwitch.ChannelId.GROUNDING_CONTACTOR
.- Returns:
- the Channel
-
getGroundingContactor
Gets the Grounding Contactor relay state. It is Normally-Open.OffGridSwitch.ChannelId.GROUNDING_CONTACTOR
.- Returns:
- the Channel
Value
-
_setGroundingContactor
Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.GROUNDING_CONTACTOR
Channel.- Parameters:
value
- the next value
-
getGridModeChannel
Gets the Channel forOffGridSwitch.ChannelId.GRID_MODE
.- Returns:
- the Channel
-
getGridMode
- Returns:
- the Channel
Value
-
_setGridMode
Internal method to set the 'nextValue' onOffGridSwitch.ChannelId.GRID_MODE
Channel.- Parameters:
value
- the next value
-
setMainContactor
void setMainContactor(OffGridSwitch.Contactor operation) throws IllegalArgumentException, OpenemsError.OpenemsNamedException Set the Main-Contactor, which connects the inverter to the public grid.- OPEN: disconnect inverter from public grid
- CLOSE: connect inverter to public grid
- Parameters:
operation
-OffGridSwitch.Contactor
operation- Throws:
IllegalArgumentException
- on errorOpenemsError.OpenemsNamedException
- on error
-
setGroundingContactor
void setGroundingContactor(OffGridSwitch.Contactor operation) throws IllegalArgumentException, OpenemsError.OpenemsNamedException Sets the Grounding-Contactor, which connects the inverter grounding in off-grid to neutral.- OPEN: disconnects inverter grounding from neutral
- CLOSE: connects in inverter grounding to neutral
- Parameters:
operation
-OffGridSwitch.Contactor
operation- Throws:
IllegalArgumentException
- on errorOpenemsError.OpenemsNamedException
- on error
-