org.openpnp.spi

Interface Actuator

All Superinterfaces:

HeadMountable, Identifiable, Locatable, Movable, MovableMountable, Named, PropertySheetHolder, Solutions.Subject, WizardConfigurable

All Known Implementing Classes:

AbstractActuator, HttpActuator, NeoDen4FeederActuator, ReferenceActuator, ScriptActuator, ThermistorToLinearSensorActuator

public interface Actuator
extends HeadMountable, WizardConfigurable, PropertySheetHolder

Defines a simple interface to some type of device that can be actuated on the machine or on a head. This is a minimal interface and it is expected that concrete implementations may have many other capabilities exposed in their specific implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Actuator.ActuatorValueType
static interface	Actuator.InterlockMonitor The InterlockMonitor controls an actuator to perform an interlock functions in the course of machine motion.

Nested classes/interfaces inherited from interface org.openpnp.spi.Locatable

Locatable.LocationOption

Nested classes/interfaces inherited from interface org.openpnp.spi.PropertySheetHolder

PropertySheetHolder.PropertySheet

Method Summary

Modifier and Type	Method and Description
void	actuate(boolean on) Turns the Actuator on or off.
void	actuate(double value) Provides the actuator with a double value to which it can respond in an implementation dependent manner.
void	actuate(java.lang.Object value) Provides the actuator with a generic value to which it can respond in an implementation dependent manner.
void	actuate(java.lang.String value) Provides the actuator with a String value to which it can respond in an implementation dependent manner.
void	actuateProfile(boolean on) Actuate the default ON/OFF profile.
void	actuateProfile(java.lang.String name) Actuate the profile identified by the given name.
java.lang.Object	getDefaultOffValue()
java.lang.Object	getDefaultOnValue()
Driver	getDriver()
Actuator.InterlockMonitor	getInterlockMonitor()
java.lang.Object	getLastActuationValue()
java.lang.String[]	getProfileValues() In case the Actuator has the Profile value type, this will return the available choice of values.
Actuator.ActuatorValueType	getValueType() Declares the primary value type of the Actuator.
java.lang.Boolean	isActuated() Returns the Boolean state of the actuator i.e.
boolean	isCoordinatedAfterActuate()
boolean	isCoordinatedBeforeActuate()
boolean	isCoordinatedBeforeRead()
default boolean	isDriverless()
java.lang.String	read() Read a value from the actuator.
java.lang.String	read(java.lang.Object value)
void	setDriver(Driver driver)

Methods inherited from interface org.openpnp.spi.HeadMountable

getCameraToolCalibratedOffset, getHead, setHead, toHeadLocation, toHeadMountableLocation, waitForCompletion

Methods inherited from interface org.openpnp.spi.MovableMountable

getAxis, getAxisRotation, getAxisX, getAxisY, getAxisZ, getMappedAxes, toRaw, toTransformed

Methods inherited from interface org.openpnp.spi.Movable

getEffectiveSafeZ, getSafeZ, getSafeZZone, home, isInSafeZZone, isReachable, moveTo, moveTo, moveToSafeZ, moveToSafeZ

Methods inherited from interface org.openpnp.spi.Locatable

getApproximativeLocation, getLocation

Methods inherited from interface org.openpnp.model.Identifiable

getId

Methods inherited from interface org.openpnp.model.Named

getName, setName

Methods inherited from interface org.openpnp.model.Solutions.Subject

findIssues, getSubjectIcon, getSubjectText

Methods inherited from interface org.openpnp.spi.WizardConfigurable

getConfigurationWizard

Methods inherited from interface org.openpnp.spi.PropertySheetHolder

getChildPropertySheetHolders, getPropertySheetHolderActions, getPropertySheetHolderIcon, getPropertySheetHolderTitle, getPropertySheets

Method Detail

getDriver

Driver getDriver()

Returns:

the driver through which this Actuator is controlled.

setDriver

void setDriver(Driver driver)

isDriverless

default boolean isDriverless()

Returns:

true if a Driver is not required. Some actuator sub-classes use alternative means for actuation (http, scripting, etc).

getValueType

Actuator.ActuatorValueType getValueType()

Declares the primary value type of the Actuator. This will allow the GUI to present the proper control for value editing.

Returns:

getProfileValues

java.lang.String[] getProfileValues()

In case the Actuator has the Profile value type, this will return the available choice of values.

Returns:

getDefaultOnValue

java.lang.Object getDefaultOnValue()

getDefaultOffValue

java.lang.Object getDefaultOffValue()

actuate

void actuate(boolean on)
      throws java.lang.Exception

Turns the Actuator on or off.

Parameters:

on -

Throws:

java.lang.Exception

actuate

void actuate(double value)
      throws java.lang.Exception

Provides the actuator with a double value to which it can respond in an implementation dependent manner.

Parameters:

value -

Throws:

java.lang.Exception

actuate

void actuate(java.lang.String value)
      throws java.lang.Exception

Provides the actuator with a String value to which it can respond in an implementation dependent manner.

Parameters:

value -

Throws:

java.lang.Exception

actuate

void actuate(java.lang.Object value)
      throws java.lang.Exception

Provides the actuator with a generic value to which it can respond in an implementation dependent manner. This will ultimately call typed actuate() methods according to getValueType().

Parameters:

value -

Throws:

java.lang.Exception

actuateProfile

void actuateProfile(java.lang.String name)
             throws java.lang.Exception

Actuate the profile identified by the given name.

Parameters:

name -

Throws:

java.lang.Exception

actuateProfile

void actuateProfile(boolean on)
             throws java.lang.Exception

Actuate the default ON/OFF profile.

Parameters:

name -

Throws:

java.lang.Exception

getLastActuationValue

java.lang.Object getLastActuationValue()

Returns:

the last actuation value or null if no actuation has happened since the last homing.

isActuated

java.lang.Boolean isActuated()

Returns the Boolean state of the actuator i.e. whether the last actuation was not equal to the default off value. Returns null when the actuator state is unknown, i.e. when it was never actuated.

Returns:

read

java.lang.String read()
               throws java.lang.Exception

Read a value from the actuator. The value will be returned exactly as provided by the Actuator and can be interpreted as needed by the caller.

Returns:

The value read.

Throws:

java.lang.Exception - if there was an error reading the actuator.

read

java.lang.String read(java.lang.Object value)
               throws java.lang.Exception

Throws:

java.lang.Exception

isCoordinatedBeforeActuate

boolean isCoordinatedBeforeActuate()

isCoordinatedAfterActuate

boolean isCoordinatedAfterActuate()

isCoordinatedBeforeRead

boolean isCoordinatedBeforeRead()

getInterlockMonitor

Actuator.InterlockMonitor getInterlockMonitor()