Jkuehn at 22:36, 4 March 2025

2025-03-04T22:36:55Z

← Older revision		Revision as of 00:36, 5 March 2025
Line 154:		Line 154:
	[[Category: Manual DMXControl 3]]		[[Category: Manual DMXControl 3]]
	</noinclude>		</noinclude>

			[[de: Kernel_DMXC3]]

Jkuehn at 13:34, 2 March 2025

2025-03-02T13:34:38Z

← Older revision		Revision as of 15:34, 2 March 2025
Line 152:		Line 152:

	<noinclude>		<noinclude>
	[[Category: DMXControl 3 ~~Manual]]~~		[[Category: Manual DMXControl 3]]
	~~[[Category: GUI en DMXC3~~]]
	</noinclude>		</noinclude>

Jkuehn at 15:41, 1 March 2025

2025-03-01T15:41:31Z

← Older revision		Revision as of 17:41, 1 March 2025
Line 1:		Line 1:
	{{Manual Header		{{Manual Header
	\| Type = DMXC3 Main Software		\| Type = DMXC3 Main-Software
	\| Version = 3.3.0}}		\| Version = 3.3.0}}

Jnoetzel: Created page with "{{Manual Header | Type = DMXC3 Main Software | Version = 3.3.0}} The {{Manual Windowcaption|Kernel}} of DMXControl 3 is the part of the software responsible for the actual calculation of all effects and handles communication with the connected interfaces. {{Picture_with_subtitle|DMXC3_Manual Kernel_Window_after_start.png|1|Kernel of DMXControl 3 after startup.|800px}} = Overview = The {{Manual Windowcaption|Kernel}} is responsible for the actual calculation of all eff..."

2025-03-01T14:08:35Z

Created page with "{{Manual Header | Type = DMXC3 Main Software | Version = 3.3.0}} The {{Manual Windowcaption|Kernel}} of DMXControl 3 is the part of the software responsible for the actual calculation of all effects and handles communication with the connected interfaces. {{Picture_with_subtitle|DMXC3_Manual Kernel_Window_after_start.png|1|Kernel of DMXControl 3 after startup.|800px}} = Overview = The {{Manual Windowcaption|Kernel}} is responsible for the actual calculation of all eff..."

New page

{{Manual Header
| Type = DMXC3 Main Software
| Version = 3.3.0}}

The {{Manual Windowcaption|Kernel}} of DMXControl 3 is the part of the software responsible for the actual calculation of all effects and handles communication with the connected interfaces.

{{Picture_with_subtitle|DMXC3_Manual Kernel_Window_after_start.png|1|Kernel of DMXControl 3 after startup.|800px}}

= Overview =
The {{Manual Windowcaption|Kernel}} is responsible for the actual calculation of all effects and communicates with the connected interfaces.

Typically, the kernel operates invisibly in the background for the user when the user interface and the kernel are started together, as is mostly common when using DMXControl 3 on a single PC. However, if desired, the kernel can be displayed using the command {{Manual MenuText|Help|Show Kernel}}. When the user interface is closed, the kernel is also shut down.
{{Manual Box | en | Hint | The kernel must not be terminated at any point while a show is running. If the kernel is ended prematurely, no DMX values will be output anymore, and all changes made to the project up to that point will be lost.}}

= Key Features =
Even though the kernel window offers the option to close it via the exit button, using this button is generally discouraged. The kernel goes through various processes when shutting down, such as terminating active {{Manual Windowcaption|[[Cuelist DMXC3|Cuelists]]}}, disabling the DMX output, and ending communication with the DMX interfaces.
{{Manual Box | en | Hint | To properly shut down and terminate the kernel, enter the command <code>shutdown</code> as a command.}}

= Controls =
The {{Manual Windowcaption|Kernel}} is designed as a console window and therefore does not feature graphical controls. Control of the kernel is thus exclusively managed via command-line parameters.

== Command-Line Parameters ==
The kernel can be queried for more detailed information about its status using the following command-line commands, allowing users to learn more about the kernel's state. Simple tests are also possible. There is no German translation or German command-line parameters available here.

{{Picture_with_subtitle|DMXC3_Manual Kernel_Command_line_parameter.png|2|Command-line parameters of the kernel.|center|800px}}

{| class="wikitable"
|- class="hintergrundfarbe10"
! style="width: 250px;" | Command !! style="width: 500px" | Description !! Example
|- class="hintergrundfarbe11"
| colspan="3" | '''Group 1: Main Menu'''
|-
| <code>shutdown</code> or {{Manual Keyboard|Ctrl|C}} || Terminates the kernel.
|-
| <code>status</code> || Displays status information.
|-
| <code>menu</code> || Access to the control menu.
|-
| <code>clear</code> || Clears the console.
|-
| <code>notification {message}</code> || Sends a notification <code>{message}</code> to all clients. || <code>'''notification''' Please save the project!</code>
|-
| <code>notify {sessionNames} {message}</code> || Sends a notification <code>{message}</code> to selected clients {sessionNames}. || <code>'''notify''' LIGHT-PC1 Please save the project!</code>
|-
| <code>mixerdump</code> || Saves the current mixer information to a log file.
|-
| <code>width {character count}</code> || Sets the console width (number of characters).
|-
| <code>load "{file path}"</code> || Loads a project.
|-
| <code>save "{file path}"</code> || Saves the current project. || <code>'''save''' "C:\Users\Public\Documents\My Project.zip"</code>
|-
| <code>dmxout {DMX channel, value}+</code> || Sets DMX output values.
|-
| <code>dmxin {DMX channel, value}+</code> || Sets DMX input values.
|-
| <code>help</code> || Opens the help menu (also accessible via <code>?</code>).
|- class="hintergrundfarbe11"
| colspan="3" | '''Group 2: Menu'''
|-
| <code>1</code> || Menu for controlling DMX channels.
|-
| <code>2</code> || Menu for controlling RDM functions.
|-
| <code>3</code> || Information about DMX output.
|-
| <code>4</code> || Information about load management (Electricity).
|-
| <code>5</code> || Information about input assignment.
|-
| <code>6</code> || General monitoring information.
|-
| <code>7</code> || Information about available plugins in DMXControl 3.
|-
| <code>8</code> || Information about the Property Value Mixer.
|-
| <code>9</code> || Information about current connections (Sessions).
|-
| <code>10</code> ||
|-
| <code>11</code> || Information about active managers and services.
|}

