Scope Commands

get_scope_home

Sentio Version: 3.0.2

Description: Gets home position information for the scope stage.

Parameters: None

Response:

Field	Type
X [µm]	Float
Y [µm]	Float

Example:

Command:   get_scope_home
Response:  0,0,250,250

Remarks: If no index/name is submitted, information for the current scope site is used; if no parameter is submitted, the current chuck position is used.

get_scope_xy

Sentio Version: 2.8.1

Description: Reads the current XY position of a scope site.

Parameters: None

Response:

Field	Type
X [µm]	Float
Y [µm]	Float

Example:

Command:   get_scope_xy
Response:  0,0,250,350     (scope is at XY 250 µm, 350 µm)

Remarks: Requires motorized scope XY hardware.

get_scope_z

Sentio Version: 2.8.1

Description: Reads the scope height.

Parameters: None

Response:

Field	Type
Z [µm]	Float

Example:

Command:   get_scope_z
Response:  0,0,-130000.0     (scope is at Z -130000.0 µm)

Remarks: Requires motorized scope Z hardware.

has_scope_xyz

Sentio Version: 2.8.1

Description: Checks whether the system has a motorized scope XYZ.

Parameters: None

Response:

Field	Type	Values
Has Scope XYZ	String	Yes, No

Example:

Command:   has_scope_xy
Response:  0,0,Yes

has_scope_z

Sentio Version: 2.8.1

Description: Checks whether the system has a motorized scope Z.

Parameters: None

Response:

Field	Type	Values
Has Scope Z	String	Yes, No

Example:

Command:   has_scope_z
Response:  0,0,Yes

Remarks: A scope stage with motorized XYZ or motorized Z alone both return Yes.

move_scope_xy

Sentio Version: 2.8.1

Description: Moves scope XY relative to a reference point.

Parameters:

Parameter	Type	Values
Reference Point	String	Zero, Center, Home, Relative
X Offset [µm]	Float	—
Y Offset [µm]	Float	—

Response:

Field	Type	Notes
New X [µm]	Float	With respect to zero
New Y [µm]	Float	With respect to zero

Examples:

Command:   move_scope_xy zero,250,350
Response:  0,0,250,350       (move to absolute position XY 250,350 µm)

Command:   move_scope_xy center,200,300
Response:  0,0,1200,1300     (move XY 200 by 300 µm relative to scope center)

Remarks: Reference point not case sensitive; first character sufficient. Relative refers to current position. X/Y offsets optional. Requires motorized scope XY hardware.

move_scope_z

Sentio Version: 2.8.1

Description: Moves scope Z relative to a reference point.

Parameters:

Parameter	Type	Values
Reference Point	String	Zero, Relative
Z Offset [µm]	Float	—

Response:

Field	Type	Notes
New Z [µm]	Float	With respect to zero

Example:

Command:   move_scope_z relative,100
Response:  0,0,-135100     (moves scope to relative position Z +100 µm)

Remarks: Requires motorized scope Z hardware.

move_scope_lift

Sentio Version: 3.7.1

Description: Moves scope Z to lift/unlift position.

Parameters:

Parameter	Type	Values
Reference Point	Boolean	True=move to lift position, False=move to unlift position
Z Offset [µm]	Float	—

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   move_scope_lift True
Response:  0,0,OK     (moves scope to lift position)

Remarks: Requires motorized scope Z hardware.

set_scope_home

Sentio Version: 3.0.2

Description: Sets home position information for the scope stage.

Parameters:

Parameter	Type
Home X [µm] (opt.)	Float
Home Y [µm] (opt.)	Float

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   set_scope_home
Response:  0,0,OK     (sets the current scope position as scope home)

Remarks: If no index/name is submitted, information for the current scope site is set; if no parameter is submitted, the current chuck position is used.

step_scope_site

Sentio Version: 3.4.0

Description: Steps the scope to the indicated site and sets it as the current site.

Parameters:

Parameter	Type	Notes
Site Index / ID	Integer / String	Zero-based index

Response:

Field	Type	Notes
Site	String	ID of the current scope site
Offset X	Float	—
Offset Y	Float	—

Example:

Command:   step_scope_site 2
Response:  0,0,Pos1,1000,2000     (steps scope to the 3rd site; indices are zero based)

Remarks: Scope site positions are always relative to the scope home position.

step_scope_site_first

Sentio Version: 3.4.0

Description: Steps the scope to the first site of the scope site list.

Parameters: None

Response:

Field	Type	Notes
Site	String	ID of the current scope site
Offset X	Float	—
Offset Y	Float	—

Example:

Command:   step_scope_site_first
Response:  0,0,Pos1,0,0

Remarks: Scope site positions are always relative to the scope home position.

step_scope_site_next

Sentio Version: 3.4.0

Description: Steps the scope to the next site and sets it as the current site.

Parameters: None

Response:

Field	Type	Notes
Site	String	ID of the current scope site
Offset X	Float	—
Offset Y	Float	—

Example:

Command:   step_scope_site_next
Response:  0,0,Pos2,1000,1000

Remarks: Scope site positions are relative to scope home. Site index is zero based.

---