ProbeCommandGroup
Bases: CommandGroupBase
This command group contains functions for working with motorized prober. You are not meant to instantiate this class directly. Access it via the probe attribute of the SentioProber class.
Example:
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, ProbeXYReference.Current, 1000, 2000)
async_step_probe_site(probe, idx)
Start the process of stepping to a positioner site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to such a site. This is an asynchronous command use in conjunction with ProberSentio.wait_complete() or ProberSentio.query_command_status().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
idx |
int
|
The index of the site to step to. |
required |
Returns:
| Type | Description |
|---|---|
int
|
The async command id of the command. |
async_step_probe_site_first(probe)
Step to first probe site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to the first site. This is an asynchronous command use in conjunction with ProberSentio.wait_complete() or ProberSentio.query_command_status().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
Returns:
| Type | Description |
|---|---|
int
|
The async command id of the command. |
async_step_probe_site_next(probe)
Step to next probe site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to the next site. This is an asynchronous command use in conjunction with ProberSentio.wait_complete() or ProberSentio.query_command_status().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
Returns:
| Type | Description |
|---|---|
int
|
The async command id of the command. |
get_probe_site(probe, idx)
Get information for a probe site.
Each positioner can define n a number of predefined positions called "sites". This command returns the data associated with a site.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to get the site for. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[int, str, float, float]
|
A tuple containing the site index, the site name, the x position in micrometer and the y position in micrometer. |
get_probe_site_number(probe)
Returns the total number of probe sites set up.
Each positioner can define n a number of predefined positions called "sites". This command returns the total number of sites.
Returns:
| Type | Description |
|---|---|
int
|
The total number of sites. |
get_probe_xy(probe, ref)
Get probe xy position in micrometer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to get the position for. |
required |
ref |
ProbeXYReference
|
The position reference for the returned values. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[float, float]
|
A tuple containing the x and y position in micrometer. |
get_probe_z(probe, ref)
Get probe z position in micrometer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to get the position for. |
required |
ref |
ProbeZReference
|
The position reference for the returned values. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The z position in micrometer. |
move_probe_contact(probe)
Move a probe to its contact position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to move. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The z position after the move in micrometer (from zero). |
move_probe_home(probe)
Move probe to its home position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to move. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[float, float]
|
A tuple containing the x and y position after the move. |
move_probe_separation(probe)
Move a probe to its separation position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to move. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The z position after the move in micrometer (from zero). |
move_probe_xy(probe, ref, x, y)
Move probe to a given position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to move. |
required |
ref |
ProbeXYReference
|
The position reference for the submitted values. |
required |
x |
float
|
The x position in micrometer. |
required |
y |
float
|
The y position in micrometer. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[float, float]
|
A tuple containing the x and y position after the move. |
move_probe_z(probe, ref, z)
Move probe to a given z position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to move. |
required |
ref |
ProbeZReference
|
The position reference for the submitted values. |
required |
z |
float
|
The target z position in micrometer. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The z position after the move in micrometer (from zero). |
set_probe_contact(probe, z=None)
Set contact position of a positioner.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to set contact height. |
required |
z |
float | None
|
The contact height in micrometer. If not specified, the current z position is used. |
None
|
set_probe_home(probe, site=None, x=None, y=None)
Set home position of a probe.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to set home position. |
required |
site |
ChuckSite | None
|
The chuck site to set the home position for. If None is specified the current site is used. |
None
|
x |
float | None
|
The x position in micrometer. If not specified, the current x position is used. |
None
|
y |
float | None
|
The y position in micrometer. If not specified, the current y position is used. |
None
|
step_probe_site(probe, idx)
Step to a specific probe site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to such a site.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
idx |
int
|
The index of the site to step to. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[str, float, float]
|
A tuple containing the site id, the x position in micrometer and the y position in micrometer. |
step_probe_site_first(probe)
Step to the first probe site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to the first site.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[str, float, float]
|
A tuple containing the site id, the x position in micrometer and the y position in micrometer. |
step_probe_site_next(probe)
Step to the next probe site.
Each positioner can define n a number of predefined positions called "sites". This command initiates a step to the next site.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
probe |
ProbeSentio
|
The probe to step. |
required |
Returns:
| Type | Description |
|---|---|
Tuple[str, float, float]
|
A tuple containing the site id, the x position in micrometer and the y position in micrometer. |
handler: python options: members: ProbeCommandGroup