ActiveX Programming Guide¶
SanjVIEW can be controlled through external scripting through the use of an ActiveX server. This lets you set values on SanjVIEW's Project Manager front panel — and read others back — from an external scripting or programming environment instead of driving the software interactively.
The source documentation illustrates this with a MATLAB example. [diagram/image in source — not reproduced here — the source shows a screenshot of the SanjVIEW Project Manager front panel alongside the note that the "Front Panel String generally matches the string required for" the corresponding scripting call; the sentence is cut off in the source material.]
Example: MATLAB¶
The following MATLAB script sets the LED Brightness (%) control on the Project Manager to 25%:
% MATLAB Script to set the Brightness in the Project Manager
vi.SetControlValue('Brightness(%)', 25); % sets the LED Brightness to 25%
vi refers to the ActiveX/VI Server reference to the running SanjVIEW instance, and SetControlValue is called with the front-panel control's name (as a string) and the value to assign. The source guide's table of contents also lists a "Python Sample Code" section; however, no Python example content was present in the converted source material available for this reference.
SanjVIEW Front Panel Variables¶
The table below lists the front panel controls and indicators documented in the source guide that are addressable through the ActiveX interface (for example, via SetControlValue), along with their LabVIEW-style data types. Only the variables for which the source provided a description are annotated; the rest are listed by name and type as documented.
| Variable Name | Data Type | Description |
|---|---|---|
| Start Measurement | Boolean | |
| Camera Image | PlugInControl | |
| Measured DT(C) | Digital | |
| Cth | PlugInControl | |
| Return to PM | Boolean | |
| Mean Cth | Digital | |
| StDev | Digital | |
| Loop Iterations | Digital | |
| Save Image | Boolean | |
| Elapsed Time (s) | Digital | |
| Save Path | Path | |
| Save Text with Image | String | |
| System Status | String | |
| Time in Cycle | Digital | |
| cooling multiplier use | Digital | |
| DEVThermocouple | Boolean | |
| DEV thermocouple type | Ring | Type of thermocouple connected. |
| Use GPIB BNC | Boolean | |
| colorbar | PlugInControl | |
| max value | Digital | |
| Min | Digital | |
| Enter Temp | Digital | |
| Focus Level | Digital | Returns the standard deviation. |
| IMAQ Session | GenClassTagRef | |
| Tcontrol COM | VISAResourceName | Identifies the resource to be opened. |
| CCD x Size | Digital | |
| CCD y Size | Digital | |
| ROI color | ColorBox | |
| Period (s) | Digital | |
| Y Step | Digital | |
| Clear Charts | Boolean | |
| BNC Enabled | Boolean | |
| Stdev Tol | Digital | |
| ROI (Current) | Array | |
| Use Cold Plate TC | Boolean | |
| Cold plate thermocouple type | Ring | Specifies the type of thermocouple connected to the channel. |
| Cold Plate Alarm [C] | Digital | |
| Get ROI | Boolean | |
| write frame | Digital | |
| Timeout | Boolean | |
| In Focus | Boolean | |
| SRref Valid | Boolean | |
| Next Frame | Ring | |
| At T setpoint | Boolean | |
| Stage SP | Digital | |
| Update Temp SP (internal) | Boolean | |
| COLD | Array | |
| HOT | Array | |
| Temp Stable | Boolean | |
| Stage Upper Limit(V) | Digital | |
| Stage lower Limit(V) | Digital | |
| Colds Shift reg | Array | |
| Hot shift reg | Array | |
| XY Coarse | Digital | |
| Align Loop | Digital | |
| Temp Limit | Slide | |
| physical ch TC1 | DAQmxName | |
| AF60 COM | VISAResourceName | Identifies the resource to be opened. |
| Which AF? | Digital | |
| hot tol | Digital | |
| new data | Boolean | |
| Stage In Range | Boolean | |
| Direct Time constant | Boolean | |
| Scaling Param | Digital | |
| Done | Boolean | |
| Focus tolerance level | Digital | |
| X center | Digital | |
| Y center | Digital | |
| Score | Digital | |
| Alignment | Boolean | |
| TCAT/SS | Boolean | |
| Camera | String | |
| Cth | Digital | |
| Base Temp (BT) | Digital | |
| Reference Image File | Path | |
| Calc Shift | Boolean | |
| Focus score | WaveformChart | |
| ROI Coarse | Array | |
| Get Coarse ROI | Boolean | |
| Positions | Array | |
| Cold Positions | Array | |
| Hot Positions | Array | |
| WL autocapture new REF? | Boolean | |
| ROI for StDev CTR | Array | |
| Focus score 2 | WaveformChart | |
| Vibration Indicator | Boolean | |
| Show Shift Corrected? | Boolean | |
| Min CtTR Stdev | Digital | |
| ROI Coarse 2 | Array | |
| stop | Boolean | |
| progress | Slide | |
| Tab Control | TabControl | |
| Force Capture | Boolean | |
| Charts/Data | TabControl | |
| % Match | Digital | |
| avg cold | Array | |
| Stage Set | Boolean | |
| ROI Focus | Array | |
| REF IMAGE | Array | |
| Min Hot Score default | Digital | |
| Min Cold Score default | Digital | |
| Capture New Ref | Boolean | |
| Latch Filename | Boolean | |
| String File | String | |
| Load in MATLAB | Boolean | |
| Saved File Name | String | |
| Cth Map Array | Array | |
| dT or dR/R | Boolean | |
| Save Every Cycle | Boolean | |
| Save loop wait | Digital | |
| Chuck Selection 2 | Boolean | |
| Get Data Fast | Boolean | |
| Workspace Path | Path | |
| Andor Connected | Boolean | |
| Z Mag Scaling | Digital | |
| Andor Grab loop | Boolean | |
| Andor loop | Digital |
Note:
Cthappears twice in the source table with two different data types (PlugInControlandDigital). Both entries are reproduced above as documented, since the source does not clarify whether these refer to the same or distinct controls.