Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions sentio_prober_control/Sentio/CommandGroups/ProbeCommandGroup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from typing import Tuple

from sentio_prober_control.Sentio.Enumerations import ProbeSentio, XyReference, ZReference, ChuckSite
from sentio_prober_control.Sentio.Enumerations import ProbePosition, XyReference, ZReference, ChuckSite
from sentio_prober_control.Sentio.Response import Response
from sentio_prober_control.Sentio.CommandGroups.CommandGroupBase import CommandGroupBase

Expand All @@ -16,15 +16,15 @@ class ProbeCommandGroup(CommandGroupBase):
from sentio_prober_control.Sentio.ProberSentio import SentioProber

prober = SentioProber.create_prober("tcpip", "127.0.0.1:35555")
prober.probe.move_probe_xy(ProbeSentio.East, XyReference.Current, 1000, 2000)
prober.probe.move_probe_xy(ProbePosition.East, XyReference.Current, 1000, 2000)
```
"""

def __init__(self, prober: 'SentioProber') -> None:
super().__init__(prober)


def async_step_probe_site(self, probe: ProbeSentio, idx: int) -> int:
def async_step_probe_site(self, probe: ProbePosition, idx: int) -> int:
"""Start the process of stepping to a positioner site.

Each positioner can define n a number of predefined positions called "sites". This command
Expand All @@ -44,7 +44,7 @@ def async_step_probe_site(self, probe: ProbeSentio, idx: int) -> int:
return resp.cmd_id()


def async_step_probe_site_next(self, probe: ProbeSentio) -> int:
def async_step_probe_site_next(self, probe: ProbePosition) -> int:
"""Step to next probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -63,7 +63,7 @@ def async_step_probe_site_next(self, probe: ProbeSentio) -> int:
return resp.cmd_id()


def async_step_probe_site_first(self, probe: ProbeSentio) -> int:
def async_step_probe_site_first(self, probe: ProbePosition) -> int:
"""Step to first probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -82,7 +82,7 @@ def async_step_probe_site_first(self, probe: ProbeSentio) -> int:
return resp.cmd_id()


def get_probe_site(self, probe: ProbeSentio, idx: int) -> Tuple[str, float, float, str]:
def get_probe_site(self, probe: ProbePosition, idx: int) -> Tuple[str, float, float, str]:
"""Get information for a probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -101,7 +101,7 @@ def get_probe_site(self, probe: ProbeSentio, idx: int) -> Tuple[str, float, floa
return str(tok[0]), float(tok[1]), float(tok[2]), str(tok[3])


def get_probe_site_number(self, probe: ProbeSentio) -> int:
def get_probe_site_number(self, probe: ProbePosition) -> int:
"""Returns the total number of probe sites set up.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -116,7 +116,7 @@ def get_probe_site_number(self, probe: ProbeSentio) -> int:
return int(resp.message())


def get_probe_xy(self, probe: ProbeSentio, ref: XyReference) -> Tuple[float, float]:
def get_probe_xy(self, probe: ProbePosition, ref: XyReference) -> Tuple[float, float]:
"""Get probe xy position in micrometer.

Args:
Expand All @@ -133,7 +133,7 @@ def get_probe_xy(self, probe: ProbeSentio, ref: XyReference) -> Tuple[float, flo
return float(tok[0]), float(tok[1])


def get_probe_z(self, probe: ProbeSentio, ref: ZReference) -> float:
def get_probe_z(self, probe: ProbePosition, ref: ZReference) -> float:
"""Get probe z position in micrometer.

Args:
Expand All @@ -148,7 +148,7 @@ def get_probe_z(self, probe: ProbeSentio, ref: ZReference) -> float:
return float(resp.message())


def move_probe_contact(self, probe: ProbeSentio) -> float:
def move_probe_contact(self, probe: ProbePosition) -> float:
"""Move a probe to its contact position.

Args:
Expand All @@ -163,7 +163,7 @@ def move_probe_contact(self, probe: ProbeSentio) -> float:
return float(resp.message())


def move_probe_separation(self, probe: ProbeSentio) -> float:
def move_probe_separation(self, probe: ProbePosition) -> float:
"""Move a probe to its separation position.

Args:
Expand All @@ -178,7 +178,7 @@ def move_probe_separation(self, probe: ProbeSentio) -> float:
return float(resp.message())


def move_probe_home(self, probe: ProbeSentio) -> Tuple[float, float]:
def move_probe_home(self, probe: ProbePosition) -> Tuple[float, float]:
"""Move probe to its home position.

Args:
Expand All @@ -194,7 +194,7 @@ def move_probe_home(self, probe: ProbeSentio) -> Tuple[float, float]:
return float(tok[0]), float(tok[1])


def move_probe_xy(self, probe: ProbeSentio, ref: XyReference, x: float, y: float) -> Tuple[float, float]:
def move_probe_xy(self, probe: ProbePosition, ref: XyReference, x: float, y: float) -> Tuple[float, float]:
"""Move probe to a given position.

Args:
Expand All @@ -213,7 +213,7 @@ def move_probe_xy(self, probe: ProbeSentio, ref: XyReference, x: float, y: float
return float(tok[0]), float(tok[1])


def move_probe_z(self, probe: ProbeSentio, ref: ZReference, z: float) -> float:
def move_probe_z(self, probe: ProbePosition, ref: ZReference, z: float) -> float:
"""Move probe to a given z position.

Args:
Expand All @@ -230,7 +230,7 @@ def move_probe_z(self, probe: ProbeSentio, ref: ZReference, z: float) -> float:
return float(resp.message())


def set_probe_contact(self, probe: ProbeSentio, z: float | None = None) -> None:
def set_probe_contact(self, probe: ProbePosition, z: float | None = None) -> None:
"""Set contact position of a positioner.

Args:
Expand All @@ -246,7 +246,7 @@ def set_probe_contact(self, probe: ProbeSentio, z: float | None = None) -> None:
Response.check_resp(self.comm.read_line())


def set_probe_home(self, probe: ProbeSentio, site: ChuckSite | None = None, x: float | None = None, y: float | None = None) -> None:
def set_probe_home(self, probe: ProbePosition, site: ChuckSite | None = None, x: float | None = None, y: float | None = None) -> None:
"""Set home position of a probe.

Args:
Expand All @@ -263,7 +263,7 @@ def set_probe_home(self, probe: ProbeSentio, site: ChuckSite | None = None, x: f
Response.check_resp(self.comm.read_line())


def step_probe_site(self, probe: ProbeSentio, idx: int) -> Tuple[str, float, float]:
def step_probe_site(self, probe: ProbePosition, idx: int) -> Tuple[str, float, float]:
"""Step to a specific probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -284,7 +284,7 @@ def step_probe_site(self, probe: ProbeSentio, idx: int) -> Tuple[str, float, flo
return tok[0], float(tok[1]), float(tok[2])


def step_probe_site_first(self, probe: ProbeSentio) -> Tuple[str, float, float]:
def step_probe_site_first(self, probe: ProbePosition) -> Tuple[str, float, float]:
"""Step to the first probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -303,7 +303,7 @@ def step_probe_site_first(self, probe: ProbeSentio) -> Tuple[str, float, float]:
return tok[0], float(tok[1]), float(tok[2])


def step_probe_site_next(self, probe: ProbeSentio) -> Tuple[str, float, float]:
def step_probe_site_next(self, probe: ProbePosition) -> Tuple[str, float, float]:
"""Step to the next probe site.

Each positioner can define n a number of predefined positions called "sites".
Expand All @@ -321,7 +321,7 @@ def step_probe_site_next(self, probe: ProbeSentio) -> Tuple[str, float, float]:
tok = resp.message().split(",")
return tok[0], float(tok[1]), float(tok[2])

def enable_probe_motor(self, probe: ProbeSentio, status: bool) -> None:
def enable_probe_motor(self, probe: ProbePosition, status: bool) -> None:
"""Enable/Disable the probe motor.

Probe with 3 motors will enable and disable by following behavior.
Expand All @@ -334,7 +334,7 @@ def enable_probe_motor(self, probe: ProbeSentio, status: bool) -> None:
self.comm.send(f"enable_positioner_motor {probe.to_string()},{status}")
Response.check_resp(self.comm.read_line())

def get_probe_status(self, probe: ProbeSentio) -> str:
def get_probe_status(self, probe: ProbePosition) -> str:
"""Obtain the status of probe.

Command will return 4 probe status
Expand All @@ -351,7 +351,7 @@ def get_probe_status(self, probe: ProbeSentio) -> str:
resp = Response.check_resp(self.comm.read_line())
return resp.message()

def set_probe_status(self, probe: ProbeSentio, status: bool) -> None:
def set_probe_status(self, probe: ProbePosition, status: bool) -> None:
"""Enable/Disable the probe stage in the SENTIO.

Enable/Disable the Probes in the SENTIO.
Expand Down
Loading