Zynthian GUI start up walkthrou' - Revision history

Jawn: /* SystemD */

2025-06-29T19:55:24Z

SystemD

Jawn: /* X-Windows */

2025-06-29T19:54:50Z

X-Windows

Wyleu: /* create_screens */

2024-01-25T00:56:01Z

create_screens

Wyleu: /* create_screens */

2024-01-24T18:13:58Z

create_screens

Wyleu: /* create_screens */

2024-01-24T18:13:40Z

create_screens

Wyleu: /* create_screens */

2024-01-24T18:13:24Z

create_screens

Wyleu: /* create_screens */

2024-01-24T18:12:55Z

create_screens

Wyleu: /* zyngui */

2024-01-24T18:12:00Z

zyngui

Wyleu: /* zyngui/zynthian_gui.py */

2024-01-24T17:53:27Z

zyngui/zynthian_gui.py

Wyleu: /* Zynthian Objects */

2024-01-24T17:50:35Z

Zynthian Objects

@@ Line 14: / Line 14: @@
 == SystemD ==
-The starting point for any modern linux system is systemd and zynthian makes much use of thus infrastructure. Thus logging is best handled by using journalctl ( journalctl -fu zynthian will give a running report of service start up).
+The starting point for any modern linux system is systemd and zynthian makes much use of this infrastructure. Thus logging is best handled by using journalctl (journalctl -fu zynthian will give a running report of service start up).
 The entry point for the GUI that is managed by zynthian.service is the shell file
 == The Zynthian code entry point ==

@@ Line 10: / Line 10: @@
 From the zynthians perspective it doesn't care it just handles a X-Windows window which provides the interface.
-This means that implementing mice and cursor's into this world is fairly simple and so the GUI can use a mouse simply connected to the Pi's USB port. The Zynthian has a setting to turn a cursor on & off for precisely this reason. The touchscreen is implemented this ways as well. This means that there are various display settings that allow font size and horizontal & vertical screen size to be defined. To cope with this wide range of displays. This has the side effect that screen characteristics need to be considered,so we avoid the cutesy pictures that seem to proliferate on many dedicated hardware devices that have only one screen size to consider. . . ( This is probably a personal gripe...:-) but it's helps to understand this limitation when proposing new features that would require GUI alterations or additions.
+This means that implementing mice and cursors into this world is fairly simple and so the GUI can use a mouse simply connected to the Pi's USB port. The Zynthian has a setting to turn a cursor on & off for precisely this reason. The touchscreen is implemented this ways as well. This means that there are various display settings that allow font size and horizontal & vertical screen size to be defined. To cope with this wide range of displays. This has the side effect that screen characteristics need to be considered, so we avoid the cutesy pictures that seem to proliferate on many dedicated hardware devices that have only one screen size to consider. . . ( This is probably a personal gripe...:-) but it helps to understand this limitation when proposing new features that would require GUI alterations or additions.
 == SystemD ==

@@ Line 125: / Line 125: @@
 |}
-A dictionary called screens is defined and this has string keys that points to the individually defined screen objects that display the appropriate screens is defined.
+A dictionary called screens is defined and this has string keys that points to the individually defined screen objects that display the appropriate screens is defined and the value of the dictionary si set to the instantiated object from the .zyngui modules.
   # Create Core UI Screens
@@ Line 133: / Line 133: @@
   self.screens['confirm'] = zynthian_gui_confirm()
   ....

@@ Line 130: / Line 130: @@
   self.screens['info'] = zynthian_gui_info()
   self.screens['splash'] = zynthian_gui_splash()
   self.screens['loading'] = zynthian_gui_loading()
   self.screens['confirm'] = zynthian_gui_confirm()

@@ Line 130: / Line 130: @@
   self.screens['info'] = zynthian_gui_info()
   self.screens['splash'] = zynthian_gui_splash()
   self.screens['loading'] = zynthian_gui_loading()
   self.screens['confirm'] = zynthian_gui_confirm()

