SIMetrix Script Manual

https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/
Admin
SIMetrix Script Manual is comprehensive documentation for the SIMetrix script language, providing...
Tokens:329,435
Snippets:2,381
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Function Examples

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_expressions.htm

Examples of calling functions with different argument counts.

```SIMetrix Script
NetName()
```

```SIMetrix Script
FFT( vout, 'Hanning')
```

--------------------------------

### AddProp Usage Examples

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_addprop.htm

Examples demonstrating property attachment with default and absolute positioning.

```text
AddProp ref Q? 26
```

```text
AddProp ref Q? 8 100 200
```

--------------------------------

### Example Key Definitions

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_defkey.htm

Examples of defining custom key shortcuts for schematic and graph operations.

```text
DefKey CR "inst res" 4
```

```text
DefKey F12:SCHEM "zoom out" 4
```

--------------------------------

### Change Component Reference Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_prop.htm

An example demonstrating how to change the 'ref' property of a selected component from R3 to R4.

```text
Prop ref R4
```

--------------------------------

### Example: Creating Toolbars in Multiple Contexts

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_createtoolbar.htm

This example demonstrates how to create a toolbar named 'verilogtoolbar' that appears in both Verilog-A and Verilog-HDL editors. Changes to toolbar configurations take effect only after all windows of that type are closed.

```simetrix
CreateToolBar VerilogAEditor verilogtoolbar
CreateToolBar VerilogHDLEditor verilogtoolbar
```

--------------------------------

### Floor Function Usage Examples

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_floor.htm

Examples demonstrating the behavior of the Floor function with positive and negative scalar values.

```text
Floor(3.45) = 3
Floor(7.89) = 7
Floor(-3.45) = -4
```

--------------------------------

### Dialog Examples

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/applications_customdialogboxes.htm

Demonstration scripts for various dialog types.

```APIDOC
## Examples
A number of trivial examples are supplied that demonstrate each of the widgets. These are supplied in the examples directory under scripts/dialogs. To use them you must copy them to the support/dialogs folder. Here is a list:

### EditDialog
Simple dialog with an edit box and an Ok button. Type:
```
Show EditDialog('Initial message')
```
to see what it does.

### TestCombo
Demo of combo box, try this:
```
Show TestCombo('bill', 'fred|bill|john')
```

### TestFunction
A spinner and a check box. Try:
```
Show TestFunction(['2.345', '1'])
```

### ListBoxFunction
A list box and a check box, Try this:
```
Show listboxfunction(['john','1'], 'fred|bill|john')
```

### TextEditTest
TextEdit and two push buttons, one of them with toggle action. Try this:
```
Show textedittest('A message')
```

### JohnsModelDialog
Bits and pieces. Try this:
```
Show johnsmodeldialog(['bill', '2.345', '4.567', '1'],
'fred|bill|john')
```

### RadioTest
A couple of radio buttons and a toggle button
```
Show radiotest('1')
```
```

--------------------------------

### SelectColumns Data Input Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_selectcolumns.htm

Example input data representing an array of semicolon-delimited strings.

```text
BUF600X1;Buf;;Buffers;;2,1,4,3
BUF600X2;Buf;;Buffers;;2,1,4,3
BUF601X1;Buf;;Buffers;;2,1,4,3
BUF601X2;Buf;;Buffers;;2,1,4,3
```

--------------------------------

### Boolean OR Filter Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_querydata.htm

This example demonstrates using a boolean OR operator with reverse polish notation to combine two filter lists. It accepts data where the second field is 'nmos' or 'nmos_sub' and the last field is 'SIMetrix'.

```text
['*;nmos;*;*;*;*;*;SIMetrix',
'*;nmos_sub;*;*;*;*;*;SIMetrix', '\OR']
```

--------------------------------

### SplitString Function Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_splitstring.htm

Demonstrates splitting a string by a token. The function returns an array of strings.

```SimNet
SplitString('fred/bill/jill', 'bill') ['fred/', '/jill']
```

```SimNet
SplitString('fred/bill/bill/jill', 'bill') ['fred/', '/', '/jill']
```

--------------------------------

### GetModelFiles Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getmodelfiles.htm

Retrieves a list of currently installed device models.

