Operation Panel Server

The Operation Panel Server provides a way to control SynVisum by Web browser.
Its primary purpose is providing only some selected parameters for an operator at semi-permanent exhibition system.
For example, with some setting template provided, only visitor name or photographs can be altered.
This reduces trouble, as other parameters cannot be altered unnecessarily.

The Operation Panel Server in semi-permanent exhibition system

The Operation Panel Server behaves like HTTP server.
Using HTML form function, only selected parameters can be altered.
It accepts upload of image files and use them.
Not only Mac OSX, but also Windows can be used for an operation computer (we have tested interoperability with Safari and IE (Internet Explorer).
It can generate operation panel HTML file automatically from corresponding SynVisum setting file.
In addition, user provided HTML files with specially designed look and behavior (script) can be used.

How to specify alterable parameters
To specify parameters which are alterable with Web browser, assign OSC (Open Sound Control) as External Control for each parameter.
(Although setting for OSC is utilized, OSC is not used as a communication means.
Also, [ Use OSC… ] is not necessary.
In the figure below, SynVisum setting and corresponding Operation Panel HTML Page generated by the server and rendered in Safari are shown.
Not only altering parameters, but also triggering scenes and monitoring output image are also possible.
(To use scene triggering feature, specify [ OSC ] in Scene Control…)

File and Folder Structure

Server Folder
To use the Operation Panel Server, first it is required to specify a [ Server Folder ].
In this [ Server Folder ] (and sub folders contained in it), place files that can be retrieved by Web browser.
(files outside of the Server Folder are never retrieved)
This is a [ root ] directory for Web browser access.
Upload Folder
The [ Upload ] folder is created automatically in the specified [ Server Folder ].
In this folder, files (of image, etc.) uploaded from Web browser are saved.
(other folders are never altered)
SynVisum Setting File
When the Operation Panel Server receives a request from a Web browser to get a HTML page (file with extension [ .html ] or [ .htm ]), it checks whether a [ SynVisum Setting File ] (with extension [ .svm ]) with same name exist in the same folder.
For example, using a Web browser, trying to get a page at address [ http://xxx.xxx.xxx.xxx/patternA.html ] results a request for [ /patternA.html ] to the Operation Panel Server.
(where xxx.xxx.xxx.xxx means IP address of a computer running SynVisum Operation Panel Server)
Then the Operation Panel Server checks a file [ patternA.svm ] in its [ root ] directory (that is, specified [ Server Folder ]).
- If such file exists, it loads the setting file and behave (display) as SynVisum.
  At this point, other settings are closed automatically.
- If not, specified file is returned as is (if any).
Operation Panel File (HTML File)
If [ SynVisum Setting File ] is loaded as described above, the server returns corresponding [ Operation Panel File ].
[ Operation Panel File ] is a HTML file describing parameters.
The server checks whether a HTML file with same name as [ SynVisum Setting File ] loaded exist in the same folder (that is, originally requested file).
- If such file exists, the server returns the file as is.
- It not, the server generates an Operation Panel File automatically and returns it.

Operation Panel Server Settings

TCP Port
Normally, HTTP server uses TCP port number [ 80 ].
But under normal usage, this port number cannot be used, because it requires SynVisum to run as special privileged user (root).
Instead, specify other port number available.
In this case, it is required to append this port number to IP address when access from Web browser.
IP address must be followed by a colon (:) and port number.
(example. http://192.168.0.4:51000/patternA.html)
Server Folder
See above.
Password
If a password is set here, it is required to enter same password when access from Web browser.
Once authenticated, password is not required for the same computer (IP address), until SynVisum quits.
(Note that Web browsers can save/reuse password)
[ User ID ] is not used, so it is not necessary to enter in Web browser.
Monitor Image Size
The server can provide Web browser with still images (snapshots) of SynVisum video output.
This specifies maximum side (horizontal or vertical) length of the image.
(Note that Output Adjust is not applied for this monitor image)
Open Files with Same Name
When the server loads [ SynVisum Setting File ] as described above, it also opens other files with same name in the same folder.
(excluding files with extension [ .svm ] [ .html ] [ .htm ])
(for security reason, files in the [ Upload Folder ] are never opened)

For example, putting a DoctorMX Cue Sheet File (extension [ .dmq ]) along side, both video and lighting can be selected together.

At this point, if DoctorMX is hidden (Hide), windows of DoctorMX can be kept appearing on screen.
[ Hide ] state of DoctorMX can be set in [ Startup Items ] of User Account control panel.

Auto Panel Generation
Following settings are used for automatic generation of Operation Panel page.
(not applicable for user provided HTML file)

Monitor Image
Uses monitoring image of SynVisum video output.
Numeric Setting
Uses numeric setting for quantity parameters (integer, real number).
Slider
Uses slider control for quantity parameters (integer, real number).
Upload Image File
Allows to upload image files from Web browser for image input parameters.
Uploaded files are stored into [ Upload Folder ] in the [ Server Folder ] (see above).
Select Uploaded File
Allows to select a image file in the [ Upload Folder ] for image input parameters.

With both [ Upload Image File ] and [ Delete All Uploaded Files ] disabled, it restricts an operator to select a file from provided set in the [ Upload Folder ].
Delete All Uploaded Files
Allows to delete all files in the [ Upload Folder ].
(deletes even if a file is not actually uploaded)
Go Homepage
Put a link to [ /index.html ] at the bottom of operation pages (regardless of its existence).
For example, it is possible to provide a custom homepage ( /index.html ) which contains some links to settings, and let the server generate operation page for each setting.

Notes About Auto Generated Operation Page

At this time, we have checked interoperability with Safari (4.0.4) of Mac OSX and IE8 (Internet Explorer) of Windows.
(not behave correctly with FireFox)
Scenes without name are not included in a page.
For string parameters, line breaks are also used as value.
This prevents a return key from confirming entry.
To confirm entry, remove keyboard focus by clicking space in a page, for example.
The page shows parameter name and OSC address for each setting.
It may be difficult to distinguish parameters with same name.
This may be improved by assigning appropriate OSC address.
Note that characters usable in OSC address are specified as part of ASCII.
Parameter value display is updated about once per second.
It includes a link to style sheet file [ svpanel.css ] in the same folder.
It is possible to customize design to some degree with this feature.

Example of customized design
It is possible to save an operation panel page source by Web browser, and modify it partially.

Notes About Operation

Select appropriate option for [ External Control and Scene Memory ].
Altering parameters from Web browser is [ External Control ].
Specifically, if personal name (string parameter) or photograph are altered, [ Switch to External ] or [ External Only ] seems appropriate.
Append TCP port number to IP address when access from Web browser (see above).
For ease of use, save address as icon or register as bookmark.

If both requested HTML file and corresponding [ SynVisum Setting File ] are absent, the server returns information about running SynVisum.
It includes product serial number and registered name.

Both single product package and single User Registraion is required per single "running" computer.
It is required to purchase product packages and User Registrations as many as computers running at a time, even if, for example, they are used for exhibition.

Security Consideration

Files outside of the [ Server Folder ] are never retrieved by Web browser (HTTP).
Note that it is possible to select a file outside of the [ Server Folder ] for an image input parameter, and that image will be displayed by SynVisum.
Except the [ Upload Folder ], no file nor folder is altered by Web browser (HTTP).
Even if [ Open Files with Same Name ] option is enabled, files in the [ Upload Folder ] are never opened.
Even if password is required, once authenticated, password is not required for the same computer (IP address), until SynVisum quits.
(Note that Web browsers can save/reuse password)