You are on page 1of 54

INSTALLATION AND

CONFIGURATION MANUAL
Version 1.6 - October 2020
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

Disclaimer
This manual and the information contained herein are the sole property of EVS Broadcast
Equipment SA and/or its affiliates (EVS) and are provided “as is” without any expressed or
implied warranties, including, but not limited to, the implied warranties of merchantability
and fitness for a particular purpose. In particular, EVS makes no warranty regarding the
use or the consequences of use of this manual and the information contained herein.
Furthermore, EVS may not be held liable for any direct or indirect, incidental, punitive or
consequential loss, damage, cost or expense of any kind whatsoever and howsoever
resulting from the normal or abnormal use of this manual and the information contained
herein, even if advised of the possibility of such loss, damage, cost or expense.
While every effort has been made to ensure that the information contained in this manual
is accurate, up-to-date and reliable, EVS cannot be held liable for inaccuracies or errors
that may appear in this publication. The information in this manual is furnished for
informational purpose and use only and subject to change without notice.
This manual cancels and replaces any previous versions thereof.

Copyright
Copyright © 2003-2020 EVS Broadcast Equipment SA. All rights reserved.
This manual may not be reproduced, transcribed, stored (in a database or a retrieval
system), translated into any language, computer language, transmitted in any form or by
any means – electronically, mechanically, printed, photocopied, optically, manually or
otherwise – in whole or in part without the prior written consent of EVS.

Trademarks
All product and brand names are registered trademarks and trademarks of EVS or of their
respective owners.

Improvement Requests
Your comments will help us improve the quality of the user documentation. Please send
improvement requests, or report any error or inaccuracy on this user manual by e-mail to
doc@evs.com.

Regional Contacts
You will find the full list of addresses and phone numbers on the following webpage:
http://www.evs.com/contact.

I
EVS Broadcast Equipment SA 1.6.B - October 2020

User Manuals on EVS Website


The latest version of the user manual, if any, and other user manuals on EVS products can
be found at the EVS download center, on the following webpage:
https://www.evs.com/en/download-area.

II
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

Table of Contents
TABLE OF CONTENTS III

WHAT'S NEW? V

1. PRODUCT OVERVIEW 1
1.1. Description 1
1.2. Setup 1

2. REQUIREMENTS 2
2.1. Network Requirements 2
2.2. Other Technical Requirements 2

3. INSTALLATION 1
3.1. First Install 1
3.2. Upgrade 5

4. CABLING 8
4.1. Cabling the SDI Connectors 8
4.2. Securing the SDI Cables 9
4.3. Connecting the Video Monitors 10
4.4. Connecting the Beplay Remote and External Controller 11
4.5. DisplayPort Cable Warning 11
4.6. Connecting the BFE Tally Box 11

5. CONFIGURATION 14
5.1. Changing the Server's Management IP Address and Hostname 14
5.2. Arranging the Displays and Setting the Display Resolution 16
5.3. Mapping the Touchscreens 17
5.4. Managing the X-One Licenses 18
5.4.1. License Manager 18
5.5. Customizing the Beplay Remote Controls 20
5.6. Customizing the External Controller 21

6. MONITORING AND SUPPORT 24


6.1. Services Management Tool 24
6.2. Dashboard Page 25
6.3. Health Page 26

Table of Contents III


EVS Broadcast Equipment SA 1.6.B - October 2020

6.4. Postgres Page 28


6.4.1. Stat Activity Tab 28
6.4.2. Backups Tab 28
6.4.3. Replication Tab 29
6.5. Metrics Page 30
6.5.1. SDI Tab 30
6.5.2. Sx Storage Tab 32
6.5.3. Sys. Stats. Tab 32
6.5.4. Temperature Tab 37
6.6. Docker Page 38
6.6.1. Services Page 38
6.6.2. Info Tab 38
6.6.3. Disk Usage Tab 39
6.7. Versions Page 40
6.7.1. Content Tab 40
6.7.2. RPMS Tab 40
6.7.3. LivePamCore Tab 41
6.7.4. Docker Images Tab 41
6.8. Consulting System Log Files and Crash Dumps 42

IV Table of Contents
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

What's New?
In the Installation and Configuration Manual the icon has been added on the left
margin to highlight information on updated features.
The changes linked to new features in version 1.6 do not result in any modifications to this
manual.

What's New? V
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

1. Product Overview

1.1. Description
X-One is an all-in-one system that combines the industry-leading speed and reliability of
EVS technology with a foundation of software-defined technology to deliver a smart, live
production system for small and mid-sized events.
The X-One system can ingest up to six camera feeds and allows you to import other
media files.
With its adaptable interface, X-One puts all of the capabilities of a control room in the
hands of a single operator. The operator can edit live feed with a built-in video switcher,
create replays, control audio, and even add graphics to live programming—all controlled
from the solution’s intuitive touch-screen—and output in the highest broadcast-standard
quality.
X-One is based on a client/server architecture that guarantees the highest level of
flexibility and scalability.

1.2. Setup