```APIDOC
## GetModelFiles

### Description
Returns a list of currently installed device models.

### Returns
- **Return type**: string array
```

--------------------------------

### Perform RegExSearch

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_regexsearch.htm

Examples demonstrating successful and unsuccessful searches within a string array.

```SIMetrix Script
RegExSearch( [ '.tran 1m 0' , '.pop TRIG_COND=1_TO_0 MAX_PERIOD=2.2u' , '.options POP_USE_TRAN_SNAPSHOT' , '.options POP_ITRMAX=20' ] , '\.options' )
```

```SIMetrix Script
RegExSearch( [ '.tran 1m 0' , '.pop TRIG_COND=1_TO_0 MAX_PERIOD=2.2u' , '.options POP_USE_TRAN_SNAPSHOT' , '.options POP_ITRMAX=20' ] , '\.ac' )
```

--------------------------------

### Define a menu item

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getmenuitems.htm

Example command for defining a menu item in the command shell.

```SIMetrix Script
DefMenu "Shell|&File|&New Schematic" "NewSchem /ne"
```

--------------------------------

### GET /functions/ModelLibsChanged

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_modellibschanged.htm

Checks if the installed model libraries have been changed since the last call to this function.

```APIDOC
## ModelLibsChanged Function

### Description
Returns 1 if the installed model libraries have been changed since the last call to this function. The function always returns 1 the first time it is called after program start.

### Returns
- **Return type** (real) - 1 if libraries have changed, 0 otherwise.
```

--------------------------------

### SIMetrix Help Command Syntax

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_help.htm

Use this command to open the SIMetrix help system. Specify parameters like /contents, /context, /file, or a specific topic to navigate.

```shell
Help [/file <filename>] /contents | /context <context-id> | <topic>
```

--------------------------------

### Join string array examples

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_join.htm

Demonstrates basic usage of the Join function with different separators and array sizes.

```SIMetrix Script
Join( [ 'a' , 'b' , 'c' ] , '|' )
```

```SIMetrix Script
Join( [ 'a' , 'b' , 'c' ] , '' )
```

```SIMetrix Script
Join( [ 'a' ] , ',' )
```

--------------------------------

### Simple Filter Mismatch Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_querydata.htm

This filter will not match the example data item because the last field differs.

```text
*;*;X;*;*;*;*;SIMPLIS
```

--------------------------------

### RunAsync Command Syntax

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_runasync.htm

Use this command to start a simulation in the background. Provide the path to the netlist file. An optional data file path can be specified; otherwise, a temporary file will be used.

```simetrix
RunAsync <netlist> [<datafile>]
```

--------------------------------

### Example Data Item for QueryData

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_querydata.htm

This is an example of a data item that can be filtered by the QueryData function. It represents a semicolon-delimited string.

```text
IRFI520N;nmos_sub;X;NMOS;;;;SIMetrix
```

--------------------------------

### Execute Hello World Script

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_atutorial.htm

Displays a message in the SIMetrix message window.

```SIMetrix Script
echo "Hello World!"
```

--------------------------------

### Gauss Function Usage Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_gauss.htm

Example of applying the Gauss function to a component value to define a 3-sigma spread.

```text
1k*Gauss(0.1)
```

--------------------------------

### Execute RegExStrStr searches

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_regexstrstr.htm

Examples demonstrating basic pattern matching, alternation, and handling of non-matching patterns.

```SIMetrix Script
RegExStrStr( 'abcdef' , 'de' )
```

```SIMetrix Script
RegExStrStr('abcdef', 'de|bc' )
```

```SIMetrix Script
RegExStrStr( 'abcdef' , '^xyz' )
```

--------------------------------

### Display a TableDialog

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_tabledialog.htm

Initializes a table with 5 rows and 3 columns, pre-populated with specific device data.

```SIMetrix Script
TableDialog([5,3],["'Device;Length;Width;', 'Q2;1u;0.35u;',
+ 'Q3;2.25u;0.35u;', 'Q4;2.25u;0.35u;', 'Q5;2.25u;0.35u;'"])
```

--------------------------------

### Simple Filter Match Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_querydata.htm

This filter uses wildcards to match the example data item. The '*' wildcard matches any sequence of characters.

