diff options
| -rw-r--r-- | README.md | 38 | ||||
| -rwxr-xr-x | sample_configuration/lock.sh (renamed from opt/lock.sh) | 0 | ||||
| -rw-r--r-- | sample_configuration/pvs2.ini | 175 | ||||
| -rwxr-xr-x | sample_configuration/unlock.sh (renamed from opt/unlock.sh) | 0 |
4 files changed, 212 insertions, 1 deletions
@@ -3,7 +3,43 @@ Pool Video Switch 2 Developer and Integrator documentation ------------------------------------------------------ -### Configuration files +### Configuration File +The configuration file should be saved as `/opt/openslx/pvs2/pvs2.ini`. As this +extension is stateless the same set of files is used by both client and manager. + +A sample configuration can be found in `sample_configuration`. + +#### General settings + +* rooms: list all rooms that should be available to users + +* allowClientQuit: If set to true, users can shut down the client by clicking on + "Quit" in the toolbar of pvsclient. + + +#### Room settings +A room section represents a physical or virtual room where clients are +placed on defined positions. Viable configuration options are: + +MUST: + +* mgrIP: The ip of the instructor's PC + +* client: An array containing all clients and their positions. For the exact + syntax compare with the provided sample configuration + +CAN: + +* backgroundImage: Path to an image file that will be drawn as a background behind the room window + +* gridSize: size of the grid, defaults to minimal size to fit all clients on the + screen + +* clientSize: size of the clients on the grid. In combination with a big grid. + This allows you to create well-detailed room configurations. + +* priority: Important for the auto-connect feature, but also affects the sorting + in the connect window of the client. ### Lock/Unlock Scripts The functionality of PVS client(`pvsclient`) can be extended by providing diff --git a/opt/lock.sh b/sample_configuration/lock.sh index 68cbc40..68cbc40 100755 --- a/opt/lock.sh +++ b/sample_configuration/lock.sh diff --git a/sample_configuration/pvs2.ini b/sample_configuration/pvs2.ini new file mode 100644 index 0000000..b768a4f --- /dev/null +++ b/sample_configuration/pvs2.ini @@ -0,0 +1,175 @@ +; This is a sample configuration file + +; Settings that affect clients in all rooms are placed here +; rooms : list the rooms that should be available in the "Load Room +; Configuration dialog" +; allowClientQuit : If set to true, users can shut down the client by clicking +; on "Quit" in the toolbar of pvsclient. +[General] +rooms=-100, -101, -113, -114 +allowClientQuit=True + +; A room +; mgrIP is the IP of th instructor's PC +; client\size must contain the number of clients +; configure clients as seen below +; +; Optional settings: +; * backgroundImage : path to an image that will be drawn as a background behind the room window +; * gridSize: size of the grid, defaults to minimal size to fit all clients on the screen +; * clientSize: size of the clients on the grid. In combination with a big grid +; allows to create well-detailed room configurations. +[-100] +mgrIP=132.230.8.71 +priority=11 +client\size=16 +client\1\ip=132.230.8.70 +client\1\pos=@Point(1 6) +client\2\ip=132.230.4.157 +client\2\pos=@Point(0 4) +client\3\ip=132.230.4.158 +client\3\pos=@Point(1 4) +client\4\ip=132.230.4.159 +client\4\pos=@Point(3 4) +client\5\ip=132.230.4.160 +client\5\pos=@Point(4 4) +client\6\ip=132.230.4.161 +client\6\pos=@Point(5 4) +client\7\ip=132.230.4.162 +client\7\pos=@Point(0 2) +client\8\ip=132.230.4.163 +client\8\pos=@Point(1 2) +client\9\ip=132.230.4.164 +client\9\pos=@Point(3 2) +client\10\ip=132.230.4.165 +client\10\pos=@Point(4 2) +client\11\ip=132.230.4.166 +client\11\pos=@Point(5 2) +client\12\ip=132.230.4.167 +client\12\pos=@Point(0 0) +client\13\ip=132.230.4.168 +client\13\pos=@Point(1 0) +client\14\ip=132.230.4.169 +client\14\pos=@Point(3 0) +client\15\ip=132.230.4.170 +client\15\pos=@Point(4 0) +client\16\ip=132.230.4.171 +client\16\pos=@Point(5 0) + +[-101] +mgrIP=132.230.4.31 +priority=12 +client\size=16 +client\1\ip=132.230.8.70 +client\1\pos=@Point(4 6) +client\2\ip=132.230.4.141 +client\2\pos=@Point(0 4) +client\3\ip=132.230.4.142 +client\3\pos=@Point(1 4) +client\4\ip=132.230.4.143 +client\4\pos=@Point(2 4) +client\5\ip=132.230.4.144 +client\5\pos=@Point(4 4) +client\6\ip=132.230.4.145 +client\6\pos=@Point(5 4) +client\7\ip=132.230.4.146 +client\7\pos=@Point(0 2) +client\8\ip=132.230.4.147 +client\8\pos=@Point(1 2) +client\9\ip=132.230.4.148 +client\9\pos=@Point(2 2) +client\10\ip=132.230.4.149 +client\10\pos=@Point(4 2) +client\11\ip=132.230.4.150 +client\11\pos=@Point(5 2) +client\12\ip=132.230.8.199 +client\12\pos=@Point(0 0) +client\13\ip=132.230.4.152 +client\13\pos=@Point(1 0) +client\14\ip=132.230.4.153 +client\14\pos=@Point(2 0) +client\15\ip=132.230.4.154 +client\15\pos=@Point(4 0) +client\16\ip=132.230.4.155 +client\16\pos=@Point(5 0) + +[100-101-combo] +mgrIP=132.230.4.30 +priority=4 +client\size=2 +client\1\ip=132.230.8.70 +client\1\pos=@Point(3 3) +client\1\ip=132.230.4.120 +client\1\pos=@Point(6 3) + + +[-113] +mgrIP=132.230.4.30 +priority=15 +client\size=16 +client\1\ip=132.230.8.17 +client\1\pos=@Point(3 3) +client\2\ip=132.230.4.121 +client\2\pos=@Point(6 4) +client\3\ip=132.230.4.122 +client\3\pos=@Point(6 3) +client\4\ip=132.230.4.123 +client\4\pos=@Point(6 2) +client\5\ip=132.230.4.124 +client\5\pos=@Point(6 1) +client\6\ip=132.230.4.125 +client\6\pos=@Point(6 0) +client\7\ip=132.230.4.126 +client\7\pos=@Point(4 0) +client\8\ip=132.230.4.127 +client\8\pos=@Point(4 1) +client\9\ip=132.230.4.128 +client\9\pos=@Point(4 2) +client\10\ip=132.230.4.129 +client\10\pos=@Point(2 0) +client\11\ip=132.230.4.130 +client\11\pos=@Point(2 1) +client\12\ip=130.230.4.131 +client\12\pos=@Point(2 2) +client\13\ip=132.230.4.132 +client\13\pos=@Point(0 0) +client\14\ip=132.230.4.133 +client\14\pos=@Point(0 1) +client\15\ip=132.230.4.134 +client\15\pos=@Point(0 2) +client\16\ip=132.230.4.135 +client\16\pos=@Point(0 3) + +[-114] +mgrIP=132.230.4.33 +backgroundImage=/opt/openslx/pvs2/alps.jpg +client\size=13 +client\1\ip=132.230.8.70 +client\1\pos=@Point(3 5) +client\2\ip=132.230.4.101 +client\2\pos=@Point(5 3) +client\3\ip=132.230.4.102 +client\3\pos=@Point(6 3) +client\4\ip=132.230.4.103 +client\4\pos=@Point(5 4) +client\5\ip=132.230.4.104 +client\5\pos=@Point(5 0) +client\6\ip=132.230.4.105 +client\6\pos=@Point(1 3) +client\7\ip=132.230.4.106 +client\7\pos=@Point(5 1) +client\8\ip=132.230.4.107 +client\8\pos=@Point(1 1) +client\9\ip=132.230.4.108 +client\9\pos=@Point(0 0) +client\10\ip=132.230.4.109 +client\10\pos=@Point(6 0) +client\11\ip=132.230.4.110 +client\11\pos=@Point(0 3) +client\12\ip=132.230.4.111 +client\12\pos=@Point(1 4) +client\13\ip=132.230.4.112 +client\13\pos=@Point(1 0) + +[client_position] +132.230.8.70=@Point(1 0) diff --git a/opt/unlock.sh b/sample_configuration/unlock.sh index f09a2fd..f09a2fd 100755 --- a/opt/unlock.sh +++ b/sample_configuration/unlock.sh |