1. Product Overview 1
EVS Broadcast Equipment SA 1.6.B - October 2020

2. Requirements

2.1. Network Requirements


The X-One client workstation and the X-One server hardware need to be connected by a 1
Gbps link. This link can go through a switch or a direct connection.

Type of Link
The type of link to use depends on the distance between the client and server:
• When the distance between the client and the server hardware is smaller than 80m, a
standard Cat 6 network cable is enough.
• When the distance is greater than 80, the connection must go over a fiber link.
This can be achieved by extending the Cat 6 cable with fiber media converters, or by
ordering the SFP+ Fiber option on the client and/or the server.

2.2. Other Technical Requirements

Recommendations When Working with Extenders


It can happen that extenders are used for the screen, keyboard, mouse and BEPlay.
The USB extenders used for the keyboard and mouse must support HID devices (USB
HID class).
The USB extenders used for the touch screen(s) and BEPlay must be USB 2.0 extenders.
It is important to respect the manufacturer’s recommendation in terms of distances
between the machine and USB device and grade of cable.

Recommendations When Working with Two Screens


When working with 2 screens, both screens must be:
• the same resolution;
• either 2 touch screens or 2 non-touch screens.

2 2. Requirements
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

3. Installation

3.1. First Install

Installation Requirements
To be able to install X-One for the first time, the following requirements should be fulfilled:
• X-One hardware (Server or Client (PMF-1U-5),
• 1 USB key 16 GB or higher (by preference USB 3.0),

Preparing the USB Key


1. Connect the USB key to a Windows 7/10 machine.
If the USB key is not empty, please format it.
2. Launch the Rufus utility using the following link:
https://github.com/pbatard/rufus/releases/download/v2.11/rufu
s-2.11p.exe
3. In the Device field, select your USB key.

4. Click the Click to Select an Image...  button (CD icon).

3. Installation 1
EVS Broadcast Equipment SA 1.6.B - October 2020

5. Select the X-One image file.

The ISO file should have been shared with you: xone_1.6.iso evs-mikefly_server-
1.6.iso.
6. Click Start.
You are prompted to select the appropriate write mode.

WARNING
If this dialog box does not appear, then you should copy the .iso file on your
local machine. Also, if you are using a laptop with a docking station, pay
attention not to plug the USB key into the docking station. Use an USB port
from the laptop instead.

7. Select the option Write in DD Image mode and click OK.

2 3. Installation
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

You will be notified that all data already on the USB drive will be overwritten.

8. Click OK to continue.
Wait until the ISO file has been completely written to the USB key. This may last 30
minutes depending on the USB key you are using.

Installing X-One
1. Connect the USB key to the server.
Warning: only this USB key should be connected to the machine.
2. Reboot the server.
3. Press F11 to enter the Boot menu.
4. If you're asked to enter a password: evsdvb.
5. Select your USB key as boot device.
6. From the EVS Production menu, select the desired installation package and press
ENTER:
◦ X-One Server 1.6 - CentOS 7.5 1804 or
◦ X-One Client 1.6 - CentOS 7.5 1804
◦ MikeFly Server 1.6 - CentOS 7.5 1804
7. Wait until you see the message "Installation complete. Please return to quit", then
press ENTER. Do not remove the USB key.
The server will reboot.
8. From the EVS Production menu, select Start Operating System and press ENTER.
9. Press ENTER when you are prompted to start the operating system again.
10. Enter the serial number of the server and press ENTER.
You can find the serial number at the back of your machine.

3. Installation 3
EVS Broadcast Equipment SA 1.6.B - October 2020

End of the Installation


At the end of the installation, the following message is displayed: '[EVS] System is
configured. Press ENTER to reboot.'

End of the Installation


Do one of the following:
• If failed=0, remove your USB key and press ENTER.
• If failed=1, please do the following:
◦ Take a picture of the screen.
◦ Double-click the ShowLogs icon on the desktop to view the latest system log
files.
◦ Double-click the GetLogs icon on the desktop to export the system log files.
If the GetLogs icon is not available check the following file:
◦ contact EVS support.
• After a few seconds, please see the Services Management tool:
http://<ipxone>:9081 to check if everything is ok on the Health page (green or
orange ) before starting to use X-One.
• If the Services Management tool is not accessible, please reboot your machine and try
again.

4 3. Installation
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

3.2. Upgrade
This procedure is only to be followed when you want to upgrade from an X-One 1.4.x
version to 1.6.

Preparing the USB Key


1. Connect the USB key to a Windows 7/10 machine.
If the USB key is not empty, please format it.
2. Launch the Rufus utility using the following link:
https://rufus.akeo.ie/downloads/rufus-2.11p.exe
3. In the Device field, select your USB key.

4. Click the Click to Select an Image...  button (CD icon).


5. Select the X-One image file.

The ISO file should have been shared with you: xone_1.6.iso .

3. Installation 5
EVS Broadcast Equipment SA 1.6.B - October 2020

6. Click Start.
You are prompted to select the appropriate write mode.

7. Select the option Write in DD Image mode and click OK.


