eyeUNIFY.link

Description

 

eyeUNIFY.link is an interface to connect to the eyeUNIFY.core.  For instance it permits third party devices like media control systems to remotely control the entire wall management.  Therefore the program provides a multithreaded socket server and a serial connector to access it on the one side and a web service client infrastructure to transmit the commands to the core on the other side. The program is written in Java and thus works on multiple platforms. Since the link is intended to run as a service, there is no GUI included.

 

Getting started

 

 

System requirements

As aforementioned for platform independence the UNIFYlink is written in Java. Therefore as only premise to run the program, a Java Runtime Environment (JRE) has to be installed on your machine. The JRE should be version 8 update 66 or newer (java version “1.8.0_66”).

Configuration

eyeUNIFYcore

Set up the parameters for the connection to the eyeUNIFY.core in UNIFYlink/Properties/eyeUNIFYcoreConfig.properties.

  • ServerHost: The IP of the machine running the eyeUNIFY.core
  • User: The username to log in
  • Password: The password associated to the user

Socket server

Set up the configuration for the socket server in UNIFYlink/Properties/SocksetServerConfig.properties.

  • StartServer: ‘1’ to enable the server, ‘0’ to disable it (if a serial connection only is needed)
  • EndChar: The character signalizing the end of a command:  “None”, CR, LF, CR/LF, NULL, “;”, “:”
  • Emulateconsole: ‘1’ to activate prompting, ‘0’ to deactivate it
  • Port: The port that the socket server shall listen to

Serial connection

Set up the configuration for the serial connection in UNIFYlink/Properties/SerialConnectionConfig.properties

  • StartSerial: ‘1’ to enable it, ‘0’ to disable ist (if a socket server only is needed)
  • Port:  The serial port to connect to the UNIFY.link
    Windows:  COM1, COM2,…
    Linux:  /dev/ttyS0,  /dev/ttyS1,…
  • Endchar: (a character signalizing the end of a command):  “None”, CR, LF, CR/LF, NULL, “;”, “:”
  • Emulate:  ‘1’ to activate prompting, ‘0’ to deactivate it
  • Baudrate/Parity/Start-, Stopbits/Databits: have to match the corresponding configuration on theother endpoint

Running on Windows

Direct employment

  • Set up the properties files (see 3.2 Configuration)
  • Execute ‘StartLinkDirect.exe’ to run the program in a command prompt.
  • The first three output-lines will show you if all connections were successfully established.
  • To end the program, simply close the command prompt

Running as service

  • Install the eyeUNIFYlink (see 3.2.2 Installation and usage)
  • Start the Windows specific ‘services’ program:
  • Look for ‘services’ in Windows search and start it.
  • Search for ‘UNIFYlink’ in the services’ user interface and select it
  • Now you can start the service by clicking the ‘start’ button
  • Also here you can adapt the service to your own needs (right-click -> Properties)
    (e.g. change the startup type to ‘automatic’ so that UNIFYlink is started with our system)

Uninstall

  • Execute ‘Remove_UNIFYlink.exe’ as administrator to remove all files from your machine and fully stop and detach the service functionality.

 

Installation and usage

  • Set up the properties files (see 3.2 Configuration)
  • Execute ‘Install_UNIFYlink.exe’ as administrator (right-click the file and choose ’run as administrator’). This will copy all needed files to your ‘Programs’ folder.
  • From now on the only file you need to start the program is ‘StartLink.exe’ (will run it in a command prompt). You can imagine it as a shortcut and place it anywhere you like.

Changing the Settings

  • Change the settings in your properties-files (see 3.1 Configuration)
  • For direct usage execute ‘StartLinkDirect.exe’ to start the server using the new properties.
  • For installed/service version execute ‘Install_UNIFYlink.exe’ as administrator again to save the adaptions to the properties.
  • Make sure all instances of the UNIFYlink are inactive while installing it.

Running on Linux

Direct employment

  • Set up the properties files (see 3.2 Configuration)
  • Open a terminal (ctrl+alt+t)
  • Change the directory to the UNIFYlink folder (e.g. ‘cd Downloads/UNIFYlink’)
  • Switch to root user and set the file permissions for ‘StartUNIFYlink.sh using ‘chmod’. Afterwards the file can be executed:
    sudo su 
    chmod +x StartUNIFYlink.sh 
    sh StartUNIFYlink.sh
  • To end the program simply close the terminal or press ctrl+c to get back to the terminal window

Installation

  • Set up the properties files (see 3.2 Configuration)
  • Open a terminal (Ctrl+alt+t)
  • Change the directory to the UNIFYlink folder (e.g. ‘cd Downloads/UNIFYlink’)
  • Switch to root user and set the file permissions for ‘installUNIFYlink.sh’ using chmod and start the installation:
     sudo su
     chmod +x install UNIFYlink.sh
     sh installUNIFYlink.sh
  • This will copy all needed files to your system and automatically set the program up as linux daemon that will be launched at system start.

Usage

The handling of the service depends on the starter the system uses to launch system daemons.
In our case there are two different versions – Upstart and systemd.

  • For systems using systemd (ab Ubuntu 15.04, Debian 8, Fedora 15, openSUSU 12.1, etc.), the daemon can be controlled with the following commands:
Start service: sudo systemctl start UNIFYlink
Stop service: sudo systemctl stop UNIFYlink
Get status, PID and log: sudo systemctl status UNIFYlink
Restart service: sudo systemctl restart UNIFYlink
Enable auto boot: sudo systemctl enable UNIFYlink
Disable auto boot: sudo systemctl disable UNIFYlink
  • For systems using Upstart (anterior versions to the distributions mentioned before)the daemon can be controlled with the following commands:
Start service: sudo service UNIFYlink start
Stop service: sudo service UNIFYlink stop
Get status and PID: sudo service UNIFYlink status
Restart service: sudo service UNIFYlink restart

Changing the settings

  • Change the settings in your properties files (see Configuration)
  • For direct usage run StartUNIFYlink.sh to start the link using the new properties.
  • For the installed/daemon version run installUNIFYlink.sh again as root user. Make sure the service is disabled while installing the new changes. Afterwards the service can be launched afresh with the adapted settings.

Uninstall

  • Open a terminal (ctrl+alt+t)
  • Change the directory to the UNIFYlink folder (e.g. ‘cd Downloads/UNIFYlink’)
  • Perform the following commands to remove the program’s files and daemon scripts from your machine:
     sudo su
     chmod +x removeUNIFYlink.sh
     sh removeUNIFYlink.sh