Package io.openems.edge.core.appmanager

Interface ComponentUtil

All Known Implementing Classes:

ComponentUtilImpl

public interface ComponentUtil

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ComponentUtil.PreferredRelay
static final record	ComponentUtil.RelayContactInfo
static final record	ComponentUtil.RelayInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	CORE_COMPONENT_IDS

Method Summary

Modifier and Type	Method	Description
boolean	anyComponentUses(String value, List<String> ignoreIds)	Checks if any component has the given String in its configuration.
default List<ComponentUtil.RelayInfo>	getAllRelayInfos()	Gets all RelayInfos of all DigitalOutputs.
default List<ComponentUtil.RelayInfo>	getAllRelayInfos(Predicate<DigitalOutput> componentFilter, BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter, BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)	Gets all RelayInfos of all DigitalOutputs.
default List<ComponentUtil.RelayInfo>	getAllRelayInfos(List<String> ignoreIds)	Gets all RelayInfos of all DigitalOutputs.
List<ComponentUtil.RelayInfo>	getAllRelayInfos(List<String> ignoreIds, Predicate<DigitalOutput> componentFilter, Function<DigitalOutput,String> componentAliasMapper, BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter, BiFunction<DigitalOutput,BooleanWriteChannel,String> channelAliasMapper, BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)	Gets all RelayInfos of all DigitalOutputs.
Optional<EdgeConfig.Component>	getComponent(String id, String factoryId)	Gets an Optional of an EdgeConfig.Component.
EdgeConfig.Component	getComponentByConfig(EdgeConfig.Component component)	Searches a component with the given component configuration.
<T extends OpenemsComponent> List<T>	getEnabledComponentsOfStartingId(String id)	Gets the enabled Components with the starting id.
<T extends OpenemsComponent> List<T>	getEnabledComponentsOfType(Class<T> clazz)	Gets the enabled Components of a Type.
List<NetworkInterface<?>>	getInterfaces()	Gets the interfaces of the currently active network settings.
String	getNextAvailableId(String baseName, int startingNumber, List<String> componentIds)	Gets the next available id with the baseName starting with the given startingNumber.
default String	getNextAvailableId(String baseName, List<String> componentIds)	Gets the next available id with the baseName.
String[]	getPreferredRelays(List<ComponentUtil.RelayInfo> relayInfos, int numberOfRelays, List<ComponentUtil.PreferredRelay> preferredRelays)	Gets the preferred relays.
EdgeConfig.Component	getScheduler()	Gets the scheduler Component.
List<String>	getSchedulerIds()	Gets the current id's in the scheduler.
int[]	getUsedModbusUnitIds(String modbusComponent)	Gets an array of modbus unit ids which are already used by other components.
List<String>	insertSchedulerOrder(List<String> actualOrder, List<String> insertOrder)	Inserts the insertOrder into the actual Order.
void	removeIdsInSchedulerIfExisting(User user, List<String> removedIds)	removes the given id s from the scheduler if they exist in the scheduler.
List<String>	removeIdsWhichNotExist(List<String> ids, List<EdgeConfig.Component> components)	Creates a new List with only components which exist in the current configuration or in the passed components list.
void	updateHosts(User user, List<InterfaceConfiguration> ips, List<InterfaceConfiguration> oldIps)	updates the host configuration deletes ip s that are in oldIps but not in ips and adds ip s that are in ips but not in oldIps.
void	updateInterfaces(User user, List<NetworkInterface<?>> interfaces)	updates the interfaces in the Host configuration.
void	updateScheduler(User user, List<String> schedulerExecutionOrder, List<EdgeConfig.Component> components)	updates the execution order of the scheduler only adds or changes order of the given id s.

Field Details

CORE_COMPONENT_IDS

static final List<String> CORE_COMPONENT_IDS

Method Details

getInterfaces

List<NetworkInterface<?>> getInterfaces()
                                 throws OpenemsError.OpenemsNamedException

Gets the interfaces of the currently active network settings.

Returns:

all interfaces in the host configuration

Throws:

OpenemsError.OpenemsNamedException - on error

anyComponentUses

boolean anyComponentUses(String value,
 List<String> ignoreIds)

Checks if any component has the given String in its configuration.

Parameters:

value - that no component should have

ignoreIds - the id s of components which configuration should be ignored

Returns:

true if a component has the given String in its configuration

getAllRelayInfos

default List<ComponentUtil.RelayInfo> getAllRelayInfos(List<String> ignoreIds)

Gets all RelayInfos of all DigitalOutputs.

Parameters:

ignoreIds - the Component-IDs that should be ignored to check if they use any relay

Returns:

a list of RelayInfos

getAllRelayInfos

List<ComponentUtil.RelayInfo> getAllRelayInfos(List<String> ignoreIds,
 Predicate<DigitalOutput> componentFilter,
 Function<DigitalOutput,String> componentAliasMapper,
 BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter,
 BiFunction<DigitalOutput,BooleanWriteChannel,String> channelAliasMapper,
 BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)

Gets all RelayInfos of all DigitalOutputs.

Parameters:

ignoreIds - the Component-IDs that should be ignored to check if they use any relay

componentFilter - a DigitalOutput component filter

componentAliasMapper - a DigitalOutput component alias mapper

channelFilter - a DigitalOutput channel filter

channelAliasMapper - a DigitalOutput channel alias mapper

disabledReasons - a DigitalOutput channel disabled function

Returns:

a list of RelayInfos

getAllRelayInfos

default List<ComponentUtil.RelayInfo> getAllRelayInfos()

Gets all RelayInfos of all DigitalOutputs.

Returns:

a list of RelayInfos

getAllRelayInfos

default List<ComponentUtil.RelayInfo> getAllRelayInfos(Predicate<DigitalOutput> componentFilter,
 BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter,
 BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)