You will be notified that all data already on the USB drive will be overwritten.

8. Click OK to continue.
Wait until the ISO file has been completely written to the USB key.

Executing the Update

Command Line Procedure


1. Plug your USB key into the server.
A disc icon labeled BOOT will appear on the desktop.
2. Double-click the icon and navigate to:
install-evs-xone-server if you want to upgrade an X-One server;
install-evs-xone-client if you want to upgrade an X-One client.
3. Right-click on a whitespace in the file explorer and select "open in terminal".
4. Execute the following command:
sh /media/BOOT/update_evs-xone-{server or client}.sh

6 3. Installation
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

5. Once the upgrade script has ended successfully (failed:0), if you used a USB key,
please unmount it before removing it from the machine:
cd
sudo umount /media/BOOT
sudo rmdir /media/BOOT

GUI Procedure
Please follow the procedure as described in the popup.

Reboot the Machine


Reboot the machine and wait for a few minutes before starting the Client:
• If you are upgrading an X-One server, please wait for 2-3 minutes and open the
Services Management tool: http://127.0.0.1:9081 to check if everything is ok
on the Health page (green or at least orange status for the resolv.conf check) before
starting to use X-One.
• If you are upgrading an X-One Client, the Services Management page is not present,
so please just wait for 30 seconds to be sure everything has started before beginning
to use X-One.

3. Installation 7
EVS Broadcast Equipment SA 1.6.B - October 2020

4. Cabling

4.1. Cabling the SDI Connectors


The SDI connectors at the back of the server can be used for incoming and outgoing SDI
feeds. The incoming feeds will be recorded, the outgoing feeds will be used for playout.
A camera's SDI Out has to be connected with one of the X-One server's SDI connectors
using a mini BNC cable. A maximum of 6 cameras can be connected. The connectors are
numbered as indicated in the table below.
Two connectors are envisaged for playout.
The SDI connectors at the back of the server can be used for outgoing SDI feeds.

Use Connector

Genlock Lock

Ingest 1 Rx0

Ingest 2 Rx1

Ingest 3 Rx2

Ingest 4 Rx3

Ingest 5 Rx4

Ingest 6 Rx5

Playout 1(= PGM 'Dirty') Rx6

Playout 2(= PGM 'Clean') Rx7

8 4. Cabling
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

4.2. Securing the SDI Cables


It is essential to maintain the cable connections horizontal to the server, to avoid one or
more of the SDI connections failing owing to the weight of the SDI cables, which might
also cause the video card to shift inside the server chassis. We therefore recommended
attaching a cable lacing bar at the back of the rack and securing the cables to it using
cable ties or Velcro® straps.

Below is an example with network cables.

4. Cabling 9
EVS Broadcast Equipment SA 1.6.B - October 2020

The cable management bracket illustrated below is supplied with all PMX machines. It
can be mounted on the side of the server by means of two screws.

You can also use a ring bracket attached to the side of the rack or flight case.

4.3. Connecting the Video Monitors


Up to two video monitors can be connected to an X-One server.

Connectors
When working with a PMX2-4601D server, the following connectors can be used:
• 4 DisplayPort connectors.

NOTE
The monitors have to be connected to display ports 1 & 2. The numbering of the
display ports is from right to left, i.e. (4 3) 2 1.

WARNING
The VGA connection does not work.

10 4. Cabling
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

4.4. Connecting the Beplay Remote and


External Controller
The Beplay remote and External Controller are connected via USB to the X-One server.
The device is recognized as soon as it is plugged in.

4.5. DisplayPort Cable Warning


If you directly connect a server with a monitor using a DisplayPort cable, you need to
make sure that pin 20 (DP_PWR) of the cable is not wired and does not carry any power.
If in doubt, use a multimeter to verify this.

According to the VESA specification, the DP_PWR (pin 20) is not supposed to be wired in
standard cables because both source and sink devices are designed to provide power.
Ignoring this will in certain cases prevent the Avago RAID Controller (AOM-S3108-H8)
from being initialized at startup and thus making the RAID unavailable for the OS.

4.6. Connecting the BFE Tally Box


In the current fixed output assignments, we only use 3 DB-25 connectors (1-4, 5-8 and 9-
12) to provide 6 PGM and 6 PRV relay contacts.

PGM PGM DB-25 PGM PGM PRV PRV DB-25 PRV PRV
Rec. outp connector outp. cmd. outp. connector outp. cmd.
# name pins mask # name pins mask
Cam
1 1-4 24-25 0001 7 5-8 18-19 0040
1
Cam
2 1-4 21-22 0002 8 5-8 15-16 0080
2
Cam
3 1-4 18-19 0003 9 9-12 24-25 0100
3
Cam
4 1-4 15-16 0004 10 9-12 21-22 0200
4

4. Cabling 11
EVS Broadcast Equipment SA 1.6.B - October 2020

Cam
5 5-8 24-25 0005 11 9-12 18-19 0400
5
Cam
6 5-8 21-22 0006 12 9-12 15-16 0800
6

