Package com.tccc.kos.ext.freestyle.service.cartridgeagitation

Class CartridgeAgitator

java.lang.Object

com.tccc.kos.ext.freestyle.service.cartridgeagitation.CartridgeAgitator

All Implemented Interfaces:

ConfigAware<CartridgeAgitatorConfig>, HandleAware, StateAware<CartridgeAgitatorSubNode.CartridgeAgitatorState>, InsertionHolderListener, InsertionListener, PumpListener, PumpLockListener

@ApiController(base="@path",
               title="Cartridge agitator",
               desc="Services for a particular cartridge agitator.")
public class CartridgeAgitator
extends Object
implements ConfigAware<CartridgeAgitatorConfig>, StateAware<CartridgeAgitatorSubNode.CartridgeAgitatorState>, PumpLockListener, InsertionHolderListener

Agitator for a cartridge shelf or tower.

Version:

2024-09-30

Constructor Summary

Constructors

Constructor	Description
CartridgeAgitator(String name, CartridgeAgitatorSubNode subNode, boolean homeSensor)

Method Summary

Modifier and Type	Method	Description
CartridgeAgitatorConfig	getConfig()
Handle	getHandle()
ListenerList<CartridgeAgitatorListener>	getListeners()
CartridgeAgitatorSubNode.CartridgeAgitatorState	getState()
boolean	isHomed()	Return true if the agitator is properly homed.
boolean	isHomeSensor()
FutureWork	manualStartPendingAgitation()	Perform any pending agitation immediately, ignoring door state or block state.
void	onConfigChanged(BeanChanges changes)
void	onContainerInsertStart(Container container, Holder[] holders)
void	onContainerRemove(Container container, Holder[] holders)
void	onPumpLock(NozzlePipeline pipeline, Pump<?> pump)
void	onPumpUnlock(NozzlePipeline pipeline, Pump<?> pump)
void	pause(Object reason, boolean home)	Pause the agitator for the specified reason.
void	resume(Object reason)	Resume the agitator by removing the pause reason.
void	setConfig(CartridgeAgitatorConfig config)
FutureWork	startAgitation(int rpm, int duration)	Run agitation for the specified for the specified duration.
void	stopAgitation(boolean home)	Stop any running agitation without waiting for it to stop.
void	stopAgitation(boolean home, boolean wait)	Stop any running agitation.
FutureWork	testAgitation()	Perform a test agitation.
void	waitForStop()	Wait until the agitator is stopped using internal timeout to make sure this doesn't block indefinitely.

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.service.config.ConfigAware

onConfigSet

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

addHandleChild, getName, getPath

Constructor Details

CartridgeAgitator

public CartridgeAgitator(String name,
 CartridgeAgitatorSubNode subNode,
 boolean homeSensor)

Method Details

pause

public void pause(Object reason,
 boolean home)

Pause the agitator for the specified reason.

Parameters:

reason - the pause reason

home - if true, home when pausing

resume

public void resume(Object reason)

Resume the agitator by removing the pause reason. The callback will be used to actually trigger the start.

manualStartPendingAgitation

public FutureWork manualStartPendingAgitation()

Perform any pending agitation immediately, ignoring door state or block state.

startAgitation

public FutureWork startAgitation(int rpm,
 int duration)

Run agitation for the specified for the specified duration.

Parameters:

rpm - the rpm setting

duration - the duration in seconds

stopAgitation

public void stopAgitation(boolean home)

Stop any running agitation without waiting for it to stop.

Parameters:

home - if true, home the agitator

stopAgitation

public void stopAgitation(boolean home,
 boolean wait)

Stop any running agitation.

Parameters:

home - if true, home the agitator

wait - if true, wait for agitation to actually stop

isHomed

public boolean isHomed()

Return true if the agitator is properly homed.

Returns:

true if properly homed

waitForStop

public void waitForStop()

Wait until the agitator is stopped using internal timeout to make sure this doesn't block indefinitely.

testAgitation

@ApiEndpoint(POST="/test",
             desc="Run an agitation test.")
public FutureWork testAgitation()

Perform a test agitation.

onConfigChanged

public void onConfigChanged(BeanChanges changes)

Specified by:

onConfigChanged in interface ConfigAware<CartridgeAgitatorConfig>

getState

public CartridgeAgitatorSubNode.CartridgeAgitatorState getState()

Specified by:

getState in interface StateAware<CartridgeAgitatorSubNode.CartridgeAgitatorState>

onPumpLock

public void onPumpLock(NozzlePipeline pipeline,
 Pump<?> pump)

Specified by:

onPumpLock in interface PumpLockListener

onPumpUnlock

public void onPumpUnlock(NozzlePipeline pipeline,
 Pump<?> pump)

Specified by:

onPumpUnlock in interface PumpLockListener

onContainerInsertStart

public void onContainerInsertStart(Container container,
 Holder[] holders)

Specified by:

onContainerInsertStart in interface InsertionHolderListener

onContainerRemove

public void onContainerRemove(Container container,
 Holder[] holders)

Specified by:

onContainerRemove in interface InsertionHolderListener

getConfig

public CartridgeAgitatorConfig getConfig()

Specified by:

getConfig in interface ConfigAware<CartridgeAgitatorConfig>

setConfig

public void setConfig(CartridgeAgitatorConfig config)

Specified by:

setConfig in interface ConfigAware<CartridgeAgitatorConfig>

getHandle

public Handle getHandle()

Specified by:

getHandle in interface HandleAware

getListeners

public ListenerList<CartridgeAgitatorListener> getListeners()

isHomeSensor

public boolean isHomeSensor()