Lesson 1 Tut3: Difference between revisions

Latest revision as of 22:18, 5 February 2019

[[File:{{{Logo}}}\|48px\|link=]]	{{{Pagetitle}}}

Lesson 2

table of content
Lesson 1: Installation and configuration Lesson 2: The Panel concept of DMXControl 3 GUI Lesson 3: The Project Explorer Lesson 4: The Stage view Lesson 5: Device properties and its control Lesson 6: Configuration of output plugins Lesson 7: Summary and some more details of setup Lesson 8: Cues and cue lists Lesson 9: Fanning, Chasers and other effects Lesson 10: The Programmer view	Lesson 11: Triggers in cue lists Lesson 12: Edit of cues and cue lists Lesson 13: Presets Lesson 14: Summary and details - Programming Lesson 15: Executors and use of cue lists Lesson 16: Softdesk Lesson 17: Audio analyser Lesson 18: Multimedia Support Lesson 19: Other DMX Clients Lesson 20: Create new device definitions	Lesson 21: Summary and details for Execution Lesson 22: Input Assignment Lesson 23: Create a RGB Matrix Lesson 24: Transfer DMX values via ArtNet to DMXControl 2 Appendix 1: Commands and Shortcuts Appendix 2: Tips for Testing and behaviot in error case

Overview

Because the operating concept changed completely compared to DMXControl 2 it is necessary to nearly start all over again for the use of DMXControl 3. These lessons will help you to become familiar with this concept and provide you the skills necessary for the basic characteristics of the new user interface. First of a small glimpse of what is waiting for you (pic.1):

Picture 1: A selection of some windows of DMXControl 3

This lesson is an introduction to the distributed architecture of DMXControl 3.0. You will learn some facts about the client and server communication and how to operate the kernel.

Lecture: Installation and Configuration

DMXControl 3 is installed with the help of a setup wizard. It verifies that the required software is installed on the PC (see below) and offers to install it if necessary. Optionally, EasyView (a visualizer) can be selected.

DMXControl 3.0 consists of two programs. One acts as server, the other one as client. The server (hereafter referred to as kernel) manages all information related to the project, such as the list of lighting instruments, and the cue list, etc. The kernel runs on the Windows operating system, but can also be launched on Linux (with Mono). The client acts as an interface between the server and the user.

Advanced note; One or more clients can run on several systems (PCs) in parallel. This structure enables you to work in teams for building and performing your show. DMXControl 3.0 also supports cooperation during the life cycle, i.e. you can execute scene lists during someone else is still programming the missing cues!

The separation of the server and the client has following advantages:

if the client (user interface) fails, the kernel (server) continues including sending DMX output
several users can share the kernel to work in a team
kernel and user interface could run on different computers

The kernel

At first, lets start the kernel that is the DMXControl server. Currently this application is called "DMXControl 3 Kernel" or "Lumos.exe" (pic.2).

In future a default user don't have to be aware about the kernel process. It will be automatically started with DMXControl and is (hopefully) continuously running.

Picture 2: Kernel window with miscellaneous information

During the start-up process of the kernel you can observe what is loaded by DMXControl. The kernel is the central master of all information about devices, cues, projects etc. that can be accessed by the clients. And it provides the DMX mixer engine and output system.

The kernel provides a command shell (pic.3). By typing "help" you get an overview about all supported commands.

Picture 3: Kernel window with command shell "help" overview

Here are a few command line options to get more detailed information about the status of the kernel:

shutdown: Ends the kernel
status: Displays status information
menu: menu-access control?
clear: Clears the console
notification xxx: Sends a notification to all clients
width xxx: Specifies the width of the console (number of characters)
load xxx: Loading a project
save xxx: Saves the current project
dmxout [channel, val] +: Sets DMX Out Values
DMXin [channel, val] +: Sets DMX In Values
help: help menu (also accessible via '?')

For further details on menu and status see Appendix 2.

The client / user interface

