Package com.tccc.kos.core.service.hardware

Class HardwareService

java.lang.Object

com.tccc.kos.commons.util.ready.ReadyBean

com.tccc.kos.commons.core.service.AbstractService

com.tccc.kos.core.service.hardware.HardwareService

All Implemented Interfaces:

CtxEventListener, ContextHandleAware, HandleAware, Ready, ReadyListener

public final class HardwareService
extends AbstractService

Service that manages all external hardware.

Since:

1.0

Version:

2023-03-06

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOPIC_BOARD_LINKED
static final String	TOPIC_BOARD_UNLINKED

Method Summary

Modifier and Type	Method	Description
List<HardwareLinkResolver>	getResolvers()	Return the list of resolvers so that new resolvers can be added in the desired order.
void	register(HardwareLink link)	Register a hardware link.
void	resolveBoards()	Trigger the board resolve process.
void	unregister(HardwareLink link)	Unregister a hardware link.

Methods inherited from class com.tccc.kos.commons.core.service.AbstractService

getHandle, getHandlePrefix

Methods inherited from class com.tccc.kos.commons.util.ready.ReadyBean

getReady, onBeanReady, onDependenciesReady

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tccc.kos.commons.core.context.CtxEventListener

onCtxAutowiringCompleted, onCtxDestroyed, onCtxPhaseCompleted

Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

addHandleChild, getName, getPath

Methods inherited from interface com.tccc.kos.commons.util.ready.Ready

isReady, setReady

Methods inherited from interface com.tccc.kos.commons.util.ready.ReadyListener

onDependenciesGroupReady

Field Details

TOPIC_BOARD_LINKED

public static final String TOPIC_BOARD_LINKED

See Also:

• Constant Field Values

TOPIC_BOARD_UNLINKED

public static final String TOPIC_BOARD_UNLINKED

See Also:

• Constant Field Values

Method Details

getResolvers

public List<HardwareLinkResolver> getResolvers()

Return the list of resolvers so that new resolvers can be added in the desired order. Resolvers are used to match HardwareLink objects to Board objects. Out of the box these are matched using BoardIdentity but the list of resolvers can be modified to include alternate ways of matching boards to links.

resolveBoards

public void resolveBoards()

Trigger the board resolve process. This process is triggered internally so there is rarely a need to call this externally unless the resolvers list has been modified.

register

public void register(HardwareLink link)

Register a hardware link. The link will be matched with a board so that the board can access the hardware.

unregister

public void unregister(HardwareLink link)

Unregister a hardware link. Called when hardware disconnects so the board can be updated to indicate that it is offline.