```text
*;*;X;*;*;*;*;SIMetrix
```

--------------------------------

### Example Data File Content

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/applications_dataimportexport.htm

A sample text file format containing time and voltage data points.

```text
Time       Voltage1 	Voltage2

0          14.5396      14.6916
1e-09      14.5397      14.6917
2e-09      14.5398      14.6917
4e-09      14.54        14.6917
8e-09      14.5408      14.6911
1.6e-08    14.5439      14.688
3.2e-08    14.5555      14.6766
6.4e-08    14.5909      14.641
1e-07      14.6404      14.5905
1.064e-07  14.6483      14.5821
```

--------------------------------

### Direct Distribution Function Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_distribution.htm

An example of the distribution function with direct definition of tolerance and distribution lookup table. The function returns a real number.

```SIMPLIS
distribution(1.0, [-1,0, 0,1, 1,0] )
```

--------------------------------

### Check for String Start with Case-Insensitive Regex

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_regexcontains.htm

Use this to find if a string begins with a specific phrase, ignoring case. The search starts from the beginning of the input string.

```simetrix
RegExContains( 'Abc' , '^ab' )
```

--------------------------------

### Check for String Start with Case-Sensitive Regex

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_regexcontains.htm

Use this to find if a string begins with a specific phrase, enforcing case sensitivity. The search starts from the specified character offset.

```simetrix
RegExContains( 'Abc' , '^ab' , 0 , 'casesensitive' )
```

--------------------------------

### Perform String Replacement with RegEx

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_regexreplace.htm

Examples demonstrating simple digit replacement, backreference usage, and handling non-matching inputs.

```SIMetrix Script
RegExReplace( 'SIMPLIS_DVM_ADVANCED_LOAD_4T_RES_BODE', '\d' , '3')
```

```SIMetrix Script
RegExReplace( 'SIMPLIS_DVM_ADVANCED_LOAD_4T_RES_BODE', '^SIMPLIS_DVM_ADVANCED_LOAD_(\d)T(_.*)$' , 'SIMPLIS_DVM_ADVANCED_LOAD_3T\2' )
```

```SIMetrix Script
RegExReplace( 'res_z' , '^SIMPLIS_DVM_ADVANCED_LOAD_(\d)T(_.*)$' , 'SIMPLIS_DVM_ADVANCED_LOAD_3T\2' )
```

--------------------------------

### Resolve relative paths with FullPath

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_fullpath.htm

Examples showing how to resolve a file name and a parent directory reference into a full path.

```SIMetrix Script
FullPath('amplifier.sch', 'c:\simulation\circuits') =
c:\simulation\circuits\amplifier.sch

FullPath('..\amplifier.sch', 'c:\simulation\circuits') =
c:\simulation\amplifier.sch
```

--------------------------------

### EditSymbolBusDialog Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_editsymbolbusdialog.htm

The EditSymbolBusDialog function provides a user interface for setting the start and size of a bus. It accepts initial values and options, and returns the user-selected start and size values.

```APIDOC
## EditSymbolBusDialog Function

### Description
Allows users to interactively set the start and size of a bus.

### Method
N/A (This appears to be a function call within a scripting environment, not a REST API endpoint.)

### Endpoint
N/A

### Parameters
#### Arguments
- **Argument 1** (Real array) - Compulsory - Initial values for start and size of bus. This is a two-element array providing initial values for start and size of bus.
- **Argument 2** (String) - Optional - Options. Set to 'fixedSize' to disable size box. The box will be initialised but the user will not be able to edit it.

### Request Example
N/A

### Response
#### Return Value
- **Return type**: Real array - Two element array providing user selected start and size values.
```

--------------------------------

### RunAsync Command

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_runasync.htm

Spawns a new simulator process and runs a specified netlist in the background.

```APIDOC
## RunAsync

### Description
Spawns a new simulator process and runs the specified netlist. This command allows the front end to remain responsive while the simulation runs in the background.

### Parameters
#### Path Parameters
- **netlist** (string) - Required - Path to the simulation netlist.
- **datafile** (string) - Optional - Path to the data file. If omitted, data is saved to a temporary file in the temporary data directory.
```

--------------------------------

### Truncate Vector Data

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_truncate.htm

