Status Commands¶
status:get_access_level¶
Sentio Version: 2.8.1
Description: Retrieves the access level of operation.
Parameters: None
Response:
| Field | Type | Values |
|---|---|---|
| Level | String | Operator, Admin, Service, Engineer, Debug |
Example:
status:get_prop¶
Sentio Version: 3.2.0
Description: Generic function to retrieve the value of a specific data item from the setup module.
Parameters:
| Parameter | Type | Values | Notes |
|---|---|---|---|
| Property Name | String | Contact — contact height of the stage (µm, absolute from z-axis zero); Separation — separation gap (µm); Hover — hover gap (µm, chuck stage only); Home — home position of the stage; Overtravel — overtravel distance (µm, chuck stage only); Edge_Sensor — edge sensor status (property name only, no other parameters) |
|
| Stage | String | Chuck (default), Probe01, Probe02, Probe03, Probe04 |
Required for Contact/Separation/Hover/Home/Overtravel |
| Chuck Site (opt.) | String | Wafer (default), Auxright, Auxleft, Auxright2, Auxleft2 |
For Contact/Separation/Hover/Home |
Parameter configuration by property: Contact, Separation, Hover, Home each take (Stage, Chuck Site); Overtravel takes (Stage) only; Edge_Sensor takes no additional parameters.
Response: Depends on the data property.
Examples:
Command: status:get_prop contact, wafer
Response: 0,0,44000 (contact height of chuck wafer site)
Command: status:get_prop edge_sensor
Response: 0,0,1,0 (edge sensor 1: ON, edge sensor 2: OFF)
status:get_machine_id¶
Sentio Version: 2.8.1
Description: Retrieves the machine ID.
Parameters: None
Response:
| Field | Type |
|---|---|
| Machine ID | String |
status:get_machine_status¶
Sentio Version: 2.8.1
Description: Retrieves the machine status flags.
Parameters: None
Response:
| Field | Type | Values |
|---|---|---|
| Status | String | NotReady — not initialized; Ready — initialized; Running — busy (e.g. stage moving); IsMeasuring — running an instrument measurement (QAlibria); LoaderBusy — cassette/slot loader busy (TS3500/TS2500 only) |
Example:
Command: status:get_machine_status
Response: 0,0,Ready,IsMeasuring (initialized, measurement in progress)
status:get_version¶
Sentio Version: 2.8.1
Description: Retrieves the system version.
Parameters: None
Response:
| Field | Type |
|---|---|
| Version | String |
status:set_prop¶
Sentio Version: 3.2.0
Description: Generic function to set the value of a specific data item on the dashboard module.
Parameters:
| Parameter | Type | Values | Notes |
|---|---|---|---|
| Property Name | String | Contact — sets contact height of the given stage at the given chuck site; Home — sets home position of a stage for a given chuck site |
|
| Stage | String | Chuck, Probe01, Probe02, Probe03, Probe04 |
|
| Chuck Site | String | Wafer, Auxright, Auxleft, Auxright2, Auxleft2 |
|
| Contact Height | Float | — | For property Contact |
| Home Position X | Float | — | For property Home |
| Home Position Y | Float | — | For property Home |
Parameter configuration: Contact takes (Stage, Chuck Site, Contact Height); Home takes (Stage, Chuck Site, Home Position X, Home Position Y).
Response: Depends on the data property.
Examples:
Command: status:set_prop contact, chuck, wafer, 16000
Response: 0,0,OK (sets contact height of chuck at wafer site to 16000 µm)
Command: status:set_prop home, probe01, wafer, 1000,2000
Response: 0,0,OK (sets home position of probe01 on wafer site to 1000,2000)
status:show_message¶
Sentio Version: 2.8.1
Description: Shows a message dialog for user interaction.
Parameters:
| Parameter | Type | Values |
|---|---|---|
| Message | String | — |
| Button | String | OK (default), OKCancel, YesNo, YesNoCancel |
| Caption | String | None (default) |
| Level | String | Hint (default), Warning, Error |
Response:
| Field | Type | Values |
|---|---|---|
| Button | String | OK, Cancel, Yes, No |
Remarks: The last three parameters (from the end of the list) may be omitted; defaults apply. Button and Level are not case sensitive.
status:start_show_message [asynchronous]¶
Sentio Version: 3.2.0
Description: Asynchronous version of status:show_message. Returns immediately; use wait_complete to obtain the pressed button.
Parameters:
| Parameter | Type | Values |
|---|---|---|
| Message | String | — |
| Button | String | OK (default), OKCancel, YesNo, YesNoCancel |
| Caption | String | None (default) |
| Level | String | Hint (default), Warning, Error |
Response: No special immediate response other than the Command ID (0, Cmdld, OK).
Example:
Command: status:start_show_message OK
Response: 0,1,OK (must then use wait_complete with the command id to obtain the pressed button)
Remarks: The last three parameters (from the end of the list) may be omitted; defaults apply.