← Older revision		Revision as of 18:12, 24 January 2024
Line 126:		Line 126:

	A dictionary called screens is defined and this has string keys that points to the individually defined screen objects that display the appropriate screens is defined.		A dictionary called screens is defined and this has string keys that points to the individually defined screen objects that display the appropriate screens is defined.
		+
		+	# Create Core UI Screens
		+	self.screens['info'] = zynthian_gui_info()
		+	self.screens['splash'] = zynthian_gui_splash()
		+	self.screens['loading'] = zynthian_gui_loading()
		+	self.screens['confirm'] = zynthian_gui_confirm()

← Older revision		Revision as of 18:12, 24 January 2024
Line 108:		Line 108:

	Then the zynthian_gui Object is defined.		Then the zynthian_gui Object is defined.
		+	==== Functions ====
		+	===== create_screens =====
		+	The zynautoconnector is started which establishes the jack client connection to the Jack Server that does all the actual audio and midi processing, and runs this in it's own thread and handles the locking to ensure components play nice.
		+
		+	The global references for the audio recorder, the mixer and the sequencer are instantiated from there modules
		+	{\| class="wikitable"
		+	\|+ Caption text
		+	\|-
		+	! object !! module !! function
		+	\|-
		+	\| self.audio_recorder \|\| zyngui/zynthian_audio_recorder \|\| Audio Recorder
		+	\|-
		+	\| self.zynmixer \|\| zynthian_engine_audio_mixer \|\| Mixer
		+	\|-
		+	\| self.zynseq \|\| zynlibs/zynseq \|\| Sequencer
		+	\|}
		+
		+	A dictionary called screens is defined and this has string keys that points to the individually defined screen objects that display the appropriate screens is defined.

← Older revision		Revision as of 17:53, 24 January 2024
Line 107:		Line 107:
	It also defines the threads that respond to the various events that occur within the GUI environment and the various devices connected to the zynthian like Keyboards both musical and QWERTY, mice and all manner of MIDI paraphernalia.		It also defines the threads that respond to the various events that occur within the GUI environment and the various devices connected to the zynthian like Keyboards both musical and QWERTY, mice and all manner of MIDI paraphernalia.

−	Then the zynthian_gui Object is defined.	+	Then the zynthian_gui Object is defined.
−
−	~~=== zyngui/zynthian_gui.py ===~~
−
−	~~/home/pi/zynthian-ui/zyngui/zynthian_gui.py~~
−
−	~~This module primarily defines the zynthian_gui class object with a few tkinter helper functions~~
−	~~and this is what actually handles all the GUI interaction and functionality.~~
−
−	~~It's about 3000 lines of code and after all this definition~~
−
−	~~At line 1775 or there abouts we get~~
−
−	* logging.info("STARTING ZYNTHIAN-UI ...")
−	~~Always good to log and use the python logging infrastructure.~~
−	* zynthian_gui_config.zyngui=zyngui=zynthian_gui()
−
−	~~Some name binding for maintaining different names spaces or some possibly more nefereous purpose, before running~~
−	* zyngui.start()
−
−	~~This method of the zynthian_gui class configures the GUI environment ready to start~~.

← Older revision		Revision as of 17:50, 24 January 2024
Line 104:		Line 104:

	Everything from the zynseq to brightness_config including the links to the C libraries that actually do the work as lib_zyncore, the zynengine objects that wrap the audio and MIDI devices and the many components used by the GUI screen.		Everything from the zynseq to brightness_config including the links to the C libraries that actually do the work as lib_zyncore, the zynengine objects that wrap the audio and MIDI devices and the many components used by the GUI screen.
		+
		+	It also defines the threads that respond to the various events that occur within the GUI environment and the various devices connected to the zynthian like Keyboards both musical and QWERTY, mice and all manner of MIDI paraphernalia.

	Then the zynthian_gui Object is defined.		Then the zynthian_gui Object is defined.