Use this function to extract a segment of a vector between specified start and end values. Interpolation is used if the exact start or end points are not present in the original vector.

```Simplex Script
Truncate(VOUT, 250u, 750u)
```

--------------------------------

### OpenDirectory Command Syntax

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_opendirectory.htm

Use this command to open a directory at the specified path.

```SIMetrix Script
OpenDirectory <path>
```

--------------------------------

### Range Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_range.htm

The Range function returns a vector that is a range of the input vector. The range is defined by start and end indices. If only the start index is provided, the range extends to the end of the vector. If no indices are provided, the original vector is returned.

```APIDOC
## Range Function

### Description
Returns a vector which is a range of the input vector in argument 1. The range extends from the indexes specified by arguments 2 and 3. If argument 3 is not supplied the range extends to the end of the input vector. If neither arguments 2 or 3 are supplied, the input vector is returned unmodified.

### Arguments
#### Argument 1: Vector
- **Type**: real/complex or string array
- **Compulsory**: Yes
- **Description**: The input vector from which to extract a range.

#### Argument 2: Start Index
- **Type**: real
- **Compulsory**: No
- **Description**: The starting index of the range (inclusive).

#### Argument 3: End Index
- **Type**: real
- **Compulsory**: No
- **Default**: Vector length - 1
- **Description**: The ending index of the range (inclusive).

### Returns
- **Return type**: Matches the type of argument 1. If argument 1 is an XY vector, the return value will be an XY vector.
```

--------------------------------

### Select Command Syntax

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_select.htm

This is the basic syntax for the Select command. Use /prop to select by property, /wire to select a specific wire, or /all to select everything on the sheet. If no switch is specified, it enters interactive select mode.

```text
Select [/wires] [/prop <prop-name>|/wire <wire-name>|/all]
```

--------------------------------

### GET GetComponentValue

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getcomponentvalue.htm

Retrieves the value of a component from a specified schematic.

```APIDOC
## GET GetComponentValue

### Description
Retrieves component values from a schematic. This function is read-only and mirrors the functionality of SetComponentValue.

### Method
GET

### Parameters
#### Arguments
- **Address** (string) - Required - The address of the component.
- **Schematic ID** (real) - Optional - Default: -1. The ID returned by OpenSchematic. If -1, the currently selected schematic is used.
- **Options** (string) - Optional - Default: none. If set to 'noopen', the schematic will not be opened to view.

### Returns
- **Return type** (string array) - Returns the component value details.
```

--------------------------------

### Display TestCombo

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/applications_customdialogboxes.htm

Demonstrates a combo box widget with a specified initial value and list of options.

```SIMetrix Script
Show TestCombo('bill', 'fred|bill|john')
```

--------------------------------

### GET GetAxisUnits

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getaxisunits.htm

Retrieves the physical units of a specified axis.

```APIDOC
## GET GetAxisUnits

### Description
Returns the physical units of the specified axis. Refer to the Units function for a list of possible return values.

### Method
GET

### Parameters
#### Path Parameters
- **Axis ID** (string) - Required - The identifier of the axis to query.

### Response
#### Success Response (200)
- **Return Value** (string) - The physical units of the axis.
```

--------------------------------

### OptimiserWidgetWriteCommandFile Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_optimiserwidgetwritecommandfile.htm

Creates a SIMetrix simulator command file from the current widget, defining parameters, analyses, and measurements for optimization.

```APIDOC
## OptimiserWidgetWriteCommandFile Function

### Description
Create SIMetrix simulator command file from current widget (GUI). The optimiser definition describes the parameters, analyses and measurements to run an optimisation analysis. The SIMetrix simulator uses a number of netlist commands to describe the analysis. This function generates those commands from the current widget.

### Arguments
#### Argument 1
*   **Filename** (String) - Required - The filename to receive simulator commands.
```

--------------------------------

### StringStartsWith Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_stringstartswith.htm

Checks whether a string starts with another string.

```APIDOC
## StringStartsWith Function

### Description
Checks whether a string starts with another string.

### Parameters
- **String to test** (string) - Required - The string to be tested.
- **String to search for** (string) - Required - The prefix string to search for.

### Returns
- **Return type** (string) - Returns 1 if the string starts with the given string, 0 otherwise.
```

--------------------------------

### Create a Progress Window

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_wm_progresswindowcreate.htm

Initializes a progress window with a defined number of steps and identifier, optionally setting the title, caption, and initial message.

```SIMetrix Script
WM_ProgressWindowCreate <number steps> <identifier> [/title <window title>] [/caption <caption message>] [/message <progress message>]
```

--------------------------------

### Open Logic Definition Editor

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_openlogicdefinitioneditor.htm

Opens a logic definition file for an arbitrary logic device in the text editor, applying syntax highlighting. Specify the filename as a parameter. Optional parameters include /encoding and /fws.

```shell
OpenLogicDefinitionEditor <filename>
```

--------------------------------

### OpenPrinter Command

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_openprinter.htm

Starts a print session for customized or non-interactive printing.

```APIDOC
## OpenPrinter Command

### Description
Starts a print session. This may be used for customised or non-interactive printing.

### Method
COMMAND

### Endpoint
N/A (Command-line or script execution)

### Parameters
#### Command-line Arguments
- **/portrait** (flag) - Optional - If specified, print will be in portrait orientation, otherwise it will be landscape.
- **/numCopies** (integer) - Optional - Number of copies to print.
- **/index** (integer) - Optional - Printer index to use. If omitted, the application default printer will be used.
- **/title** (string) - Optional - Title of the print job. This is used to identify a print job and will be displayed in the list of current print jobs. The title is not printed on the final document.
- **/printer** (string) - Optional - Specify printer by name. If omitted, printer will be defined by its index or the application default printer will be used.
- **/greyscale** (on|off) - Optional - Set to 'on' to enable grey-scale printing.

### Request Example
```
OpenPrinter /portrait /numCopies 2 /printer "HP LaserJet" /title "MyReport"
```

### Response
#### Success Response (Implicit)
- The command initiates a print job. Success is typically indicated by the absence of error messages.

#### Response Example
(No explicit response body for this command; success is indicated by the print job being sent to the printer.)
```

--------------------------------

### GET /functions/NetNames

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_netnames.htm

Retrieves a list of all net names within a schematic.

```APIDOC
## GET /functions/NetNames

### Description
Returns an array of all net names in the selected schematic.

### Method
GET

### Endpoint
/functions/NetNames

### Parameters
#### Query Parameters
- **Schematic ID** (real) - Optional - Schematic ID as returned by the OpenSchematic function. If omitted or -1, the currently selected schematic is used.

### Response
#### Success Response (200)
- **Return Value** (string array) - An array of strings holding all the net names in the schematic. Returns an empty value if the schematic is empty or cannot be found.
```

--------------------------------

### OptimiserStart Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_optimiserstart.htm

Initiates an optimization run for the SIMPLIS simulator by creating the necessary runtime environment.

```APIDOC
## OptimiserStart Function

### Description
Starts an optimiser run. This function is used for running optimisation for the SIMPLIS simulator. This function creates the runtime environment needed to run an optimisation session.

### Arguments
- **Optimiser definition ID** (Real) - Compulsory - Description: ID reference to optimiser definition as returned by functions: OptimiserCreateFromXMLString, OptimiserCreateFromXML, OptimiserWidgetCreateOptDef, OptimiserSimulatorGetDef.

### Returns
- Return type: Real
- Status: Returns 1 if successful, 0 on failure.

### See Also
- OptimiserRunning
- OptimiserApplySpecification
- OptimiserApplyFailedRun
- OptimiserSuccess
- OptimiserErrorMessage
- OptimiserFinish
```

--------------------------------

### GET GetSelectedGrid

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getselectedgrid.htm

Retrieves the ID of the currently selected grid in a graph.

```APIDOC
## GetSelectedGrid

### Description
Returns the ID of the selected grid. Grids are sections of a graph that contain one or more horizontally stacked Y-axes and one or more vertically stacked X-axes.

### Arguments
No arguments.

### Returns
- **Return type** (string) - The ID of the selected grid.
```

--------------------------------

### ChooseDirectory Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_choosedirectory.htm

Opens a system directory selection dialog and returns the selected path.