I/O Output: Reed relays, electrically isolated from each other


Electrical power: 48 Volt DC
Switching capacity max. 15 watts
Switching current typ. 500mA, max. 1 Amp
Contact resistance max. 150 mOhm

Detailed pin assignments of the first output 1-4 DB-25 (inputs are not used) are shown in
the table below.

PIN Designation Description

1 OPTO IN 4 - Input 4 (-)

2 OPTO IN 4 + Input 4 (+)

3 V_OUT1+ +5V, max. 100 mA load, short-circuit proof

4 OPTO IN 3 - Input 3 (-)

5 OPTO IN 3 + Input 3 (+)

6 V_OUT1 + +5V, max. 100 mA load, short-circuit proof

7 OPTO IN 2 - Input 2 (-)

8 OPTO IN 2 + Input 2 (+)

9 V_OUT1 + +5V, max. 100 mA load, short-circuit proof

10 OPTO IN 1 - Input 1 (-)

11 OPTO IN 1 + Input 1 (+)

12 V_OUT1 + +5V, max. 100 mA load, short-circuit proof

13 N.C. Not assigned

14 V_OUT1 - 0 Volt

15 RELAY OUT 4 b Output 4 b

16 RELAY OUT 4 a Output 4 a

17 V_OUT1 - 0 Volt

18 RELAY OUT 3 b Output 3 b

19 RELAY OUT 3 a Output 3 a

20 V_OUT1 - 0 Volt

21 RELAY OUT 2 b Output 2 b

22 RELAY OUT 2 a Output 2 a

23 V_OUT1 - 0 Volt

12 4. Cabling
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

PIN Designation Description

24 RELAY OUT 1 b Output 1 b

25 RELAY OUT 1 a Output 1 a

4. Cabling 13
EVS Broadcast Equipment SA 1.6.B - October 2020

5. Configuration

5.1. Changing the Server's Management


IP Address and Hostname

Manually Changing the Server's Management IP Address


To manually change the IP address of a X-One server using the GNOME control-center
application, proceed as follows:
1. Click on the network connection icon in the system menu located in the top right-hand
corner of the screen.

A menu will appear.


2. Click the Settings icon in the bottom left-hand corner of the menu to access the
GNOME control-center application GUI.

14 5. Configuration
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

3. Select the Network on the left-hand side. The Network settings tool appears in the
right-hand menu.

4. Click the gear wheel icon of the connection you want to edit.

NOTE
• eno1 & eno2 represent the onboard ethernet connections.

The Editing dialog box appears. The Details tab is selected by default.
5. Click the IPv4 tab.
The IPv4 tab allows you to configure the method used to connect to a network, to
enter an IP address, DNS and route information as required.
6. To assign the IP address manually, select the option Manual.

7. Enter the desired IP address, netmask and IP address of the gateway, then click
Apply.

5. Configuration 15
EVS Broadcast Equipment SA 1.6.B - October 2020

8. In order to apply the settings, the connection needs to be re-activated. Click the
ON/OFF button to re-activate the connection.

Manually Changing the Server's Hostname


1. Press the Super key on your keyboard.
The Activities Overview is displayed.
2. In the search bar, type Settings and press ENTER.
The GNOME control-center application GUI appears.
3. Select the Details on the left-hand side.
The About tab opens by default.
4. Change the hostname in the Device Name field.

5.2. Arranging the Displays and Setting


the Display Resolution
1. Open the Applications menu, select Other, and then select NVIDIA X Server
Settings.
The NVIDIA X Screen Configuration menu appears.
2. Click on the X Server Display Configuration in the setting list in the left pane.
The currently connected displays should be shown.
3. Click on a display to select it (a selected display will have a red border around it).
4. Rearrange the display by a simple drag-and-drop operation.
5. Select the appropriate resolution in the Resolution field.
6. Click Apply.

16 5. Configuration
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

5.3. Mapping the Touchscreens

About the Mapping Process


The touchscreens are automatically mapped. The mapping process is necessary to make
sure that the touch gestures performed by the user on one particular half of the monitors,
e.g. selecting an element, actually take effect on that half, and not on the same half of the
other monitor.
If the touchscreen monitors are not mapped and the user selects an element on the left
half of the secondary screen, an element on the left half of the primary screen will be
selected instead. If the user selects an element on the right half of the primary screen, an
element on the right half of the secondary screen will be selected instead.

Touchscreen Mapper
The Touchscreen Mapper application is the tool that performs the mapping for you.
It is automatically launched each time you start the X-One client. It also has a shortcut on
the server desktop to manually start the application.

When to Start the Mapping Process


The mapping process has to be started each time:
• one of your monitors is unplugged and plugged in again;
• the order of the screens is changed;
• an X-One server (PMX) is rebooted.

How to Start the Mapping Process


To start the mapping of your touchscreens, proceed as follows:
1. Double-click the X-One client shortcut.
The TouchScreen Mapper application is automatically launched.
You are prompted to tap your main screen.

5. Configuration 17
EVS Broadcast Equipment SA 1.6.B - October 2020