Gets all RelayInfos of all DigitalOutputs.

Parameters:

componentFilter - a DigitalOutput component filter

channelFilter - a DigitalOutput channel filter

disabledReasons - additional reasons why a channel is disabled

Returns:

a list of RelayInfos

getComponentByConfig

EdgeConfig.Component getComponentByConfig(EdgeConfig.Component component)

Searches a component with the given component configuration.

Parameters:

component - with the configuration to be searched for

Returns:

the found component or null if not found

getEnabledComponentsOfStartingId

<T extends OpenemsComponent> List<T> getEnabledComponentsOfStartingId(String id)

Gets the enabled Components with the starting id.

Type Parameters:

T - the type to which the components should be assignable to

Parameters:

id - the starting id of the components

Returns:

a list of found components

getEnabledComponentsOfType

<T extends OpenemsComponent> List<T> getEnabledComponentsOfType(Class<T> clazz)

Gets the enabled Components of a Type.

the method 'this.componentManager.getEnabledComponentsOfType(clazz)' does not return the component if the given class is an interface and the component has the interface implemented

Type Parameters:

T - the type to which the components should be assignable to

Parameters:

clazz - to which the component should be assignable to

Returns:

a list of found components

getNextAvailableId

default String getNextAvailableId(String baseName,
 List<String> componentIds)

Gets the next available id with the baseName.

Parameters:

baseName - like ess, meter without a number

componentIds - the used componentIds from the other apps, because if the user updates multiple instances very quickly and components of the same type are created they are not instantly added to the componentManager

Returns:

the id

getNextAvailableId

String getNextAvailableId(String baseName,
 int startingNumber,
 List<String> componentIds)

Gets the next available id with the baseName starting with the given startingNumber.

Parameters:

baseName - like ess, meter without a number

startingNumber - the number at the end of the id to start from

componentIds - the used componentIds from the other apps, because if the user updates multiple instances very quickly and components of the same type are created they are not instantly added to the componentManager

Returns:

the id

getPreferredRelays

String[] getPreferredRelays(List<ComponentUtil.RelayInfo> relayInfos,
 int numberOfRelays,
 List<ComponentUtil.PreferredRelay> preferredRelays)

Gets the preferred relays. If the default ports are already taken the next available in a row are taken. If not enough in a row are available the first available relays of any relay are returned.

Parameters:

relayInfos - the RelayInfos to search in for the preferred relays

numberOfRelays - the number of the result number of relays

preferredRelays - the ComponentUtil.PreferredRelay options

Returns:

the first found preferred relays

updateInterfaces

void updateInterfaces(User user,
 List<NetworkInterface<?>> interfaces)
               throws OpenemsError.OpenemsNamedException

updates the interfaces in the Host configuration.

Parameters:

user - the executing user

interfaces - the new interfaces

Throws:

OpenemsError.OpenemsNamedException - on error

updateScheduler

void updateScheduler(User user,
 List<String> schedulerExecutionOrder,
 List<EdgeConfig.Component> components)
              throws OpenemsError.OpenemsNamedException

updates the execution order of the scheduler only adds or changes order of the given id s.

Parameters:

user - the executing user

schedulerExecutionOrder - the execution order

components - the components which are currently created

Throws:

OpenemsError.OpenemsNamedException - when the scheduler can not be updated

removeIdsInSchedulerIfExisting

void removeIdsInSchedulerIfExisting(User user,
 List<String> removedIds)
                             throws OpenemsError.OpenemsNamedException

removes the given id s from the scheduler if they exist in the scheduler.

Parameters:

user - the executing user

removedIds - the ip s that should be removed

Throws:

OpenemsError.OpenemsNamedException - on error

getSchedulerIds

List<String> getSchedulerIds()
                      throws OpenemsError.OpenemsNamedException

Gets the current id's in the scheduler.

Returns:

the id's

Throws:

OpenemsError.OpenemsNamedException - on error

getScheduler

EdgeConfig.Component getScheduler()
                           throws OpenemsError.OpenemsNamedException

Gets the scheduler Component.

Returns:

the scheduler component

Throws:

OpenemsError.OpenemsNamedException - if more or no scheduler is available

removeIdsWhichNotExist

List<String> removeIdsWhichNotExist(List<String> ids,
 List<EdgeConfig.Component> components)

Creates a new List with only components which exist in the current configuration or in the passed components list.

Parameters:

ids - the initial list

components - the current creating components

Returns:

a new list only with id's of components that exist

insertSchedulerOrder

List<String> insertSchedulerOrder(List<String> actualOrder,
 List<String> insertOrder)

Inserts the insertOrder into the actual Order.

Parameters:

actualOrder - the current scheduler order

insertOrder - the order which should be inserted

Returns:

the complete order

updateHosts

void updateHosts(User user,
 List<InterfaceConfiguration> ips,
 List<InterfaceConfiguration> oldIps)
          throws OpenemsError.OpenemsNamedException

updates the host configuration deletes ip s that are in oldIps but not in ips and adds ip s that are in ips but not in oldIps.

Parameters:

user - the executing user

ips - the ip s that should be in the configuration

oldIps - the old ip s that were in the old configuration

Throws:

OpenemsError.OpenemsNamedException - on error

getComponent

Optional<EdgeConfig.Component> getComponent(String id,
 String factoryId)

Gets an Optional of an EdgeConfig.Component.

Parameters:

id - the id of the component

factoryId - the factoryId of the component

Returns:

the optional component

getUsedModbusUnitIds

int[] getUsedModbusUnitIds(String modbusComponent)

Gets an array of modbus unit ids which are already used by other components. The result of this method may not contain all modbus unit ids.

Parameters:

modbusComponent - the id of the modbus component

Returns:

an array of used modbus unit ids