```APIDOC
## ChooseDirectory

### Description
Opens a dialog box showing a directory tree. Returns the path selected by the user or an empty string if the operation is cancelled. This function uses the standard system dialog which includes access to network shares.

### Parameters
#### Arguments
- **Starting Directory** (string) - Required - The initial directory shown in the dialog.

### Returns
- **Return type** (string array) - The path selected by the user.
```

--------------------------------

### GET GetLastError

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getlasterror.htm

Retrieves the status of the most recent command executed in the system.

```APIDOC
## GET GetLastError

### Description
Returns a string signifying the status of the most recent command executed. This function is useful for implementing customized error handling logic.

### Method
GET

### Endpoint
GetLastError()

### Returns
- **status** (string) - Returns one of three values: 'OK' (command executed without error), 'Error' (one or more errors occurred), or 'Fatal' (command not recognized or braced substitution failed).

### Response Example
{
  "status": "OK"
}
```

--------------------------------

### OpenVerilogA Command

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_openveriloga.htm

Opens a Verilog-A source file in the text editor with syntax highlighting.

```APIDOC
## OpenVerilogA

### Description
Opens a Verilog-A source file in the text editor. This will apply syntax highlighting for the Verilog-A language.

### Parameters
- **/encoding** (string) - Optional - Encoding for the file. For details see documentation of second argument to LoadFile.
- **/fws** (string) - Optional - File watcher status, can be set to enable, disable, or auto.
- **filename** (string) - Required - Path of Verilog-A source file to open.

### Request Example
OpenVerilogA "path/to/file.va"
```

--------------------------------

### GET /functions/DescendDirectories

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_descenddirectories.htm

Retrieves a list of all directories under a specified path recursively.

```APIDOC
## GET /functions/DescendDirectories

### Description
Returns all directories under the specified directory. The function recurses through all sub-directories, including those pointed to by symbolic links. It returns only directory names, not files.

### Method
GET

### Endpoint
/functions/DescendDirectories

### Parameters
#### Query Parameters
- **Directory** (string) - Required - The root directory path to begin the recursive search.

### Response
#### Success Response (200)
- **Result** (string array) - A list of all directory paths found under the specified root.
```

--------------------------------

### Help Command

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_help.htm

Opens the SIMetrix help system with various options to navigate to specific topics or the table of contents.

```APIDOC
## Help Command

### Description
Opens the SIMetrix help system.

### Method
Command-line utility

### Endpoint
N/A (Command-line tool)

### Parameters
#### Query Parameters
- **/contents** (flag) - Optional - Opens help in the main contents page.
- **/context <context-id>** (parameter) - Optional - Included for backward compatibility. Equivalent to 'Help <context-id>'.
- **/file <filename>** (parameter) - Optional - If specified, help will be obtained from the given filename. Otherwise, the default SIMetrix.chm help file will be used.
- **<topic>** (parameter) - Optional - If specified, the help system will display the page related to the topic. If the topic does not exist, a list of available topics will be displayed.

### Request Example
```
Help .tran
```

### Response
#### Success Response (200)
Opens the SIMetrix help viewer to the specified topic or content.

#### Response Example
N/A (GUI interaction)
```

--------------------------------

### OpenVerilogHDL Command

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_openveriloghdl.htm

Opens a Verilog-HDL source file in the text editor with syntax highlighting.

```APIDOC
## OpenVerilogHDL

### Description
Opens a Verilog-HDL source file in the text editor. This will apply syntax highlighting for the Verilog-HDL language.

### Parameters
- **/encoding** (string) - Optional - Encoding for the file. See LoadFile documentation for details.
- **/fws** (string) - Optional - File watcher status: enable, disable, or auto.
- **filename** (string) - Required - Path of the Verilog-HDL source file to open.

### Request Example
OpenVerilogHDL "path/to/file.v"

### See Also
- OpenNetlist
- OpenBasicTextEditor
- OpenScript
- OpenVerilogA
- OpenLogicDefinitionEditor
- OpenAsciiFile
```

--------------------------------

### GetEthernetAddresses Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getethernetaddresses.htm

Retrieves information about the installed Ethernet adapters on the system.

