Zynthian Webconf debug with Visual Studio Code (VSC) - Revision history

Jawn: /* Visual Studio Code Configure. */

2025-09-24T09:21:32Z

Visual Studio Code Configure.

Jawn: /* Visual Studio Code Configure. */

2025-09-24T09:20:41Z

Visual Studio Code Configure.

Wyleu: /* Running the Debugger */

2022-02-15T16:01:38Z

Running the Debugger

Riban: Adds how to configure and connect via ssh

2022-02-09T07:45:52Z

Adds how to configure and connect via ssh

Riban: Minor gramatical corrections (only read first few paragraphs)

2022-02-09T06:43:12Z

Minor gramatical corrections (only read first few paragraphs)

Wyleu: /* The ssh connection */

2022-01-12T18:29:40Z

The ssh connection

Wyleu: /* The ssh connection */

2022-01-12T18:28:52Z

The ssh connection

Wyleu: /* The ssh connection */

2022-01-12T18:28:26Z

The ssh connection

Wyleu: /* The ssh connection */

2022-01-12T18:27:43Z

The ssh connection

Wyleu: /* The ssh connection */

2022-01-12T18:27:20Z

The ssh connection

@@ Line 73: / Line 73: @@
 [[File:Vsc-remote explorer password.png|thumb|center|800px]]
-Once VSC has established a connection, it will download the appropriate python components to the zynthian to allow debugging to take place remotely. This make take some time and als o may complain about missing components, giv it some time it will get here if it possibly can....
+Once VSC has established a connection, it will download the appropriate python components to the zynthian to allow debugging to take place remotely. This make take some time and also may complain about missing components, give it some time it will get here if it possibly can....
 [[File:Vsc setting up remote server.png|thumb|center|800px]]

@@ Line 62: / Line 62: @@
 [[File:Vsc_remote_explorer_dialog.png|thumb|center|800px]]
-We enter the details for our specific zynthian machine.  Zynthian runs as root (atm). It always has done so make sure you put root in here. Many hours can be blissfully wile'd away wondering why you can see a machine you'vee loggged into as the wrong user.
+We enter the details for our specific zynthian machine.  Zynthian runs as root (atm). It always has done so make sure you put root in here. Many hours can be blissfully wile'd away wondering why you can see a machine you've logged into as the wrong user.
 [[File:Vsc remote explorer zynthian-orig.png|thumb|center|800px]]

@@ Line 103: / Line 103: @@
 == Running the Debugger ==
-[[File:Vsc start debugging.png|thumb|center]]
+Once you have a specific module in focus you can run the debugger within that module. In this case zynthian_webconf.py ( The module that runs the webconf implementation). We are going to watch MIDI signals being acknowledged in the webconf display.
-[[File:Vsc remote installing.png|thumb|center]]
+[[File:Vsc start debugging.png|800px|center]]
-[[File:Vsc debug selection.png|thumb|center]]
+Make sure you have the python debugger extension loaded. This is done via the Cog in the lower left corner and selecting Extensions. Search on Python in the dialog and you should see a similar list to that below. It's a Microsoft component so it's efficacy is established. Select nd it will load it's self, It's pretty good at doing this but do give it some time to complete...
-[[File:Vsc already in use.png|thumb|center]]
+[[File:Vsc remote installing.png|800px|center]]
 == Turning off Running Webconf instance ==

← Older revision		Revision as of 07:45, 9 February 2022
Line 14:		Line 14:

	== The ssh connection ==		== The ssh connection ==
		+
		+	To configure SSH connection to the Zynthian:
		+
		+	* Click on the green icon at the bottom left of VSC (tooltip: Open a Remote Window) or F1 then type "Connect to host"
		+	* Select "Connect to host..."
		+	* Select "+ Add New SSH Host..."
		+	* Enter "ssh root@zynthian.local" (use the hostname or IP address of your Zynthian)
		+	* Select "/home/<username>/.ssh/config" to store this configuration in your ssh file (may differ on non *nix systems)
		+
		+	To connect to Zynthian:
		+
		+	* Click on the green icon at the bottom left of VSC (tooltip: Open a Remote Window) or F1 then type "Connect to host"
		+	* Select the entry for the previously configured host, e.g. "zynthian.local"
		+	* Enter password

	The addition of the remote component adds the Remote Explorer element		The addition of the remote component adds the Remote Explorer element

