Commit 3faa2e26 authored by maybites's avatar maybites
Browse files

updated readme with screenshots

parent 68d486f4
......@@ -15,38 +15,63 @@ To install the Telemersive Gateway: clone the gitlab repository into a directory
git clone https://gitlab.zhdk.ch/TPF/tesapp.git
```
### Startup
### Startup for the first time
1. open MaxMSP
2. Go to File > Open.. and navigate to 'TeSApp.maxproj'
3. Inside the new Project Window locate 'TeSApp.maxpat' and double click it
2. Go to File > Open.. and navigate to 'TelemersiveGateway.maxproj'
3. Inside the new Project Window locate 'TelemersiveGateway.maxpat' and double click it
4. You might be confronted with different popup windows mentioning missing dependencies:
* Missing MaxPackages like Spout (on Windows) or Syphon (on OSX) -> simply follow the 'install' button.
* Missing MaxPackages like
![Dependencies](/media/GUI_Dependencies.png "Dependencies")
* Spout (on Windows) or Syphon (on OSX)
* Sadam Libraries
-> simply follow the 'install' button.
* Missing NodeJS Libraries -> the [config] window should be already open > go to tab 'debug' and press 'script npm install'. Once the debug tool turns from blue to green, you are good to go.
![Debug](/media/GUI_Debug.png "Debug")
5. If you want to get videostreams or synchronize your files: set paths to externals > tab 'externals'.
* For enabling videostreams you need to donwload ultragrid and point the app to the ultragrid app.
* For synching files on windows you need to have cygwin installed. During the installation process, make sure you install 'rsync', which is not installed by default. On OSX this is installed by default.
* For enabling videostreams you need to download Ultragrid and point the app to the ultragrid app.
* **Windows only:** For synching files on windows you need to have cygwin installed. During the installation process, make sure you install 'rsync', which is not installed by default. On OSX this is installed by default.
* **Windows only:** If you want to send Mocap data from Motive (Optitrack), you need the NatNet2OSC apps. Motive 2.x will work with NatNet3. If you only want to receive data, there is no need for this external.
![Externals](/media/GUI_Externals.png "Externals")
### Login
![Login](/media/GUI_Login.png "Login")
### login
1. Enter your credentials under the tab 'login'. This infos are confidential and are only provided on a need to know basis.
* Broker URL: e.g. 'telematics.zhdk.com'
* Broker Port: e.g. '1883'
* Broker User: e.g. 'peer'
* Broker Pwd:
* Network Card: If your machine has more than one network card available, you will have to choose which one you want to use.
* press 'connect'
* Router URL: e.g. 'telematics.zhdk.com'
* Router Port: e.g. '1883'
* Router User: e.g. 'peer'
* Router Pwd: e.g. '*******'
2. Network Card: If your machine has more than one network card available, you will have to choose which one you want to use.
3. press 'connect'
If the connection is successful, the red 'disconnect' button gets highlighted and the green 'connect' button greyed-out.
2. Once you are connected, you can either create a room or join an already existing room. In any case, the procedure is the same:
4. Once you are connected, you can now see all the available rooms to join.
5. Enter your room credentials.
* Enter your PeerName
* Select a room from the menu or enter a room name.
* Enter the room password
* press 'join'
If the room you enter doesn't exist, a new room will be created and the password will be set as the room password. The password cannot be changed anymore, only once every peer has left the room, the room manager (a service of the telemersive-router) removes the room and again a new room with the same name but with a new password can be created.
6. press 'join'
If the room join is successful, the red 'leave' button gets highlighted and the green 'join' button greyed-out.
3. press 'save' to save all the credentials for your next login.
7. press 'save' to save all the credentials for your next login. Save also stores your local device settings.
press 'close' to close the [config]-window.
### Closing the app
press the 'quit' button in the upper right corner
![Login](/media/GUI_Quit.png "Login")
You will be presented with a choice:
4. press 'close' to close the [config]-window.
'cancel' will cancel the process.
'No' will quit the app **without** saving the current state.
'Yes' will quit the app **after** saving the current state.
This diff is collapsed.
......@@ -10,7 +10,7 @@
}
,
"classnamespace" : "box",
"rect" : [ 436.0, 276.0, 466.0, 91.0 ],
"rect" : [ 436.0, 276.0, 463.0, 123.0 ],
"bglocked" : 0,
"openinpresentation" : 1,
"default_fontsize" : 12.0,
......@@ -40,6 +40,29 @@
"assistshowspatchername" : 0,
"title" : "Dependencies",
"boxes" : [ {
"box" : {
"args" : [ "@package", "Sadam Library", "@version", "20.3.7" ],
"bgmode" : 0,
"border" : 0,
"clickthrough" : 0,
"enablehscroll" : 0,
"enablevscroll" : 0,
"id" : "obj-1",
"lockeddragscroll" : 0,
"maxclass" : "bpatcher",
"name" : "tg.dep.packageTest.maxpat",
"numinlets" : 1,
"numoutlets" : 1,
"offset" : [ 0.0, 0.0 ],
"outlettype" : [ "int" ],
"patching_rect" : [ 31.0, 182.85714285714289, 440.0, 24.0 ],
"presentation" : 1,
"presentation_rect" : [ 11.0, 78.0, 440.0, 24.0 ],
"viewvisibility" : 1
}
}
, {
"box" : {
"id" : "obj-17",
"maxclass" : "button",
......@@ -47,7 +70,7 @@
"numoutlets" : 1,
"outlettype" : [ "bang" ],
"parameter_enable" : 0,
"patching_rect" : [ 108.0, 228.0, 22.0, 22.0 ]
"patching_rect" : [ 109.5, 263.0, 22.0, 22.0 ]
}
}
......@@ -95,7 +118,7 @@
"maxclass" : "outlet",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 108.0, 263.0, 30.0, 30.0 ]
"patching_rect" : [ 109.5, 298.0, 30.0, 30.0 ]
}
}
......@@ -131,7 +154,7 @@
"numinlets" : 2,
"numoutlets" : 1,
"outlettype" : [ "" ],
"patching_rect" : [ 137.0, 228.0, 33.0, 22.0 ],
"patching_rect" : [ 138.5, 263.0, 33.0, 22.0 ],
"text" : "front"
}
......@@ -143,8 +166,8 @@
"numinlets" : 2,
"numoutlets" : 2,
"outlettype" : [ "bang", "" ],
"patching_rect" : [ 108.0, 198.5, 34.0, 22.0 ],
"text" : "sel 1"
"patching_rect" : [ 109.5, 233.5, 34.0, 22.0 ],
"text" : "sel 2"
}
}
......@@ -170,7 +193,7 @@
"numinlets" : 1,
"numoutlets" : 1,
"outlettype" : [ "bang" ],
"patching_rect" : [ 14.5, 198.5, 60.0, 22.0 ],
"patching_rect" : [ 16.0, 233.5, 60.0, 22.0 ],
"text" : "loadbang"
}
......@@ -183,7 +206,7 @@
"numinlets" : 2,
"numoutlets" : 1,
"outlettype" : [ "" ],
"patching_rect" : [ 14.5, 228.5, 83.0, 49.0 ],
"patching_rect" : [ 16.0, 263.5, 83.0, 49.0 ],
"text" : "window flags nomenu, window exec"
}
......@@ -195,7 +218,7 @@
"numinlets" : 1,
"numoutlets" : 2,
"outlettype" : [ "", "" ],
"patching_rect" : [ 14.5, 299.0, 69.0, 22.0 ],
"patching_rect" : [ 16.0, 334.0, 69.0, 22.0 ],
"save" : [ "#N", "thispatcher", ";", "#Q", "end", ";" ],
"text" : "thispatcher"
}
......@@ -228,6 +251,13 @@
"lines" : [ {
"patchline" : {
"destination" : [ "obj-19", 0 ],
"source" : [ "obj-1", 0 ]
}
}
, {
"patchline" : {
"destination" : [ "obj-1", 0 ],
"source" : [ "obj-12", 0 ]
}
......@@ -321,7 +351,7 @@
],
"dependency_cache" : [ {
"name" : "tg.dep.packageTest.maxpat",
"bootpath" : "~/Arbeiten/01_projekte/181111_IASpace/01_projekte/20xx_Telematik/01_dev/TeSApp/patchers/mockup",
"bootpath" : "~/Arbeiten/01_projekte/181111_IASpace/01_projekte/20xx_Telematik/01_dev/telemersive-gateway/patchers/utils",
"patcherrelativepath" : ".",
"type" : "JSON",
"implicit" : 1
......@@ -349,13 +379,13 @@
, {
"name" : "BlueButton",
"default" : {
"color" : [ 1.0, 1.0, 1.0, 1.0 ],
"centerjust" : [ 2 ],
"fontname" : [ "Courier New" ],
"selectioncolor" : [ 1.0, 1.0, 1.0, 1.0 ],
"accentcolor" : [ 1.0, 1.0, 1.0, 1.0 ],
"elementcolor" : [ 0.640617, 0.64074, 0.640596, 1.0 ],
"bgcolor" : [ 0.160784, 0.733333, 0.980392, 1.0 ],
"elementcolor" : [ 0.640617, 0.64074, 0.640596, 1.0 ]
"color" : [ 1.0, 1.0, 1.0, 1.0 ],
"fontname" : [ "Courier New" ],
"centerjust" : [ 2 ],
"accentcolor" : [ 1.0, 1.0, 1.0, 1.0 ]
}
,
"parentstyle" : "",
......
......@@ -44,16 +44,6 @@
"enabled" : 1,
"includeincollective" : 1
}
,
"1" : {
"bootpath" : "/",
"projectrelativepath" : "../../../../../../../../..",
"label" : "",
"recursive" : 1,
"enabled" : 1,
"includeincollective" : 0
}
}
,
"detailsvisible" : 1,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment