584
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − '''Debugging Webconf with Visual Studio Code'''+ Line 13:
Line 13: − '''The ssh connection''' + Line 22:
Line 22: − + + + Line 36:
Line 38: − + + + + + + Line 94:
Line 101: − + Line 100:
Line 107: − + + − + − − + − + + + + + + + + + − [[File:Vsc debug line 132.png|thumb|center]]+ + − +
Zynthian Webconf debug with Visual Studio Code (VSC) (view source)
Revision as of 18:29, 12 January 2022
, 18:29, 12 January 2022→The ssh connection
== 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 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.
[[File:Vsc_git_graph.png|thumb|center|Zynthian git graph]]
[[File:Vsc_git_graph.png|thumb|center|Zynthian git graph]]
== The ssh connection ==
The addition of the remote component adds the Remote Explorer element
The addition of the remote component adds the Remote Explorer element
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.!
[[File:Zynthian-orig.local.png|frame|center|Zynthian-orig.local]]
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]]
== Visual Studio Code Configure. ==
== Visual Studio Code Configure. ==
[[File:Zynthian-sys-security.png|thumb |center|800px]]
[[File:Zynthian-sys-security.png|thumb |center|800px]]
To access this we press on the + button against the appropriate machine. ( images a little awry here )
To access this we press on the + button against the appropriate machine. Visual Studio Code keeps and manages accurate records on the ssh connections you have made. It's handling of details down to the passwords and such and it's overall willingness to just do stuff as you would expect.
[[File:Vsc_remote_explorer_add_new.png|thumb|center|800px]]
[[File:Vsc_remote_explorer_add_new.png|thumb|center|800px]]
The -A option...?
-A Enable forwarding of the authentication agent connection.
[[File:Vsc_remote_explorer_dialog.png|thumb|center|800px]]
[[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.
[[File:Vsc remote explorer zynthian-orig.png|thumb|center|800px]]
[[File:Vsc remote explorer zynthian-orig.png|thumb|center|800px]]
We run the debugger,
We run the debugger,
[[File:Vsc address already in use with stop.png|thumb|center]]
[[File:Vsc address already in use with stop.png|thumb|center|800px]]
Error!!
Error!!
but there is already a process running that has grabbed the port 80. It's the zynthian-webconf instance that is started by the raspberry pi when it starts up by systemd and this will need to be stopped to allow us to run our own instance....
but there is already a process running that has grabbed the port 80. It's the zynthian-webconf instance that is started by the raspberry pi when it starts up by systemd and this will need to be stopped to allow us to run our own instance....
So we use the terminal to generate a command line prompt and shout at systemd to turn oof the running instance
So we use the terminal to generate a command line prompt and shout at systemd to turn of the running instance
<big>systemctl stop zynthian-webconf</big>
<big>systemctl stop zynthian-webconf</big>
[[File:Vsc stop webconf systemd.png|thumb|center|800px]]
[[File:Vsc stop webconf systemd.png|thumb|center]]
And look it's no longer running!!!
And look it's no longer running!!!
[[File:Zynthian dead webconf.png|thumb|center]]
[[File:Zynthian dead webconf.png|thumb|center|800px]]
== Running the debugger in anger ... ==
== Running the debugger in anger ... ==
[[File:Zynthian-orig running midi.png|thumb|center]]
So leaving with the zynthian-webconf.py module highlighted start the debugger as before.
And then go and open the lib/midi_log_handler.py page once the web server is running and highlight the line 132 by pressing to the left of the line number
a red circle should appear. . .
[[File:Vsc debug line 132.png|thumb|center|800px]]
Then select the midi log page within webconf and play some midi . . . .
[[File:Zynthian-orig running midi.png|thumb|center|800px]]
The program will halt on the debug line 132, and you should be able to operate the debugger transport controls and all the nice debug tools that will display and set values.
The following shows it after step over has been pressed twice. . .
[[File:Vsc debug stepover.png|thumb|center]]
[[File:Vsc debug stepover.png|thumb|center|800px]]