In the next step you should start the windows-based user interface (currently called "DMXControl 3 GUI" or LumosGUI.exe"), which is located in the sub-folder "GUI" in the program directory. This client is explained in more detail in the next lessons. First, however, the communication between kernel and client is initiated automatically. When you start the client a connection window opens. You can also select the Menu Connection-->Connect in order to connect with the server. In the lower right corner of the DMXControl window there is a small blue/grey server-icon that shows a small cross in red if no connection exists. The connection window also opens if you click on that icon (pic.4).

Picture 4: Lumos GUI "Connect to DMXControl Server" window

If you have installed a firewall you have to grant the communication between client and server(pic.5).

Picture 5: Firewall setup

After establishing the connection you should see a small blue icon in the lower line of the DMXControl main window indicating the existing connection. A red cross indicates that the connection failed.

If you execute the "LumosGUI.exe" with the parameter "-nonetwork", the kernel will automatically start up a client and connect it directly to the kernel. Thereby you do not have to connect the client manually and the system is ready to go. After installation you will find an entry in your start-menu called "DMXControl 3". This option includes this parameter.

Project Management

To start a new project, choose File => New Project. If you want to save the current project, click on File => Save Project or File => Save Project As.... All project files are saved in a zip-file. You can load saved files with File => Load Project.

The name of current project is indicated in the top line of DMXControl window.

Exercise

1) Please try following commands in command shell:

menu
status
shutdown -> uups!

2) Restart kernel and GUI and connect your client ("DMXControl 3 GUI") with DMXControl server.

3) Try it: exit your DMXControl GUI by task manager and start again: The kernel continues running.

Congratulation! Now you have successfully installed your own DMXControl configuration!

Assumptions for installation

DMXControl 3.0 requires following software to be installed:

DirectX 9.0c
.NET Framework 3.5 SP1 or higher
XNA Framework 3.0(xnafx30_redist.msi)

In the GUI folder, there is a program called GraphicalView.exe. With this program, you can check your system for compatibility with DMXControl 3. It contains a test scene.

Additional links and references

DirectX 9.0c
.NET Framework 3.5
.NET Framework 3.5 Service Pack 1
XNA Framework 3.0 (Has to be installed even if a higher version of XNA framework is already installed)

Lesson 2

table of content
Lesson 1: Installation and configuration Lesson 2: The Panel concept of DMXControl 3 GUI Lesson 3: The Project Explorer Lesson 4: The Stage view Lesson 5: Device properties and its control Lesson 6: Configuration of output plugins Lesson 7: Summary and some more details of setup Lesson 8: Cues and cue lists Lesson 9: Fanning, Chasers and other effects Lesson 10: The Programmer view	Lesson 11: Triggers in cue lists Lesson 12: Edit of cues and cue lists Lesson 13: Presets Lesson 14: Summary and details - Programming Lesson 15: Executors and use of cue lists Lesson 16: Softdesk Lesson 17: Audio analyser Lesson 18: Multimedia Support Lesson 19: Other DMX Clients Lesson 20: Create new device definitions	Lesson 21: Summary and details for Execution Lesson 22: Input Assignment Lesson 23: Create a RGB Matrix Lesson 24: Transfer DMX values via ArtNet to DMXControl 2 Appendix 1: Commands and Shortcuts Appendix 2: Tips for Testing and behaviot in error case

