public interface OnixAddon extends ServerAddon
Modifier and Type | Method and Description |
---|---|
void |
addMessageListener(MessageListener listener)
Adds a listener which gets informed about the actions the Onix device does.
|
float |
getXPressure()
Returns the x-pressure.
|
float |
getXPressureSetpoint()
Returns the x-pressure setpoint.
|
float |
getYPressure()
Returns the y-pressure.
|
float |
getYPressureSetpoint()
Returns the y-pressure setpoint.
|
void |
initialize()
Initialize the onix device.
|
boolean |
isConnected()
Returns true if the connection to the onix device is established.
|
boolean |
isOn()
Have no idea yet what this device function is doing...
|
boolean |
isPlateSealed()
Returns true if the plate is sealed.
|
boolean |
isProtocolRunning()
Returns true if currently a protocol is running (which blocks the device), and false otherwise.
|
boolean |
isPWMX()
Returns true if currently a pulse-width modulation between well 1 and 2 is running.
|
boolean |
isPWMY()
Returns true if currently a pulse-width modulation in Y is running.
|
boolean |
isUnknown1Alright()
Yet, I don't know what this is returning.
|
boolean |
isUnknown2Alright()
Yet, I don't know what this is returning.
|
boolean |
isVacuumReady()
Returns true if vacuum is ready.
|
boolean |
isValve(int valve)
Returns if given valve is active.
|
boolean |
reconnect()
Reconnects to the device.
|
void |
removeMessageListener(MessageListener listener)
Removes a previously added listener.
|
void |
runProtocol(RMIReader protocolReader)
Runs a standard CellAsic Onix protocol, utilizing the given reader (e.g.
|
void |
runProtocolAndWait(RMIReader protocolReader)
Runs a standard CellAsic Onix protocol, utilizing the given reader (e.g.
|
void |
setSwitch()
No idea about the functionality behind this function.
|
void |
setValve(int valve,
boolean active)
Sets if a given valve is active
|
void |
setXPressureSetpoint(float pressure)
Sets the pressure setpoint in x.
|
void |
setYPressureSetpoint(float pressure)
Sets the pressure setpoint in y.
|
void |
showNativeUI()
Displays the native Onix UI from CellAsic.
|
void |
startPWMX(long periodMS,
double fraction1)
Starts a pulse-width modulation between the two wells 1 and 2 with the X pressure.
|
void |
startPWMY(long periodMS,
double fraction3,
double fraction4,
double fraction5,
double fraction6)
Starts a pulse-width modulation between valves 3 to valve 6 with the Y pressure.
|
void |
stopProtocol()
Stops a currently executed protocol at the next possible step.
|
void |
stopPWMX()
Stops a pulse-width modulation which was previously started.
|
void |
stopPWMY()
Stops a pulse-width modulation which was previously started.
|
void |
uninitialize()
Uninitialize the onix device.
|
getAddonDescription, getAddonID, getAddonName, getAddonVersion
void initialize() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
void uninitialize() throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void addMessageListener(MessageListener listener) throws java.rmi.RemoteException
listener
- Listener to be added.java.rmi.RemoteException
void removeMessageListener(MessageListener listener) throws java.rmi.RemoteException
listener
- Listener to be removed.java.rmi.RemoteException
float getXPressure() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
float getYPressure() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isConnected() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isOn() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isValve(int valve) throws java.rmi.RemoteException, OnixException
valve
- Number of the valve (0<=valve<=7)java.rmi.RemoteException
OnixException
boolean reconnect() throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void setSwitch() throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void setValve(int valve, boolean active) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
valve
- the number of the valve.active
- true if activejava.rmi.RemoteException
OnixException
OnixProtocolRunningException
void showNativeUI() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
float getXPressureSetpoint() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
float getYPressureSetpoint() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isPlateSealed() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isVacuumReady() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isUnknown1Alright() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isUnknown2Alright() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
void setXPressureSetpoint(float pressure) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
pressure
- Pressure setpoint.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void setYPressureSetpoint(float pressure) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
pressure
- Pressure setpoint.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void runProtocol(RMIReader protocolReader) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
protocolReader
- Reader which supplies the protocol.configurationReader
- A reader to read in the configuration, e.g. a file reader.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void runProtocolAndWait(RMIReader protocolReader) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
protocolReader
- Reader which supplies the protocol.configurationReader
- A reader to read in the configuration, e.g. a file reader.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void stopProtocol() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
boolean isProtocolRunning() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
void startPWMX(long periodMS, double fraction1) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
periodMS
- The period in milliseconds. Must be positive.fraction1
- The fraction of time (0<=fraction1<=1) well 1 is active during the period.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void stopPWMX() throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
java.rmi.RemoteException
OnixException
OnixProtocolRunningException
boolean isPWMX() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException
void startPWMY(long periodMS, double fraction3, double fraction4, double fraction5, double fraction6) throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
periodMS
- The period in milliseconds. Must be positive.fraction3
- The fraction of time (0<=fraction3<=1) valve 3 is open during the period.fraction4
- The fraction of time (0<=fraction4<=1) valve 4 is open during the period.fraction5
- The fraction of time (0<=fraction5<=1) valve 5 is open during the period.fraction6
- The fraction of time (0<=fraction6<=1) valve 6 is open during the period.java.rmi.RemoteException
OnixException
OnixProtocolRunningException
void stopPWMY() throws java.rmi.RemoteException, OnixException, OnixProtocolRunningException
java.rmi.RemoteException
OnixException
OnixProtocolRunningException
boolean isPWMY() throws java.rmi.RemoteException, OnixException
java.rmi.RemoteException
OnixException