2. Tap your main screen to start the mapping.


You are notified when your screens have been successfully mapped. The X-One client
is launched.

5.4. Managing the X-One Licenses

5.4.1. License Manager

Overview
The License Manager allows you to request and activate the necessary X-One license
keys. Double-click the License Manager shortcut on your server or client workstation
desktop to open the application in a terminal window.
The following system information is displayed: computer name, server serial number,
customer information (company name, first and last name, email, phone), global expiry
date, computer description, and a list of installed license keys. If no license keys have
been installed yet, this list will be empty.
A list of options is also offered to you.
To exit the application again, type 7 and press ENTER.

Setting and Viewing the Customer Information

Setting the Customer Information


When you start the License Manager for the first time, the customer information will be
empty. To set the customer information, proceed as follows:
1. Type 2 (Set Customer Info) and press ENTER.
2. Enter the following information:

18 5. Configuration
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

◦ Company Name
◦ First Name
◦ Last Name
◦ Email Address
◦ Phone
The following fields are automatically completed:
◦ Serial Number
◦ Computer Description
Press ENTER each time you have entered a value.
You are informed that the customer info is successfully saved.
3. Press ENTER again to return to the main menu.

Viewing the Customer Information


To view the customer information you just entered, type 1 (View Current Customer
Information) and press ENTER.

Requesting and Importing a License Key

Requesting a License Key


To request a license key, proceed as follows:
1. Type 3 (Generate a Request Key File) and press ENTER.
A request license key file is generated on the desktop. The naming convention for the
file is: hostname_ID_SystemID.xml.
2. Send the request key file to EVS Support.

Importing a License Key


To import a license key, proceed as follows:
1. Type 5 (Import Keys) and press ENTER.
2. Drag and drop the license key into the terminal.
The full file path of the license key will appear in the terminal.
3. Press ENTER to continue.
After importing the key, a message is displayed: 'xx out of xx keys imported'.
To view the already installed license keys, type 5 (Installed Keys) and press ENTER.

Deleting a License Key


To delete an installed license key, proceed as follows:

5. Configuration 19
EVS Broadcast Equipment SA 1.6.B - October 2020

1. Type 6 (Delete a Key) and press ENTER.


A numbered list is displayed of all the installed keys.
2. Enter the full key string of the key you wish to delete and press ENTER.
The key is deleted and a message is shown: 'Key deleted'.

5.5. Customizing the Beplay Remote


Controls
On the Beplay, it is possible to change the default action assignment of the operational
block buttons (operational blocks 1-4) by modifying the remoteConfig.json file in the
/home/evs/evs/ directory.
The configuration file consists of two parts.
The first part lists the names of the available buttons and the actions that can be assigned
to each button.
The available buttons are:

TOP_1 BOTTOM_2
TOP_2 BOTTOM_3
TOP_3 BOTTOM_4
TOP_4 BOTTOM_5
TOP_5 LEFT_1
F1 LEFT_2
F2 LEFT_3
F3 LEFT_4
F4 RIGHT_1
F5 RIGHT_2
F6 RIGHT_3
BOTTOM_1

The available actions are:


Editing

MARK SAVE
IN OUT

Navigation

GO_TO_IN GO_TO_OUT
GO_BACK_TO_TRAIN GO_TO_BEGIN_TRAIN
PREVIOUS_CLIP NEXT_CLIP
PREVIOUS_FRAME NEXT_FRAME
TOGGLE_SECONDARY_BAR_FOCUS TAKE

Preset

SEND_TO_PGM1 SEND_TO_PRV1

20 5. Configuration
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

SEND_TO_PGM2 SEND_TO_PRV2
SEND_TO_PGM3 SEND_TO_PRV3
SEND_TO_PGM4 SEND_TO_PRV4
SEND_TO_PGM5 SEND_TO_PRV5
SEND_TO_PGM6 SEND_TO_PRV6

Player

GOTOSPEED1 GOTOSPEED2
GOTOSPEED3

The second part contains the configuration of each button. The configuration file contains
a section for each button. Each section contains three fields:
• key: Name of the button.
• press: Name of the action that is executed when pressing the button.
• shift: Name of the action that is executed when pressing the button in combination
with the SHIFT button.
Example of the default configuration for the Live button:
{
"key": "F1",
"press": "SEND_TO_PGM1",
"shift": "SEND_TO_PRV1"
}

NOTE
The configuration file is read at startup. Changes while the Client application is
running will be taken into account at the next restart.

NOTE
To reset the buttons to their default assignments, you can delete the
remoteConfig.json file. X-One will automatically regenerate it at the next
Client application restart.

WARNING
If the format of the configuration file is not valid, a warning message will appear
at the startup of the Client application: 'Invalid format for Beplay configuration
file. Please correct the file and restart X-One client.

5.6. Customizing the External Controller


It is possible to change the default action assignment of the external controller buttons by
modifying the secondaryKeyboard.json file in the /home/evs/evs/ directory.
The configuration file consists of two parts.

5. Configuration 21
EVS Broadcast Equipment SA 1.6.B - October 2020

