-?|-h|--help
Show the help information.
--version
Show the version information.
-t|--targetIP
The IP parameter specifies the IP-address of the SIMATIC PLC on which the monitor command will executed.
-f|--file
Path to a file that describes the variables to be monitored. Each line in the file represents a value that should be monitored. These can be either a symbol name or an absolute address from the in/output section.
The file name extension is up to the user.
The general format description:
<VariableNameOfElementaryDataType>
<SymbolNameOfArray>
<SymbolNameOfArray>[arrayIndex]
<SymbolNameOfArray>[arrayIndex, *, arrayIndex]
<InstanceNameOfStructuredType>
<InstanceNameOfStructuredType>.<SymbolNameOfField>
<InstanceNameOfClass>
<InstanceNameOfClass>.<MemberName>
<AbsoluteAddress>:<ElementaryDataType>
# this is a comment
The content of a specific file can look like this:
# comment
globalInt
globalBool
%IW0:int
P1.myFBWithStatic.myVarStaticInt
When monitoring an array, the array is shown with all indices available according to the byte-alignment made by the ST Compiler. For further information regarding alignment of data types, please see Types and Variables.
-s|--symbols
A list of variables to monitor, separated by spaces. E.g. --symbols "var1 var2 var3". For details, what can be passed as the value, please take a look at the format description under the parameter '--file'.
-c|--continuously
Default: false
Set this flag to monitor continuously. The sampling rate is 100 ms.
If the PLC is in RUN mode the outputs are monitored at the start of the cycle and the inputs and all other addresses at the end of the cycle. If the PLC is in STOP the addresses are monitored all together. To leave the continuous mode press 'x'.
If this flag is not set, the values will be requested and shown only once. When monitoring as a oneshot the addresses are monitored all together, immediately and once only.
-o|--output
Default: table
Defines the output format. Possible output formats are json and table. table is a human readable format.
-u|--username
optional
Add a legitimation username for the PLC (e.g. -u My_UserName).
Legitimation with username requires a password provided via option "-p|--password".
User name may only contain ASCII7-characters!
Be aware that Non-ASCII-characters in the username will be removed so that, the user name will be invalid and access to the PLC will be denied!
The username is required for PLCs with enabled user mangagement and access control (UMAC)! For all PLCs with legacy access control, the username must not be used!
-p|--password
Add a legitimation password for the PLC (e.g. -p "MY_PASSWORD"), note that this password is submitted in clear text. If you use the flag with empty string (e.g. -p "") a secure prompt will appear and you can enter the password in a safe way.
-C|--certificate
The file containing the public key for communicating with the PLC. The certificate can be either extracted from TIA Portal or from the SIMATIC PLC 1500 via certificate management.