Package io.openems.edge.app.common.props

Class RelayProps

java.lang.Object

io.openems.edge.app.common.props.RelayProps

public final class RelayProps
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RelayProps.RelayContactFilter
static final record	RelayProps.RelayContactInformation
static interface	RelayProps.RelayContactInformationProvider	Provider interface for a RelayProps.RelayContactInformation.

Method Summary

Modifier and Type	Method	Description
static RelayProps.RelayContactInformation	createPhaseInformation(ComponentUtil util, int numberOfRelays, List<RelayProps.RelayContactFilter> filter, List<ComponentUtil.PreferredRelay> preferredRelays)	Utility method to create a RelayProps.RelayContactInformation.
static RelayProps.RelayContactFilter	emptyFilter()	Creates an empty RelayProps.RelayContactFilter.
static ComponentUtil.PreferredRelay	feneconHome2030PreferredRelays(boolean isHomeInstalled, int[] preferredRelays)	Creates the ComponentUtil.PreferredRelay if a Home 20/30 relay board is installed.
static RelayProps.RelayContactFilter	feneconHomeFilter(Language l, boolean isHomeInstalled, boolean onlyHighVoltageRelays)	Creates a RelayProps.RelayContactFilter for a home.
static <APP extends OpenemsApp, PROP extends Nameable & Type<PROP, APP, P>, P extends Type.Parameter.BundleProvider> AppDef<APP,PROP,P>	phaseGroup(PROP... phaseDefs)	Creates a AppDef for a group of picking contacts from relays.
static <P extends Type.Parameter.BundleProvider & RelayProps.RelayContactInformationProvider> AppDef<OpenemsApp,Nameable,P>	relayContactDef(boolean isMulti, int contactPosition, Nameable... allContacts)	Creates a AppDef for selecting a relay contact.
static <P extends Type.Parameter.BundleProvider & RelayProps.RelayContactInformationProvider> AppDef<OpenemsApp,Nameable,P>	relayContactDef(int contactPosition, Nameable... allContacts)	Creates a AppDef for selecting a relay contact.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createPhaseInformation

public static RelayProps.RelayContactInformation createPhaseInformation(ComponentUtil util,
 int numberOfRelays,
 List<RelayProps.RelayContactFilter> filter,
 List<ComponentUtil.PreferredRelay> preferredRelays)

Utility method to create a RelayProps.RelayContactInformation.

Parameters:

util - the ComponentUtil

numberOfRelays - the number of relays

filter - the RelayProps.RelayContactFilter

preferredRelays - the PreferredRelays

Returns:

the created RelayProps.RelayContactInformation

See Also:

• RelayProps.RelayContactInformationProvider

emptyFilter

public static RelayProps.RelayContactFilter emptyFilter()

Creates an empty RelayProps.RelayContactFilter.

Returns:

the RelayProps.RelayContactFilter

feneconHomeFilter

public static RelayProps.RelayContactFilter feneconHomeFilter(Language l,
 boolean isHomeInstalled,
 boolean onlyHighVoltageRelays)

Creates a RelayProps.RelayContactFilter for a home.

Parameters:

l - the current language

isHomeInstalled - if a home is installed; can be obtained with PropsUtil.isHomeInstalled(io.openems.edge.core.appmanager.AppManagerUtil)

onlyHighVoltageRelays - determines which relay channels are disabled

Returns:

the RelayProps.RelayContactFilter

feneconHome2030PreferredRelays

public static ComponentUtil.PreferredRelay feneconHome2030PreferredRelays(boolean isHomeInstalled,
 int[] preferredRelays)

Creates the ComponentUtil.PreferredRelay if a Home 20/30 relay board is installed.

Parameters:

isHomeInstalled - if a Home is installed

preferredRelays - the relay contacts

Returns:

the ComponentUtil.PreferredRelay configuration

relayContactDef

public static <P extends Type.Parameter.BundleProvider & RelayProps.RelayContactInformationProvider>
AppDef<OpenemsApp,Nameable,P> relayContactDef(int contactPosition,
 Nameable... allContacts)

Creates a AppDef for selecting a relay contact. Sets the default value from the RelayProps.RelayContactInformation and also disables options which are already used by other components.

Type Parameters:

P - the type of the parameter

Parameters:

contactPosition - the number of the contacts to select e. g. a HeatPump app needs 2 relay contacts to be configured pass 1 for the first and 2 for the second one.

allContacts - the other names of contacts

Returns:

the AppDef

relayContactDef

public static <P extends Type.Parameter.BundleProvider & RelayProps.RelayContactInformationProvider>
AppDef<OpenemsApp,Nameable,P> relayContactDef(boolean isMulti,
 int contactPosition,
 Nameable... allContacts)

Creates a AppDef for selecting a relay contact. Sets the default value from the RelayProps.RelayContactInformation and also disables options which are already used by other components.

Type Parameters:

P - the type of the parameter

Parameters:

isMulti - if the selection is an array of channel

contactPosition - the number of the contacts to select e. g. a HeatPump app needs 2 relay contacts to be configured pass 1 for the first and 2 for the second one.

allContacts - the other names of contacts

Returns:

the AppDef

phaseGroup

@SafeVarargs
public static <APP extends OpenemsApp,
PROP extends Nameable & Type<PROP,
APP,
P>,
P extends Type.Parameter.BundleProvider>
AppDef<APP,PROP,P> phaseGroup(PROP... phaseDefs)

Creates a AppDef for a group of picking contacts from relays. Used to not pick contacts twice.

Type Parameters:

APP - the type of the app

PROP - the type of the property

P - the type of parameter

Parameters:

phaseDefs - the AppDefs of the relay contacts

Returns:

the AppDef