@@ Line 1: / Line 1: @@
-{{Hauptüberschrift
+{{Maintitle
 | logo = Im-aim.png
-| ueberschrift = Erste Schritte: {{PAGENAME}}
+| maintitle = First Steps: {{PAGENAME}}
 }}
 {{NavigationTop-Tut3
-| hoch = [[Tutorials DMXControl 3|Inhaltsverzeichnis]]
+| LinkForwards = Lesson_2_Tut3
-| vorLink = Lesson_2_Tut3
+| TextForwards  = Lesson 2
-| vorText = Lesson 2
 }}
-{{DMXC3_lesson/en}}
 ==Overview==
+Because the operating concept changed completely compared to DMXControl 2 it is necessary to nearly start all over again for the use of DMXControl 3. These lessons will help you to become familiar with this concept and provide you the skills necessary for the basic characteristics of the new user interface. First of a small glimpse of what is waiting for you (pic.1):
+{{Picture_with_subtitle|DMXC3 Overview.jpg|1|A selection of some windows of DMXControl 3|center|600px}}
+This lesson is an introduction to the distributed architecture of DMXControl 3.0. You will learn some facts about the client and server communication and how to operate the kernel.
-Because of changed operating concept compared to DMXControl 2 a fundamental rethink in the use of DMXControl 3 is necessary. These lessons will help you to become familiar with this concept and provide the skills necessary on the basic characteristics of the new user interface. Here at the beginning a preview as a taste of what awaits you:
+<br><br>
-[[File:DMXC3 Overview.jpg]]
-This lecture introduces into the distributed architecture of DMXControl 3.0. You will learn some facts about the client and server communication and how to operate the kernel.
 ==Lecture: Installation and Configuration==
+DMXControl 3 is installed with the help of a setup wizard. It verifies that the required software is installed on the PC (see below) and offers to install it if necessary. Optionally, EasyView (a visualizer) can be selected.
+DMXControl 3.0 consists of two programs. One acts as server, the other one as client. The server (hereafter referred to as kernel) manages all information related to the project, such as the list of lighting instruments, and the cue list, etc. The kernel runs on the Windows operating system, but can also be launched on Linux (with Mono). The client acts as an interface between the server and the user.
-DMXControl 3 is installed via a setup wizard. It verifies that the required software is installed on the PC (see below) and offers to install it if necessary. Optionally, as with the installation of  DMXControl 2 EasyView can be selected.
+''Advanced note; One or more clients can run on several systems (PCs) in parallel. This structure enables you to work in teams for building and performing your show. DMXControl 3.0 also supports cooperation during the life cycle, i.e. you can execute scene lists during someone else is still programming the missing cues!
-DMXControl  3.0 provides a distributed architecture, i.e. there is a server that can communicate with several clients. The server (hereinafter referred to as kernel) manages all information related to the project. The kernel runs basically on  Windows operating system, but can also be launched on Linux (with Mono).
-The client is a Windows program.  The client provides the interface between the server and the user. One or more clients can be run on several systems (PCs). This structure allows you to work in teams during the setup and the show scene where lists can be played even while a mate is still working on the show.
-Thus, you can even work in teams for  implementing and performing your show. DMXControl 3.0 supports also  cooperation during the life cycle, i.e. you can execute scene lists  during your mate is still programming the missing cues!
-The separation of the server and the client brings the following benefits:
-* the kernel continues in case of malfunction in the user interface and continues DMX output
-* several users can share the kernel to work in a team
-* kernel and user interface could run on different computers
+''The separation of the server and the client has following advantages:<br />
+* ''if the client (user interface) fails, the kernel (server) continues including sending DMX output
+* ''several users can share the kernel to work in a team
+* ''kernel and user interface could run on different computers
+<br>
 ===The kernel===
+At first, lets start the kernel that is the DMXControl server. Currently this application is called "DMXControl 3 Kernel" or "Lumos.exe" (pic.2).
-At  first, lets start the kernel, i.e. the DMXControl server. Currently this application is called "DMXControl 3 Kernel" or "Lumos.exe" (hint: in the beta version you  have to start the kernel as administrator when you have used the standard installation).
 In future a default user don't have to be aware about the kernel process. It will be automatically started with DMXControl and is (hopefully) continuously running.
-[[File:DMXC3L01 kernel.JPG|600px]]
+{{Picture_with_subtitle|DMXC3L01 kernel.JPG|2|Kernel window with miscellaneous information|center|600px}}
-During  launching the kernel you can observe what is loaded by DMXControl. The  kernel is the central master of all information about devices, cues,  projects etc. that can be accessed by the clients. And it provides the DMX mixer engine and output system.
-The kernel provides a command shell. By typing "help" you get an overview about all supported commands.
-During the boot process you can see what everything is loaded DMXControl. The kernel is the central point for all information about devices, scenes, projects, etc. can be accessed by all clients on that.The kernel provides a command-line interface. The keyword can help you can print a list of all possible commands.
-[[File:DMXC3L01 konsole.JPG|600px]]
-Here are a few command line options to get more detailed information about the status of the kernel:     shutdown: Ends the kernel     status: Displays status information     menu: menu-access control?     clear: Clears the console     xxx notification: Sends a notification to all clients     xxx width: Specifies the width of the console fixed (number of characters)     xxx load: Loading a project     xxx save: Saves the current project     dmxout [channel, val] +: Sets DMX Out Values     DMXin [channel, val] +: Sets DMX In Values     help: help menu (also accessible via '?')
-For further details see [[Appendix 2]].
-===The client===
-In  next step you should start the Windows based GUI client (currently  called "DMXControl 3 GUI" or LumosGUI.exe"). This client will be explained in next lectures.  At first a connection between client and server is initiated. You can also select the Menu "Connection-->Connect" in order to  connect with the server.
+During the start-up process of the kernel you can observe what is loaded by DMXControl. The kernel is the central master of all information about devices, cues, projects etc. that can be accessed by the clients. And it provides the DMX mixer engine and output system.
-In the next step you should use the Windows-based user interface (called LumosGUI.exe) start, which in the subfolder "GUI" is located in the program directory. This program is explained in more detail in the next lessons.First, however, the communication between kernel and client initiated. When you start the client automatically a connection window opens. But you can also later on the Connection menu -> Open Connect this window. In the lower right corner of the window DMXControl is a small monitor icon that has a red cross when there is no connection to the server. A click on the icon will open the Connection window.
+The kernel provides a command shell (pic.3). By typing "help" you get an overview about all supported commands.
+<br>
+{{Picture_with_subtitle|DMXC3L01 konsole.JPG|3|Kernel window with command shell "help" overview|center|600px}}
-[[File:DMXC3L01 connect.JPG]]
+Here are a few command line options to get more detailed information about the status of the kernel:
+*shutdown: Ends the kernel
+*status: Displays status information
+*menu: menu-access control?
+*clear: Clears the console
+*notification xxx: Sends a notification to all clients
+*width xxx: Specifies the width of the console (number of characters)
+*load xxx: Loading a project
+*save xxx: Saves the current project
+*dmxout [channel, val] +: Sets DMX Out Values
+*DMXin [channel, val] +: Sets DMX In Values
+*help: help menu (also accessible via '?')
-If you have installed a firewall you have to grant the communication between client and server.
+For further details on ''menu'' and ''status'' see Appendix 2.
+<br><br>
+===The client / user interface===
+In the next step you should start the windows-based user interface (currently called "DMXControl 3 GUI" or LumosGUI.exe"), which is located in the sub-folder "GUI" in the program directory. This client is explained in more detail in the next lessons.
+First, however, the communication between kernel and client is initiated automatically. When you start the client a connection window opens. You can also select the Menu ''Connection-->Connect'' in order to connect with the server. In the lower right corner of the DMXControl window there is a small blue/grey server-icon that shows a small cross in red if no connection exists. The connection window also opens if you click on that icon (pic.4).
+{{Picture_with_subtitle|DMXC3L01 connect.JPG|4|Lumos GUI "Connect to DMXControl Server" window|center|500px}}
-[[File:700px-DMXC3 Tutorial Lektion1 Firewall.png|600px]]
+If you have installed a firewall you have to grant the communication between client and server(pic.5).
-After  establishing the connection you should see a small blue icon in the lower line of the client indicating the existing connection. A red cross indicates that the connection failed.
+{{Picture_with_subtitle|DMXC3_Tutorial_Lektion1_Firewall.png|5|Firewall setup|center|700px}}
-Now  you are able to load your project. DMXControl will provide a default  demo project. You can open it with menue point "Project".
+After  establishing the connection you should see a small blue icon in the lower line of the DMXControl main window indicating the existing connection. A red cross indicates that the connection failed.
-{{BoxHinweis
+{{BoxHint
-|Text=If you program the "Lumos.exe" when running the parameter "-nonetwork" are relaying, the kernel will boot automatically mitgestartet a client and connected directly to the kernel. This is you and you avoid the manual and connect the system to the start ready to go. From the Start menu when you install a link is generated that passes these parameters at startup. The link is called "DMXControl 3".
+|Text=If you execute the "LumosGUI.exe" with the parameter "-nonetwork", the kernel will automatically start up a client and connect it directly to the kernel. Thereby you do not have to connect the client manually and the system is ready to go. '''After installation you will find an entry in your start-menu called "DMXControl 3". This option includes this parameter.'''
 }}
+<br>
 ===Project Management===
+To start a new project, choose '''File => New  Project'''. If you want to save the current project, click on '''File => Save Project''' or '''File => Save Project As...'''. All project files are saved in a zip-file. You can load saved files with '''File => Load Project'''.
-You  can save a project as a default project. If you use '''File -> New  Project''', DMXControl will load your default project, which can be a  project you already patched your fixtures. To save a project as a  default project, goto '''File -> Save Project''' as, type the name  "DefaultProject" and save it to the ressources folder of the kernel  "\path\to\your\DMXControl 3.0\Kernel\Ressources\". All project files are archived in a zip-file.
+The name of current project is indicated in the top line of DMXControl window.
+<br><br>
+==Exercise==
-==Excercise==
 ) Please try following commands in command shell:
-* menue
+* menu
 * status
 * shutdown -> uups!
+<br>
 ) Restart kernel and GUI and connect your client ("DMXControl 3 GUI") with DMXControl server.
-) Try it: Shut up your DMXControl GUI by task manager and start again: The kernel continues running.
+) Try it: exit your DMXControl GUI by task manager and start again: The kernel continues running.
+<br><br>
 Congratulation! Now you have successfully installed your own DMXControl configuration!
+<br><br>
 ==Assumptions for installation==
 DMXControl 3.0 requires following software to be installed:
@@ Line 108: / Line 94: @@
 * XNA Framework 3.0(xnafx30_redist.msi)
+{{BoxHint
+|Text = In the GUI folder, there is a program called '''GraphicalView.exe'''. With this program, you can check your system for compatibility with DMXControl 3. It contains a test scene.
+}}
+<br>
 ==Additional links and references==
 # [http://www.microsoft.com/DOWNLOADS/details.aspx?familyid=9226A611-62FE-4F61-ABA1-914185249413&displaylang=de DirectX 9.0c]
 # [http://www.microsoft.com/downloads/de-de/details.aspx?FamilyID=333325fd-ae52-4e35-b531-508d977d32a6 .NET Framework 3.5]
 # [http://www.microsoft.com/downloads/de-de/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7 .NET Framework 3.5 Service Pack 1]
 #  [http://www.microsoft.com/downloads/details.aspx?FamilyID=6521d889-5414-49b8-ab32-e3fff05a4c50&displaylang=en  XNA Framework 3.0] (Has to be installed even if a higher version of XNA  framework is already installed)
-==Certificate==
-I have understood the topics of this lecture and want to continue with next course:
-[[Lesson 2]]
 {{NavigationTop-Tut3
-| hoch = [[Tutorials DMXControl 3|Inhaltsverzeichnis]]
+| LinkForwards = Lesson_2_Tut3
-| vorLink = Lesson_2_Tut3
+| TextForwards  = Lesson 2
-| vorText = Lesson 2
 }}
-[[Kategorie: DMXControl 3]]
-[[de:Lektion 1]]
-[[en:Lesson 1]]
 __NOTOC__
 __NOTITLE__
+[[de:Lektion_1_Tut3]]
+[[Category: Tutorials DMXControl 3]]