```APIDOC
## GetEthernetAddresses Function

### Description
Returns information about the installed Ethernet adapters.

### Method
N/A (This is a function, not an API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response
- **return value** (string array) - A string array providing information about the Ethernet adapters installed in the system. Depending on the operating system, this will either be a simple list of Ethernet addresses or a list of semi-colon delimited strings providing the Ethernet address followed by a description of the adapter.

#### Response Example
```json
["00:1A:2B:3C:4D:5E - Intel(R) Ethernet Connection (7) I219-V", "00:1A:2B:3C:4D:5F - Realtek PCIe GbE Family Controller"]
```
```

--------------------------------

### Initialize PWLDialog with X-Y Pairs

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_pwldialog.htm

Use this to initialize the PWLDialog with a predefined set of X-Y pairs. The pairs are provided as a string array.

```simetrix
Show pwldialog(['0','0.5','1','1.5','2','2.5'])
```

--------------------------------

### Linked Run Example using /sweep and /append

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_run.htm

The traditional method for linking runs using /sweep, /label, and /append switches. This method is older and less simple than OpenLinkedRun/CloseLinkedRun.

```text
** First run
Run /sweep start /label "Run=1" netlist.net
** save group name
Let grp1 = (Groups())[0]... changes to netlist
** second run
Run /sweep continue /label "Run=2" /append {grp1} netlist.net... changes to netlist

** third run
Run /sweep continue /label "Run=3" /append {grp1} netlist.net... changes to netlist
** fourth and final run
Run /sweep finish /label "Run=4" /append {grp1} netlist.net
```

--------------------------------

### WC Function Usage Example

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_wc.htm

This example demonstrates how to use the WC function in a device value expression for Monte Carlo analysis. The function returns a random number within +/- 0.1 of 1.0, resulting in values like 900 or 1100. In non-Monte Carlo runs, it defaults to 1000.

```simetrix
1k*WC(0.1)
```

--------------------------------

### For Loop Iteration

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_atutorial.htm

Starts a loop to iterate through the collected component references.

```SIMetrix Script
for idx=0 to length(refs)-1
```

--------------------------------

### Braced Substitution Usage

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_expressions.htm

Examples showing how to use braced substitutions to evaluate expressions in commands that do not natively support them.

```SIMetrix Script
if {netname()} < 4.56 then
```

```SIMetrix Script
let v = {netname()}
if v < 4.56 then
```

--------------------------------

### Open a SelectDialog with Options

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_selectdialog.htm

Use this function to display a dialog box with a list of options. Configure selection mode, sorting, and initial selections via the first argument. The second argument provides the list entries.

```Simplex Script
SelectDialog(['Caption','Message','single',,'1'],
['Fred','John','Bill'])
```

--------------------------------

### GET WM_GetCentralWidgetGeometry

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_wm_getcentralwidgetgeometry.htm

Retrieves the geometry information for the editor region of a specified window.

```APIDOC
## GET WM_GetCentralWidgetGeometry

### Description
Returns window geometry information for the editor region of the window.

### Parameters
#### Path Parameters
- **Window name** (string) - Required - Window name as returned from the function WM_GetWindowNames.

### Response
#### Success Response (200)
- **Geometry information** (string) - Geometry information for the editor region.
```

--------------------------------

### GET OptimiserSimulatorGetInfo

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_optimisersimulatorgetinfo.htm

Retrieves file paths associated with the current simulator optimiser.

```APIDOC
## GET OptimiserSimulatorGetInfo

### Description
Retrieves information about the current simulator optimiser files. Returns an empty vector if no simulator optimiser is current.

### Method
GET

### Endpoint
OptimiserSimulatorGetInfo

### Returns
- **0** (String) - Path to attached schematic
- **1** (String) - Path to results file
- **2** (String) - Path to definition file

### See Also
- OptimiserGetInfo
- OptimiserWidgetGetInfo
```

--------------------------------

### Run SIMPLIS Simulation

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_runsimplis.htm

Executes the SIMPLIS simulator. Ensure you have a valid license. This command does not pre-process the netlist; use PreProcessNetlist separately if needed.

```bash
RunSIMPLIS [/fresh] [/append] [/label division-label] [/sweep start|continue|finish] [/checkAbort] filename
```

--------------------------------

### GET /OptimiserGetInfo

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_optimisergetinfo.htm