The first part lists the names of the available buttons and the actions that can be assigned
to each button.
The available buttons are:

Pad 1 Pad 11
Pad 2 Pad 12
Pad 3 Repeat
Pad 4 Rewind
Pad 5 Fast-Forward
Pad 6 Stop
Pad 7 Play
Pad 8 Button A
Pad 9 Button B
Pad 10 Slider

The available actions are:


Player

Camera 1 to PGM Camera 1 to PRV


Camera 2 to PGM Camera 2 to PRV
Camera 3 to PGM Camera 3 to PRV
Camera 4 to PGM Camera 4 to PRV
Camera 5 to PGM Camera 5 to PRV
Camera 6 to PGM Camera 6 to PRV
Secondary bar 1 to PGM Secondary bar 1 to PRV
Secondary bar 2 to PGM Secondary bar 2 to PRV
Secondary bar 3 to PGM Secondary bar 3 to PRV
Secondary bar 4 to PGM Secondary bar 4 to PRV
Secondary bar 5 to PGM Secondary bar 5 to PRV
Secondary bar 6 to PGM Secondary bar 6 to PRV
Select Default Speed Select Speed 1
Select Speed 2 Select Speed 3
Transition 1 Transition 2
Transition 3 Transition 4
Transition 5 Transition 6
Transition 7 Take

The second part contains the configuration of each button. The configuration file contains
a section for each button. Each section contains the following two fields that need to be
associated:
• aliases: Name of the button.
• actions: Name of the action that is executed when pressing the button.
The other fields, i.e. param, value, note, channel, velocity and type are specific to the
button and should not be changed.
Example of the default configuration for the Rewind button:
{
"aliases": ["Rewind"],

22 5. Configuration
INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

"type": "Control Change",


"channel": 9,
"param": 47,
"value": 127,
"actions": [ "Select Speed 2" ]
}

NOTE
The configuration file is read at startup. Changes while the Client application is
running will be taken into account at the next restart.

NOTE
To reset the buttons to their default assignments, you can delete the
remoteConfig.json file. X-One will automatically regenerate it at the next
Client application restart.

WARNING
If the format of the configuration file is not valid, a warning message will appear
at the startup of the Client application: 'Invalid format for Beplay configuration
file. Please correct the file and restart X-One client.

5. Configuration 23
EVS Broadcast Equipment SA 1.6.B - October 2020

6. Monitoring and Support

6.1. Services Management Tool

About the Services Management Tool


The Services Management tool is a web tool which allows a system administrator or EVS
support person to monitor for a particular X-One server in more detail the health and status
of its micro-services, to restart them in case of a problem and to export their logs. It also
allows to check in more detail certain system metrics.

Accessing the Services Management Tool


The Services Management tool can be accessed via the following link:
http://<serverip>:9081

24 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

6.2. Dashboard Page


The Dashboard page allows you to view at a glance the status of the different X-One
micro-services and backend components. To get the latest status, click the refresh
button.

The backend components can have one of the following health statuses:
• Passing (green)
• Warning (orange)
• Critical (red) In case of an error, more detailed information can be viewed.

6. Monitoring and Support 25


EVS Broadcast Equipment SA 1.6.B - October 2020

6.3. Health Page


The Health page displays the status of your X-ONE system.

The following checks are performed:


• Check /etc/resolv.conf: This checks that the DNS servers referenced in
/etc/resolv.conf are accessible. If not, you should change your
/etc/resolv.conf (do not delete it), because having a wrong
/etc/resolv.conf is known to cause timeouts and can negatively impact the
stability of the stack.
• Check disk free space: It checks that you have enough disk space. If not, some files
have to be deleted, for example crash dumps can fill the /var/crash folder and can
safely be deleted. For other file systems, support from EVS may be needed.
• Data RAID status: It checks the software RAID. If this check fails, then the RAID is
degraded and it is likely that one disk is damaged and it might need to be replaced. It is
recommended to take action because if you lose another disk then you will lose the
content and the system will not be available.
• HDD disk health: It checks the state of the internal disk.
• Megaraid status: It check for any problem with the LSI megaraid. If there is a
problem, please contact EVS support.
• Serf Health Status: It checks for a degraded service state. It should always be
passing. If not, you can try to restart it in a Terminal.
sudo systemctl restart consul
• evs-phoenix-asset / evs-phoenix-ingest / evs-phoenix-playout / evs-phoenix-
transform / evs-phoenix-workflow: It checks the status of these EVS VIA services.
• evs-resource-status / evs-sx-storage-status / evs-sxe-content-status / evs-sxe-
ingest-status / evs-sxe-playout-status: It checks the status of these services.
• Thinpool free space: It checks the space available for the Docker backend storage.
If this check is not passing, please call EVS support as we might need to either free-
up some space or allocate more disk space.
• xone: It checks the status of the X-One service.

26 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

• Zookeeper OK status: Checks the status of Zookeeper.

WARNING
After an installation, all checks on the Health page will be in orange for a while.
This is because the data RAID must be built for the first time.

