Install messages - Manual - Structured Text Debugger - The SIMATIC Debugger. Enables debugging source code on the PLC and is needed to run the debugger extension. - Debugger (sdb),tool

Structured Text Debugger CLI Tool (sdb)

Portfolio
SIMATIC AX
Product
Structured Text Debugger
Software version
1.3.6
Edition
11/2024
Language
English (original)
Package Name
@ax/sdb

Install messages are received when a logpoint or trigger condition has changed.
An install message has the following syntax:

Scope: <filepath> -> Line:<scopeStart> -> <pouName> - <installState>
   Callpath: <callpath>
   Logpoints:
      Line:<line> Id:<id> - <logpointState>
      ...

\<filepath>
The path to the ST file in which the scope is located at.

\<scopeStart>
The line number where the scope starts. A scope is defined by the 'pouName'.

\<pouName>
The program organization unit (Program, Method, Function, Function block) where the logpoints are located at. When adding a trigger condition it will effect all logpoints in that scope.

\<installState>
The state for the scope defined by 'pouName'. Possible values are: 'Undefined', 'Installed', 'Uninstalled', 'InstallFailed' and 'UninstallFailed'.

When reading values from the PLC all logpoints in one scope/pou are wrapped into one watch item. The 'installState' represents the state of this wrapper. The 'installState' will change to 'Installed' when the first logpoint is added successfully to the scope. The installState will change to 'Uninstalled' as soon as the last logpoint in the scope is removed.

\<callpath>
The active callpath. If no callpath is present, the value will be 'Not set'. Otherwise, it will show the currently active callpath. A callpath is a trigger condition. Logpoints are only updated if the POU item (scope) was called from the given 'callpath'. It effects all logpoints in the scope. The callpath can be set with the watch set command.

\<line>
The line number where the logpoint is located at.

\<id>
The unique identifier of a logpoint. It can be used to remove the logpoint with the watch remove command.

\<logpointState>
The state of the logpoint specified with 'line' and 'id'. Possible values are: 'Undefined', 'Installed', 'Removed'.

When a valid logpoint is added, the 'logpointState' will change to 'Installed'. From that point on, the logpoint will print values to the CLI. When a logpoint is removed via the watch remove command the state changes to 'Uninstalled'.