Difference between revisions of "Lesson 1 Tut3"

From English DMXC-Wiki
Jump to navigation Jump to search
(47 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Hauptüberschrift
+
{{Maintitle
 
| logo = Im-aim.png
 
| logo = Im-aim.png
| ueberschrift = First Steps: {{PAGENAME}}
+
| maintitle = First Steps: {{PAGENAME}}
 +
}}
 +
{{NavigationTop-Tut3
 +
| LinkForwards = Lesson_2_Tut3
 +
| TextForwards  = Lesson 2
 
}}
 
}}
 
{{DMXC3_lesson/en}}
 
 
 
!!! to do: DMXControl Treffen 2012 - move kernel commands into appendix
 
 
  
 
==Overview==
 
==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 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.
+
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.  
 
+
<br><br>
 
 
 
==Lecture: Installation and Configuration==
 
==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 provides a distributed architecture, i.e. there is a kernel that  can communicate with several clients. The kernel runs basically on  Windows operating system, but can also be launched on Linux (with Mono).
+
{{BoxAttention
 +
|Text=DMXControl 3 is in the beta phase. Therefore, there may be unforeseen responses or error messages. In addition, some features are not yet fully mature and DMXControl 3 still does not offer the functionality that provides DMXControl 2. Therefore DMXControl 3 is in its current state is not intended for productive use as long the beta test is running!
 +
}}
  
One or multiple clients can be started on different  systems (Windows, iOS, Android). 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!
+
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.
 
 
The separation of server and clients provides some 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
 
  
 +
''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:<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===
 
===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 "Lumos.exe" (hint: in the beta version you have to start the kernel as administrator when you have used the standard installation).
+
{{BoxHint
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.
+
| Text=In the beta version you have to start the kernel as administrator when you used the standard installation.
 +
}}
  
[[File:DMXC3L01 kernel.JPG|600px]]
+
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.
  
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.
+
{{Picture_with_subtitle|DMXC3L01 kernel.JPG|2|Kernel window with miscellaneous information|center|600px}}
  
The kernel provides a command shell. By typing "help" you get an overview about all supported commands.
+
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.
  
[[File:DMXC3L01 konsole.JPG|600px]]
+
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}}
  
 +
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 see [[Appendix 2]].
+
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}}
  
===The client===
+
If you have installed a firewall you have to grant the communication between client and server(pic.5).
  
In  next step you should start the Windows based GUI client (currently  called "LumosGUI.exe"). This client will be explained in next lectures.  At first you have to select the Menu "Connection-->Connect" in order to  connect with the server.
+
{{Picture_with_subtitle|DMXC3_Tutorial_Lektion1_Firewall.png|5|Firewall setup|center|700px}}
  
 +
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.
  
[[File:DMXC3L01 connect.JPG]]
+
{{BoxHint
 
+
|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.'''
If you have installed a firewall you have to grant the communication between client and server.
+
}}
 
+
<br>
 
 
[[File:DMXC3L01 startGUI.JPG|600px]]
 
 
 
After establishing the connection you should see a small icon in the lower  line of the client indicating the existing connection.
 
 
 
Now  you are able to load your project. DMXControl will provide a default  demo project. You can open it with menue point "Project".
 
 
 
 
===Project Management===
 
===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 Project -> 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 Project -> 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\"
+
The name of current project is indicated in the top line of DMXControl window.
 
+
<br><br>
 
+
==Exercise==
'''topics to be added (by beta testers)'''
 
* how to save a project
 
*
 
 
 
==Excercise==
 
 
 
 
1) Please try following commands in command shell:
 
1) Please try following commands in command shell:
* menue
+
* menu
 
* status
 
* status
 
* shutdown -> uups!  
 
* shutdown -> uups!  
 +
<br>
 +
2) Restart kernel and GUI and connect your client ("DMXControl 3 GUI") with DMXControl server.
  
2) Restart kernel and GUI and connect your client with DMXControl server.
+
3) 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!
 
Congratulation! Now you have successfully installed your own DMXControl configuration!
 
+
<br><br>
 
 
 
==Assumptions for installation==
 
==Assumptions for installation==
 
+
DMXControl 3.0 requires following software to be installed:
DMXControl 3.0 requires following software to be installed before executing the setup program:
 
  
 
* DirectX 9.0c
 
* DirectX 9.0c
Line 91: Line 102:
 
* XNA Framework 3.0(xnafx30_redist.msi)
 
* 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==
 
==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/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=333325fd-ae52-4e35-b531-508d977d32a6 .NET Framework 3.5]
Line 98: Line 112:
 
#  [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)
 
#  [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)
  
==Known Issues==
+
{{NavigationTop-Tut3
 
+
| LinkForwards = Lesson_2_Tut3
===GUI Elements display glitches===
+
| TextForwards  = Lesson 2
This could look like shown below:
+
}}
Also if you move windows it happens that thay are not displayed correct.
 
 
 
[[File:Dmxc_3_menu_errors.jpg]]
 
 
 
This can occur if you have a NVidia graphics card and use an old driver version.
 
 
 
I experienced this issue with a GeForce G 103M Driver Version 258.96 + PhysX 09.10.0513 on Windows XP x86_64.
 
 
 
Consider updating the driver to the latest version. Version 266.58 + PhysX 09.10.0514 is known to work.
 
 
 
==Certificate==
 
I have understood the topics of this lecture and want to continue with next course:
 
[[Lesson 2]]
 
 
 
 
 
[[de:Lektion 1]]
 
[[en:Lesson 1]]
 
 
 
 
__NOTOC__
 
__NOTOC__
 
__NOTITLE__
 
__NOTITLE__
 +
[[de:Lektion_1_Tut3]]
 +
[[Category: Tutorials DMXControl 3]]

Revision as of 20:34, 21 May 2013

[[File:{{{Logo}}}|48px|link=]] {{{Pagetitle}}}
Lesson 2 Arrow forw.png
table of content

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
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.


 Attention DMXControl 3 is in the beta phase. Therefore, there may be unforeseen responses or error messages. In addition, some features are not yet fully mature and DMXControl 3 still does not offer the functionality that provides DMXControl 2. Therefore DMXControl 3 is in its current state is not intended for productive use as long the beta test is running!


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).


 Important Hint In the beta version you have to start the kernel as administrator when you 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.


Picture 2: Kernel window with miscellaneous information
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
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
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
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.


 Important Hint 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)


 Important Hint 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

  1. DirectX 9.0c
  2. .NET Framework 3.5
  3. .NET Framework 3.5 Service Pack 1
  4. XNA Framework 3.0 (Has to be installed even if a higher version of XNA framework is already installed)
Lesson 2 Arrow forw.png
table of content

__NOTITLE__