eyeUNIFY.ctrl

 

Usage

This chapter describes the usage of eyeUNIFY.ctrl.

Login

Opening the eyeUNIFY.ctrl website for the first time a login screen appears:
Login
Enter your username and password and click “Login”. This username and password must be configured as an security domain in the wildfly server. See eyeUNIFY.core documentation to learn more about security domains.
There are several errors that can occur during the login:

  • Wrong username/password: Check your username and password again.
  • Error while connecting server: Check if eyeUNIFY.core is running and configured correctly. If eyeUNIFY.core and eyeUNIFY.ctrl are running on different servers, see Connecting to a remote eyeUNIFY.core

The user interface of eyeUNIFY.ctrl

After you successfully logged in the empty user interface of eyeUNIFY.ctrl is showing up:
User interface

  1. Wall area: The selected wall or screen will be displayed here.
  2. Source area: Sources and layouts will be displayed here.
  3. Layouts tab: Lists all available layouts.
  4. Sources tab: Lists all available sources.
  5. Side menu switch: Opens the side menu.
  6. Wall select box: All walls and displays will be available here.
  7. Setup button: Opens the setup menu.
  8. User button: Opens the user menu.
  9. Search box: provides a global search.

Open a new window

Select a channel from the source area by clicking it. Then open it witch a second click on the wall area.

Create a new Layout

Layouts are groups of channels that can be resized and moved. To save a layout, first open the channels you want to group on the wall area then click the “+” on the layout tab. Enter a name and click “Ok”.

Fast close mode

This mode allows to close several windows relay easy by clicking it.

Close all

This function closes all open windows from the current selected wall.
Open the side menu, there open the “close windows” menu and click “close all”.

Wall select box

The wall select box lists all walls and screens (other than those that are used in other a wall). Select the wall or screen you want to work on.

Global search

Searches for walls, screens ,sources and channels. Enter a keyword and select the result you want to use.

Setup

This chapter describes the Setup of eyeUNIFY via eyeUNIFY.ctrl.

Add a new Device

Open the setup menu by clicking the gear-wheel and select the device menu on the left side. Here you will find four text boxes:

  • Address: URL to the UnifyDevice service of the device (typical “http://<IP or Hostname>:8081/UnifyDevice”)
  • Name: Optional name for the new device (if not set a default name will be generated).
  • User: User for the device (if the device is password protected).
  • Password: Password for the device (if the device is password protected).

Click “add” to add a new device. After the device is added successful, it will appear in the device list:
Demo Device

If you click on “Deploy” the device creates all its screens and sources automatically.

See eyeUNIFY.exec documentation to learn more about password protected devices.

Add a new Source

Open the setup dialog, select the “source” menu and click “add” to add a new source. Enter a name for the source and an optional description. Each source can have an unlimited number of channels. To add a channel to your source, select the channel type and click “+”. The flowing types are supported:

RTSP

This channel type is used to display IP-Streams (for example cameras).
RTSP channels have the following properties:

  • Description: Description for the channel (will be displayed in the UI).
  • URL: URL of the video stream.
  • User: User for the stream (if required).
  • Password: Password for the stream (if required).

VNC

Use this channel type, if you want to display a VNC client.

  • Description: Description for the channel (will be displayed in the UI).
  • Address: IP-Address or Hostname of the VNC server.
  • Port: Port of the VNC server
  • Password: Password of the VNC server (if required)

RGB

Displays inputs from Datapath capture cards. Devices that have those channels will create them automatically.

  • Description: Description for the channel (will be displayed in the UI).
  • RGB channels: id of the channel

Simple executable

This channel type opens a locally installed software.

  • Description: Description for the channel (will be displayed in the UI).
  • Path: Path to the executable.

Create a new wall

Open the setup menu, select the “Walls” tab and click “add” to create a new wall.
Enter a name for your new wall and select the grid size you want to use (the grid size will not be saved). You will find a list of screens on the right side and a gray rectangle on the left side. Select a screen by clicking it, then place it in the gray rectangle with a second click. Repeat this action with all screens that you want to use on your wall.
Click “OK” to save the wall.

Edit a screen

Note: Screens can not be created in eyeUNIFY.ctrl, they are automatically created when adding devices.

Open the setup menu, select the “Screens” tab and click the “Edit” button next to the screen you want to edit.
Screens have three properties:

  • Name: Name for the screen (will be displayed in wall select drop down).
  • Width: Number of sub screens in width.
  • Height: Number of sub screens in height.

Advanced configuration

This chapter describes the advanced configuration and usage of eyeUNIFY.ctrl.

Configure Preview

eyeUNIFY.ctrl provides a preview function which allows you to define a screenshot for each channel to improve the identification.

To use this function, you need to configure a directory to save the images to first. Open the management page of the wildfly server then open the menu “Deployments“. Select the “eyeUNIFY.ctrl“ module, click “En/Disable“ and confirm the message.

Open the file “eyeUNIFYctrl.properties“ from the working directory of the Wildfly server (depending on your configuration, this file can be found either directly in the installation directory of the Wildfly server or in the subdirectory “bin”). Change the option “PreviewLocation” to the directory where the images should be saved (Special characters must be escaped. For example “\\” instead of “\”).

After this save changes and reactivate the “eyeUNIFY.ctrl” module.

The Nagios client

eyeUNIFY.ctrl comes with a Nagios client which allows you to display your existing Nagios system in eyeUNIFY.ctrl.

This feature requires a Nagios Core 4.0.7 or newer.

Open the management page of the wildfly server then open the menu “Deployments“. Select the “eyeUNIFY.ctrl“ module and click “En/Disable“ and confirm the message. Open the file “eyeUNIFYctrl.properties“ from the working directory of the Wildfly server (depending on your configuration, this file can be found either directly in the installation directory of the Wildfly server or in the subdirectory “bin”). Add the following three lines:

  • NagiosURL=URL to your Nagios system for example: “http://192.168.1.5/nagios/”.
  • NagiosUser=User for Nagios.
  • NagiosPw=Password for the user.

After all changes are made and the file has been saved, reactivate the eyeUNIFY.ctrl module. Now you can find the Nagios client in the setup menu in eyeUNIFY.ctrl under the “system status” entry.

Connecting to a remote eyeUNIFY.core

If eyeUNIFY.core and eyeUNIFY.ctrl are running on different servers, it is necessary to change the configuration of eyeUNIFY.ctrl.

Before you change these settings, the eyeUNIFY.ctrl module must be disabled. Therefore connect to the administration page of the Wildfly server an open the menu “Deployments”. Select the module “eyeUNIFYctrl”, click “En/Disable” and confirm the message.

Open the file “eyeUNIFYctrl.properties” from the working directory of the Wildfly server (depending on your configuration, this file can be found either directly in the installation directory of the Wildfly server or in the sub directory “bin“). The following options in this file must be edited:

  • ServerHost: Name or IP address of the server which is running eyeUNIFY.core.
  • SubscriptionAddress: Name or IP address of the server which is running eyeUNIFY.ctrl.

After all changes have been performed and the file has been saved reactivate the eyeUNIFY.ctrl on the administration page of the Wildfly.