{{Manual Box | en | Hint | If an entered path contains spaces, quotation marks are mandatory.}}

= Usage =
== Network Communication ==
For the separate operation of the {{Manual Windowcaption|[[GUI DMXC3|User Interface]]}} and the {{Manual Windowcaption|Kernel}} on different PCs to function, the following requirements must be met:
* All components of the DMXC3 network must be able to reach the PC running the kernel. This can be checked using a ping, especially when setting up a more complex configuration.
* To enable communication between components in the DMX3 network, the ports listed below<ref>List of standardized network ports (English): https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers</ref> must be opened in the firewall. Typically, the firewall prompts for this upon the first start and automatically adds them.

{| class="wikitable"
! style="width: 75px;" | Port!! style="width: 75px" | TCP !! style="width: 75px" | UDP || Description
|-
| 17474 || || Unofficial
| DMXControl 3 Network Discovery
|-
| 17475 || colspan=2 | Unofficial
| DMXControl 3 Network Broker
|}

{{Manual Reference |arrow| Further information on working with DMXControl 3 across multiple PCs is described in the article [[Network Concept DMXC3|Network Concept]].}}

== Startup Parameters ==
Startup parameters are typically passed to a shortcut to launch an application. To pass a startup parameter to the kernel, create a new shortcut to the application and adjust the target field in the properties. By default, this field only contains the full path to the application, such as:

{{Manual Filepath|C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Kernel\Lumos.exe}}

It is important that the entire path is enclosed in quotation marks. The permitted startup parameters are appended sequentially after the path to the application, with each keyword preceded by two dashes. For example, to load a specific project directly upon starting the kernel, the full entry would look like this:

{{Manual Filepath|C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Kernel\Lumos.exe" '''--load''' "{PROJECT-ID}#{VERSION}"}}

Following the keyword <code>--load</code>, the internal project ID is provided in quotation marks. Optionally, this can be supplemented with the project version, prefixed with a #. Specifying the project name is not possible.

{{Manual Reference |arrow| Additional notes on setting up an automatic start of DMXControl 3 with the direct loading of a specific project are provided in the article on {{Manual Windowcaption|[[System Configuration DMXC3|System Configuration]]}}.}}
{{Manual Box | en | Hint | The project {{Manual Filepath|{PROJECT-ID}}} is currently only located in the kernel's configuration directory, where projects are centrally stored and managed.}}

Multiple startup parameters are allowed per shortcut, as listed in the table below.

{| class="wikitable"
! style="width: 250px;" | Parameter !! style="width: 500px" | Description !! style="width: 375px" | Example
|-
| <code>--hidden</code> || The kernel runs hidden in the background and is not visible in the taskbar. ||
|-
| <code>--nonetwork</code> || Network functionality remains disabled, so the {{Manual MenuText|Connection}} entry in the main window’s menu bar will not appear in the GUI later. The nonetwork mode can be used when the kernel and GUI operate on the same PC. ||
|-
| <code>--load</code> || By specifying a project ID and optionally a version number, the kernel will load a specific project directly upon startup. || <code>--load "{PROJECT-ID}#{VERSION}"</code>
|}

== Configuration Directory ==
After the kernel is started for the first time, a directory is created in Windows Explorer where various settings are stored. By default, this directory is located at {{Manual Filepath|C:\Users\{USERNAME}\AppData\Roaming\DMXControl Projects e.V\DMXControl\Kernel\Config}}, where {{Manual Filepath|'''{USERNAME}'''}} should be replaced with the name of the current PC user. Alternatively, the directory can be accessed via {{Manual Filepath|%AppData%\Roaming\DMXControl Projects e.V.\Kernel\Config}}.

{| class="wikitable"
! style="width: 250px;" | File !! style="width: 500px" | Description !! style="width: 375px" | Example || Optional
|-
| <code>ApplicationConfig.xml</code> || Contains the general program settings of DMXControl 3. || || {{No}}
|-
| <code>DMXInterfaceConfig.xml</code> || Stores the settings of the integrated DMX interfaces. || || {{No}}
|-
| <code>GoboCorrelations_GPU.csv</code> || Saves the result of the gobo correlation. || || {{No}}
|-
| <code>KernelPluginConfig.xml</code> || Stores the status of plugins. || || {{No}}
|-
| <code>SavedAttachables.xml</code> || This file stores all effects from the Saved Effects tab. || || {{No}}
|-
| <code>Statistics.xml</code> || This file records the runtime of the last 100 sessions and the total sum of output DMX values. || || {{No}}
|}

= Links and References =
== Further Information ==
<references/>

<noinclude>
[[Category: DMXControl 3 Manual]]
[[Category: GUI en DMXC3]]
</noinclude>

Kernel DMXC3 - Revision history

Jkuehn at 22:36, 4 March 2025

Jkuehn at 13:34, 2 March 2025

Jkuehn at 15:41, 1 March 2025