Command Line Interface

The Symbol Explorer can be called up via the command line using the command line interface (CLI).

The following commands are available:

--SnapShotFromPlc     Take a snapshot from PLC target.
--SyncPlcToSnapShot   Synchronize PLC target with a Snapshot.
--SyncFileToPlc       Synchronize Snapshot with a PLC target.

--SnapShotFromPlc

Create snapshots of a PLC.

Option

Description

<NetId>

AMS Net Id of the target

<Port>

AMS port of the target

<SnapShotPath>

SnapShot file path

  --SnapShotFromPlc <NetId> <Port> <SnapShotPath>

--SyncPlcToSnapShot

Synchronize PLC symbol values with a snapshot.
The current PLC symbol values are transferred to a snapshot.

Option

Description

<NetId>

AMS Net Id of the target

<Port>

AMS port of the target

<SnapShotPath>

SnapShot file path

  --SyncPlcToSnapShot <NetId> <Port> <SnapShotPath>

--SyncSnapShotToPlc

Synchronize snapshot symbol values with the PLC.
The snapshot symbol values are transferred to the PLC.

Option

Description

<NetId>

AMS Net Id of the target

<Port>

AMS port of the target

<SnapShotPath>

SnapShot file path

  --SyncSnapShotToPlc <NetId> <Port> <SnapShotPath>

Symbol Entry Point

A symbol entry point is required for the CLI as well as via the UI to access symbols of a target. The symbol entry point can be specified for the CLI in the form of a configuration file. To create the file, the target must be accessed once with the UI and the Symbol Entry Point dialog is started. In the dialog, you can select which symbols are of interest, just as for the UI.

Call sample


...\TwinCAT\Functions\SymbolExplorer.exe --SnapShotFromPlc <192.168.10.1.1> <851> <"c:\Temp\Snapshots\File.tcpvs>

Sample for starting the Symbol Explorer from the PLC

TwinCAT 3 PLC Library: Tc2_Utilities -> NT_StartProcess Sample

NT_StartProcess

Sample for configuring the input variables.

PATHSTR: "...\TwinCAT\Functions\SymbolExplorer.exe"

DIRNAME: "...\TwinCAT\Functions"

COMNDLINE: "--SnapShotFromPlc 192.168.10.1.1 851 "c:\Temp\Snapshots\File.tcpvs".