Retrieves file information for a specific optimiser definition ID.

```APIDOC
## GET OptimiserGetInfo

### Description
Retrieves file information associated with a specific optimiser definition ID.

### Method
GET

### Parameters
#### Arguments
- **Optimiser definition ID** (Real) - Required - ID reference to optimiser definition as returned by functions: OptimiserCreateFromXMLString, OptimiserCreateFromXML, OptimiserWidgetCreateOptDef, or OptimiserSimulatorGetDef.

### Response
#### Success Response (200)
- **0** (String) - Path to attached schematic
- **1** (String) - Path to results file
- **2** (String) - Path to definition file

Returns an empty vector if ID is invalid.
```

--------------------------------

### GetSimulatorOptions Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/functionsummary.htm

Returns a list of simulator options.

```APIDOC
## GetSimulatorOptions

### Description
Returns a list of simulator options.

### Method
GET

### Endpoint
/api/scripting/getSimulatorOptions

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **options** (array) - An array of strings, where each string is the name of a simulator option.

#### Response Example
{
  "options": ["GMIN", "RELTOL", "VNTOL"]
}
```

--------------------------------

### GET /OptimiserAnalysisLine

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_optimiseranalysisline.htm

Retrieves the analysis lines for a specified optimiser definition ID.

```APIDOC
## GET /OptimiserAnalysisLine

### Description
Returns an array of strings where each element contains one optimiser analysis line. The final element contains any options line present in the definition.

### Parameters
#### Path Parameters
- **Optimiser definition ID** (Real) - Required - ID reference to optimiser definition as returned by functions such as OptimiserCreateFromXMLString, OptimiserCreateFromXML, OptimiserWidgetCreateOptDef, or OptimiserSimulatorGetDef.

### Response
#### Success Response (200)
- **Return type** (String array) - An array with each element containing one optimiser analysis line. The final element holds any options line present in the definition. If there are no options lines, the final element will be an empty string.
```

--------------------------------

### Create a Custom Tool Button

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/applications_creatingmodifyingtoolbars.htm

Defines a new button with a specific image and class. This command should be placed in the startup script for persistence.

```SIMetrix Script
CreateToolButton /class component diffres diffres.png
"Place Diffused Resistor"
```

--------------------------------

### GET GetSchematicVersion

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getschematicversion.htm

Retrieves version information for the currently selected or specified schematic.

```APIDOC
## GET GetSchematicVersion

### Description
Returns version information for the currently selected schematic or a specific schematic identified by its ID.

### Parameters
#### Arguments
- **Schematic ID** (real) - Optional - Schematic ID as returned by the OpenSchematic function. If omitted or -1, the currently selected schematic is used.

### Returns
- **Return type**: string array (length 4)
- **Index 0**: Format version (integer defining the binary file format).
- **Index 1**: User version (incremented each time the schematic is saved).
- **Index 2**: Exact SIMetrix version used to save the file (valid for version 5.4 or later).
- **Index 3**: Name of the application that created the schematic file.
```

--------------------------------

### Enable Script Echoing

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_executingscripts.htm

Displays each command in the message window as it executes.

```SIMetrix Script
Set EchoOn
```

--------------------------------

### GetSymbolFiles Function

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/func_getsymbolfiles.htm

Retrieves the full paths of all installed symbol library files.

```APIDOC
## GetSymbolFiles Function

### Description
Returns full paths of all installed symbol library files.

### Arguments
No arguments

### Returns
Return type: string array
```

--------------------------------

### Open SPICE Netlist File

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_opennetlist.htm

Use this command to open a SPICE netlist or model file in the text editor. Syntax highlighting is applied for the simulator command language. If the NetlistEditor option is set, an external application will be used instead.

```simplescript
OpenNetlist <filename>
```

--------------------------------

### Define String Constants

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/scriptlanguage_variablesconstantstypes.htm

Examples of string literals using single quotation marks.

```SIMetrix
'this is a string'
'This is a "string"'
```

--------------------------------

### Create a new directory using MD

Source: https://help.simetrix.co.uk/9.2/simetrix/script_manual/topics/com_md.htm

Use this command to create a directory with the specified name.

```SIMetrix Script
MD <directory-name>
```
Tokens:
Raw