Debug Settings

To access the per-project simulation script debug settings, click on the “System” entry in the Project Explorer, and look in the Property Editor for the “Debug” Section.

Debug Port

The Debug Port setting controls the network port that this project will use to communicate with the debugging interface.

It defaults to 34009, but different values can be used if required. For example, if you need to debug multiple projects at once on the same machine, they should all use different port values.

The debugging interface will need to use the same port number.

Enable Debugger

Sym3 will start listening for connections on the Debug Port when the simulation starts. To disable this behaviour, uncheck the “Enable Debugger” option. When this is unchecked, you will be unable to debug simulation script.

Extension Workspace Settings

Each workspace should have a launch.json file, located in a .vscode directory that will allow the extension to be configured. When you use the Edit With Visual Studio Code button, one is automatically created for you.

{
	"version": "0.2.0",
	"configurations": [
		{
			"type": "sym3",
			"request": "attach",
			"name": "Local session"
		},
        {
            "type": "sym3",
			"request": "attach",
			"name": "Remote session",
            "port": 32000
            "host": "1.2.3.4"
        }
	]
}

Under the configurations property, you can define a list of “launch configurations”, which are different Debug sessions. A workspace can have multiple configurations. To select which configuration will be launched when you press F5, press Ctrl+P and type >Debug: Select and Start Debugging. This will show a list. Choose an entry to start debugging with that session. The next time you press F5, the last session chosen will be launched.

The properties of the launch configurations are as follows:

Property Type Description
type string The debugger that this configuration is for. For debugging with Sym3, this should always be sym3.
request string The type of debugging session to use. Sym3 only supports attach.
name string The name of the debugging session, for display by VS Code.
port number Default = 34009

The port to connect to Sym3 on.
host string Default = 127.0.0.1

The host to connect to Sym3 on.