6. Monitoring and Support 27


EVS Broadcast Equipment SA 1.6.B - October 2020

6.4. Postgres Page

6.4.1. Stat Activity Tab


The Stat Activity tab shows the status of the different connections made with Postgres.

6.4.2. Backups Tab


The Backups tab allows to create a backup of the Postgres database and to restore or
delete a backup. It should only be used if requested by EVS support.

28 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

6.4.3. Replication Tab


The Replication tab does not apply to X-One.

6. Monitoring and Support 29


EVS Broadcast Equipment SA 1.6.B - October 2020

6.5. Metrics Page


The Metrics page displays several statistics about the health and performance of the
backend and server hardware components.

6.5.1. SDI Tab


The SDI tab allows you to view the incoming SDI feeds, check their technical details and
monitor their status. You can also see whether the feeds are genlocked or not.

SDI Engine Version


Current version number of the evs-sxe-sdi service.

Genlock Status
Generic genlock status of the SDI board.

SDI Status
• Error:
◦ No Error
◦ No Signal: There is no incoming video signal or the cable is disconnected
◦ Bad Signal: The signal is not in the configured format
◦ Unknown: There is no stream.
• Running: Status of the evs-sxe-sdi service.
• SyncWithRef: Indicates if the incoming video signal is genlocked.

30 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

Config
The Config section lists the input signal characteristics requested by the client (e.g. Ingest
service).

Signal
The Signal section lists the actual characteristics of the input signal monitored by the SDI
adapter card.
The following information is displayed about each signal:
• AudioTracks: The number of audio tracks present in the SDI input signal. Tracks are
counted as individual mono tracks. Eight stereo SDI pairs are displayed as sixteen
audio tracks.
• FrameRate: The frequency at which frames are displayed.
• Progressive: Progressive scan mode or not.
• Horizontal Resolution: The number of pixels from left to right.
• Vertical Resolution: The number of pixels from top to bottom.
• 3G Interface: Indicates if the input is connected to a 3G-SDI signal.
• LtcValid: A valid LTC (= longitudinal time code) input signal has been detected.
• LtcValue: The current value of the LTC. Note that you need to refresh your browser
page to get a current value.

Monitoring
The Monitoring section displays a JPEG thumbnail (270x180 pixels) of the incoming video
signal. The thumbnail is refreshed every second.
• When a signal is received, 'Error: No error' will be displayed in the top left corner and
the thumbnail is automatically refreshed.
• When no signal is received, 'Error. No signal' will be displayed in the top left corner
and the thumbnail will be replaced with the error message "Error. Failed to retrieve
channel thumbnail".

NOTE
With some early 12.x SDI engine versions, the last known image may be
displayed instead of an error message.

6. Monitoring and Support 31


EVS Broadcast Equipment SA 1.6.B - October 2020

6.5.2. Sx Storage Tab


The Sx Storage tab displays information about the storage of the X-ONE server.
For example, total amount vs used storage, number of storage partitions, number of
tracks, etc.

6.5.3. Sys. Stats. Tab


The Sys. Stats page displays real-time statistics about the performance of various Linux
subsystems (CPU, Memory, I/O, Network, etc.).

32 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

Run Queues
This area contains run queue and load average data.

Parameter Description

Load average System load average for the last minute, past 5
minutes, past 15 minutes.

Run queue size The number of kernel threads in memory that are
waiting for a CPU to run.

Process list size Number of tasks in the task list.

CPU
This area displays usage statistics of all CPUs as well as of individual CPUs.

Parameter Description

Core CPU core.

User Percentage of CPU utilization that occurred while


executing at the user level (application).

System Percentage of CPU utilization that occurred while


executing at the system level (kernel).

Nice Percentage of CPU utilization that occurred while


executing at the user level with nice priority.

IOWait Percentage of time that the CPU or CPUs were idle


during which the system had an outstanding disk I/O
request.

Idle Percentage of time that the CPU or CPUs were idle


and the system did not have an outstanding disk I/O
request.

%Used Total percentage of CPU utilization.

6. Monitoring and Support 33


EVS Broadcast Equipment SA 1.6.B - October 2020

Disks
This area displays the activities by the individual block devices.

Parameter Description

Device Device (or partition) name as listed in the /dev


directory.

Avg queue len Average queue length of the requests that were
issued to the device.

Reads (sector)/sec Number of sectors (kilobytes, megabytes) read from


the device per second.

Writes (sector)/sec Number of sectors (kilobytes, megabytes) written to


the device per second.

Transfer/sec Number of transfers per second that were issued to


the device. A transfer is an I/O request to the device.
Multiple logical requests can be combined into a
single I/O request to the device. A transfer is of
indeterminate size.

Avg wait Average time (in milliseconds) for I/O requests


issued to the device to be served. This includes the
time spent by the requests in the queue and the time
spent servicing them.

% Util Percentage of elapsed time during which I/O


requests were issued to the device (bandwidth
utilization for the device). Device saturation occurs
when this value is close to 100%.

34 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