@@ Line 1: / Line 1: @@
 == Debugging Webconf with Visual Studio Code ==
-This is presented as an example of how a Visual Studio Code can be used to examine a component of the zynthian sub system as it runs using the Visual studio Code extensions, python & remote-ssh.
+This is presented as an example of how Visual Studio Code (VSC) can be used to examine a component of the Zynthian sub system as it runs using the Visual Studio Code extensions: '''Python''' & '''Remote-SSH'''.
-These are loaded using the cog dialog at the bottom of the vsc code page.
+These are loaded using the cog dialog at the bottom of the Visual Studio Code page.
 [[File:Vsc_extentions_detail.png|thumb|center ]]
-Once you have these components added you can attempt to log onto an existing Zynthian from your PC, MAC, or linux machine, just so long as it's capable of running Visual Studio Code. In my own case I have it running on a 64 bit Raspbian instance, and I had to build it from source to get it running which is a degree of proof of the overall flexibility of what is after all a Microsoft product!
+Once you have these components added you can attempt to log onto an existing Zynthian from your PC, MAC, or Linux machine, just so long as it's capable of running Visual Studio Code. In my own case I have it running on a 64-bit Raspbian instance and I had to build it from source to get it running which is a degree of proof of the overall flexibility of what is after all, a Microsoft product!
 I also tend to add the git-graph extension.
@@ Line 18: / Line 18: @@
 [[File:Vsc_remote_explorer_section.png|thumb|center]]
-I already have a couple of remote zynthians in the machine and VSC is pretty tenacious at hanging onto remote instances it knows about. But we will try to add a new machine.
+I already have a couple of remote Zynthians in the machine and VSC is pretty tenacious at hanging onto remote instances it knows about. But we will try to add a new machine.
-I have a zynthian called zynthian-orig.local. It's actually a genuine zynthian product running a Pi3 and no membrane switches and some fairly simplistic interface. Indeed it has to be disassembled to change the ssd. Such were the early days.!
+I have a Zynthian called zynthian-orig.local. It's actually a genuine Zynthian product running a Pi3 and no membrane switches and some fairly simplistic interface. Indeed it has to be disassembled to change the ssd. Such were the early days.!
 The fact that one can run this debug against the modern code is a sign of great overall consistancy.
@@ Line 28: / Line 28: @@
 == Visual Studio Code Configure. ==
-Firstly we need to add the extensions.
+First we need to add the extensions.
 [[File:Vsc_extensions.png|thumb|center|800px]]

← Older revision		Revision as of 18:29, 12 January 2022
Line 21:		Line 21:

	I have a zynthian called zynthian-orig.local. It's actually a genuine zynthian product running a Pi3 and no membrane switches and some fairly simplistic interface. Indeed it has to be disassembled to change the ssd. Such were the early days.!		I have a zynthian called zynthian-orig.local. It's actually a genuine zynthian product running a Pi3 and no membrane switches and some fairly simplistic interface. Indeed it has to be disassembled to change the ssd. Such were the early days.!
		+
		+	The fact that one can run this debug against the modern code is a sign of great overall consistancy.

	[[File:Zynthian-orig.local.png\|center\|500px\|Zynthian-orig.local]]		[[File:Zynthian-orig.local.png\|center\|500px\|Zynthian-orig.local]]

@@ Line 22: / Line 22: @@
 I have a zynthian called zynthian-orig.local. It's actually a genuine zynthian product running a Pi3 and no membrane switches and some fairly simplistic interface. Indeed it has to be disassembled to change the ssd. Such were the early days.!
-[[File:Zynthian-orig.local.png|frame|center|200px|Zynthian-orig.local]]
+[[File:Zynthian-orig.local.png|center|500px|Zynthian-orig.local]]
 == Visual Studio Code Configure. ==