Network
This area displays network statistics.

Parameter Description

Interface Name of the network interface for which statistics


are reported.

rxpck/s Packet receiving rate (unit: packets/second).

txpck/s Packet transmitting rate (unit: packets/second).

rxKb/s Data receiving rate (unit: Kbytes/second).

txKb/s Data transmitting rate (unit: Kbytes/second).

rxcmp/s Compressed packets receiving rate (unit:


Kbytes/second).

txcmp/s Compressed packets transmitting rate (unit:


Kbytes/second).

mac MAC address of the network interface.

connected Indicates if the network interface is physically


connected to the network or not.

speed Speed of the network interface.

state Status of the network interface.

ip4 IP address of the network interface. Either manually


added or automatically assigned by DHCP.

dns IP address of the EVS DNS server.

gateway IP address of the router used to access external


networks.

dhcp Indicates if the IP address of the network interface


was manually or automatically (via DHCP) assigned.

6. Monitoring and Support 35


EVS Broadcast Equipment SA 1.6.B - October 2020

Memory
This area displays memory statistics.

Parameter Description

Buffers Memory used as buffers by the kernel in kilobytes.

Cached Memory used to cache data by the kernel in


kilobytes.

Commit Memory in kilobytes needed for current workload.

Commit percent % of memory needed for current workload in relation


to the total memory (RAM+swap).

Mem used Memory used (excluding kernel usage).

Mem free Free memory available in kilobytes.

Mem used percent Percentage of memory used.

Swap
This area displays the swap statistics.

Parameter Description

Swap used Used swap in kilobytes.

Swap free Free swap in kilobytes.

Swap used percent Percentage of swap used.

36 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

6.5.4. Temperature Tab


The temperature page displays real-time information about the temperature of the CPUs
and CPU cores of the server.

6. Monitoring and Support 37


EVS Broadcast Equipment SA 1.6.B - October 2020

6.6. Docker Page


The Docker page contains more detailed information about Docker and the Docker
containers and images present on the backend.

6.6.1. Services Page


The Services page allows you to check the status of the native microservices running on
X-One, and to restart them in case they are down.

6.6.2. Info Tab


The Info tab displays the following information:
• Docker version and edition
• Number of Docker containers (in total, running, paused, stopped)
• Supported storage driver (e.g. devicemapper, overlay)
• Storage driver status
• Number of Docker images

38 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

6.6.3. Disk Usage Tab


The Disk Usage tab displays information about the various docker images stored on the
server. Note that this request can take a very long time.

6. Monitoring and Support 39


EVS Broadcast Equipment SA 1.6.B - October 2020

6.7. Versions Page


The Versions page enables you to see which version of the different backend components
(e.g. services, infrastructure tools) is currently installed and running on the X-One backend
server and in which form they are deployed (e.g. rpm package, file, docker image, etc.).

6.7.1. Content Tab


The Content tab allows you to see the infrastructure tools that are currently installed and
running on the backend server, their version (= Active version) and the form (Docker
image, RPM package, file) in which they have been installed. It also allows you to see if
the active version is as expected (= Version in content).

6.7.2. RPMS Tab


The RPMS tab allows you to see the X-One backend components that are installed as
RPM package, their version and their installation date.

40 6. Monitoring and Support


INSTALLATION AND CONFIGURATION MANUAL X-One 1.6

6.7.3. LivePamCore Tab


The LivePamCore tab allows you to see the X-One backend services that are installed
and their version.

6.7.4. Docker Images Tab


The Docker Images tab allows you to see the X-One backend components installed as
Docker images, their version and size.

6. Monitoring and Support 41


EVS Broadcast Equipment SA 1.6.B - October 2020

6.8. Consulting System Log Files and


Crash Dumps

Log Files Folder


The X-One system log files are stored in the following directory: /var/log/evs.

Crash Dump Folder


Crash dumps are available in the following directory: /var/crash/.

Exporting System Log Files


To generate and export the latest X-One system log files, proceed as follows:
1. Double-click or double-tap the GetLogs icon on your X-One client workstation
desktop.

A terminal window is opened.


The various system log files are generated and exported to the Logs directory on your
desktop in the form of a .tgz file with the following filename format: evs_logs_
<hostname>_YYYYMMDD_HHMMSS.tgz.
You can either remove or keep all the log files.
2. Enter Y and press ENTER to remove all logs. Enter N and press ENTER  to keep all
logs.
3. Tap or click X to close the terminal window again.

42 6. Monitoring and Support


Corporate
+32 4 361 7000

North & Latin America


+1 973 575 7811

EVS Headquarters Asia & Pacific


Liège Science Park +852 2914 2501
13, rue Bois St Jean
B-4102 Seraing Other regional offices
Belgium www.evs.com/contact

EVS Broadcast Equipment is continuously adapting and improving its products in accordance with the ever changing
requirements of the Broadcast Industry.
The data contained herein is therefore subject to change without prior notice. Companies and product names are
To learn more about EVS go to www.evs.com trademarks or registered trademarks of their respective companies.

You might also like