Luxriot Evo: Administration Guide
Luxriot Evo: Administration Guide
Luxriot Evo: Administration Guide
Administration
Guide
Table of Contents
Luxriot EVO
Luxriot EVO is a free version of the new-generation Luxriot video management software. Delivering an outstanding
quality performance, this video management system supports over 4000 cameras from major producers and is ideal
for use at homes or small offices with surveillance networks of nine cameras or fewer. The meticulously designed
interface will allow any user to quickly understand the whole process of configuration and start using the software.
Luxriot EVO is a free product, and so it not covered by Luxriot technical support services and has a much shorter list
of components. Should you need a more comprehensive functional or enterprise-level video management system
solution with a complete surveillance ecosystem, we suggest using the more advanced versions of the software –
Luxriot EVO S and Luxriot EVO Global.
Luxriot EVO S
Luxriot EVO S is a new-generation piece of VMS software from Luxriot, which offers a fast and scalable stand-alone
multiple-server solution that truly answers your company’s security needs. It has been proven to be high-quality and
reliable and has now been upgraded to a 64-bit version, adding an even more intuitive user interface and better
functionality, as well as a long list of add-ons.
Cross-functional and modern, Luxriot EVO S supports over 4000 cameras and other network devices from major
producers. The software is designed for surveillance systems with 96 or fewer cameras and also allows hybrid
solutions. Looking for a complete enterprise-level solution? We suggest that you refer to the Luxriot EVO Global
version of the software.
Luxriot EVO Global is a complete surveillance ecosystem solution for enterprises of any size, including those
distributed across multiple sites. The software was designed with the core of Luxriot VMS, whose quality has been
proven worldwide over the last decade. The new version of the software, Luxriot EVO Global, not only offers 64-bit
speed and all the necessary tools for setting up an absolute situational alertness system aimed at responding quickly
to events, as well as introducing a central server governance hierarchy of all the components.
This is one of the most comprehensive enterprise-level VMS solutions on the market, featuring interactive maps
linked to alarms; an advanced event and action manager; analytics tools; video wall support and other impressive
components you will definitely appreciate. To ensure the safety of your data, the software also offers archive
replication, advanced system health monitoring and failover clustering mechanism, all of which reduce the
disruption of your video surveillance recordings to zero. All this, as well as the various possibilities for customisation
and Luxriot flawless technical support, makes Luxriot EVO Global a video surveillance solution you can count on.
Luxriot EVO
Free software version allows up to 9 video channels by default. Client application - Luxriot EVO Monitor - can only
be connected to a single Luxriot EVO server, and streaming server (Web/mobile access), which is an integral part of
the server, is limited to one connection at a time. This license also features 1 free video analytics channel.
Advanced features like centralised server management, events & actions, external components (LPR, FR, VCA),
maps etc. are not supported for the free software edition; technical support is not guaranteed.
Free version upgrade is offered for Luxriot EVO.
Luxriot EVO S
Luxriot EVO S is, alike Luxriot EVO, a single server installation with no imposed limitation on stream resolution;
number of allowed cameras varies depending on the server license type: 24, 48, 72, and 96 channel editions, as well
as special unlimited channel edition are available. Also, there are no restrictions for remote connection amount from
Luxriot EVO Monitor applications and Web/mobile clients. This license also features 1 free video analytics channel,
with an option to purchase more.
Luxriot LPR, VCA, face recognition (FR), as well as map and event/action modules are supported.
Free software updates are offered for 2 years since last license activation date; technical support is provided for 2
years since last version installation, making it a maximum of 4 years of support for non-renewed license. In order to
obtain further updates and support, a license subscription upgrade should be acquired.
Luxriot EVO Global edition presents a full-scale CCTV solution with centralised management and advanced
enterprise features. Vast number of servers can be merged into a single surveillance system, offering transparent
configuration for physically separated servers.
Unlike previous two editions, Luxriot EVO Global solution is licensed per channel, with no theoretical limitation for
total amount of cameras distributed between multiple servers.
All external modules are available via centralised management, and events/actions are shared between servers. This
license also includes 1 free video analytics channel, with an option to purchase more.
Free software updates are offered for 2 years since the last license activation date; technical support is provided for 2
years since last version installation, making it a maximum of 4 years of support for non-renewed license
subscription. In order to obtain further updates and support, a license subscription upgrade should be acquired.
After the subscription expires, the license itself remains active and the Luxriot EVO server is operational.
For Luxriot EVO Video Analytics (VA): 1x physical core 3GHz+ and 1GB RAM per video channel. CPU must
support AVX/AVX2.
1.3 Prerequisites
There are a number of requirements for the Luxriot EVO host system:
Microsoft Windows operating system (7 SP1, 8, 8.1, 10, Server 2012 R2, Server 2016, Server 2019), real or
virtual machine
both .NET Framework 3.5 SP1 and 4.x installed (the latest version should come with OS updates)
for Windows Server operating systems, make sure the Desktop Experience feature is installed
all Windows updates must be installed (especially, this is critical for Windows 8 and newer editions and
for pending updates)
ports for remote connections should be enabled through the firewalls (default ports are 60554 for Luxriot
EVO Monitor and Luxriot EVO Console and 8080 for the Luxriot EVO Streaming Server and external
services)
installation and recording directories should be added to antivirus exception list so that they are not
scanned or interfered with in any other manner
indexing and defragmentation services must be disabled for the storage locations
for the software analytics requirements, see the corresponding section of the VCA manual (provided as a
separate document)
for Luxriot EVO Monitor application, DirectX 10+ is required along with the latest stable graphics card
drivers
for Luxriot EVO Monitor, display resolution of 1280x720 pixels or higher is recommended
For Windows Server 2016 and 2019, specify the Server with Desktop Experience option as part of the
installation. Prior versions of Windows Server allow you to install this feature post installation.
If you use a server with a clean Windows installation, make sure to install all available Windows updates
before starting the software installation. Component deficiency (framework components, redistributables
etc.) may lead to unexpected issues in software operation.
If you are using Windows 10 N or KN (special edition without media technologies), make sure to install
Windows 10 Media Feature Pack in order to ensure Luxriot EVO operation. Without media features,
Luxriot EVO will not work. You will find the media feature pack online, provided by Microsoft.
Antivirus scanning, defragmentation, indexing and other similar processes being enabled for Luxriot
EVO storages may result in dramatically decreased write speed, recording disturbances and, occasionally,
database corruption. We strongly recommend that you make sure that storage locations are not affected by
these processes.
Luxriot is not responsible for software failures and/or any footage loss caused by underlying OS and/or
hardware issues. It is the responsibility of the systems administrator to configure the server and provide
maintenance, unless otherwise agreed (e.g., if server hardware has been shipped by Luxriot for bespoken
configuration).
We strongly advise that you keep the software versions (e.g., 1.x.x) and subversions (e.g., 1.2.x) across your
system match exactly. Software build numbers (e.g., 1.2.0.xxxxx) may differ slightly in case your are using 64-
bit and 32-bit editions.
If you are not sure about what server hardware to choose, do not hesitate to use Luxriot provided hardware
calculators and/or contact Luxriot representative for an accurate estimation.
We advise installing and activating the software on the ultimate server assembly, as extensive subsequent hardware
changes are likely to cause software license activation failure. If this happens, undo these changes, if possible, or
contact product support to find a solution.
Luxriot EVO is installed as a Windows service so please make sure that the Windows user you are logged in as has
sufficient privileges; otherwise, software may not be installed correctly. Note that there is no option to install and
run the software in application mode.
The following topics will guide you through the installation process, as well as provide details on product
configuration. If you are using a Luxriot product for the first time, we strongly advise you to carefully read and
follow the instructions in this manual and related documentation.
Luxriot is not responsible for software failures and/or any footage loss caused by underlying OS and/or
hardware issues. It is the responsibility of the systems administrator to configure the server and provide
maintenance, unless otherwise agreed (e.g., if server hardware has been shipped by Luxriot for bespoken
configuration).
Step 1
Carefully read the Luxriot license agreement: you must agree to all parts of the given document in order to proceed.
If you agree, select I agree... in order to continue; otherwise, terminate software installation. If you have any
questions regarding the contents of the present license agreement, please contact [email protected].
License Agreement
Step 2
Select the destination folder you want the software to be installed in. By default, Luxriot EVO S is installed in:
32-bit: C:\Program Files (x86)\Luxriot\Luxriot EVO S
64-bit: C:\Program Files\Luxriot\Luxriot EVO S
If you are re-installing Luxriot EVO S and previously selected a non-default location, make sure to select the same
destination directory, or, alternatively, completely uninstall previous Luxriot EVO S version. If unsure about this,
ask for Luxriot technical support team assistance. A full description of the software upgrade procedure is available in
the corresponding section of the Luxriot EVO administration manual.
The setup wizards estimates how much disk space will be required. Make sure you have enough free space on the
target disk. Note that low system disk space will dramatically decrease system performance and affect overall system
stability.
Installation Directory
Step 3
Some components are optional and so you can choose not to install them. The main Luxriot EVO S parts are
obligatory and cannot be deselected (by default, these options are selected and greyed out).
If not chosen at this stage, Luxriot EVO Monitor can be installed separately later.
According to the National Defense Authorization Act, section 889, federal agencies and their contractors are
prohibited from using video surveillance equipment from certain Chinese companies. If your installation falls
into this category, please follow the sub-step below.
Here, you have an option to exclude the drivers for the abovementioned surveillance cameras, thus making the
installation NDAA compliant.
In order to exclude the drivers for the non-compliant devices from the installation, expand the Luxriot EVO Server
Service node in the list, and enable the NDAA approved cameras only option.
Installation Progress
Upon completion, the setup wizard will show you an installation summary. If all the steps have been fulfilled
successfully, simply click Finish to close the wizard.
Installation Complete
After the installation has been completed, there are a few more steps necessary for you to begin using the software:
apply server initialisation settings via Server Setup Wizard - it will pop up automatically after the
installation in case you are doing a clean or a new installation
activate the software - if it is not activated, the wizard will also pop up automatically
after you run the console for the first time, you will be offered to complete the Setup Wizard to start the
deployment, following the recommended configuration steps
All of these steps are described in details in the full version of the Luxriot EVO management manual, which is
available right after the installation via your Start menu.
Setup Completed
Remote Upgrade
Starting from software version 1.10.0, it is possible to apply remote upgrade to Luxriot EVO Console and Luxriot
EVO Monitor components from the Luxriot EVO S server. This feature allows you to deploy remote client machines
once and then easily handle the upgrades from any place, keeping the whole system up to date with little effort.
Once you have upgraded the Luxriot EVO S server to a newer version, you can then put the installation packages of
the same version onto the Luxriot EVO S server computer. The idea is that you first define the location of the
executable files and then remote Luxriot EVO Monitor and Luxriot EVO Console applications receive an update
notification. The locations must be on the Luxriot EVO S server machine, even if you are accessing the server from a
remote Luxriot EVO Console. The installation itself is initiated from the remote client side.
To access the remote upgrade feature, open your Luxriot EVO Console application, click the main application menu
button in the upper-right-hand corner and choose the System upgrade option. The System upgrade dialog box will
appear.
Now, if a remote Luxriot EVO Console or Luxriot EVO Monitor application of an older version is used to connect to
this server, it will receive a notification about the available upgrade. The notifications can be disabled in the
application settings.
So, if Luxriot EVO Console or Luxriot EVO Monitor detects that an upgrade is available, it will offer you to download
it straight away. If your network connection allows it, click OK to agree and download the upgrade package.
We strongly advise that you keep the software versions (e.g., 1.x.x) and subversions (e.g., 1.2.x) across your
system match exactly. Software build numbers (e.g., 1.2.0.xxxxx) may differ slightly in case your are using 64-
bit and 32-bit editions.
Before starting the upgrade/uninstall procedure, ensure that all Luxriot EVO processes have been terminated
and that Luxriot EVO files are not in use: this is necessary in order to upgrade all files to the newer versions.
This includes any Luxriot EVO processes or related applications that are running, and also any third-party
applications that have access to Luxriot EVO files, e.g., antivirus scanners, third-party integrations, etc.
Luxriot EVO processes can be found via Task Manager: these start with VMS, e.g., VMSServer.exe.
If the processes are not stopped, or if other applications are still interfering with the process, you may be asked
for a reboot: in that case, please restart your server machine afterwards to complete the action. This will not
affect the overall process quality.
Upgrade Software
This section describes manual software update (newer version installation on top of the older one) by running the
installation locally. For remote upgrades, see the corresponding section of this document.
Before starting the software upgrade:
1. Make sure there are no other running installations and that the operating system is not in the middle of
installing updates. If Windows updates are pending, apply them, then restart the computer (if required), and
start the Luxriot EVO upgrade.
2. Verify that the operating system is stable and is running normally (check system logs, overall health) - these
must be no "blue screens", unexpected shutdowns, slowdowns etc. (Normally, we recommend that you
regularly run such system checkups, not only before upgrade).
3. Ensure stable power and connectivity (the latter is essential if you are connected via RDP).
4. See if there are any special requirements or recommendations from Luxriot regarding the target version.
Usually, these are either mentioned on the download page, or provided alongside the download links in case
the new version was recommended and sent by our engineers.
5. Check your software license subscription, and renew it, if necessary: the subscription must not run out before
the target version release date. You can check the software release date by right-clicking the installation file >
Properties > Digital signatures > see timestamp. The license information is available via license manager,
Luxriot EVO Activation Wizard.
If you proceed with the upgrade but do not provide a valid license after the installation is complete, the software will
not operate. Therefore, do not proceed with the upgrade until you have renewed the subscription.
To verify the software release date against your license subscription expiration date, right-click the installation
file > choose Properties > go to the Digital Signatures tab and check the timestamp.
If some of the files cannot be upgraded because they are in use, you will get a corresponding warning.
Choose Ignore to proceed with the installation: reboot may be required afterwards but it is safe to select
this option, esp. if the processes are from Luxriot EVO; or
Stop the listed applications/services and click Retry to continue installing the software, or
Click Abort to roll back the installation (the process will be cancelled and you will get a corresponding
error in the wizard's dialog box).
According to the National Defense Authorization Act, section 889, federal agencies and their contractors are
prohibited from using video surveillance equipment from certain Chinese companies. If your installation falls
into this category, please follow the sub-step below.
Here, you have an option to exclude the drivers for the abovementioned surveillance cameras, thus making the
installation NDAA compliant.
In order to exclude the drivers for the non-compliant devices from the installation, expand the Luxriot EVO Server
Service node in the list, and enable the NDAA approved cameras only option.
Uninstall/Change Software
Before making any changes to the installation, make sure to close and stop all software services and
applications. If processes are not stopped, some of the software components may not be removed or replaced
during the installation process.
In order to check this, open Windows Task Manager, select 'Show processes from all users' and make sure
there are no processes starting with 'VMS..'. If there are any, stop them manually and then proceed with the
installation changes.
Uninstall
If you did not stop the Luxriot EVO server before starting the uninstall process or if some third-party software (e.g.,
antivirus) has locked Luxriot EVO files, you will get a warning.
click Ignore to let the wizard handle the files automatically (recommended, an reboot may be required)
Generally, if you see that the process mentioned in the warning is Luxriot EVO own process, simply choose the
Ignore option and let the wizard do the job.
When the wizard finishes removing software components, hit Finish to exit.
Clean Install
Sometimes it is necessary to install software anew, i.e., to change software bit version, roll back version, and also in
event of major software-related troubles.
You can perform clean install yourself if you are already familiar with the software. If you are doing it for the
first time, we recommend that the procedure is supervised by a Luxriot support engineer so that you learn how
to do this quickly and effectively, avoiding possible mistakes.
Although software upgrade is not possible with different bit versions, you can migrate your installation to a
different bit version by performing a clean install.
To perform a clean installation, it is crucial to make sure that no Luxriot software processes are running,
whether explicitly or in the background. Follow these steps:
1. Stop all Luxriot software services and/or applications;
2. Open Windows Task Manager, click 'Show processes from all users' and check that there are no processes
starting with 'VMS..'; if there are any, stop them;
3. Uninstall software as described above, keeping your license and configuration;
4. Install [new] software version, carefully following all steps and recommendations;
5. Start the software and check if the desired change has been carried out.
Start and stop the server service from the system tray
If the server service is stopped while Luxriot EVO Console connections are active, the wait-for-server-connection
window will appear on top of Luxriot EVO Console, disabling any input. The same thing will happen if there are any
problems with server connectivity. It will automatically disappear when the server is online again; alternatively, you
can click Close to exit Luxriot EVO Console at this point and open it manually later.
Connection lost
2 License Activation
In order to use the product, a valid license is required - whether this is a free, a trial or a purchased one. Any type
of license can be activated using this wizard; note that license activation choice will differ depending on the
installation package you have selected.
Each license includes a certain number of video channels, and a certain number of video analytics channels.
Also, each Luxriot EVO license, including the free Luxriot EVO edition, contain 1 (one) video analytics channel free
of charge.
Once you have installed the software and entered the server initialisation settings, the activation wizard will
appear. If you have rebooted the server computer after completing the installation, simply run the activation
manager in one of the following ways:
from the Windows Start Menu, under Luxriot folder, or
by typing Activation Wizard in the search field, or
by right-clicking the server tray icon and selecting About > Manage license (server tray icon appears only
after you run the Luxriot EVO Server shortcut from your Desktop or Start menu), or
when connected to localhost via Luxriot EVO Console, go to the main menu > About > Manage license.
The license manager will only pop up automatically after the initial installation. If you wish to apply license
upgrades at any time, including the after-software-upgrade, run the license manager manually as described above.
It is advisable to run hardware stability tests and finalise the server hardware configuration before applying the
license, as subsequent hardware changes may cause activation related issues. Approximately up to 30% of the initial
hardware components can be replaced without losing the activation.
Subtopics here describe every type of license activation in details.
Licensing is mandatory for Luxriot EVO S and Luxriot EVO Global software packages. Luxriot EVO Recording
Server does not require a license as it is not an independent component but rather operates under a Luxriot
EVO Global server only.
Virtualised environment is supported starting from software version 1.13.0. If you experience any issues with
the license activation, kindly contact our support engineers by emailing [email protected].
License upgrade is available for the license keys purchased earlier. Note that all the software processes (both
applications and services) must be stopped in order for the license to be applied correctly.
For upgrade acquisition details and assistance, please contact us via https://www.luxriot.com/purchase/inquiry-
form/.
All software processes must be stopped in order to apply license related changes
Offline license upgrade essentially the same as the offline license activation process: the same steps should be taken
to retrieve the new license file.
generate activation file on the target server
go to the online activation system at http://www.luxriot.com/purchase/software-activation/ and fill in the
form
apply provided license file to your system
Click Cancel to return to the beginning of the wizard.
Remove license
Select Remove License if you wish to completely delete all the license information from the server.
Deactivate license
Click Deactivate Existing License to confirm deletion of the currently installed license. Note that you will be unable
to log into Luxriot EVO Console to access your current server configuration without a valid license of the same type;
Luxriot EVO Monitor applications will also not connect to such a server. In order to use the server again, you will
have to enter the license again - either the same or a new one.
An attempt to log into Luxriot EVO Console failed because the license is missing
Alternatively, press Cancel to return to the wizard start page. If you are not sure about the deactivation, consult
Luxriot technical support.
The default username and password for the new installation is admin/[empty].
If your server has default TCP port configured (which is 60554), you do not need to specify it when connecting:
simply type the IP or hostname of the server to connect to. However, if the server TCP port has been altered,
you need to specify the port explicitly, making the connection address look as follows:
<address>:<port>, e.g., 192.168.1.77:60555 or localhost:60887
Server TCP port can be changed via Luxriot EVO Server Setup Wizard.
If you are refused the connection, make sure that the server is running and accessible over the network. (For more
detailed information about what to do, please refer to the Troubleshooting section of this document: it is constantly
updated with most common cases).
The new password must comply with server policies, by default these are: minimum 8 characters total
length, including at least 2 lowercase and 2 uppercase letters.
About Server
If you are connected to your Luxriot EVO server locally (via localhost), the About window will allow you to open the
activation manager from here (except for Luxriot EVO Monitor). For remote connections, this option will be grayed
out.
In Luxriot EVO version 1.6.0, major changes were made to permission management. As a result,
configuration imported from an XML file (from Luxriot VMS) will not contain any user permissions: you will
need to review and set all user permissions after importing the configuration.
In your Luxriot VMS Client, right-click your desired server and choose Tasks -> Configuration Export.
Export tool
Next, switch to your Luxriot EVO installation where you want to load the configuration: open Luxriot EVO Console
and log into the target server. In Luxriot EVO Console, click the application menu button located in the upper-right-
hand corner of the Luxriot EVO Console window and choose Configuration import. Locate your pre-saved XML file
in the Open file dialog box and click Open: Configuration import dialog box will open, giving you the option to
review the resources to be imported.
If some resource is already present in Luxriot EVO configuration, the wizard will mark the imported copy to be
merged to the existing one; you can change this by selecting the desired resource and choosing the import
type below: Import via -> Add/Merge. Merging means that user permissions are extended and in case of any
differences Luxriot EVO settings have priority. Otherwise, the import wizard will simply add the target
resource to your configuration and action type choice will be grayed out.
Confirm import
After the import, you will be able to edit the newly added resources as usual via corresponding menu sections.
You can also bring a database from another server. By default, all Luxriot EVO databases are located in the
following directories:
C:\ProgramData\Luxriot\Luxriot EVO S - for the Luxriot EVO S product edition
C:\ProgramData\Luxriot\Luxriot EVO Global - for the Luxriot EVO Global product edition
C:\ProgramData\Luxriot\Luxriot EVO Recording Server - for the Luxriot EVO Recording Server
component of a Luxriot EVO Global installation
From the standard Windows Explorer Open File dialog box, locate the target VMSConfig-xxxxxxxxxxxx.db file and
open it.
Important: this action cannot be undone. Before confirming, make sure to review all the changes you wish to
apply.
Before applying all the changes, review your import summary and click OK to confirm and finish the import.
All selected items will be added to the server configuration immediately and you will be able to work with them
normally.
Automatic Backup
Automated configuration backup allows you to save your Luxriot EVO database based on a schedule. To access the
settings via Luxriot EVO Console, click the application menu button in the upper-right-hand corner and choose
Automated backup configuration.
Backup status
In the Status tab, you can see the date of the last backup attempt and the next scheduled backup time.
Additionally to the automated backup, it is possible to create a configuration restore point manually at any time. The
same wizards provides an opportunity to start the Luxriot EVO with an earlier database version.
Run the Backup and restore wizard from your Windows Start menu: Start -> All Apps -> Luxriot -> Luxriot Server
Backup and Restore Wizard. In Windows 7 and older versions, use Start -> All Programs -> software installation
folder -> Tools -> Luxriot Server Backup and Restore Wizard; alternatively, use Cortana/Search to locate the
wizard in the programs menu.
Backup
Choose the first option to back up the database contents to serve as a restore point and click Next.
Restore
Choose this option if you wish to start the Luxriot EVO server with a database from an earlier time instead of the
current configuration.
If you have a clean Luxriot EVO installation and wish to restore its configuration from an earlier point, make
sure to initialise the server using the Server Setup Wizard, which usually pops up automatically after the
installation is completed and is available via Start menu. (There is no need to do this if you upgraded the
software to a newer version so that it already has been initialised earlier).
A database from a newer software version cannot be used for this. Older database versions can be used
without issues; however, we recommend that you use the latest available backup from a stable software
version (not beta).
Restore in progress
The wizard will ask you to stop the Luxriot EVO services and start restoring the database after your confirmation.
Caution! This is an irreversible operation. Do not abort the process or shut down the server machine during
the process.
If nothing interferes with the restore process and the backup file is intact, you will receive a success message after
the wizard finishes restoring your Luxriot EVO server configuration. Server service will be automatically started with
the restored database.
This step will allow you to automatically search and add cameras and other video source devices into your server
configuration. Press the Launch Step 1 button to begin.
Setup Wizard
Scan Parameters
Device Autodiscovery
After scanning has been completed, you will be taken to the Device Autodiscovery dialog box, which will allow you to
review the found devices and their channels, and enter/modify related settings. Use the Search field in the upper-
right-hand corner to find a specific device by name, model, IP, port or hardware ID (for IP devices, ID includes MAC
address).
There are two types of selection in the item list: checkboxes and colour highlight. Checkboxes are used to
choose the items to be added to server configuration after you close the dialog box; highlighted items are
subject to immediate properties changes. Use CTRL+click or Shift+click to select all or several items at once to
change their settings.
Click a device in the item list to load its settings into the Device Properties window. Note that some settings may be
missing for some of the automatically found devices; this depends mostly on device and whether user data was
correctly provided. In such cases, simply fill in the missing data manually and click the Apply button below to save
the configuration changes.
If device is not integrated with the software (native support), it may be detected as generic type (e.g., ONVIF). If you
think some devices have not been discovered, check if they have different HTTP ports; also, try adding
them manually.
After changing the channel recording configuration, do not forget to click Apply, otherwise the changes will
not take effect.
Recording configuration here is assigned to the main streams of the target channels. In order to set up
substream recording, please go to channel configuration.
All previously discovered devices and all configuration changes will be discarded if you restart camera
autodiscovery.
When you have finished with configuration, click Add selected devices and channels to go back to the wizard.
If you are using the Luxriot EVO version of the software, you can now either restart the wizard to cover the rest of
your devices, or close it. Press the Launch Luxriot EVO Monitor button to switch to the monitoring mode at once.
Luxriot EVO S users can press the Launch Step 2 button to proceed with Users. This step will allow you to add users
and user groups and give them permissions for the devices and channels added earlier.
The built-in Administrator user account and built-in Administrators group are root users with access to
absolutely all the available resources. As a result, resources choice is unavailable for the Administrators group,
and it is also impossible to add Administrator user to any other group.
Any users added as members to the built-in Administrators group will have the same full authority as root
users.
User Groups
First, decide whether you want to create user groups or work with a non-systemised array of user accounts. For large
systems with complex user structure, groups are strongly recommended for reasons of improved manageability.
Choose No to proceed with plain user management at once; otherwise, you will be offered the chance to create user
groups and distribute existing resources between them. Note that the Setup Wizard interface offers simplified
settings for user groups at this point; later, you will be able to create nested groups via the corresponding Luxriot
EVO Console section.
Users
To create the first user, simply fill in their details and then click Create below. By default, the most recently modified
user will stay open for changes; correct user details, if necessary and then click Apply changes, or click Reset to
discard the most recent changes and revert to the latest saved state (the same thing will happen if you select a
different item for editing). Note that you do not have to re-enter the password when editing - only activate Set
password if you wish to re-define it.
To add more users, press the + New button on the upper panel and proceed in the same way as described previously.
Use the recycle bin icon to delete selected user(s) (hold CTRL or Shift to select multiple items).
To add a resource, pick at least one permission for it and it will then automatically be moved to the Selected
resources list. To remove a resource, uncheck all its permissions - either manually or using the Clear button below.
Note that double-clicking resources does not work here as one or multiple different permissions must be specified.
When you have finished, click OK to save and go back to the main wizard window.
On the last step, basic alarm and action management is introduced. Press the Launch Step 3 button to open the
dialog box.
Note that all the settings here apply solely to the channels discovered on the previous step; if you have configured
other devices prior to launching this wizard, they will not receive the current event & action settings - launch the
Event & Action Configurator to set up rules for other devices. You can also use E&A Configurator if you wish to add
other (advanced) types of alarms and/or actions.
When you are finished with all steps, you have the following options:
Restart wizard: start the wizard again to set up more resources
Launch Luxriot EVO Monitor: open Luxriot EVO Monitor application (will close the wizard)
Done: close the wizard and proceed to Luxriot EVO Console
You can run this Setup Wizard again at any time via your Luxriot EVO Console application menu in the upper right
corner.
Navigation Panel
Application Menu
Sections
Components
The panel on the left will display the list of all available configuration components based on the selected section. As a
result of license limitations, some of the items may be greyed out or unavailable. The list below shows maximum
available items by category:
Configuration: setup for the server components
Organisations, Networks, Servers, External services, Failover clusters, Users, Devices, Channels,
Recording, Maps, Layout templates, Layouts, Video walls, User buttons, Visual groups, Live
podcasts, Data sources, Mail servers, Reports, Access control
Events & Actions: configuration of automated scenarios
Rules, Events, Actions, Global events, Conditions, Schedules, Counters, OPC, Indicators
Monitoring: live component status
Servers, Devices, Channels, Streams, Archive statistics, Storages, User sessions, Video walls,
External services, Reports, Access control, OPC, Indicators
Audit: log of server events and user actions
Servers, Users
This document further describes the purpose and usage of each category in details.
Item List
The main part of the Luxriot EVO Console window displays items in the selected category depending on the search
and/or item filters. You can select one or more items at once using the Shift or CTRL button.
Item Actions
Item Filters
Application Settings
To change Luxriot EVO Console application settings, go to the main application menu in the upper-right-hand
corner and choose Settings. The preferences here only affect the current Luxriot EVO Console instance, no matter to
which server it connects.
Keyboard Shortcuts
Backspace: browse one step back in Luxriot EVO Console
Alt+F4: close Luxriot EVO Console
CTRL+A: select all items
Visual Elements
General
Remove item(s)
Deselect item(s)
Search
Configuration
Health monitoring
Audit log
Management
Server
Server group
External service
Failover cluster
Software Watchdog
Storage
User account/session
User group
General details
Device
Device group
Channel
Channel group
Motion detector
Layout Template
Layout
Layout group
Map
Video wall
User button
Visual group
Shared channel
Rules
Events
Actions
Global events
Conditions
Mail servers
4 Server Settings
All the changes in the server configuration are done via Luxriot EVO Console application. The settings are
immediately saved and stored in an encrypted internal database, which guarantees that your server
configuration cannot be accessed without entering a valid username and password.
Server database encryption is automatic, meaning that you do not need to enabled it explicitly, and is available
starting from the software version 1.8.0.
General
In order to access Luxriot EVO S server settings via Luxriot EVO Console, select Configuration section and then
choose Servers components from the menu on the left.
Details
On the Details tab, you can change the server name: it will appear everywhere in Luxriot EVO Console and in the
connected Luxriot EVO Monitor applications, including Web client.
Server details
Connections
The Connections tab allows you to define ports for Luxriot EVO Monitor and Luxriot EVO Streaming Server
connection; the default ports are 60554 for Luxriot EVO Monitor and 8080 for Luxriot EVO Streaming Server
(HTTP). Note that, in case you plan to access your Luxriot EVO S server from the Internet, the ports must be
properly forwarded on your router according to your desired topology and allowed through the firewall. Details on
the port forwarding setup can be found in your router operation guide.
Connection settings
Here, you can enable encryption for client-server connections and also for HTTP connections (by default, it is
disabled).
Server-client encryption setting affects all TCP traffic, i.e.:
Luxriot EVO Console connections to the Luxriot EVO S server
Luxriot EVO Monitor connections to the server
When you change the server-client encryption setting, all currently connected clients - both Luxriot EVO Console
and Luxriot EVO Monitor applications - will be disconnected so that the encryption settings can be applied correctly.
They will re-connect back shortly provided that they support encryption, too - make sure to upgrade them so that
their version matches server version.
Connection encryption is supported starting from software version 1.8.0. If your system has remote Luxriot
EVO Console and/or Luxriot EVO Monitor applications of older versions, these will be unable to connect
to a server that has encryption enabled; therefore, first make sure to upgrade all the clients and only then
enable encryption on the server side.
To enable HTTPS (HTTP over TLS), mark the corresponding setting and then:
specify HTTPS port (different from HTTP)
add a digital certificate
You can either use your own valid digital certificate or generate one right in the software. In the latter case, the
certificate will be self-signed and you will need to add it as trusted when connecting from the mobile app and from
your Web browser(s).
If you are using your own CA certificates, create a .pem file with your certificate chain as described here:
https://www.digicert.com/ssl-support/pem-ssl-creation.htm
This is necessary for the certificate to be recognized correctly by all HTTP clients - Web browsers and Luxriot
EVO mobile applications. If you simply apply your CA certificate in Luxriot EVO Console, there is a chance it is
not recognized because some applications require the entire certificate chain.
Then, apply the .pem file as the certificate together with your key when the importing certificate into Luxriot
EVO Console.
Also, if you are going to use SNMP traps in your Event & Action scenarios, here you can define server's SNMP
community name and SNMP port for incoming and outgoing messages. Community will be used by the SNMP
manager to send requests; SNMP port will serve for both incoming and outgoing messages (supported incoming
messages are third-party SNMP manager requests, not external SNMP traps!). Leave both values zeroed to
disable this functionality.
The next topics describe the remaining aspects of server settings in details.
4.1 Watchdog
General
Server Watchdog is an important part of the Luxriot EVO software. It runs as a separate Windows service
and protects the software from certain types of failures by automatically attempting to restart the server.
Watchdog operates based on the software and system overall health monitoring; default trigger values have been
selected on the grounds of our analysis of extensive tests, which we conducted on many systems with different
configuration and stability level.
Although it is possible to disable the Server Watchdog service, we strongly advise against doing so, as the principal
role of the watchdog is to keep the software operation as stable as possible in the given circumstances.
Watchdog operation can be tracked by messages in the Windows Application log and in the software Audit log. If
you do experience frequent disturbances such as software restarts or server rebooting, this might be an indication of
some serious issue related to the software, operating system and/or underlying hardware. In such a situation, the
best course of action is to:
carefully read the messages in the Windows Application Log, as these may already contain some indication
of why Watchdog was triggered;
refer to the relevant topic in the Troubleshooting section of this manual to read about typical causes of
such cases;
send a Problem Report from the faulty server, providing as much information as possible about the issue;
consult the Luxriot technical support team directly via [email protected].
Configuration
Watchdog operation can be configured for each server independently. To access the watchdog settings in Luxriot
EVO Console, select Configuration in the bottom left menu and select Servers from the list on the left, then double-
click the desired server or simply click Edit button on the top panel for the pre-selected server.
Watchdog configuration
The table below contains a detailed explanation of the watchdog settings. Please note that, for most cases, default
and near-default settings are recommended; it is advisable that you consult with Luxriot support if, for some
reason, you plan to make extensive changes to these settings. Click the information icon next to each setting to read
more about them.
4.2 Storage
Server storage configuration includes storage directories, size and duration quotas, optional encryption, cleanup
time settings and storage differentiation by name for further flexible allocation of the recorded streams.
To access the storage settings for the server via Luxriot EVO Console, choose the Configuration section, then select
Servers from the menu on the left, double-click your server and then click the Storage tab. Click the Open storage
properties button to open the configuration dialog box.
There are also several settings in server settings dialog box itself. These are explained in the end of this chapter.
Directories
All available local disks will be automatically listed after the first installation (with empty configuration) and
enabled for recording with default archive directories using the Default storage label. By default, system disk (C:) is
not listed if other disks are available, as we strongly do not recommend recording to the system disk.
If you are upgrading, re-installing the software, restoring an earlier database configuration, or inserting new local
disks into the server after the software has been installed, the local disks will not be listed automatically so you need
to add them as new storages. You can also add network paths to remote storage locations.
Use UP and DOWN arrows on the right to change the disk order (priority); use the recycle bin button in the
top panel to remove any local or network directory from the storage configuration.
Mapped network shares that appear as drives in Windows Explorer will not be listed automatically because
Luxriot EVO operates as Windows Service and therefore is unable to access these (due to Windows API
peculiarities). You are welcome to add these as network directories in storage settings.
Minimum quota per each storage location for any storage type is 20GB.
We advise against recording to the system drive because it is often used by other processes like
defragmentation and system backup, not to mention the operating system itself, and thus doing so may affect
recording efficiency and stability. As a result, disk C: is not selected for recording by default.
Total size and free space on the network storages is not displayed here. You can check these in the
Monitoring section of Luxriot EVO Console, under Storages.
To change the disk quota, simply highlight the desired location for storage from the item list, then enter the quota
size in GB and click Apply changes.
If you plan to protect some footage from being erased (this functionality is available via Luxriot EVO Monitor
application), keep in mind that protected archive areas will be ignored when forcing quotas. Make sure
there is enough free space on the disk(s) and set lower quotas, if necessary.
To review and/or un-protect such areas, go to the Monitoring section of Luxriot EVO Console, choose
Archive statistics on the left, highlight one or more target channels, and press the Protected intervals button
on the top panel.
Storages
You can either use the Default storage category for all locations, or create multiple different storage profiles (types,
names, labels). These can be used for manually distributed streaming between storage directories:
storage directories are marked with corresponding storage tags
each channel is assigned to a recording location
To choose a storage profile different from the Default, select the storage location from the Directories list and click
the Change button.
Change storage
Select one of the built-in storage profiles or create and edit a new one.
Readonly storage type can be used, for example, in the following cases:
it is necessary to view the old data from a different Luxriot EVO server when you need to insert the
disks originating from another computer and you do not wish that these data are erased
some storage unit contains important footage that has been requested to be kept for a longer time so
that the recordings are not erased over time while still allowing access to the footage
Click + New storage button to create a new storage profile, or select an existing one and click the Edit button in the
upper-right-hand corner to change its name.
Add Storage
In order to add a new local disk or a network storage (NAS, SAN, network share), click + New button on the
upper panel, select New local directory or New shared directory, and then enter the setup details.
If you are using a NAS, make sure to disable the Recycle Bin feature (for some NAS models, it is called
trashbox or similar). This will ensure that the erased files (e.g., when reaching quota) are actually deleted
permanently.
If you are adding a previously encrypted storage (e.g., it has been used on another server), make sure to
provide the same password. You can track the storage status in the Monitoring section of Luxriot EVO
Console, under Storages.
Storage Encryption
Once you have added all the necessary storages, you can enable encryption and set a password for each storage
separately.
When assigning a new password for the storage, make sure to remember it or store in a secure place: you will
require it, should you need to access the storage contents in the following scenarios:
when accessing the archive with the Portable Player tool
when adding the same disk as a storage unit for another server
when adding a disk containing archive backup as a storage unit
if you delete the encrypted disk from the storage configuration and then add it anew
There is a field that allows you to enter a password hint, which will be displayed in these situations.
You will not be prompted for the password when accessing the archive from the Luxriot EVO Monitor
application connected to a server with encrypted archive: Luxriot EVO server will decrypt it automatically.
Starting from the moment you set the password, all footage recorded to the target storage becomes encrypted;
retroactive encryption for the previously recorded archive is not supported.
When the storage password is changed, the new password is used for encryption from then on. If storage encryption
is disabled for some time and then enabled back, that part of the archive will remain unencrypted.
Duration Quota
Set the global recording duration limit for your server here: enable quota management and then enter desired
number of days. All recordings older than the number of days specified will be erased.
Retention
You can set the software erasing mechanism so that it cleans up old recordings only during specific periods of time,
e.g., when the recorder is less overloaded or when the quality of recordings are less important.
This control has priority over the storage quota. Setting insufficient cleanup time may lead to storage overflow
and result in recordings being lost. We strongly recommend that you do not enable any cleanup hours'
restrictions unless you absolutely know what you are doing.
Fallback
You can dedicate a specific recording location to serve as a failover storage, called fallback storage. Such storage
location will be used for recording only if all specified target storages of the certain type have failed.
Luxriot EVO server automatically detects when a channel or channels cannot be written onto their normal
destination storage and switches to the fallback storage after the specified timeout has been reached. Minimum and
also default timeout is thirty seconds, and maximum is five minutes. A default system event is raised when fallback
is activated.
The fallback storage must be able to handle the load and have enough free space to keep the recordings until
the main storage gets back online.
Server checks if the main storage is available if one of the conditions has been fulfilled:
server has finished and closed a data file (4GB)
the data file has not reached 4GB in size but six hours have passed
server was restarted
In other words, the recording mechanism checks if the main storage is available every 6h OR every 4GB of recorded
data OR after a restart (upon startup). If the main storage is OK, Luxriot EVO server continues to record onto it; the
recordings made onto the fallback storage stay there and are not transferred anywhere.
To save the changes, hit the Apply button beneath the storage settings, then hit OK to close the storage
configuration dialog box, and then click OK to finally save the storage settings together with the server
configuration. Pressing Cancel on the last step will revoke the changes in the storage configuration.
Outdated archive is erased automatically once any of the quotas is reached (storage or duration, server wide or
individual). Oldest recordings are removed to free up some space for the newer recordings. However, there are some
exceptional cases when the footage is not or may not be erased:
storage marked as Readonly will not be used for writing and no data will be erased from such storages
based on quotas (however, footage from such storages can be removed using selective erasing from the
Luxriot EVO Monitor application)
no erasing will be conducted outside cleanup hours (by default, erasing is allowed 24/7 and this setting is
recommended)
protected archive intervals will be also ignored by the erasing mechanism until you un-protect them
Archive protection is an additional feature available in the Luxriot EVO Monitor application, in playback mode.
You can mark certain footage to protect it from being erased if it is important to keep it for longer, overriding the
quotas (e.g., important evidence). To unlock the protected intervals, go to Archive statistics in the Monitoring
section of Luxriot EVO Console.
If there are too many protected recordings on a disk, the storage may be filled up to 100%: this may negatively
affect the overall recording operation. Pay attention to the amount of free space on every storage unit in case
you are using archive protection:
set lower recording quotas so that there are always 10-15% of free space on each storage,
un-protect the archive that no longer needs to be protected from erasing.
When you protect a short period of the archive (e.g., several minutes), in fact, the whole file containing
this period is protected from erasing. Therefore, intervals adjacent to protected period will also be locked. You
can verify the exact protected interval by opening Luxriot EVO Console >> Monitoring section >> Archive
statistics >> Protected intervals.
Keep this in mind when protecting too many short intervals: as all files containing them are locked, they will
not be erased when forcing quotas, so you may come to a point when there is not enough free space on the
disk. If you know you will use the archive protection feature a lot, it may be wise to set a lower disk quota -
for example, 80% instead of 90%.
Luxriot EVO Monitor application allows users with corresponding privileges to delete certain parts of the archive.
This mechanism can delete recordings from storages marked as Readonly but cannot erase protected archive from
any storage unit.
If the footage is not protected, it will be removed as outdated when the server eraser reaches one of the quotas. Also,
the unprotected footage can be removed manually by someone who has a permission to delete archive.
However, as such a feature may be regarded as a potential threat for the archive integrity, it is disabled by
default. You can enable it in the server storage settings by marking the Allow manual deletion option.
Enabling manual archive deletion will automatically enable the admin user to do so, as admin is a root user
who has all possible privileges. The same is true for all users belonging to the Administrators group. If you are
enabling this feature, make sure that no unauthorized personnel have access to the administrative accounts.
There is a possibility to grant archive access permissions for a limited time: for example, for the last N days or M
hours. The access permissions are a part of the channel permission set.
Here, in the server settings dialog box > Storage tab, you can define the allowed archive access period, starting from
the present moment.
Depending on your needs, the duration can be expressed in minutes, hours, or days. The minimum period is 10
minutes and the maximum value is 366 days (1 year).
Example: if the recent archive interval is set to 30 minutes, all users having a Restricted video playback permission
will be able to browse the last half an hour of the target channel archive in all archive playback modes of the Luxriot
EVO Monitor application.
4.3 Encryption
All Luxriot EVO editions have enhanced security aimed at data protection, which includes not only advanced
permission management but also encryption wherever possible. Data protection for Luxriot EVO encompasses
database encryption, server-to-server and server-to-clients connection encryption, as well as password protection
for the proprietary archive.
Database Encryption
Luxriot EVO server uses several databases for storing the server configuration, audit logs and other software data,
and all of them are encrypted by default. Once you install the software version that supports database encryption, all
the databases are automatically converted to the encrypted format. There is no need to adjust any settings to enable
this feature.
Database encryption was introduced starting from the Luxriot EVO version 1.8.0 and is supported in all
succeeding versions.
Connection Encryption
Traffic encryption is not enabled by default, it can be turned ON in the server settings, in the Connections tab. There
are separate settings for TCP connection encryption and HTTPS.
Client-Server Connections
This setting affects all TCP traffic between servers and clients, including server-to-server communications in Luxriot
EVO Global.
When configuring a Luxriot EVO Global system that has remote servers and clients of version 1.7 or earlier,
make sure to upgrade all remote components to the same version as Luxriot EVO Global so that they support
encrypted connections. As soon as it is done, you can safely enable encryption for TCP connections.
HTTPS
Connections from remote Web browser clients and mobile applications, as well as API connections, can also use a
secure channel instead of plain HTTP.
To enable secure communications, enable HTTPS in the server settings, then specify desired HTTPS ports (different
from HTTP ports) for local and internet connections, and then add the digital certificate you wish to use; you can
either use your own certificate or generate a self-signed one right on this step.
It is recommended that you use a valid digital certificate signed by a trusted authority instead of self-signed
ones. If you use a certificate generated by Luxriot EVO, your browser will show you a warning.
Archive Encryption
Each archive storage (local or network), as well as archive backups made through the Archive Backup Wizard, can be
encrypted. You can provide a different password for every storage unit, and there is also an option to change the
password at any time.
To access the archive encryption settings in Luxriot EVO Console, open the Configuration section, choose Servers
on the left, then double-click the desired server to edit its settings. In the Storage tab, click the Open storage
properties button.
Click the target storage in the list on the right or add a new local or network storage unit by using the +New button
above the storage list: its properties will appear on the left. Mark the Enable encryption option and specify the
password you want.
To save the changes, hit the Apply button beneath the storage settings, then hit OK to close the storage
configuration dialog box, and then click OK to finally save the storage settings together with the server
configuration. Pressing Cancel on the last step will revoke the changes in the storage configuration.
When assigning a new password for the storage, make sure to remember it or store in a secure place: you will
require it, should you need to access the storage contents in the following scenarios:
when accessing the archive with the Portable Player tool
when adding the same disk as a storage unit for another server
when adding a disk with archive backup as a storage unit
if you delete the encrypted disk from the storage configuration and then add it anew
There is a field that allows you to enter a password hint, which will be displayed in these situations.
You will not be prompted for the password when accessing the archive from the Luxriot EVO Monitor
application connected to a server with encrypted archive: Luxriot EVO server will decrypt it automatically.
Starting from the moment you set the password, all footage recorded to the target storage becomes encrypted;
retroactive encryption for the previously recorded archive is not supported. If you wish to have the already recorded
data to be encrypted, you can use the replication feature in Luxriot EVO Global, targeting the replicas to an
encrypted storage.
When the storage password is changed, the new password is used for encryption from then on. If storage encryption
is disabled for some time and then enabled back, that part of the archive will remain unencrypted.
If you wish to use a storage, which contains encrypted archive, as a new storage unit and add it to the server
configuration, you will be prompted for the password. You need to provide the password that was used to encrypt
that disk. If you have provided a password hint earlier, it will appear as a tooltip when hovering your mouse over
the password field.
Do not modify the contents of encrypted disks manually, this may result in the corruption of the whole
archive.
Archive Backups
The archive backup tool also provides an option to specify a password to encrypt the backup.
Security Policy
Security settings related to password management, connections etc. can be defined for each system. To access the
server security policy settings via Luxriot EVO Console, choose the Configuration section, select Servers from the
menu on the left, double-click your target server and then click the Security policy tab.
It is recommended that, in order to enhance your system security, you do not leave the default policy settings but
rather define your own, system-specific preferences.
Password related policies are solely meant for Luxriot EVO internal users and they do not affect any other user
account settings (e.g., Windows users etc.). All policies are in effect for all user accounts, including the built-in
root admin user account.
The maximum number of simultaneous connections from the same user account can be re-defined for
any specific user via user settings dialog box. User-specific setting has priority over global connection quota
and it may be either larger or smaller than the global quota.
Example 1: global policy is set to 0, which means no imposed limitations. However, user account admin has
his max number of connections set to 3, which means that three incoming connections with this user account
are allowed at a time so that the administrator can connect via Luxriot EVO Console, Luxriot EVO Monitor
and Luxriot EVO Mobile at once for troubleshooting purposes.
Example 2: global policy is set to 1, which means only one connection from each user is allowed at a time.
However, user demo has an allowance of 30 simultaneous connections so that this account can be used for
demonstration purposes.
Audit Policy
Whenever a permission is used, a corresponding entry appears in the internal Luxriot EVO audit log; internal server
events are logged as well. The audit policy lets you define, which user actions and server events are recorded, as well
as set the maximum size and duration of the audit log.
External Audit
For Luxriot EVO Global software edition, it is possible to set up set up log event storing in an external audit
database. The main (internal) audit log is kept always, and the external audit is a copy (addition). You cannot turn
OFF the internal audit if you do not need it, but you can limit it to one or two days, and keep the external log for a
longer period.
Once you have entered the database connection details, you can test it and enable it
After adding the database connection, you can test it to verify that the entered configuration is correct. The database
must exist for the Luxriot EVO server to connect successfully, and you cannot create a new external database from
Luxriot EVO Console. The connection test runs automatically once you have entered a new DB connection or
modified the connection settings.
The connection test may take some time. You can tell by the disabled (grayed out) buttons below. If you
close the server settings dialog box, the test will still run in background so you will have the result pop up after
some time.
If your target database contains something else and you want to clean it, press Reset: all contents of the target
database will be then removed and replaced with the tables necessary for the audit log.
Similarly to internal audit, here you can limit for how long and how many records should be kept in the external
audit database. Set zeroes for unlimited options (the number of records will be then only limited by databaase
type).
You can prepare the database connection and leave it disabled (default mode) until you decide to enable the
external logging. To do this, put the chack mark in the corresponding checkbox.
When done, click OK to save the settings and close the dialog box.
Troubleshooting: if, during operation, the Luxriot EVO server is unable to write events to the external
database, you will have a warning (highlighted orange) in the Monitoring section of Luxriot EVO Console, under
the Servers category. Click the target Luxriot EVO Global server, then click Details on the upper panel to see the
database connection errors.
Bookmark Policy
Here, you can set limits for the bookmark database by defining its desired duration and size, and also change
bookmark colours for different severity levels. The settings here affect the whole system - all servers, all channels.
The default (and also the maximum) number of records (items in the database) is 500000, and they are kept for
5 (five) years. Set 0 days to set unlimited duration quota (the items' quota will still have effect).
These limitations were introduced in the software version 1.14.1. Therefore, when you upgrade from an older
version, database will be reduced in size by removing the oldest bookmarks so that their number matches the default
quota (500000). If the old database contains more than 1 million items, it is truncated and compacted during the
upgrade.
NTP Server
Luxriot EVO servers use the local machine time. Luxriot EVO Console provides you with an opportunity to force
sync time with the specified NTP server.
Essentially, this is the same as configuring the target server OS use the speficied NTP server: the time server you set
via Luxriot EVO Console is applied to the underlying OS settings. The only difference is that you can do this
remotely via Luxriot EVO Console interface, without connecting via RDP or other remote control software.
Image Title
Scan Parameters
Device Autodiscovery
After scanning has been completed, you will be taken to the Device Autodiscovery dialog box, which will allow you to
review the found devices and their channels, and enter/modify related settings. Use the Search field in the upper-
right-hand corner to find a specific device by name, model, IP, port or hardware ID (for IP devices, ID includes MAC
address).
There are two types of selection in the item list: checkboxes and colour highlight. Checkboxes are used to
choose the items to be added to server configuration after you close the dialog box; highlighted items are
subject to immediate properties changes. Use CTRL+click or Shift+click to select all or several items at once to
change their settings.
Click a device in the item list to load its settings into the Device Properties window. Note that some settings may be
missing for some of the automatically found devices; this depends mostly on device and whether user data was
correctly provided. In such cases, simply fill in the missing data manually and click the Apply button below to save
the configuration changes.
If device is not integrated with the software (native support), it may be detected as generic type (e.g., ONVIF). If you
think some devices have not been discovered, check if they have different HTTP ports; also, try adding
them manually.
After changing the channel recording configuration, do not forget to click Apply, otherwise the changes will
not take effect.
Recording configuration here is assigned to the main streams of the target channels. In order to set up
substream recording, please go to channel configuration.
All previously discovered devices and all configuration changes will be discarded if you restart camera
autodiscovery.
When you are ready, click the Add selected devices and channels button below; all checked devices will be added
with selected corresponding channels. Newly added devices and channels will be added to the item list.
When deleting devices, remember that corresponding channels will not be removed at the same time and
therefore your newly discovered devices may not be added due to license limitation. Go to the Channels tab to
manage them separately.
Only IP devices can be added manually. Attached devices (e.g., capture boards) require autodiscovery.
Network and Channels become available after device model has been chosen
Details
Membership
Choose groups for the current device to become a member of. Use Add and Remove buttons below or double-click to
manipulate groups. One device may belong to several groups at once.
Permissions
Add users and/or user groups simply by checking at least one permission for the target server; remove by clearing
permissions - either by deselecting them or by clicking the Clear button below. You can also double-click users to
remove them from the list of privileged users. Devices with an empty permission list will not be available to anyone
except for the root (global) administrator.
Network
Channels
Here you can detach automatically detected channels from the device and replace them with one of the existing 'free'
channels (not attached to any device). Use the Reset button to undo any changes made to the channels (this only
works for current editing session, reset will not be available after you save the changes and reopen this dialog box).
If you wish the original camera channel(s) to stay attached to the device, just leave the channel list as it is.
Channels
Add devices
To remove any of the listed items, select them with your left mouse button (use CTRL+click or Shift+click to select
multiple devices at once) and hit the Delete button on the upper panel or on your keyboard. Select any device and
use the Add button on the upper panel to add a copy of that device.
Device parameters
For each added device, enter corresponding settings. Note that you can skip IP and port on this step if you wish to
use automatic incremental IP assigning (see IPs and Ports tab description below).
If you do not apply the modifications, they will be discarded when you select a different device from the item
list. Remember to always click the Apply button.
You will be asked to review the list of modified fields and confirm the changes.
Confirm changes
Click OK to accept the changes and go back to the configuration dialog box.
You can select multiple devices and assign IP addresses incrementally with the defined increment. Similarly, it is
possible to change the HTTP port for all devices at once, if required (port value stays the same for all selected
devices, with no increment). In order to do this, select desired devices by using CTRL+click or Shift+click, then start
entering the IP address: the field will expand, giving you the option to enter the increment.
Channel Settings
Here you can modify channel names and recording configuration. Note that channel name is not copied from the
device name.
Unlike with automatic device discovery, default recording configuration here is [none], meaning that recording is
not conducted. Select one or multiple devices and then click the Change button in order to choose an
existing recording configuration for the target devices or create a new one.
Depending on the selected device model, the number of channels may coincide with or exceed the number of
devices, e.g., when device is a 4-channel encoder.
Channel properties
Select one or multiple devices and click Change, then select appropriate recording profile or create a new one.
When you have finished, click OK to add all the new devices and their channels to your server configuration.
Device Models
There are several device types available in the Luxriot EVO model list:
emulation
generic
models by vendor
Each group of models is further explained in more details. The selected model affects device-specific functionality;
server-side functions (e.g., motion detection, Open VCA) will be available regardless of the device model.
Emulation devices allow using a video/image file as the video source. This is an auxiliary driver often used for
demo purposes, or when configuring/troubleshooting license plate or facial recognition. Still images must be in
JPG/JPEG format. Video files must be in AVI format, encoded as MPEG4 AVC h.264; video files exported from
Luxriot EVO Monitor or Portable Player will work, too, provided that they were exported as AVI with JPEG
compression.
After creating an emulation device, go to its channel's properties and specify the full local path to the target
video/image file (Channels > open channel for editing > Channel configuration tab > Channel properties > Settings
> Location). If you move such a device to another server, make sure to copy the file to the new server, or adjust the
path in the channel settings.
Generic drivers are based on common video transfer protocols, so these can be used for legacy hardware, non-
integrated cameras/video servers, or non-traditional video sources (e.g., screen capturing software).
RTSP uses generic RTSP streaming over TCP/UDP, and includes two video streams and also audio (G.711). After
adding this kind of device, go to its channel properties and specify the RTSP tag for both main and secondary video
streams (Channels > open channel for editing > Channel configuration tab > Channel properties > RTSP > Path to
Session Description Protocol File). The RTSP tag is the URL part after the IP address, so it should look something
like /mpeg4/media.amp or /videostream.cgi. You can find this information in the device HTTP/CGI
documentation provided by the manufacturer. You can also specify a custom RTSP port here, in case the device
configuration uses a non-standard port, or if port forwarding is set up.
ONVIF Driver
This driver can be used for all devices that are ONVIF Profile S conformant. By default, the ONVIF Compatible
model is recommended (and it is also used when auto-detecting devices). It it does not work with older cameras, try
the ONVIF Compatible (legacy) driver.
In device autodiscovery, this model will be used alongside with the native integrations: for not-yet-integrated
brands/models, ONVIF model will be assigned wherever possible (i.e., if device responds properly to the ONVIF
communication).
External Source
This device type is reserved for receiving streams from the Luxriot EVO Mobile applications. Channels belonging to
such devices are only counted by the license when the app streaming is active.
After adding this device, copy the Code from its properties to your Luxriot EVO Mobile app to enable streaming from
the app to the Luxriot EVO server. You will find more details in the mobile app section of this document.
Webpage
Choose this model to add streaming from a website UI. The contents fetched from the specified URL will be
displayed as a single, static (non-interactive) live video stream, with an option to record it. You can use this
device driver for streaming from public services, monitoring web services, sites with dynamic contents etc.
Unlike for the generic RTSP driver (where you set the device IP and then add the RTSP URL in the channel
properties), here you need to specify the full URL in the device settings at once. Channel properties for webpages
will have a separate tab, Web page configuration (Channels > open channel for editing > Web page configuration).
Models by Brand
Native device integrations are available for over 140 manufacturers and their 5000+ device models. This list
includes cameras, NVRs, video encoders, and I/O modules. Models from this list are used when running device
autodiscovery, and you can also use them when manually adding devices.
If you cannot find your exact device model in the list, try the closest available model: quite often, cameras within a
series are intercompatible. Also, if you know the device's OEM brand, you can try models from that manufacturer.
Manage Devices
Device management is accessible via Luxriot EVO Console Configuration section, by choosing the Devices category
in the menu on the left.
Upper panel items allow you to add devices automatically or manually, edit, view and remove them, as well as
quickly assign groups and servers. Double-click any device to open it for editing; click View channels on the upper
panel to open channel-specific controls in the same window. If device has multiple channels, all of them will be
listed.
If you have opened a device for editing but there is a need to open the associated channel's properties at
the same time, use the Related items buttons in the bottom left corner of the Edit device dialog box.
Please refer to the Add Devices Manually section of this document for detailed description of all available tabs and
settings.
Use bottom panel buttons to quickly filter recently added/updated devices, choose groups only or solely devices not
assigned to any of the servers.
Remove Devices
To remove a device, select it in the item list and use the Recycle bin button on the upper panel to delete the
target device. Use Shift+click or CTRL+click to select multiple devices, or CTRL+A to select all.
You can choose to remove all associated channels together with the device(s)
You will be offered to remove all the attached channels together with the device(s). Press Yes to delete the channels
or choose No to leave the channels: they will appear as detached in the channel list then and you will be able to re-
attach them to other devices, keeping the channel recording configuration. If you choose Yes, all existing shared
channels based on the channels of the target device will be removed automatically as well.
If you try deleting a device that has associated rules in the Event & Action Configurator, you will get a
warning dialog box with those rules listed. You can either proceed with removing the target device, its
channel(s) and its rule(s), or cancel the deletion.
As with other resources, devices can be grouped together for easier management. Click the little arrow near + New
device button and select New device group.
Copy Device*
*Feature is subject to license limitations and may be unavailable in some software editions.
Starting from the Luxriot EVO version 1.11.0, it is possible to copy an existing device and its channel(s). To copy
a device, click the little arrow next to the + New device button on the upper panel and choose Create copy from the
drop-down list. The related channel(s) will be copied automatically.
select one of the existing devices in the list on the left (a single device can be selected at a time),
set the number of target copies below,
when ready, click the + Add button to create the selected copies,
repeat previous steps with other devices, if required.
To add a single device copy, you can simply double-click it in the list.
Use the search fields on top of the lists to find the necessary item in a long list. If you no longer wish to add any of
the created copies, you can select multiple items using CTRL+left click or Shift+click and remove them using the
Recycle bin icon above.
After you have added new devices using this method, please allow some minutes for the configuration to be
saved. After that, you will be able to change the newly created device and channel settings.
The associated channel(s) will be added automatically with all the existing settings, including the assigned
recording configuration.
Replace Camera
In the Luxriot EVO versions up to 1.11.0, it was impossible to alter the device model, so a special procedure was
foreseen if the camera needed a replacement.
Now, if you replace the hardware, you can simply change the device model by opening the target device for
editing - either by double-clicking it in the device list, or by using the Edit button on the upper panel. Note that,
when you change the model of an existing device, you will only see model suggestions with the same number of
channels, and not the whole list of available devices.
When you change the device model, all the channel settings that are configured via Channel properties
dialog box are discarded. These settings include video stream properties, audio, DI/DO etc.
Channel settings that are preserved are: motion detection, dewarp, data source, user permissions and
recording configuration.
Channels currently bound to devices cannot be deleted: the recycle bin button will only appear when
detached channels are selected. To remove a channel, go to Devices, open properties of the target device
and disengage the channel on the Channels tab by clicking the Detach button; also, you will be offered to
delete all associated channels when you remove the device itself - this will also remove any existing shared
channels.
Channels that have any associated rules in the Event and Action Configurator cannot be removed. If you
try deleting such a channel, you will get an error saying The channel cannot be removed because it is in use.
In order to remove such a channel. you need to delete the rules related to it first. To do so, just go to the Events
& Actions section, choose Rules in the menu on the left, select the target server and open the configurator,
then remove the necessary rules from the central column by using the < and > buttons.
All available channels and channels groups will be listed here. The upper panel offers a range of configuration
opportunities.
Channel groups can be added for easier management in Luxriot EVO Console; by default, there exist no built-in
channel groups. Click + Create channel group button to bring up the corresponding dialog box.
Enter the group title here, select channels to be group members and select higher level group(s) to contain target
group as a member, if desired. Set user permissions for channels in this group.
Double-click any existing channel group in the list or use the Edit button in the upper panel to bring up the
configuration dialog box. Available options are analogous to the ones displayed during group creation time.
Edit Channel
Channels are automatically created together with each newly created device; it is not possible to create a channel
separately. Click any channel in the list twice or use the Edit button on the upper panel to manage the channel
properties.
Permissions tab: grant channel access permissions to users and user groups
Video file configuration: settings for the generic video emulation driver: main and substream file path
and delay between frames
Motion detector* tab: choose between a camera-side or software-side motion detector, default state is
disabled
Video analytics: server-side video analysis configuration
Audio tab: combine current channel with audio from another source
Inputs/Outputs: DI/DO settings
Channel configuration: open an additional channel configuration dialog box to manage video stream
settings, frame adjustments and DI/DO
Video overlay: configure different overlay elements, e.g., textual contents received from data sources
Dewarp tab: select dewarp profile for fisheye and Panomorph lenses
Video configuration: main and secondary stream adjustment (for newer device drivers)
RTSP configuration: RTSP port and transport selection (for newer device drivers)
Edge configuration: configuration of edge (device-side) synchronization (for newer device drivers)
Please refer to the Channel Settings topic for detailed description for each of the tabs.
*Motion detector on the software side has two options: high performance and high accuracy:
High Performance mode: this type of analysis is performed for only key frames whose frequency can vary
from several frames per second to one frame every few seconds - this is less sensitive for picture quality, but
greatly affects detector operation. CPU consumption is significantly lower due to this, and it can be
additionally reduced by increasing time interval between two analyzed frames.
High Accuracy mode: this mode performs motion analysis for the whole video stream, so we recommend
selecting this option when you want to achieve best detection results. The lower time interval means higher
precision. Keep in mind that CPU and virtual memory usage is much greater if this mode is selected.
If you have opened a channel for editing but there is a need to open the associated device's properties at the
same time, use the Related items buttons in the bottom left corner.
After a device and its associated channel has been added to the configuration, it is vital to check if the actual video is
received. There are several methods to do this in Luxriot EVO Console:
click the Show video button on the upper panel in the Configuration > Channels: you can switch from
main to the secondary stream and back
go to the Monitoring section > Channels and check the channel status
open the target channel for editing and go to Dewarp or Data source settings
Assign Group
Channel membership can be managed via the channel properties dialog box. To quickly assign group to any of
existing channels, select desired channel(s) (use CTRL+click or Shift+click to select multiple items) and click Assign
group button on the upper panel.
Replace Camera
In the Luxriot EVO versions up to 1.11.0, it was impossible to alter the device model, so a special procedure was
foreseen if the camera needed a replacement.
Now, if you replace the hardware, you can simply change the device model by opening the target device for
editing - either by double-clicking it in the device list, or by using the Edit button on the upper panel. Note that,
when you change the model of an existing device, you will only see model suggestions with the same number of
channels, and not the whole list of available devices.
When you change the device model, all the channel settings that are configured via Channel properties
dialog box are discarded. These settings include video stream properties, audio, DI/DO etc.
Channel settings that are preserved are: motion detection, dewarp, data source, user permissions and
recording configuration.
Other
Select one or multiple channels/channel groups and click the Disable button on the upper panel to deactivate target
items. Disabled channel contents will not be requested from actual physical devices, and, as a consequence, will not
be recorded; neither will they be displayed in the Luxriot EVO Monitor application(s).
The filter panel at the bottom enables you to view recently added/updated items, as well as other relevant filters. The
filter that is currently active is highlighted blue: click the N filtered button to reset all filters and display all the
available items again.
Details
Here you can change the channel title and assign recording configuration. Available fields:
Title: user-defined cannel name, as it will appear in Luxriot EVO Console and Luxriot EVO Monitor
applications
Main stream recording configuration: choose how the first video stream (usually, higher resolution)
will be recorded
Main stream storage: destination storage for this stream (may differ from other streams)
Substream recording configuration: choose how the second video stream (usually, lower resolution)
will be recorded
Substream storage: destination storage for this stream (may differ from other streams)
Edge stream recording configuration: choose how the edge stream will be recorded, if used
(available for ONVIF Profile G conformant devices and also for offline recordings made by Luxriot EVO
Mobile)
Edge stream storage: destination storage for this stream (may differ from other streams)
Video lost time: the amount of time in seconds for EVO to wait after all channel's video steams
disappear and before triggering a Video loss event
Recording identifier (only displayed if Show object IDs option is enabled in the application settings):
unique channel identifier that is used as its folder name in the archive
Channel details
You can either use the Default storage category for all target streams, or use different storages for different streams.
The latter can be used for manually distributing streams between different directories:
storage directories are marked with the relevant storage profiles (e.g., Main, Substreams, Edge),
each channel and even channel's streams are then assigned different storages.
To choose a storage profile that is not Default, select a storage from the Directories list and click the Change button.
Click the Change button to choose the recording configuration: you can pick an existing configuration or create a
new one, or a schedule on the spot from the same dialog box.
Please choose Continuous Recording configuration for edge streams to ensure proper recording.
When you assign a motion-based recording configuration to a channel with a disabled motion detector,
the software will automatically suggest enabling motion detection for the target channel. The camera-side
detector is given priority; if it is not available, the software-side detector will be enabled and set to the high-
performance mode. We recommend that you review the motion detector settings to make sure it operates as
desired, especially if the camera-side detector is in use.
Note that if you leave motion detection OFF and assign motion-based recording configuration to the target channel,
no data will be recorded.
Members
This section allows you to attach user buttons to channels, so that they appear together in the Luxriot EVO Monitor
application. User buttons bound to channels in this way will appear as video overlay controls when the target
channel is placed into a viewport.
If you are editing a channel group, this tab will allow you to put other channels and channel groups into the target
group.
Membership
Choose the group(s) you want to contain the target channel as a member: double-click the relevant items or use the
Add/Remove buttons below to select/deselect. You will have both channel groups (internal in Luxriot EVO Console)
and visual groups here.
Permissions
Allow users and user groups to access and administer the target channel. To add a user or user group, simply select
at least one permission, and the user (user group) will be automatically moved to the Selected users list. To clear all
permissions, double-click the user in the left-hand column. You can also use the checkbox next to Permissions in
the central column to toggle between all/none (if not all permissions are selected, the checkbox will be filled with a
black rectangle).
This tab will only appear for channels bound to devices with the Webpage model (generic model specifically
dedicated to streaming from web), and will affect both live and recording.
This tab only appears if the underlying device is of the (Emulation) Video File type. Here, you can specify the paths
to the video streams that will act as main ans secondary stream.
Choose between camera-side or software-side motion detectors (MD). The default detector state is disabled,
meaning that no motion information is received or passed for recording for the target channel. If you are using
motion-driven recording profiles, make sure to enable motion detection for the selected channel(s).
When selecting camera-side motion detection, make sure to go to device Web interface to enable
and configure motion detector. Settings may vary depending on device manufacturer; also, check with Luxriot
to make sure hardware motion detection is supported for the target device.
Camera-side motion detection is recommended for most cases for two basic reasons:
computational load is transferred from servers to devices, decreasing server load, and
on most devices, hardware-side motion detection is performed on raw video stream, which means superior
accuracy compared to software-side detector, as software only gets access to compressed stream.
Software-side motion detector is a preferable choice if:
legacy devices without MD support are used, or
there is a necessity to use build heatmaps - in this case, grid-like MD on the software side is helpful.
High Accuracy mode: this mode performs motion analysis for the whole video stream, so we recommend
selecting this option when you want to achieve best detection results. The lower time interval means higher
precision. Keep in mind that CPU and virtual memory usage is much greater if this mode is selected.
In both modes, the level of sensitivity can be adjusted, as can the time interval setting which defines the
frequency of frame analysis.
Regardless of which mode you select, you can further decrease the amount of server-side calculations by using a
lower-resolution stream (if available). For example, if your main stream is 3MP and your substream is D1, the
motion detection engine will spend much less system resources on D1 analysis than it would spend on a 3MP image.
Note that some cameras deliver lower-resolution streams as cropped high-resolution images (not resized, as it would
be expected) - in such cases, using a substream for MD analysis will produce wrong results and therefore doing
so is not advisable.
Most cameras provide second stream as first stream image scaled to fit low resolution; however, some devices
crop the centre of a high-resolution image to fit the small frame, and thus the substream picture appears as if
it were zoomed in. Keep this in mind when you are using substream for live view and especially for software-
side motion detector analysis.
Click the Motion detection exclusions button in order to set up exclusion zones. Note that these settings only
cover the software-side motion detector; in order to configure the exclusions for the camera-side motion detector, go
to the Web interface of the target device.
Video Analytics
Luxriot EVO servers have a built-in engine for the video analysis (VA). In this tab, you can enable and configure the
detection parameters for the target channel.
You can configure VA without enabling it for the target channel. This may be convenient when you have a
limited VA license but still want to pre-configure the detection.
Before enabling VA for the channel, make sure your VA license allows it. Each Luxriot EVO installation inclused 1
(one) VA channel free of charge. You can check what channels are using VA license by adding the corresponding
column in the Channels section. To do this, click the grid icon in the upper right corner of Luxriot EVO Console
and move the Video Analytics column to the list on the left, then click OK.
Video analytics tab allows you to enable and set up VA for the target channel
The following settings are available here:
Enable: if selected, the server will perform video analysis for the target video channel
Use low-resolution stream if available: similarly to motion detector, VA can be performed on the
secondary video stream in order to save server resources. We recommend that you keep this setting ON.
Enable metadata display: select this option to turn ON the metadata overlay on the side (affects all
connected Luxriot EVO Monitor applications)
Classes: click Change and choose the object classes that you want to be detected in the target video
Detection interval*: time (delay) in milliseconds between two successive detections (similar to MD),
default: 200ms
Object loss timeout: time interval in seconds, after which the object out of sight will be considered lost
(and will be detected as new object if appears again), defaul: 6 seconds
Scene dynamics**: relative speed of the objects in the scene
Confidence threshold: minimum level of confidence to decide if the object belongs to a class
(detections with lower confidence will be disregarded), default: 70%
Object similarity threshold***: the minimal level of object similarity between two detections to decide
that it is the same object (objects with lower similarity will be detected as new), default: 85%, optimal
range: 50-90%
*This is the minimum time detween two detections. If the video stream FPS is low, the actual interval may be longer.
**This setting teaches the VA engine where to look for the same object in the next frame. Slower option means the
object is present in more frames. Faster means the object is present in less frames during its appearance. Choose
slower options for calm scenes with low-speed objects (e.g., people walking), and faster for dynamic scenes (highway
etc.).
***Highly affects the engine ability to track the objects. If the value is too low for the target scene, different objects
may be considered one. Too high (close to 100) causes each detection to produce a new object each time. We
recommend that you start with the default value, and change it slowly when testing. Scenes with many similar
objects (e.g., items on the conveyor belt) require slightly higher similarity and correct object speed (see above).
Audio
Here, select the audio source for the target channel. The available options are:
Inputs
If digital inputs (DI) are supported for the underlying device, the available inputs will be listed here. Mark them in
the list in order to allow event generation from those inputs: events can be later set up in the E&A Configurator
using the Digital input event type. After changing the DI name, click Apply below for the changes to take effect: the
setting will not be saved if you simply switch to another tab.
Note that the tab contents is retrieved in real time from the target device, therefore, it may take several seconds for
the contents to become available. In case the target device is offline/unavailable, or if there is no support for DI for
the selected device model, the list will be empty and a corresponding warning will appear.
Outputs
You can change the state of digital outputs (DO) from the E&A Configurator (target action type: Control digital
output). For the DO to be available in actions, select them here by putting a mark in the corresponding checkboxes.
Optionally, you can also change the DO names. Click the Apply button below the output details to save the changes
before moving to other settings.
For each relay output, you can also specify the desired mode: switch, inverted switch or pulse. This defines the
command that will be sent to the device when DO action is triggered in E&A.
Note that the tab contents is retrieved in real time from the target device, therefore, it may take several seconds for
the contents to become available.If the target device is offline/unavailable, has no DO, or if there is no support for
DO for the selected device model, the list will be empty and a corresponding warning will appear. In case your device
does have DO but they are not supported by software, you can still change their state from Luxriot EVO E&A by
using CGI/HTTP commands (action type: Send HTTP request or Run program). The exact command text depends
on the device and can be found in the device documentation.
Video Overlays
Click the Configure video overlays button to bring up the dialog box. Here, you can create channels shortcuts
and also choose a data provider to embed some textual data with the video. The section below explains channel
shortcuts; for setup guidelines on the data overlay, please refer to the Data Sources section of this document .
Channel shortcuts are interactive video overlay elements intended for instant switching between video channels
in the Luxriot EVO Monitor application's live view mode. In other words, these are visual controls that appear on top
of the video and clicking them will open other (pre-defined) video channels in the same viewport. These "portals"
are configured in Luxriot EVO Console and then used in the Luxriot EVO Monitor application.
Start by dragging and dropping a channel shortcut from the panel above the video. A coloured rectangle will appear
on top of the video: drag it around and use the visual controls to change its size, and place it where you want the
shortcut to be. As the shortcut is a "portal" to another video channel, usual shortcut places are windows, doors, ends
of streets or corridors, etc.
Make sure the video from the target channel is available before setting up the channel shortcuts in order to
ensure correct shortcut placement.
On the right side of the configuration dialog box, there are channel shortcut properties:
Size: visual element size (relative to the viewport size)
Location: coordinates of the top left corner of the visual element in the viewport
Colour: choose the element colour from one of the standard palettes (blue by default)
Opacity: transparency of the visual element, from 100% transparent on the left to 100% opaque on the
right
Linked resource: target video channel (mandatory setting)
The linked resource is the video channel that will be displayed once the shortcut is clicked by user; it must be
defined, otherwise the shortcut does not make any sense and will not be saved. Other settings are optional. The
visual element size and location are listed for your reference: it is more convenient to change the rectangle size and
position by manipulating it in the viewport. However, you can still change the numbers to adjust the size and
position.
To remove any unneeded shortcut, select it in the video viewport and click the Recycle bin button in the panel
above the video.
To save the video overlay settings, click OK to close the dialog box and then click Apply or OK in the Edit channel
dialog box. If you click Cancel to discard changes in the Edit channel dialog box, adjustments in the video overlays
will not be saved.
Channel Configuration
The Channel Configuration tab allows you to adjust advanced channel settings. Some of these can be changed via
Luxriot EVO Console but sometimes software does not cover some of the device settings, so you are also given the
option to go straight to the device Web interface - simply click the Open device in browser button to do this.
You can open the target device in browser or go to the software provided settings dialog box
Click Open channel properties to access the additional channel configuration dialog box. The available tabs depend
on the device model and capabilities: for some cameras, only basic configuration options are present, while for
others, advanced settings are accessible. If you see that a camera has certain capabilities that are not configurable
via Luxriot EVO Console configuration interface, go to the device's Web interface in order to change that specific
setting.
Video Input tab: set video transport (the available list of options depends on the device type and model;
common types include HTTP, RTSP* and native transport)
Video Adjustment tab: fine-tune picture settings such as brightness and contrast level
Substream tab: enable second (lower resolution) stream; some integrations also support stream settings
Video Configuration tab: choose streaming settings**
Motion Detection tab: with some devices, the camera-side motion detector must be explicitly enabled
here
External PTZ tab: adjust external PTZ controller settings; communication port must match the
communication port that the RS232/485 controller is connected to, and baud rate has to match the baud
rate of your PTZ controller/analog PTZ camera
RTSP tab: appears if RTSP transport type has been chosen; set RTSP port and mode
(TCP/UDP/multicast***) here
*You may have to specify the RTSP port on the corresponding tab if it differs from default (port 554 is default for
most devices). To do this, select the RTSP transport type and then click Apply: as a result, the RTSP tab will become
available. For ONVIF devices, the RTSP port is set automatically.
**Remember, the higher the resolution/bitrate/quality/frame rate you set, the more storage space and bandwidth it
will use when recording. These settings also affect CPU/virtual memory resource consumption for live video and
software-side motion detection.
***Multicast mode availability depends on device integration.
Note that a valid administrative account login and password for the camera should be provided in Device
settings in order to access and set the device configuration.
Dewarp
Here, you can configure generic dewarp settings or enable dewarp engine for the Panomorph Enables® lens. For
details, please see the subsequent topic on dewarp setup.
Video Configuration
This tab is only available for certain device drivers like ONVIF. For other devices, go to the Channel Configuration
tab (described above).
Here, you can select stream properties for both main and secondary video streams. The options are fetched from
the device so the availability may differ depending on the vendor.
The settings are changed on the device side, too, so make sure the target device is not configured in some other
video management software in order to avoid configuration conflict.
Available settings:
Profile: choose one of the video stream profiles (built-in or pre-configured on the device side)
Encoding, resolution, quality, GOV length*, frame rate, bitrate, bitrate mode: choose one of the
available settings according to your needs
By default, camera-side settings are used (whatever is currently set on the device side). You can override all settings
or only some of them.
Note that a valid administrative account login and password for the camera should be provided in Device
settings in order to access and set the device configuration.
*Too long GOV intervals (hence, low i-frame rate) may cause recording and playback issues. Channels
with too low i-frame rate will have a warning (orange colour) in the Monitoring section of Luxriot EVO Console,
under Channels. To view this column, click the grid icon in the upper right corner and move the columns Main
stream GOP size and Substream GOP size to the left, then click OK.
RTSP Configuration
This tab is only available for certain device drivers like ONVIF. For other devices, go to the Channel Configuration
tab (described above).
By default, the default port of 554 is used for obtaining video over RTSP. Here, you can override the default
port, and also choose between unicast and multicast.
Edge Configuration
This tab is only available for certain device drivers like ONVIF. For other devices, go to the Channel Configuration
tab (described above).
For some devices, Luxriot EVO can fetch the recording done on the device side (on camera SD card). This tab
contains some settings related to the edge stream synchronization.
Select at least two devices in the list and click Bulk Edit on the top panel to bring up the corresponding dialog box.
Some settings will be grayed out, indicating that these settings either cannot be changed at all or specifically via bulk
edit.
When done, click OK to save and close the dialog box: the settings will be applied to all the selected devices.
Select at least two channels in the list and click Bulk Edit on the top panel to bring up the corresponding dialog box.
Some settings will be grayed out, indicating that they either cannot be changed at all or specifically via bulk edit: for
instance, it is impossible to change the title field this way, as each channel normally has its own name, which
therefore should be edited for each channel individually.
Recording resource cannot be deleted if it is currently in use, i.e., when a recording profile is assigned to a
recording configuration or a schedule, or when any of the recording resources are assigned to a channel.
Recording profiles allow users to set which data streams are recorded and how. Profiles cannot be assigned directly
to devices; rather, these are used as components for recording schedules and recording configurations. For this
reason, profiles do not include such settings as pre-recording interval: this setting is defined per-channel and,
therefore, is set in the recording configuration.
To add a new recording profile, click the down arrow button near + New recording configuration and select + New
recording profile. The profile creation dialog box will appear.
To configure motion-based recording, enable Video stream in the Alert recording section and enable Detected
motion triggers alert setting. If you wish to record still frames at low rate during non-motion period, keep the Video
stream option in the Continuous recording section enabled and set your desired frame rate - e.g., 1FPS - then set
high FPS or no limit in the Alert recording section. If you only wish to record while motion is present, deselect the
Video stream option in the Continuous recording section.
When you assign a motion-based recording configuration to a channel with a disabled motion detector,
the software will automatically suggest enabling motion detection for the target channel. The camera-side
detector is given priority; if it is not available, the software-side detector will be enabled and set to the high-
performance mode. We recommend that you review the motion detector settings to make sure it operates as
desired, especially if the camera-side detector is in use.
Recording schedules are sets of recording profiles that define what recording profiles are used depending on the day
and time of the week.
To add a new recording schedule, click the down arrow button near + New recording configuration and select +
New recording schedule. The schedule creation dialog box will appear, allowing you to enter a user-defined name
for the new schedule and add multiple profiles to define recording behaviour.
Click OK to save and add the profile to the schedule. Multiple profiles will be automatically sorted based on their
start time.
Use the Edit and Remove buttons below to manage the profiles added. When you are finished, click OK to save; the
newly created schedule will be added to the item list in the Recording section.
Recording configurations are global recording arrangements that can be assigned to a per-channel recording setup.
Recording configurations can be based on a single recording profile or on a pre-defined recording schedule.
To add a new configuration, click the down arrow button next to + New recording configuration.
Note that quotas do not give priority to channels that are assigned configuration. For example, if you set the
duration quota to ten days, it merely means that the maximum recording duration will be ten days for a
channel with given configuration; this will not reduce recording duration for other channels.
When you have finished, click OK to save and exit. Recording configuration will now be added to the item list and
will become available in channel recording configuration.
Enable Recording
When you assign a motion-based recording configuration to a channel with a disabled motion detector,
the software will automatically suggest enabling motion detection for the target channel. The camera-side
detector is given priority; if it is not available, the software-side detector will be enabled and set to the high-
performance mode. We recommend that you review the motion detector settings to make sure it operates as
desired, especially if the camera-side detector is in use.
Disable Recording
To disable recording for any channel(s), choose the No recording configuration, which is present in the list by
default. If you have deleted it, simply create a new recording profile without any streams selected for recording and
then create a recording configuration for this profile.
The built-in Administrator user account and built-in Administrators group are root users with access to
absolutely all the available resources. As a result, resources choice is unavailable for the Administrators group,
and it is also impossible to add Administrator user to any other group.
Any users added as members to the built-in Administrators group will have the same full authority as root
users.
Add Users
Click the + New user button on the upper panel to bring up the configuration dialog box.
Details
connections
Deleting a user also removes all the settings related to that user; restoring these may be time-consuming. Use
the Active setting to enable/disable users and temporarily block access for those.
If two or more users try using PTZ control of a device at the same time, PTZ priority is used to decide who
gains access first: user with a lower priority is blocked for ten seconds to allow a higher-priority user to use
PTZ. If two users with the same PTZ priority have an access conflict, they will be both granted PTZ access
simultaneously.
Default PTZ priority for all users, including those built-in and imported, is equal to five (medium priority).
You can assign any user a higher PTZ priority (six to ten) or a lower one (four to zero) by editing individual
user properties.
Membership
Choose which groups you want the selected user to be a member of. Every user can participate in one or multiple
groups, depending on the system structure.
Resources
Each user can be granted permissions for server and channel/channel group administration. Select resources by
adding at least one permission; remove them by clearing permissions using the Clear button below, or simply by
double-clicking them in the Selected resources list.
When the number of users is large, it may be more convenient to create multiple user groups and then distribute
resources between user groups, rather than between individual users. One user can be a member of several groups.
Click the down arrow near the + Create new user button and select New user group from the drop-down list to
bring up the configuration dialog box.
In the Members tab, choose which users and/or user groups will become members of the target group: manipulate
items by double-clicking them or using the Add/Remove buttons below.
AD/LDAP imported user accounts can be used to log into Luxriot EVO Console, Luxriot EVO Monitor, and
Web client for Luxriot EVO Streaming Server. These user accounts cannot be used in Luxriot EVO Mobile
applications at this point.
Note that it is not necessary for you to be logged into Windows under the same AD account; rather, once AD
accounts are imported as external users into Luxriot EVO, you can use any valid AD account credentials to log
into Luxriot EVO Console or Luxriot EVO Monitor. Also, note that you are always required to enter the
password for the AD account, even if you are logged under the same user account in your current Windows
session.
If you are using AD/LDAP user accounts for the Web login, we strongly recommend that you turn on HTTPS
for enhanced safety. Plain HTTP will work, too, but is not recommended for security reasons.
For you to be able to log into a Luxriot EVO server with an AD user account, you must be able to log into the
target server computer with the same AD account. If you are unable to do so, contact your Windows
administrator and let him check the effective policies.
In order to use your imported AD account with Luxriot EVO, type in your full domain name and user name, and
then specify the password. Please see the description below on how to add your AD users into Luxriot EVO.
In Luxriot EVO Console, open the Configuration section and choose Users from the menu on the left; then, click the
little arrow next tot the +New user button and choose New external user group from the drop-down list.
Create new external user group from the Users menu section
On the Details tab, click the Change button next to the empty External group field in order to load the available AD
group list in a separate dialog box.
Available AD groups
The selected user group will appear in External group field in the Details tab. Switch to the Members tab to view the
imported user list.
On the Membership tab, you can choose an internal user group to contain the newly imported external user group
(nested grouping). All user permissions inherited from the higher level group will be applied to the members of the
imported external user group and will be displayed as grayed out in the Resources tab.
You can make the external user group a part of some other internal user group
If you have decided to make no nested groups or wish to add more permissions specifically to the AD user group, go
to the Resources tab to manage the user permissions.
After adding the external user group, you can edit the group properties as well as individual external users. In order
to do this, select the target user/user group in the list and click the Edit button on the upper panel, or, alternatively,
simply double-click the desired item to bring up the configuration dialog box.
Editing an external user group will be pretty much the same as adding a new one; individual external user settings
will have some differences comparing to the regular, built-in user settings.
If two or more users try using PTZ control of a device at the same time, PTZ priority is used to decide who
gains access first: user with a lower priority is blocked for ten seconds to allow a higher-priority user to use
PTZ. If two users with the same PTZ priority have an access conflict, they will be both granted PTZ access
simultaneously.
Default PTZ priority for all users, including those built-in and imported, is equal to five (medium priority).
You can assign any user a higher PTZ priority (six to ten) or a lower one (four to zero) by editing individual
user properties.
On the Membership tab, you can choose an internal user group to contain the AD user as a member. All user
permissions inherited from the group will be applied to the target AD user and will be displayed as grayed out in the
Resources tab. You can assign additional user-specific permissions on the Resources tab.
Please note that some of the permissions may not be applicable to your software license edition.
In Luxriot EVO version 1.6.0, major changes were made to permission management. As a result,
configuration imported from an XML file (from Luxriot VMS) will not contain any user permissions: you will
need to review and set all user permissions after importing the configuration.
Access Permissions
All the available resources are listed in the column on the right; click any item to load the permission list in the
central column. Then, mark all the permissions you wish to grant; resources having at lest one permission enabled
will be automatically moved to the left column.
It is not possible to select multiple resources for the permission management. You are welcome to use
resource grouping (e.g., channel groups) for easier and faster permission management.
When permissions are inherited from some group(s), a corresponding mark will appear in the central column next
to the permission type.
The following types of permissions are available (each one can be defined separately):
Server
Playback: allows users to access recorded video, audio, VCA metadata and external data from
the specified server for those recordings that do not have corresponding channels in the server
configuration (i.e., orphan archive tracks)
Export: allows users to export video clips and snapshots from such recordings
Channel
Live: access live video, audio, VCA metadata, external service data, external data (from Data
Sources), send audio OUT and export snapshots from the live view mode
PTZ: general PTZ control, preset and tour usage, preset and tour management
Playback: access to recorded video, audio, VCA metadata, external service data, external data
(from Data Sources), snapshot and video clip export from all playback modes, view and manage
bookmarks
Restricted playback: same permission set with a time limitation**
Uncategorized: back up and delete archive, protect archive from deletion, remove protection
External Service Group
View live data: see the live data coming from the external services in the target group
External service search: browse recorded external service data
Layout
View: see and use the layout in Luxriot EVO Monitor
Manage: delete or replace existing layouts via Luxriot EVO Monitor
Layout Group
View: see and use layouts from the target group in Luxriot EVO Monitor
Manage: add new shared layouts from Luxriot EVO Monitor and delete existing layouts
Visual Group
View: see visual group contents in Luxriot EVO Monitor*
Map
View: see and use the map in Luxriot EVO Monitor
Software Counter
Access archived VCA metadata: see the counter in Reports in Luxriot EVO Monitor
Video Wall
View: see and use the video wall in Luxriot EVO Monitor
Manage: change video wall contents via Luxriot EVO Monitor
User Button
View: see and use the target user button to viewports in Luxriot EVO Monitor and in Luxriot
EVO Mobile applications
Starting from the software version 1.15.0, it is possible to grant individual rights for software counters. However, if
the Access archived VCA metadata permission has been given for the whole server, the target user or user group
will have access to all counters on that server, regardless of the individual counter permissions.
*A visual group will only be displayed in Luxriot EVO Monitor if the user has permissions to see at least one
visual group element.
**The permission sets under time-limited Restricted video playback and full Video playback are essentially
the same. The difference is that restricted access only allows users to access the last N minutes/hours/days of
the archive. Therefore, the two sets are mutually exclusive. The restricted interval is defined individually
for each server in the server storage settings.
Administrative Permissions
Administrative permissions for the resources, servers and connections can be managed via Administration profile
tab in the user management dialog box.
Giving a user at least one permission from the Console section will allow this user to log into the target
server via Luxriot EVO Console. The corresponding resources will be available for configuration and all the
rest of the contents will be hidden.
The following types of permissions are available for per-user/per-user group configuration:
Client
Login via Monitor: connect to the target server via Luxriot EVO Monitor application
Login via Monitor without entering login reason: if unchecked, the user will be prompted to
enter a justification (comment) before logging in
Login via HTTP: connect to the target server via Web client and from external services,
including LPR and FR
Login via Mobile: connect to the target server from Luxriot EVO Mobile and OS X app
Console
Manage organisations, servers, users, permissions, networks, external services:
enables the user to access the configuration of the corresponding server contents
Manage devices, device channels, visual groups, layouts, layout templates, video
walls, maps, data sources, user buttons, shared channels: enables the user to edit
existing and create new (if applicable) resources of the given type
Manage recording: create and edit recording profiles, schedules and configurations
Manage Event & Action rules: create, remove and edit events, actions and all the related
resources in the Events & Actions section, including mail servers, conditions etc., regardless
of permissions for the source items
Access audit log and monitoring section: view all the information in the server Audit and in
the Monitoring sections
Manage auto backup: access scheduled backup configuration
Start wizard: allows users to run the quick setup wizard via Luxriot EVO Console for step-by-
step configuration
Remote upgrade: access the remote upgrade section of Luxriot EVO Console, set up and do
the remote upgrade procedure
Import configuration: load configuration from XML (from the old product version) and
import existing Luxriot EVO database
Starting from version 1.13.0, there is an additional user permission under Administration profile: log into Monitor
application without entering login reason. If this permission is granted, users will log into the Luxriot EVO
Monitor application as usual; if not, an additional prompt will pop up, asking them to enter a justification for
logging into the server.
Membership
Users can be grouped logically to make permissions management easier. Groups can overlap, meaning that a single
user can belong to multiple groups at once, and some groups can be nested - i.e., one group can contain one or more
other groups. In addition to own permissions, each user inherits permissions from all the groups he is currently in.
To manage user membership from the user configuration dialog box, double-click any user. This will open the
properties window, where you can switch to Membership tab. Here you can pick which group - or groups - this
user will be a member of.
User membership
Double-click on groups or use the Add/Remove buttons below to move groups between columns. When you have
finished, click OK to save changes and exit.
Alternatively, you can select one or multiple users from the users list, then click the Assign group button on the
upper panel: a list of available groups will appear, allowing you to select one of the existing groups. After this, click
OK to add selected users to the target group.
General
Administration profile permissions to manage maps, visual groups, live podcasts etc. include access to all channels
from the Edit dialog of these entities. For example, a user is granted permission to manage maps but does not have
any per-channel permissions: when creating a map, he will be able to put channel markers on it and associate these
markers with any channels on the server. At the same time, he will have no access to the channel management
whatsoever.
In order to enable a user to add new cameras or devices of other types, it is necessary to grant the following
permissions from the Administration profile:
Manage devices
Manage device channels
This is necessary as devices and channels are related entities in Luxriot EVO and a single Manage devices
permission is not enough as new channels are created automatically alongside with the newly added devices.
The Manage devices permission itself allows the user to change device settings (e.g., IP address, group membership)
and create new device groups.
To see the data from external services (e.g., LPR/FR recognitions, third-party integrations via HTTP API) in the live
view notification panel or search the past records, the following permission sets are required:
Live:
View live external service data (per-channel permission under View live video permission
group)
View live external service data (permission for the external service group)
Archive:
External service search (per-channel permission under Video playback permission group)
External service search (permission for the external service group)
This allows to cover the case when one channel belongs to several different external service groups.
Archive Backup
Snapshot Export
For a user to be able to save multichannel snapshots from the Archive playback mode, the Export snapshots from
playback permission must be granted for all channels present in the layout.
Add permission for the anonymous user to receive live view data
Now you can use a short link to receive live video feed over HTTP from your configured channels without
authorisation.
The link can be embedded into your own webpage to provide 'Live Cam' functionality.
This functionality requires that Streaming Server is enabled (HTTP port is not set to zero in the target server
settings).
In order to see the channel identifiers in Luxriot EVO Console, go to the application settings via main menu button
in the upper-right-hand corner and choose Settings. In the dialog box, enable the Show object IDs option and save.
If you are using AD/LDAP user accounts for the Web client login, we strongly recommend that you turn
on HTTPS for enhanced security.
At this point, the recommended browsers (100% supported) for clients are Google Chrome and Mozilla
Firefox (under any operating system).
If you are using HTTPS with your own CA certificate (bound to your domain name), remember these
important guidelines for the mobile app setup:
when connecting via local network, use server IP address
when connecting over internet (4G etc.), use the hostname instead of IP (main domain must be the same
as in the certificate)
if port forwarding is used (local HTTPS port is different from external), enter the port number as the
"Internet port" in the server connection configuration
If you are using your own CA certificates, create a .pem file with your certificate chain as described here:
https://www.digicert.com/ssl-support/pem-ssl-creation.htm
This is necessary for the certificate to be recognized correctly by all HTTP clients - Web browsers and Luxriot
EVO mobile applications. If you simply apply your CA certificate in Luxriot EVO Console, there is a chance it is
not recognized because some applications require the entire certificate chain.
Then, apply the .pem file as the certificate together with your key when the importing certificate into Luxriot
EVO Console.
Once you are done with the setup, click OK to save and close the dialog box.
Your Luxriot EVO Streaming Server will now be set up and accessible via local - and, if used, external - IP address.
You can immediately check if the connection is working: just open your browser and type: <local IP>:<HTTP port>;
for example, server configuration for the snapshot above will require 192.168.1.83:8089.
User permissions for Luxriot EVO Mobile and Web browser login
Authentication required
When configured, Luxriot EVO Streaming Server is accessible via browser from the server itself and from computers
on the local network, and, if system is not isolated, from the Internet. This is the simplest way to make sure your
Luxriot EVO Streaming Server is running and reachable. To access the Luxriot EVO Streaming Server, open your
browser and type:
<Server IP>:<HTTP port>
then press Enter. Your browser will connect to Luxriot EVO Streaming Server, and user authentication will be
requested: enter your user name and password to proceed.
Starting with Luxriot EVO version 1.14.0, you can also use your AD/LDAP user accounts for the Web
browser login. The user name should be entered in the following format:
domain.name\user.name
The field is case-insensitive, meaning that you can use either user.name or User.Name notation.
After logging in, you will see Luxriot EVO Streaming Server Web browser user interface:
left menu: channel list and setup tabs
main window: live streaming/playback area
upper-right-hand corner: layout templates and layouts
upper-left-hand corner: the Luxriot EVO Streaming Server logo; click the logo to extend viewing area
by minimising the menu on the left
Access Permissions
The channel and feature availability depends on the user permissions; the built-in administrator has access to all
resources. For the Web browser connections, only HTTP connection, live, archive and PTZ access permissions are
applicable, as other functionality (e.g., audio) is not present.
In order to allow a user to connect to Luxriot EVO Streaming Server, go to Configuration section of Luxriot EVO
Console, choose Users, then select the user or user group for editing and open the Administration profile tab:
add the Login via HTTP permission to allow Web browser and/or HTTP API connections
add the Login via Mobile permission to allow connections from mobile apps and OS X client
To allow channel access, add per-channel or per-channel group privileges in the Permissions tab:
View live Video: enables live view
Listen live audio: enables incoming audio (from the camera)
Send live audio: send audio to camera (talk back)
Control PTZ: pan, tilt and zoom controls
Use PTZ presets: access to existing PTZ presets
Set user permissions in order to see channels in Luxriot EVO Streaming Server
Channel, channel group and user button permissions can also be changed in the Channels section, by double-
clicking the corresponding channel or channel group in the list and then selecting the Permissions tab.
The menu on the left has two tabs: devices, which shows which channels are available, and setup, which contains
streaming settings. Click on the titles to switch between them.
Devices
The video sources are loaded in a single list. To start streaming from a particular device, select layout template from
the menu in the upper-right-hand corner, then click your desired viewport so that it is highlighted blue, and then
click a device from the list.
Setup
The Setup tab allows you to choose PTZ control behaviour and configure stream options:
PTZ controls:
Always: if the camera supports Pan-Tilt-Zoom, virtual PTZ sphere will be always shown as
overlay control
When selected: if the camera has PTZ capabilities, the virtual PTZ sphere will be shown when
the corresponding stream is selected
Never: do not show PTZ controls at all, meaning that PTZ functionality will be disabled
Stream options:
Main: only the first (main) stream, [usually] of a larger resolution will be used for all devices
Secondary: only the secondary stream (substream), [usually] of a smaller resolution will be
used for all devices
Auto: the most appropriate stream will be selected automatically based on viewport size
The Web browser client allows you to view live video and to play back recorded video from the available channels.
For live view mode, PTZ controls are available.
Live
To start live-streaming, select a layout template from the upper-right-hand menu (1x1, 1x2, 2x1 or 2x2), then click
your desired viewport so that a blue frame selection appears around it, and then choose the target stream from the
Devices list on the left. To replace the existing live stream, either select it and choose a device 'on top' of it, or click
the X button in the upper-right-hand corner of the viewport to close it and then assign a new stream to this
viewport.
Notice that some images may appear with horizontal or vertical black stripes at the sides: this happens because
image aspect ratio is maintained instead of it being stretched to fill the viewport. When the picture size is smaller
than the target viewport, there will be a black background on either sides.
Archive Playback
If recording is enabled for the target channel, the stream overlay controls will include an archive playback button in
the upper-right-hand corner. Press the button to begin playback: the target stream will be displayed in single
channel mode. To switch back to live view, press the 'eye' button in the upper-right-hand corner; this will restore
your previous layout.
Layout templates allow you to choose viewport layout: 1x1, 2x1, 1x2 and 2x2 are currently available options.
Layouts menu
From here, you can also load the previously saved layouts simply by clicking them; if your layout list is longer than
the menu window, use the mouse wheel to scroll down.
The layouts are saved in your browser cookies, so:
Luxriot EVO Streaming Server layouts cannot be transferred to other browsers, user accounts or
computers
layouts are removed when browser cookie data is cleared
Getting Started
Install Luxriot EVO Mobile from the corresponding app store, or by following a link from our
website www.luxriot.com.
Interface Overview
Luxriot EVO Mobile user interface is mostly intuitive: you can interact with the app by tapping or long tapping the
interface elements, and also by swiping.
In the top left corner, you will find the application menu. It contains:
an option to add a new server connection,
a possibility to record offline in-app video for further upload to any sever,
app settings,
details about the app version.
After you connect to any server, the application menu will be replaced by server menu containing server-specific
resources and actions:
view selection (channel arrangement for live view),
event log (push notifications from the server),
bookmarks,
user buttons,
camera streaming option (device >> server),
log out option.
The server menu also has a submenu 'three dot' button next to the server name. Apart from the Log out option, it
allows you to edit the connection settings (e.g., change the user account) without returning to the server list. The
'three dot' button is also present in other places within the app, and it offers extra option or actions.
Finally, wherever it is impossible to place the submenu button, a 'hidden' drop-down menu is available. Long tap
any channel in the multichannel view to see the available quick actions.
When running in foreground, the app will prevent you phone from going to sleep, so the display will not be
switched off automatically. Keep this in mind and do not forget to exit the app or lock the device/turn the
display OFF when you do not need the app anymore.
When you first start Luxriot EVO Mobile, you will have a demo server connection present by default: feel free to use
it for a tryout. You can start adding your own server connections at once but we recommend that you first review the
app settings and adjust them to fit your needs.
Settings
Tap the menu button in the top left corner to bring up the main app menu, then tap Settings. The parameters here
define global app behaviour (for all servers); they are preserved as you upgrade the app but are discarded if you
uninstall it.
The settings are logically grouped for your convenience. Tap a category to access the settings.
General
Language: set application interface language here (matches device locale by default)
Date format: set the date presentation format you want the application to use, e.g.,
YYYY/MM/DD
Time format: set the time presentation format you want the application to use, e.g., HH:MM:SS
(24h)
Timezone: choose between your mobile client or connected server time zone
Streaming
Quality preference
Main: only the first (main) stream, [usually] of a larger resolution will be used for all
devices
Secondary: only the secondary stream (substream), [usually] of a smaller resolution
will be used for all devices
Auto: the most appropriate stream will be selected automatically based on the
connection
Display video statistics
ON/OFF: defines if the video stream properties (FPS, bitrate) are shown for both
incoming and outgoing streams
Decoder configuration: choose how the incoming streams will be decoded
Hardware only: hardware decoding modules available on your phone will be used
automatically (recommended for battery saving)
Hardware and software: software decoders will be used if required (warning: software
decoding is battery intensive!)
Per codec configuration: choose decoding settings individually for each of the expected
codecs
Icons: descriptive elements overlaying the video
Show battery intensive decoder icon: the icon will appear in case a software decoder is
in use
Device camera: settings related to your phone's camera; the first time you open this section, you will be
prompted to run camera detection
Camera choice and preferences for the reverse streaming (device >> sever) for both live and
offline recording modes
Off: choose this if you do not plan to stream device's video to the server
Camera 1: main mobile device camera (normally, back camera)
Camera 2: secondary camera (normally, front camera with less megapixels)
Resolution/FPS/bitrate/codec preference, microphone ON/OFF
Preview: camera preview with the settings defined above
Detect cameras: allow the app to retrieve your phone's camera configuration (detection may
take some time, making the app unresponsive - expected behaviour)
Stream device GPS location with video to server: when ON, the video streamed from the
device camera will be overlayed with GPS coordinates and device marker will be displayed on
the geo maps, if configured
Offline video: settings for offline video recording (for further upload)
Store offline video: choose whether you want to store the recorded files in the app
directory on the internal storage or on the external storage (SD card)
Offline video storage limit: restrict the space available for recordings to 100, 200 or
500 MB, 1, 2, 5, 10 or 20 GB, or unlimited
When no space left: the app can either overwrite the oldest file(s) or stop recording
new files
Default video upload server: choose server every time you upload the video or set one
of the configured servers to be the default destination
Device configuration: network and other settings related to your phone (but not directly to its cameras)
Allow app/widgets to use: choose preferred network type for the app and for the app widgets
separately
WiFi only: the app will only connect to the server(s) if it is connected to a wireless
network (including servers available via VPN)
WiFi and mobile data: the app will use both wireless networks and enabled data
services (3G/4G)
Widgets: all settings related to the app widgets (application extensions)
Widget update interval: automatically load a new frame every 30 seconds, every 1, 2, 5, 10 or 15
minutes
Allow widgets to use: WiFi only, or both WiFi and 3G/4G
Panic button: choose the default server for streaming (panic buttons is a widget-like
buttons that can be placed on the home screen; tapping the button will start streaming live video
to the pre-defined server (device must be registered on the server)
When enabling a camera and turning ON sound, you may be asked to confirm permissions for the app to
access your phone's camera(s) and microphone. Select YES to grant access to these components if you wish to
be able to stream video and audio from your phone to the server and clients connected to it.
Application settings
To exit, tap the arrow icon in the upper left corner, or use your device's Back button (software or hardware) or
gesture.
Additional options:
Use HTTPS: use HTTPS over TLS instead of plain HTTP (target server must have HTTPS enabled and
configured)
Enable event notifications: turn ON push notifications from Luxriot EVO servers (notifications should
be pre-configured via Events & Actions using the Send event to client action)
Trust all certificates from this session: accept all digital certificates provided by target server
(required in case you are using a self-signed certificate on the server side)
Set as startup server: turn this ON if you wish the app to connect to the target server upon
startup: when started, the app will load the server list and try to connect to the selected server
automatically
Show trusted certificates: display all accepted digital certificates from the target server; tap the
certificate to discard it
Server settings
When you are ready, tap Save to save the settings and exit the dialog box, or tap the "<-" Back to discard the changes
and simply go back to the main menu.
To edit the settings for an existing server connection, tap the vertical dots on the right side next to the server name,
and then tap the Edit button that will appear in the drop-down menu. Use the Delete menu option to remove any
existing entry.
Live View
Tap your pre-configured server in the list to establish connection. If you are using HTTPS with a self-signed
certificate, you will have to confirm that you trust the server certificate.
When you connect to a server, the live view mode is loaded by default. If you have already connected to the selected
server previously, the most recent live view layout will appear. Each channel's name will be displayed in the top left
corner of the picture, together with video stream properties - codec, bit rate, frame rate and resolution; stream
statistics can be turned OFF via app settings (see above).
Tap any camera live view video to switch to the single channel view. Tap the "<-" Back button in the upper left
corner to return back to the channel list. In both multi- and single channel view, you can swipe up and down to
switch between channels. In the single channel view, they will appear one by one. In the multichannel view, the
new portion of channels will be shown.
You can change the multichannel layout by tapping the server menu in the upper left corner > View > choose the
desired layout (1x1, 2x1, 2x2, and 3x2 options are available).
Live view
Swipe left/right (while holding the device horizontally) or up/down (for vertical mode) to scroll the channels. Tap
and hold channel live view to bring the available channel list (similarly to the channel selection menu, chosen item
will replace the selected channel).
In both single and multichannel view, you can pinch the picture to zoom IN/OUT (digital zoom). A tiny picture-in-
picture preview will appear in the upper left corner of the channel: tap it to reset the DPTZ to the normal zoom level.
Alternatively, double tap the picture to clear the zoom.
Tap any channel to replace the currently displayed layout with a single channel view with extra controls. The
available controls are:
Bottom left corner:
Camera icon: take a snapshot. Tap to save the currently displayed frame onto your device.
Speaker icon: audio IN (from the camera). Tap once to enable incoming audio (the icon will
turn blue), tap once again to stop. The icon will only appear if the target channel has sound
enabled.
Microphone icon: audio OUT (talk to the remote camera). Tap once to start sending audio
back to the camera (the icon will turn blue), tap once again to stop. Note: you do not need to
tap and hold the mic icon, like in the regular Luxriot EVO Monitor application, simply tap once
to enable audio streaming. This icon will only appear if the related functionality is available.
Bottom right corner - three dots' menu:
PTZ: toggle PTZ controls (for PTZ capable cameras). While having overlay PTZ controls ON:
tap/long tap inside the sphere to pan and tilt (the closer you tap to the sphere edge,
the faster the PTZ speed will be)
tap/long tap the ends of the zoom bar to zoom IN/OUT
PTZ presets: tap to see the list of available PTZ presets; tap any to make camera go to the
specified preset
PTZ tours: tap to see the list of available preset tours; tap any to start the tour; tap Stop PTZ
Tour to terminate any currently executed tour
Cast to device: tap to cast the current channel to one of the available Chromecast devices
Maintain aspect ratio: toggle aspect ratio (original/stretch to fit); the setting is applied to all
channels
Tap the picture again to switch to full screen (remove extra controls). You can still swipe up/down (or left/right for
landscape screen orientation) to switch between channels.
PTZ Tours button will only appear if the target camera has at least one tour configured. PTZ tours can be
created and managed via Luxriot EVO Monitor application.
While in this mode, you can swipe left or right to load previous or next channel in the list. Long tap on the free space
(where there is no stream) or on the stream itself (when PTZ controls are OFF) to bring up the list of all available
channels: swipe down and up to browse the list, tap any channel to display it.
Server Menu
You can find the server control buttons in the upper-right-hand corner. For vertical screen orientation, all menu
controls (except for the timer) collapse into a single button with drop-down list.
Eye icon/timer: shows current server time. When you tap it, you are given the option to select the
time (the app will automatically switch to Archive mode afterwards)
Cameras: tap to select a channel from the list of available ones. Note that every channels can only be
mapped once and attempts to map a channel for the second time will result in it being placed in the new
position and removed from the old one
Views: tap to open layout selection. The layouts currently available are: 1x1, 2x1, 2x2, 3x2. "Add Current"
enables you to save current layout under a specified name. If a larger layout has been selected, existing
channels will be mapped automatically and all the extra slots will appear blank. To add more channels, tap
the "Cameras" button and pick one; all the slots will become marked with blue frames, tap any of them to
place the new video channel there.
Make snapshot: tap to save a snapshot to the gallery.
Cast: stream to Chromecast
Stream camera: send the video stream from your phone's camera back to the Luxriot EVO server
Camera to widget: assign one of the channels to a widget (widget should be added to the phone's
desktop beforehand, see below for details)
User buttons: tap a user button to trigger the action assigned to it (see below for details)
Events: push notifications from the target server (configurable via Event & Action section in Luxriot EVO
Console)
Stream Camera
It is possible to send the video captured by your phone's main or front camera back to the Luxriot EVO server for
further live view on other connected clients and also for server-side recording. To do so, you need to add your mobile
device to Luxriot EVO configuration and then confirm it in your app.
First, go to your server configuration via Luxriot EVO Console, go to the Configuration section and choose Devices
from the menu on the left. On the upper panel, click the + New device button in order to create a new device; enter
your desired name and set the Model to (Generics) - External Source, then save. Note the value appearing in the
Code field: you will need to enter it into your app.
Next, go to your app -> server list -> tap Settings in the bottom, find Camera in the list and choose your video
preferences; the contents of each item may vary depending on your mobile device capabilities:
Camera: back/front (primary/secondary)
Resolution: [the actual list depends on the mobile device capabilities]
FPS: from 10 up to max allowed by device
Camera Microphone: disable/enable sound
Below the settings, you will see the camera preview. Save your preferences and go back to the server list.
For Android 6.0 and newer, you may need to go to your mobile device's system permissions and explicitly
allow Luxriot EVO Mobile to use the camera in case you were not asked for this permission or if you have
chosen to deny access to this components.
Then, connect to your Luxriot EVO server, tap the menu icon in the upper right corner and choose Stream
camera. You will see your camera preview and a message in the bottom saying Click icon to stream. Click the Play
button in the bottom right corner to initiate streaming (the button will turn blue); when asked, enter the code from
the Luxriot EVO Console in the Registration token dialog box. For example, if your device configuration in the
Luxriot EVO Console says CODE:FZL3XT3L, you just need to enter the FZL3XT3L part in the Registration token
field.
Luxriot EVO Mobile will automatically start streaming and you will see the contents of your mobile device stream in
all other Luxriot EVO Mobile and/or Luxriot EVO Monitor applications. The message in the bottom line will change
to Streaming and will show your video stream statistics. In order to stop streaming, tap the Play button once again.
You can now manage this stream as a usual channel in Luxriot EVO Console meaning that you can record both video
and audio from it, analyze if for motion etc. To remove this entity, simply delete the device via Luxriot EVO Console.
If you re-install the application on your mobile device, you will need to go to the Luxriot EVO Console and add
your mobile device anew, basically, following the algorithm of adding a new device, or go to the device settings
and click Reset near the Code field to generate a new code, then enter the new code in your app.
Once you have registered your phone on the server, you can set up a panic button on your mobile device. This
button is placed on your hoe screen and, when tapped, initiates live streaming to the pre-defined server
immediately - you do not need to open the app and search for the server. To set up this panic button, go to the
mobile application settings and:
define the panic server where the stream should be sent to, then
create a panic button and place it onto the home screen.
Archive Playback
To switch to playback mode, tap the Archive tab on the bottom panel. Alternatively, tap the eye/timer icon to go to a
specific time: choose a point in time to begin playback at, then tap Set. Timer can be manipulated in the following
manner:
use UP/DOWN arrows or swipe UP/DOWN to change the value of each position
switch between the Time and Date tabs by tapping them
press Cancel to go back to Live mode, or tap Set to proceed with playback
When switching to Archive mode from a multiple camera view: all viewports will be highlighted blue - tap a camera
to select it. Note that this mode enables you to view one camera at a time: selecting a larger layout will result in an
automatic switch to live view.
Archive timeline controls:
green colour represents data, maroon means there is no recorded data for that period
tap the Next/Previous Frame arrows on the sides to go to the next/previous available picture
use the Play button in the centre to start/pause playback
tap the +/- labels to jump back/forward by ten seconds, one minute, ten minutes or an hour
tap the camera icon in the bottom-left-hand corner to save a snapshot
if the channel has several recorded streams (e.g., main and secondary), corresponding choice will appear
above the timeline on the left
Archive view
Swipe left/right to switch between cameras within the current layout; tap and hold the image to bring up the
available camera list (just as in the camera selection menu, this will exit the current layout and switch to single-
camera layout). Use the timeline below to browse the recorded video and use the play/stop buttons to control the
playback.
Widgets
Widgets are information elements that can be placed on the home screen on Android devices and in the Today view
on iOS devices. Individual channels that require frequent monitoring can be placed as Luxriot EVO Mobile widgets
with moderate or low (from twice per minute down to four times per hour) refresh rate so that you do not have to
open the whole app each time you need to check the channel. For channels accessible via Internet, this means you
can monitor them even if you are in a remote location on 3G or 4G: relatively low frame refresh frequency does not
use much bandwidth. You can also limit widgets to use WiFi connection only.
General steps to add and use a widget are the following:
add as many widgets as you need, one widget per channel,
go to Luxriot EVO Mobile app settings and set widget update and network usage preferences (for details,
see the Settings section above),
assign channels to widgets.
To add a widget on an Android device:
tap on a blank space on the home screen and hold for a couple of seconds until the menus appear,
tap the Widgets menu at the bottom of the screen, locate Luxriot EVO Mobile widget and then drag to
place it onto the desired place. Widget of default size (2x2 cells) will appear with a Slot not configured
message inside:
drag the orange borders to adjust the widget size, then tap outside the widget to exit the
adjustment mode (you can change the widget position and size at any time later by long tapping
the widget and then moving it)
tap the widget once: Luxriot EVO Mobile application will open, allowing you to choose the
channel,
then, in the Luxriot EVO Mobile app:
go to the app settings before connecting to the server and choose how frequently the widgets will
be refreshed, and also their network usage preference (see the Settings section above for details),
connect to a server of your choice, choose Camera to widget from the main menu, then tap a
channel to choose it (all channels will be highlighted with blue frames, swipe left or right to load
more channels to choose from), and then choose a widget slot from the list by tapping it, too (the
slot may be empty or already contain a channel),
go back to your home screen: the assigned channel should now be present in the widget, with the channel
name in the top left corner, slot number in the bottom left corner, and last refresh time in the bottom right
corner.
To replace the channel, follow the steps 3-4 above; to remove the widget, simply tap and hold it until the menus
appear and then drag and drop it onto the Recycle bin icon. Tapping a widget will result in opening the
corresponding app, as described above.
To add a widget on an iOS device:
swipe down over the Home screen, Lock screen or Notification centre to bring the Today view screen,
scroll to the bottom to reach for the Edit menu, tap Edit,
locate the Luxriot EVO Mobile app and tap (+) sign to the left of it: the app will be added to the list above,
tap Done when you have finished; the widget will appear under Widgets, allowing you to add and resize
the slots - tap any slot to open the Luxriot EVO Mobile app,
then, in the Luxriot EVO Mobile app:
go to the app settings before connecting to the server and choose how frequently the widgets will
be refreshed, and also their network usage preference (see the Settings section above for details),
connect to a server of your choice, choose Camera to widget from the main menu, then tap a
channel to choose it (all channels will be highlighted with blue frames, swipe left or right to load
more channels to choose from), and then choose a widget slot from the list by tapping it, too (the
slot may be empty or already contain a channel),
go back to your Today view: the assigned channel should now be present in the widget, with the channel
name in the top left corner, slot number in the bottom left corner, and last refresh time in the bottom right
corner.
You can drag widgets to rearrange them in the Today view; tapping a widget will open the associated app. To remove
a widget, go back to the widget list in the Today view, as described above, and tap the (-) sign next to the Luxriot
EVO Mobile name, then tap the Remove button. If you remove the widget and then add it anew, it will retain its view
(slots).
User Buttons
User buttons are software buttons, controls used in Luxriot EVO Monitor and Luxriot EVO Mobile for manual event
triggering: upon clicking or tapping a user button, the action associated with it is triggered. The action, the user
button itself and the rule that makes the user button work are all pre-configured via Luxriot EVO Console; see
corresponding sections of the server management manual for details.
If you are connected to a server that has configured user buttons and your user account has permissions to use them,
the buttons will be available in the app. To access them, tap the main menu and choose User buttons (vertical view)
or simply tap the corresponding button on the top panel (horizontal screen orientation). Then, choose the
button you want to use and tap it: the associated action will be triggered and you will receive a confirmation in the
bottom of the screen.
Events
Luxriot EVO Mobile app allows you to receive push notifications from the Luxriot EVO server once they have been
set up via Luxriot EVO Console Event & Action management.
In order to do this, create an action of the Send event to client type via Luxriot EVO Console and enable the Display
event in mobile application option, then attach this action to your desired event in the Rules section. When creating
the rule, do not forget to set the target channel for it: the notifications will appear for that particular channel and
their availability can be controlled via channel access permissions. It is possible to limit the reception of the
notifications to certain user profile or user group. You will find more details on how this is done in the Events &
Actions section, under Actions.
Triggered notifications will immediately appear on the mobile device(s) that have Luxriot EVO Mobile app installed
with the target Luxriot EVO server configured (connected user account must have permissions for the target
channel). The app itself may be not running: events will pop up as regular text message notifications. If the target
mobile device is offline, the notifications will arrive shortly after it re-connects to a network that provides required
server connection.
Offline Camera
Starting from version 1.7, Luxriot EVO Mobile allows you to record offline video clips for further upload to the
server. The video can be recorded from the device camera in the app and stored as long as required until the server
connection is available.
To enable this, you first need to:
set up the target server connection in the app
choose your camera preferences
register your smart device on the Luxriot EVO server as External Model as you would do for live streaming
from device camera
enable Edge Recording for the newly created channel
You only have to do this once for each device (unless you re-install the app). From then on, you will be able to record
as many video clips as you wish, and then upload them to the target server.
If you do not have paired your device with the server yet, go to your Luxriot EVO server configuration via Luxriot
EVO Console, go to the Configuration section and choose Devices from the menu on the left. On the upper panel,
click the + New device button in order to create a new device; enter your desired name and set the Model to
(Generics) - External Source, then save. Note the value appearing in the Code field: you will need to enter it into
your app.
Next, go to your app -> server list -> tap Settings in the bottom, find Camera in the list and choose your video
preferences; the contents of each item may vary depending on your mobile device capabilities:
Camera: back/front (primary/secondary)
Codec: H.264/H.265 (depends on device capabilities)
Offline recordings
Rotate your device the way you want to hold it during the process and tap the Start recording button: it will turn red
indicating that the recording is happening. Tap it again to stop: a new file will appear in the list and the camera
preview will return to live.
Tap any file in the list to play it back; the play/pause button will appear below the picture allowing you to
start/stop the playback. Use the recycle bin icon next to the file name to remove individual recordings. The
details on the upper right will show how much storage space has been used. The Recycle bin icon in the top right
corner will remove all the recorded videos.
Now, to upload the recordings to the server, use the Play button: the one in the top right corner will upload all the
files; there is also a possibility to upload the last recording only by using the Play button next to the file name. You
will be presented with file details and server choice: when ready, tap the Upload button. The video file(s) will be
uploaded to the selected Luxriot EVO server and stored as edge stream for your device's channel. Do not worry if
the upload is interrupted due to network issues: the upload will resume as soon as the connection to the target
server is available again.
GPS Tracking
Starting from the Luxriot EVO Mobile version 1.7 and Luxriot EVO version 1.8.0, it is possible to send the GPS
coordinates of the smart device to the Luxriot EVO server. The coordinates are then displayed on top of the live and
recorded video, and they are also used to trace the device on geo maps.
GPS coordinates displaying on top of the video streamed from Luxriot EVO Mobile
Setup:
enable sending of GPS data in your app settings
register your device on the server as described above in the Stream Camera/Offline Camera sections so
that it exists in the server device/channel configuration
create a geo map on the server via Luxriot EVO Console
place a camera marker on the map, set your smart device as the target channel and enable tracking in the
properties
Setup in Brief
Actual setup of E&A depends greatly on your system configuration, E&A usage scenarios, required automation level
and other things. However, we recommend that, regardless of system scale and architecture, you stick to the
following order of E&A configuration steps for optimum results:
1. Preliminary actions
a. Create a plan of your E&A scenarios on paper or in any diagramming/smart draw software - this will
ensure you always have a basis to check against
b. Set up the your Luxriot EVO system so that you have all the servers, devices, channels, users, external
system connections, and optional elements pre-created
c. Pre-configure all the necessary hardware equipment (e.g., camera IO wires, external physical alarms,
buttons) and connect it
d. Pre-configure all third-party programs/scripts/executable files, if necessary
2. Extra setup in Luxriot EVO Console
a. Create User Buttons, if you are going to use them for manual action triggering
b. Create Maps, Layouts, PTZ Presets if necessary
9.1 Rules
All rules defined via Event & Action Configurator are listed in the Rules section. Click the Change button near
server name to select a different server from the list: for each server, only relevant rules are displayed. You can
perform the following actions from the Rules section without opening the E&A Configurator:
view the complete list of existing rules, per server, and their properties
disable a specific rule or a set of rules by using the Disable button on the upper panel
enable a specific rule or a set of rules by using the Enable button on the upper panel
test a specific rule (the rule must be enabled)
In order to add, remove and modify the rules, choose the target server and click the Open Configurator button on
the top panel.
The Event & Action Configurator will open in a new window; by default, no rules are defined.
Choose the target item from the Events list and then click the + Event button below: configuration dialog box will
then open with the target device pre-selected. Here you can add alerts from device digital inputs, VCA notifications
and other types of events; see the detailed description of how to create events in the Add Events section.
Events are arranged by sources. Typical event sources are: channels, channel groups, servers, user buttons, video
walls, external services.
Built-in (default) types of events - lost/restored video, recording errors etc. - cannot be edited. This is also the
case for all built-in actions.
Choose a target item from the Actions list and then click the + Action button below: the configuration dialog box will
then open with the target device pre-selected. Here you can add different reactions any type of event:
trigger device digital output
write to OS Application log
Manage Rules
To start combining events, actions and additional controls, simply follow this scheme:
find your desired event in the Events list - use search filter on the top panel, if required
use the < and > arrows or double-click events to add/remove them to/from the Rules list
click free space of the target rule in the Rules list (use CTRL or Shift to select multiple ones) - the selected
rows will then become highlighted green
find your desired action in the Actions list - use search filter on top, if required
use the < and > arrows or double-click actions to add/remove them to/from the Rules list, and the +
button to add more than one action for a single event
select desired actions and add auxiliary controls by clicking buttons on the bottom panel (see description
below for details)
Useful tips:
double-click a device (highlighted grey) to add all its events to the rule map
to add an action to an existing rule, use the + button instead of the < button: the original event will
be duplicated and new action will be added to the copy
use the + button between Rules and Actions lists to add multiple actions of the same type to the
selected rule(s)
to clear the Rules list, select all rules using Shift or CTRL+A, then press < button on the left to
remove all events
The rule header displays the event source and event itself; below, related actions are listed, each with its own set
of special controls. Actions of the same type are listed under the same rule header; for all other cases, the events are
duplicated, resulting in a separate rule. One condition, one schedule and one delay timer can be attached to each
action.
For each event/action pair that is added to the rule map, additional options can be defined in the form
of conditions, delays periods and schedules. Select one or multiple target events from the Rules list and then click
desired control item in the bottom panel.
To remove auxiliary controls from a rule, select it in the Rules list and click the Clear button on the bottom panel.
Note that all defined conditions, timers and schedules will be removed from the target rule, and it is not possible to
de-attach them one by one.
Delay Timers
To add a pause timer for specific actions, select one or more of the mapped rules (use CTRL+click or Shift+click to
mark multiple items) subject to delay, and then click the Delay Timer button on the bottom panel of the central part
of the Event & Action Configurator.
When you have finished, click OK to save and exit the dialog box. The newly created delay timer will be assigned to
the pre-selected actions.
Extending an action allows you to postpone the action execution repeatedly if more events of the same type
arrive within the chosen time period. For example, if incoming events are of a Recording Error type, there
may come too much of them at once e.g. in case of a major storage issue, causing a lot of triggered actions of
the same type, while only a single action may be desirable.
Say, if required action is Write to application log, setting a delay timer to 5 minutes + extended action will
postpone the email sending for 5 minutes every time a new recording error appears; when, at a certain point,
more than 5 minutes have passed without new incoming events, a single log entry will be eventually
created. The separate action option, on the contrary, will force logging for every single triggered event.
To remove a delay timer from rule configuration, click the timer to highlight it within the rule, and then click the
Clear button in the bottom panel. Note that, if there are schedules and/or conditions attached to the same rule, they
will be removed as well.
Schedules
Schedules are used when you wish a rule to be active based on a pre-defined itinerary. You can create any number of
custom schedules via the Conditions section in the Luxriot EVO Console and then use them for rule control:
see Create Schedules section in this document for a detailed explanation of this.
Select one or multiple target events from the Rules list and then click Schedule button in the bottom panel.
Conditions
Conditions are supplementary variables that can allow or prevent action execution. The decision is taken based on
the condition state: if the condition is ON, the planned action will be executed; if the condition is OFF, the action
will not be performed regardless of the frequency of the triggered event. The condition state can be changed as a
result of some other event, so ad additional rule should be added to perform this task; alternatively, you can
manually set and unset conditions at your will. Thus, conditions allow the activation and deactivation of rules
without requiring them to be entirely deleted.
To assign a condition to the rule, choose one or multiple target events from the Rules list and click the Condition
button on the bottom panel, then either select target condition from the list or create a new one.
Please read the Conditions topic of this document if this feature is new to you: it contains detailed description and
usage examples.
Use the Snapshot Source button to attach different snapshots to several actions of the same type
When you combine such actions with events that already are related to some channel (e.g., Video Lost, Motion, VCA,
DI), that channel is selected automatically for the resulting action. For the rest of events, the channel is not set by
default and you need to use the target/source channel buttons on the panel below the rules. Also, you can set a
different channel instead of the one selected automatically by using the same buttons.
Attaching Snapshots
The Send Email action allows you to attach a snapshot from one channel and deliver it together with the email to the
recipient. The snapshot can be taken either from the main stream or from the secondary stream (substream), if
available. At the action creation time, you just enable the snapshot from either main or secondary stream, and then
you will have an option to specify the source channel when creating the rule that involves such an action.
When creating the Send Email action, you can choose to attach a snapshot by selecting the necessary stream option
(main/sub) from the drop-down list. The channel itself is not specified at this step as it is not known beforehand, to
which channel this action will be applied in future - this makes the action universal, applicable to any target channel.
The source channel is specified when you attach the Send Email action to an event, i.e., create a rule in the Event &
Action Configurator:
if the event in the rule has some channel as a source (e.g., motion, VCA, DI), this channel is set
automatically as a snapshot source
for events having sources other than channels (e.g., user buttons, server events), you can specify the source
channel by using the Snapshot source button on the panel below the rule map
you can modify the source channel by using the same button, and also disable snapshot attachment by
selecting none as the source
Email sending rules can accept any extra modifiers just like any other rules - delay timers, conditions and schedules,
each of them once.
There are other actions, apart from Send Email with a Snapshot, that are related to channels and may use them as
action targets. These are, namely, Create Bookmark and Send Event to Client.
Recording changes are logged in the notification area of the target channel
The Create Bookmark action requires a channel to add the bookmark to. To add bookmarks to multiple channels
simultaneously, add several actions of the Create Bookmark type and specify different target channels for each.
The Send Event to Client action only needs a target channel to be specified in case the action has the Display event
in notification panel option enabled: as a result, the pre-defined message will appear in the notification area of the
specified channel (overlay area in live view, the same place where the stream errors appear - see Luxriot EVO
Monitor user manual for more information). Similarly to bookmarks, you can add more than one action of the same
type and add different channels as targets in order to display the message in the notification areas of these channels.
Examples
Here are a few examples of the Event & Action Configurator usage. You will find more examples in each of the
related topics.
Task: upon a user button click, save a snapshot from every existing channel on one server.
Preliminary setup:
create a user button with your desired name
create an action: export snapshot to a specified location
Export snapshot to a specified location using text macros for the file name
Note that the action itself does not contain any fields for the channel to serve as the snapshot source. Thus, the
action is universal and can be used repeatedly for many rules; the target channel for the snapshot is then to be
specified for each rule in the E&A Configurator.
Use the text macros in the file name and/or path: this is necessary for each snapshot to have a unique name.
Otherwise, the snapshots in the same directory will overwrite each other. {ACTION_PARAMETER_TITLE} here is
the best option here to differentiate between channels because the originating event (user button clicked) and the
action target (server) are the same for all rules. For example, here are two different applications for the same
macros:
K:\Snapshot\{ACTION_PARAMETER_TITLE}_{EVENT_TIME}.jpg - each file name contains channel name
(snapshot source specified at the rule creation step) and a timestamp
K:\Snapshot\{ACTION_PARAMETER_TITLE\{EVENT_TIME}.jpg - directories with channel names are created,
and all snapshots from the same source are put into the same folder and have timestamps as their names
Task: send an email notification when the video stream from certain channel(s) is not available for more than five
minutes.
Preliminary setup:
in the channel settings, set the video loss timeout to 300s (five minutes) for each target channel (select
multiple channels and use the Bulk Edit button on the upper panel to modify several channels at once)
configure a mail server with your desired parameters
create an action: send email to the responsible person using the pre-configured SMTP server
Rules:
the Video lost event from each of the target devices triggers the Send email action
This example will cover a use case with a global event, showing how multiple servers within a single system can be
involved in a more sophisticated chain of events and actions.
Task: if there are recording errors on Server A, log this event locally and also add corresponding entry to Windows
Application log on the central server. The Recording error event is there by default and so there is no need to create
it.
Preliminary setup:
Server A: Write to A Application log action
Central Server: Write to CS Application log action
Global event Recording Error on Server A
Rules for Server A:
Recording error event triggers local Write to A Application log action
Recording error event triggers Send global event action for the Recording Error on Server A event
Central Server rules:
Recording Error on Server A global event triggers its own Write to CS Application log action
Default events
Default events are available in the Event & Action Configurator and can be used in the same way as user-defined
events, except for they cannot be edited. Events are arranged by sources. Typical event sources are: channels,
channel groups, servers, user buttons, video walls, external services.
Before creating events from camera DI, VCA source, or external services, make sure to:
enable alert generation in channel settings via Luxriot EVO Console for device digital inputs (DI);
enable and set up rules via camera Web interface for edge VCA and set up rules via channel settings
for software-side Open VCA;
set up the External Service event generation logic for external services (license plate recognition,
face recognition etc.)
Without these settings, the event source will be not available for the target device in the event settings.
This type of event is triggered by the status code coming from the access control integration, whenever the status
code is not related to any door (making it impossible to use Door event). The codes are vendor-specific and will vary
depending on the access control suite type.
Title: user-defined event name, as it will appear in the E&A Configurator
Source: access control server that will send the status changes
Code: vendor-specific event code
Door Event
This type of event is used to set up Luxriot EVO server reactions based on door status changes, which are received
from the integrated third-party access control software.
Door event
Settings:
Title: user-defined event title
Source: a door from the access control module (choose from list)
Code: received status or error code from the access control module (choose from list)
enable and set up rules via camera Web interface for edge VCA, or set up Open VCA rules (Open VCA must
be activated)
Without these settings, the target channel will not have corresponding DI or VCA items available in the event
settings (the item list will be empty).
Digital Input
This event is triggered when a device's DI (digital input) state is changed. Before creating the event, make sure you
have enabled DI event generation in the device channel's properties.
The following settings are available for Digital Input event:
Title: user-defined event name
Source: choose the device from which the DI event originates; event generation must be enabled in
the channel settings
Digital Input: select one of the DIs of the target device to serve as event trigger; the number of inputs
depends on the total available and configured inputs
Digital Input Mode: the binary input state to trigger alert; must conform with the DI state set up in
the channel settings
VCA Event
For camera-side VCA and software-side Open VCA events. Note that this event only covers triggered VCA rules,
and not counters. In order to set up reactions for VCA counter changes, use the Channel variable value event (for
Open VCA) or Counter value event (for camera-side counters).
The available settings are:
Title: user-defined event name
Source: choose a channel from which the video analytics event originates; analytics rules must be enabled
via the camera Web interface (some cameras have basic VCA events enabled by default, e.g. volume
detection) or pre-configured using the Luxriot EVO Console for the software-side Open VCA module (see
External Events
These events come from all kinds of external systems via Luxriot EVO HTTP API.
External Service
External Service type events are messages from modules that are operating via Luxriot EVO HTTP API and are
listed in Luxriot EVO Console as external services. By default, license plate recognition and face recognition services
are integrated, and any other third-party integrations can be connected.
The following settings should be defined:
Title: user-defined event name
Source: the channel that is used by the target external service
Service group: the group the external service belongs to in Luxriot EVO Console settings
Target event: service-specific result type, e.g., recognition result
Known: recognition result has a match within the external service database (black/white list in
LPR, subjects' database in FR), matching any tag
Unknown: recognition result has no matches within the external service database
Tags: recognition result was found in the external service database and it has a specific tag
assigned to it
External
External events are HTTP requests from third-party software: integrations, scripts, Web browsers etc. These are a
basic example of Luxriot EVO HTTP API: an URL is used to trigger the event.
Event ID: alphanumeric event identifier, only Latin letters [a-zA-Z] and digits [0-9] allowed
The request link is built as follows:
http://<server_address>:<http_port>/externalEvent/activate?id=<event_id>, where
<server_address> is the target server's IP address or hostname (in Luxriot EVO Global systems, use the
exact Luxriot EVO Recording Server address, not Luxriot EVO Global server address)
<http_port> is the server's HTTP port (8080 by default)
<event_id> is an alphanumeric identifier of the event, which is defined at the event creation step
Example: http://192.168.1.99:8080/externalEvent/activate?id=666
Counter Value
Solely for camera-side counters and software counters (server-side, NOT VCA).
Software counters can be created in Luxriot EVO Console to count any events in the system. Camera-side counters
are only available for certain integrations (e.g., Dahua with smart tools).
This event is similar to the previous one, with the difference that you do not have to set the data type, bur rather
simply select a pre-created counter. Counters from the cameras must be also explicitly added in Luxriot EVO
Console under E&A > Counters > New VCA Counter.
Title: user-defined event name
Source: choose one of the pre-created software or camera-side counters
Condition: define what the counter value will be compared to
Conditional operator: choose the comparison type - greater, less, equal, etc.
Value: an integer value for the counter to be compared to
Data Source
The server will monitor incoming text from Data sources, triggering an event in case the specified string (textual
value) is received. This can be used to react to certain keywords from POS terminals and any other serial data
sources. The string for comparison is defined in free text form (not regex). The server will be looking for an exact
match, i.e., the field is case-sensitive and all extra symbols (commas, spaces) are accounted for.
Available settings:
Title: user-defined event name
Source: data source to be used as event source; text from data provider will be analyzed for matches
Text: case-sensitive keyword or key phrase; when an exact match is found in the text, the event will be
triggered
For the event to operate, it is not necessary for the target data source to be bound to any channel. Associating data
sources with channels only affects video overlay in the Luxriot EVO Monitor application; text detection will work on
the server side, and therefore the data source may be independent.
This event is dedicated to Open VCA counters (those set up on the server side for a specific channel). Each counter
value update triggers a comparison of the integer counter value to the pre-defined value. The comparison operation
is carried out using two integer data types and returns true (event is triggered) if the condition is true. The available
conditions are: equal/not equal, greater/less, greater/less or equal.
To react to Open VCA rules, use the VCA Event under channel-related events.
Title: user-defined event name
Source: a channel that has Open VCA enabled and at least one counter set up
Condition: define what the counter value will be compared to
Variable: Open VCA counter name
Type: must be integer (other types are listed to ensure event compatibility with older software
versions)
Conditional operator: choose type of comparison - greater, less, equal, etc.
Value: an integer value for the counter to be compared to
Variable Value
If you have some variables set up in the E&A section, you can use E&A manager to trigger events when these
variables meet some specific condition. Mostly, these variables are mappings from Data sources: thus, this event
supplements the previous Data Source event by matching any data type (not just text).
The second purpose of this event is analysis of metadata received from cameras (or other devices). A typical
example of this is variables from thermal cameras containing exact temperature measurement. To use this
feature, first create channel variables under Variables in the E&A section. Then, use them as
An event is raised when the Sum variable is strictly greater than 100.0
This event has the following settings:
Title: user-defined event name
Source: a channel to be analysed for the variable (which is set in the corresponding data source profile or
has VCA configured); if none selected, the event will be visible for all channels
Variable: variable name, must match the mapping name in the data sources profile or the VCA counter
name
Type: variable type; may be integer, double or string for a data source mapping, and integer for VCA
counters
Conditional operator: depends on the variable type
Value: value that will be compared with the variable value
Other Events
Events having no special category (or, at this point, unique), are grouped under Other events.
Data received from OPC servers can be analysed - compared to specified values using conditional operators - so that
an event is triggered when the target OPC node value meets the defined condition.
For this type of event to work, there should be at least one OPC server configuration available with at least one data
node.
This event will be triggered if the target OPC server has 5 or more connected clients
Settings:
Title: user-defined event name
Source: OPC client configuration (connection to an OPC server)
Condition: defines a requirement for the OPC data item that will trigger the event
Variable: OPC data node, must be of compatible type and have a read permission
Value type: one of the standard data types, auto detected
Conditional operator: list of possible conditional operators, depends on the data type
Value: value to compare the variable to, must match the variable value type
For some conditional operators, the Value field may be different, e.g., represent a range, a regular expression, or a
bit mask. This depends on the selected data type and conditional operators available for it.
In the Luxriot EVO Global system, when a recording server goes down, this event will be triggered on the central
management server. (Built-in events only include central server disconnection and failover activation events.) You
can add both connection and disconnection events, or either one, for every recording server in the system.
Settings:
Title: user-defined event name
Source: central management server (unchangeable)
Recording server: target secondary server to trigger the event, or Any to enable this event for all
recording servers
Connection event: connected/disconnected (one at a time)
Scheduled Event
The server can create automatic events on a daily or weekly basis, or at certain intervals. Such an event does not
have any underlying source to originate from, it is simply generated by the system in the specified moment(s) of
time. Note that the time defined here is server time.
Minimum time interval for the periodic event is 15 seconds and maximum is 86400 seconds (which is equal to
24 hours).
To add a schedule, simply click the Add button below and append as many items as you like. You can add multiple
moments per day as well.
Video Wall*
This type of event is raised when the video wall state is changed. This happens when objects are sent to video
wall from the resources' menu in Luxriot EVO Monitor, when they pop up automatically based on another event, or
when users manage the video wall via dedicated tab in the Luxriot EVO Monitor application. Note that events of this
type are not generated if screen contents is changed directly via local screen management - drag-and-drop or
double-click.
Advanced options let you specifically define the nature of that change, the video wall screen and even the target
viewport.
This event can happen on three levels, depending on the defined scope:
any part of the video wall (video wall is defined, other settings set to any)
specific video wall screen (video wall and its screen are defined, leaving viewport choice to any)
specific viewport in the video wall screen (all settings defined)
The triggered events for all these areas will differ slightly (see examples below).
Available settings:
Title: user-defined event name
Source: video wall
Mode: the type of changes
Updated: any change in the specified location (any or a specific object has been placed on or
removed from the target location)
Added: the target object has been added to the specified location for the very first time
Removed: the target object has been completely removed from the target location
Video wall screen: target video wall display
Viewport index: number of the port to trigger the event, set 0 (zero) for any viewport
Object: any object (if updated), or a specific map/channel (updated/added/removed)
Note that the target object must be specified for added/removed modes: there are no events for "any object added"
or "any object removed". These two modes are intended to be used with concrete objects. If you do not care, which
object was added or removed, use the updated mode.
Channel Y is then displayed in another viewport (so that it now appear in two viewports): event
is not triggered
video wall, its screen and a viewport index are defined:
every time Channel Y pops up or is placed into the target viewport, the event is triggered
*This feature is only available in the Luxriot EVO Global software edition.
Removing and adding event sources again (e.g., deleting and creating edge VCA rule with the same name) may
render them unusable if they are already included in the Event & Action configuration. Make sure to verify
the event operability and then re-create and re-insert the event after modifying it, if necessary.
Default actions
When you generate an alert for main stream or substream, all channels having alert-based recording enabled
will start recording for the duration of time period defined in the profile as post-recording time; after that,
the profile operation will be terminated and target channel will return to its normal recording configuration.
Default actions are available in the Event & Action Configurator and can be used in the same way as the user-
defined actions.
Door Action
If you have a third-party access control module connected, you can change the door state from here. You must have
at least one door added in the access control profile to make this work.
This action type allows you to make a PTZ camera go to a specific pre-configured preset. You just need to specify:
Title: a user-defined action name
Target: the target device which is to accept the PTZ command
PTZ priority: priority to execute PTZ action with (0 = lowest, 10 = highest, higher priority will override
tours and user commands*)
Preset: pick one of the automatically loaded target device presets from the drop-down list (you might
need to create some first via Luxriot EVO Monitor)
This action is similar to the previous one but instead of activating a single PTZ profile you run a series of presets
called a PTZ tour. PTZ tours must be pre-created via Luxriot EVO Monitor application. For each tour, you define the
order of presets and their duration.
Devices having relay (digital) outputs (DOs) can have them triggered as a result of the Control digital output action.
You are asked to enter the following details for this action type:
Title: user-defined action name, by default it is > Activate PTZ preset >, suggesting that before and after
>> arrows you can insert the camera name and DO number/target - or, alternatively, re-define the whole
title according to your own naming convention
Target: the target device which is to accept the digital input control command
Digital Output: pick one of the available DOs of the target device to be triggered
Digital Output Mode: choose whether an activation or deactivation command is sent to the target relay
output
Digital output(s) must be enabled in channel settings for the target camera; otherwise, you not will see any
available DOs in the drop-down list after selecting the target device. Also, make sure that digital output
operation has been allowed via device Web interface.
Device Action
This action is reserved for special device-side actions like wiper control, arm/disarm, lights ON/OFF etc. This
functionality depends on the device integration.
Title: the user-defined action name
Target: the target channel to accept the command
Device action: integration-specific device action
Currently, device actions are only supported for few devices. If you do not see any available action for your camera,
try using the Send HTTP Request action described further: that action allows you to enter a CGI/HTTP command
from device API.
Export Snapshot
A snapshot from the main or secondary stream of any channel can be saved as a result of an action. The file can be
saved either locally (on the target server) or to a remote server (FTP).
It is possible to send an audio file to the connected device in case it has a built-in or a connected speaker: Luxriot
EVO server can use a .wav file to send audio to the remote camera or video server.
This action is used as a complement for the Start playing an audio file action: it stops the audio transmission in case
you need to force stop it earlier than specified in the Start playing an audio file action, e.g., if the starting action lets
the audio file to be played infinitely.
The following settings are available here:
Title: user-defined action name
Target: target channel (leave none for the action to be available for any channel)
Logging
In addition to default audit log, you can choose custom events to be appended to the Luxriot EVO server audit log or
to Windows application log.
The Application log action type allows you to write a log entry into the Windows Application log, which will
be accessible via Windows Event Viewer. The log entry level is Information and entry source is Luxriot EVO Server.
You can define:
Title: a use-defined action name inside the Luxriot EVO Console; by default it is Write to Application log
Log Message: the message text to appear in Windows Application log
The Audit log action type is similar to that of Application log: it allows you to write a log entry into the Luxriot EVO
own Audit log, which will be accessible via Luxriot EVO Console, in the Audit section. The log entry is added in the
Server audio section and its event type will be User defined. You can set:
Title: a use-defined action name inside to be used in E&A; by default it is Write to Audit log
Log Message: the message text to appear in the Audit log
Use the Insert Field button on the right-hand side (it appears when you have clicked inside the text area) or right-
click the text area and choose Insert to add a text macro (see Action Parameters further in this topic for details).
Notifications
Actions in this section allow you to send all kinds of alerts to clients and also email notifications.
Highlight On Map
If your target item appears on one or more maps, you can visually accent it on the map as a result of the triggered
event. It is possible to define one particular map or make the device become highlighted on all maps where is has
been placed.
You can set up individual channels, maps and layouts to appear on a specific video wall display as a result of some
triggered event, e.g. motion detected in certain regions. If you wish an object to pop up in all connected Luxriot EVO
Monitor applications without using video walls, use the built-in (default) event of the Pop up on screen type.
Additional setup is required from the Luxriot EVO Monitor application side:
shared layouts should be pre-created in order to be used in action creation
target Luxriot EVO Monitor window must be allowed to accept either channels/maps or layouts
target Luxriot EVO Monitor window must be set to be a part of the target video wall
An action that will pop up a map on the specified video wall display
You can create new maps, geo maps and layouts right from the object selection dialog in case you have not created
them beforehand.
Send Email
In order to send an email notification, you are requested to define the following values in the action settings:
Title: a user-defined action name; by default it is <mailserver> Send email, you can insert the device
name and target email address - or, alternatively,you can re-define the whole title according to your own
naming convention
Target: specify the SMTP server to be used for email sending; if none are selected, the action will be
available for selection on any of the existing configured mail servers when creating a rule
To: notification recipient email address
Subject: email notification subject (use the Insert field button to add text macros)
Body: email notification body text (use the Insert field button to add text macros)
This action is similar to the Send Email action described above, with all the settings being the same plus snapshot
adjustments: attach a snapshot from a channel and send it together with the email. The channel is specified when
creating a rule with this action.
Additional settings:
Attach snapshot: choose if you want to take a snapshot of main stream or substream of a channel and
deliver it together with the message
Snapshot title: user-defined file name, e.g., Snap.jpg, or
Snap_{EVENT_TIME}_from_{ACTION_PARAMETER_TITLE}.jpg
Enable subtitles: enable this setting to activate subtitles and expand additional settings
Text: subtitle text (plain text and/or macros)
Position: subtitle alignment (top/bottom, left/right, corners)
Font: subtitle font (choose from the system dialog)
Colours: background (transparent by default), foreground (text itself), shadow (text shadow)
The subtitles will be hard merged with the exported image.
Subtitle settings
In the Send Email with a Snapshot action, you only need to define whether this specific action will take a
snapshot from the main or from the secondary stream. Actual channel for the snapshot to be taken from will
be defined when you create a rule involving this action:
if the source event originates from some channel, that channel will be automatically used as a
snapshot source; you will be able to change the target channel using the Snapshot source button
below the rule map in the E&A Configurator
if the source event does not come from a channel (e.g., user button click event), you will have an
option to define the target channel using the Snapshot source button below the rule map in the E&A
Configurator
If you specify no snapshot source when creating the rule, a regular email will be sent. You will find more details on
attaching the snapshot in the Rules section of this document.
This event allows to send a push notification to all or specific Luxriot EVO Monitor applications. This may be just a
pop-up message, or an event in the channel notification area with a sound, or all of these combined.
Available settings:
Title: user-defined (custom) action name that will appear in the E&A Configurator
Message: notification body text (use the Insert field button to add text macros)
Display event in alerts: mark this if you want a message to be appended to the Luxriot EVO Monitor
log in the Alerts section
Display a warning message box: mark this if you want a dialog box to pop up on the Luxriot EVO
Monitor side (to be closed by the user)
Display event in notification panel: the message will be shown in the notification panel of the live
view of a specific channel (you will have to set the channel when creating the rule)
Display event in mobile application: the message will be sent as a push notification to all Luxriot
EVO Mobile clients that have the target server configured
Play audio notification: play a sound on the Luxriot EVO Monitor side; sounds themselves are defined
in each Luxriot EVO Monitor application
Audio notification: sound notification number, from 1 to 10 (here, you just specify the
number, actual sound is defined per client and may not coincide in different application
instances)
Send event to specific user or user group: show the notification only to a specific user or user group
Any of the existing recording profiles can be activated for the channel of your choice as a result of a triggered event.
You can separately activate main stream and substream recording: use the Activate Recording Profile action for
main stream and the Activate Substream Recording Profile action for secondary stream. Enter action details as
follows:
Title: the user-defined action name
Target: the target device for which recording is to be activated
Recording profile: the pre-configured recording profile to be activated as an action; you will find profile
configuration tips further in this section of the manual
The recording profiles are changed within the channel's recording configuration. Thus, for example, if the channel's
recording configuration has a 3-second pre-recording duration, it will stay 3s for any recording profile you activate
via E&A.
The recording profile is activated permanently; to switch to a different recording profile, use another action of
the same type and different target profile.
Example of emergency recording scenario: create a user button and bind 2 actions to it, one action activating
continuous recording, and the other one activating no recording (will activate the recording default profile).
Then, add a delay timer to the second action with a required duration, e.g., 1 minute. You will be able to trigger
the emergency recording manually from both Luxriot EVO Monitor and Luxriot EVO Mobile applications.
When channel recording profile includes alert-based recording, recording can be activated as a result of a
Generate Alert type action and its engagement time is determined by the profile's post-recording time parameter. In
this case, actual recording profile is not changed and the current recording profile is used (the one assigned to the
channel through its recording configuration). The default (built-in) recording profiles have post-recording intervals
of 10 seconds, which may be fine when conducting, e.g., motion-based recording (video is recorded for 10s after
motion event), but may not be suitable for other types of events. In such case, you can pre-configure any number of
different recording profiles and use them for action setup.
If a recording profile is triggered by an Activate Recording Profile type action, the recording profile used for the
target channel is complemented with the profile triggered from E&A, and recording duration can be controlled using
action delay timers.
Scenario 1. The camera's recording configuration is normally motion-based. The action is intended to be used for
recording based on digital input events, which are triggered when someone opens main entrance door; starting from
that point, the video and audio streams will be recorded continuously for one minute.
channel base recording configuration: motion-based video recording
actions triggering recording profiles:
action #1 triggers a recording profile with continuous video + audio (e.g., built-in Continuous
Recording profile)
action #2 triggers the built-in No Recording profile: as a result, channel recording is returned to
its default (configured) state
action #2 is delayed for one minute using a Delay Timer
Scenario 2. The camera normally records continuous video with low FPS during the daytime, and does not record
anything at night and during weekends. If camera VCA detects fire or smoke in the area, continuous recording at full
frame rate will be conducted for 30 minutes.
channel base recording configuration: based on schedule, continuous recording at restricted FPS + no
recording
action triggering recording profiles:
action #1 triggers continuous video recording without frame rate limitation
action #2 triggers the built-in No Recording profile: as a result, channel recording is returned to
its default (configured) state
action #2 is delayed for thirty minutes using a Delay Timer
Create Bookmark
Bookmarks can be created by the server, based on any available event. This can be done either completely
automatically or complemented with user input - from the users who are connected via Luxriot EVO Monitor
application.
Note that the target channel is not specified at this step: you will have an option to specify it using the Target
Channel button when you create a rule with this particular Add Bookmark action. If the source event of such a rule
is channel-specific (e.g., Video Lost, Motion), the channel will be set automatically. Please see the Add Rules section
for examples.
Scenario 1: fully automated
In the Add Bookmark action settings, do not enable the Request user description option. Instead, specify desired
bookmark title and description. Now, when you use this action in a rule, a bookmark will be added automatically
with the pre-defined description.
Scenario 2: bookmark with user confirmation
Enable the Request user description option and specify the bookmark title: make sure to make the title
comprehensible as it will be displayed to the Luxriot EVO Monitor user when prompting for the comment.
Optionally, you can specify the description - it will be used when no user input is specified (users ignored or missed
the description dialog box).
After you have added the action, you can go ahead and use it in the E&A Configurator: there, upon adding a rule, you
will have an option to specify the target channel for the bookmark to be added to.
Other Actions
Actions having no special category are listed here.
External Service
For external services that have their own events (e.g., third party integrations via HTTP API), it is possible to trigger
these as actions from Luxriot EVO servers. You need to specify:
Title: user-defined action title
External service: external service (connected to the Luxriot EVO system via HTTP API) to accept the
data
Target action: choose one from the list of available items (availability is ensured on the external service
side)
This type of action is handy when you have your own service integrated via Luxriot EVO HTTP API.
This action type uses an existing OPC client configuration to send write commands to an OPC server, thus changing
values of its nodes.
Run Program
The Run program option gives you the opportunity to define an executable file (script, batch or a GUI application)
that will be launched as a reaction to defined events.
The following parameters should be specified:
Title: a user-defined action name
Target: target Luxriot EVO server to execute program on
File Path: full path to the executable file
Parameters: input parameters, if the program launched accepts any (e.g., a batch file) (use the Insert
field button to add text macros)
Run Mode: execution mode - hidden (silent, invisible to server user), minimised (minimised to taskbar)
or normal (program will run in its default state)
As a result of a triggered event, HTTP/CGI requests can be sent from Luxriot EVO servers to any third-party servers
or devices that can accept such commands. The target devices can be third-party software, Web servers, cameras or
any access control hardware. This event is similar to the previous one, with the difference that here there is a single
HTTP request, while using the Run Program action you can program multiple requests with necessary delays and
internal logic.
SNMP Trap
This event allows Luxriot EVO server to act as an SNMP agent and generate and send trap messages to a third-
party SNMP manager.
OPC servers provided by different vendors can be used with Luxriot EVO. The present document does not
cover OPC server installation and configuration, as well as related Windows settings necessary for valid
OPC client-server connection setup: these are vendor-specific and can be found in the OPC server
documentation.
OPC Functionality
Any Luxriot EVO server can connect to a third-party OPC server, thus acting as an OPC client. These connections
are then used within the E&A Configurator to create events and actions based on OPC data (variables): events
compare the variable contents to pre-defined values in a specified way; actions change the variable contents to a pre-
defined value.
Communication with OPC servers can be maintained in one of two ways: synchronous and asynchronous.
When in synchronous mode, Luxriot EVO server polls an OPC server and receives updates with the latest data set as
a result; this happens every few seconds. In the asynchronous mode, Luxriot EVO server "subscribes" to the updates
and then waits for a list of updated items from the OPC server.
Asynchronous reading and writing is a preferred method and is typically more efficient. However, some
modifications of Windows security policies and DCOM permissions might be required for this connection
mode to work, and these are vendor- and use-case specific. Please follow the guidelines in your OPC server
documentation carefully to ensure the operability: there are no settings on the Luxriot EVO side that could
affect your OPC server connection availability.
Before getting to OPC setup on the Luxriot EVO side, install and configure your OPC server with hardware devices,
and adjust Windows settings (if required). Configuration instructions below imply that you have done so and a
remote OPC server with some data is reachable and operational.
OPC client configurations are located in this section as main OPC integration purpose is event and action scenarios
(rules). In your Luxriot EVO Console, switch to the Events & Actions section and choose OPC in the list on the left.
To add a new configuration, click the + New OPC client configuration button in the upper panel.
*Once you assign the OPC client configuration to a server, the Server field will become greyed out, meaning
that you cannot change this setting anymore. In other words, it is impossible to move an OPC client
configuration between servers. To do this, you will need to create a new OPC connection for another server.
**The Prog ID parameter is mandatory and it is supplied by your OPC server. Typically, it is available in the
OPC server settings; check your OPC server configuration manual for the exact information.
The newly created profile will appear in the list. Select it and hit the Test button on the panel above to validate the
configuration; the following responses may be received:
OPC client test passed: asynchronous connection with the configured OPC server has been successfully
established
Code 22020100 (asynchronous data mode not available): connection established successfully but only
synchronous mode is available
Code -2147023174 (RPC server is unavailable): connection unavailable due to invalid OPC client settings
(e.g., incorrect target host name or IP), Windows settings or connectivity issues
Code -2147024809 (parameter is incorrect): incorrect OPC client configuration (e.g., no username was
entered while expected)
Code -2147024891 (access denied): OPC server denied connection due to lack of permissions (e.g., invalid
user name and/or password was used)
Code -2147221164 (class not registered) or code -2147221005 (invalid class string): typically, incorrect
program ID format or program ID itself
The first two responses indicate successful connection with synchronous or asynchronous read/write mode; other
codes mean no connection has been established so it is necessary to review the settings and troubleshoot. Other
codes may appear as well in case of miscellaneous Windows configuration and/or connectivity issues.
Once you have created an OPC server connection, Luxriot EVO server can retrieve the list of existing data items
(nodes) from the OPC server and work with it. All the available nodes, their attributes and their values are listed
when you create an event or an action of the OPC Client type.
Events allow you to create conditions - react to specific changes in the node values by applying conditional
operators: for example, if variable type is boolean, you can check if it is equal to 1 (=true) or 0 (=false). For other
variable types, there are other (corresponding) conditional operators.
OPC data types are converted to standard data types for further use in Luxriot EVO: for example, both 16-bit
and 32-bit integers are converted to the Int (integer) type. Some of the data types are not converted (e.g.,
currency, date&time, miscellaneous arrays) so it is not possible to use them as variables in the events and
actions.
Pay attention to the access rights of the nodes: for events, it is enough to have the read permission; for
actions, the node must be writable, otherwise you will not be able to select it as the target action variable.
For detailed information on the creation of events and actions, please refer to the corresponding topics of this
document.
Add Condition
To add, remove and manage the conditions in the Luxriot EVO Console, go to the Events & Actions section and
choose Conditions from the menu on the left. Conditions can be also added as you go from the Event & Action
Configurator.
Click the + New condition button on the upper panel to bring up the condition configuration dialog box. Here you
have to:
enter an comprehensible title for the condition - usually, the best ones are those which express a state,
e.g., camera offline, motion present, door opened etc.
choose the target server - conditions, as non-global events, are local and operate within a single server
set condition default state, i.e., the state it is in before it is set or unset for the first time; this can be
either ON or OFF
Consider a system that has three cameras installed: Camera A overlooking area A, Camera B overlooking area B that
is just next to area A, and Camera C, which is a supplementary PTZ device and can be turned to view both areas and
even more, and overlooks area C by default. If a person walks into area A, he/she will be detected by Camera A's
video analytics; if he moves on, he will enter area B and the security guard will see him on Camera B.
Now, imagine that Camera B suddenly goes offline. The security guard is OK with that, until there is someone in
area B; he notices some motion in area A and takes control of Camera C, and makes it overlook area B, but the
person of interest is long gone by that time, and there is no footage of him being present in area B. So, the task is to
automate the process so that Camera 3 serves as a backup while Camera B is offline; the configuration in such a
case may look as follows:
Event 1: VCA, source: Camera A
Event 2: Video Lost, source: Camera B
Condition: Camera B Offline, default state: OFF
Action 1: make Camera C go to preset Area B
Action 2: Set Condition, target: condition Camera B Offline
Rules:
Event 2 triggers Action 2 (that switches the state of condition Camera B Offline to ON)
Event 1 triggers Action 1 upon the condition Camera B Offline
Thus, Action 1 (go to the PTZ preset) is only actually triggered then and then only if Camera B Offline condition
state is ON, which is not possible while Camera B is online.
Now, we need this to work both ways, i.e., we want to return Camera C to its home position and reset condition state
back to OFF when Camera B comes online again. New configuration elements will be added:
Event 3: Video Restored, source: Camera B
Action 3: Unset Condition, target: condition Camera B Offline
Action 4: make Camera C go to preset Area C
Rules:
Event 3 triggers Action 3 (that switches condition state to OFF)
Event 3 triggers Action 4
These new rules ensure that, once Camera B is streaming again, Camera C will go back to its original position, thus
terminating it as a backup device; and the condition is OFF, meaning that the triggering of VCA rules in area A will
not make Camera C move.
The whole setup in Event & Action Configurator is as follows:
Sample rules
When you have finished, click OK to save and exit the dialog box. The newly created delay timer will be assigned to
the pre-selected actions.
Extending an action allows you to postpone the action execution repeatedly if more events of the same type
arrive within the chosen time period. For example, if incoming events are of a Recording Error type, there
may come too much of them at once e.g. in case of a major storage issue, causing a lot of triggered actions of
the same type, while only a single action may be desirable.
Say, if required action is Write to application log, setting a delay timer to 5 minutes + extended action will
postpone the email sending for 5 minutes every time a new recording error appears; when, at a certain point,
more than 5 minutes have passed without new incoming events, a single log entry will be eventually
created. The separate action option, on the contrary, will force logging for every single triggered event.
To remove a delay timer from rule configuration, click the timer to highlight it within the rule, and then click the
Clear button in the bottom panel. Note that, if there are schedules and/or conditions attached to the same rule, they
will be removed as well.
Multiple schedules
Software Counters
Software counters are entities that contain a certain integer value, which can be altered based on some occurred
event. These can be used in Luxriot EVO, for example, to count events that do not originate from VCA and therefore
cannot be accounted for using VCA counters.
Counters can be created in the Events & Actions section of Luxriot EVO Console, under the Counters subsection.
Each one has a title and a server where it resides (as the Event & Action scenarios are defined per server; use global
events to transfer events from one server to another - for Luxriot EVO Global installations).
Reports can be then built based on the software counter values, along with VCA counters: automatic reports are
available for configuration in Luxriot EVO Console, and manual reports can be created in the Luxriot EVO Monitor
application. Both modes also permit report export in PDF format.
To add, remove and manage the software counters in the Luxriot EVO Console, go to the Events & Actions section of
Luxriot EVO Console and choose Conditions from the menu on the left. Click the + New counter button on the
upper panel to bring up the counter configuration dialog box. Here you have to:
enter an comprehensible title for the counter - e.g., what is going to be counted
choose the target server - counters, as non-global entities, are local and operate within a single server
Counter values can be changed based on any event in the Event & Action scenarios, when building rules. Counter
value changes can be a separate action or an additional one to serve for counting the number of times when the rule
was triggered.
There are three built-in actions that are available by default for any created counter:
Increment: increase counter value by one
Decrement: decrease counter value by one
Reset: set the counter's value to zero
The initial state of any newly created counter is zero.
Internal Luxriot EVO counters can be removed at will at any point: select all redundant counters and click the
Recycle bin button on the upper panel.
However, only software (user-created) counters can be deleted in this way. Counters originating from VCA cannot be
deleted in this way, as they exist in the VCA configuration (either camera-side or server-side video analytics). Those
entities do not even appear in the list in the Counters section. To view them, press the Manage data button on the
upper panel: an additional dialog box will pop up, displaying all counters, both user-defined and VCA imported.
If there are no new incoming data for the removed counter, it will disappear from Reports shortly - both in Luxriot
EVO Console and Luxriot EVO Monitor. If it still exists and Luxriot EVO continues receiving data from the target
counter, it will re-appear in this list automatically. So, in other words, the Manage data dialog box reflects the
current state of the counter's database.
Usage Example
Consider a use case where it is required to count how many times during the day the office door was unlocked; the
door is opened by an access control module, which is also wired to the digital input of a camera so that the system is
notified when the door is unlocked.
Required E&A items in this case are:
Event 1: Digital Input, source: corridor camera
Event 2: Scheduled event, type: scheduled, every day 12:00AM
Counters: HowManyTimesDoorWasOpened
Action 1: Increment, target: counter HowManyTimesDoorWasOpened
Action 2: Reset, target: counter HowManyTimesDoorWasOpened
Events 1&2 are not default and should be added, and the counter has to be created as well. Actions associated with
the counter will be added automatically so there is no need to create these.
Indicators
Indicators are objects with several states. These states (conditions) can be changed based on any events in the
Event&Action Configurator. Indicators can be placed on maps, thus helping you build an interactive dashboard.
You can create indicators in the Events & Actions section of Luxriot EVO Console, under Indicators, then place them
onto maps - either regular or geo maps. The indicator state and colour can be then changed based on E&A events:
once you create an indicator, it is automatically added to the Actions section of the E&A Configurator and actions for
changing its state are created.
Example of an indicator
To add, remove and manage the indicators in the Luxriot EVO Console, go to the Events & Actions section of Luxriot
EVO Console and choose Indicators from the menu on the left. Click the + New indicator button on the upper panel
to bring up the counter configuration dialog box.
The following settings are available here:
Title: user-defined name
Server: Luxriot EVO server, to which the indicator belongs (related actions will be only available in the
target server E&A Configurator)
States: 5 different indicator conditions with custom names and colours
When adjusting the state details, do not forget to hit the Apply button for the changes to take effect.
The indicator state can be changed based on any event in the Event & Action scenarios, when creating rules. The
indicator state can be changed as a separate action, or it can be combined with any other one, thus helping visualize
the state of other items.
There are five built-in actions for every indicator that allow to set the indicator to any of its states. If you only need
two or three, simply do not trigger other conditions. The actions will appear automatically after you create the
indicator.
Maps
When placed onto maps, indicators change their colour and display the comment according to their state. Both
regular and geographic maps have an indicator marker available on the panel above the map, alongside with
other markers. Thus, you can build interactive panels that will reflect the condition of the system.
Usage examples
Variables
Variables in Luxriot EVO are entities having a certain value that changes over time. Create variables if you wish
to set up reactions (via E&A) to certain variable values, e.g., certain temperature readings from thermal cameras.
To access the variables management in Luxriot EVO Console, choose the Events & Actions section and switch to
Variables in the menu on the left.
Variables differ by source. Currently, there are two groups of sources: devices (IP cameras or other) and data
sources.
Channel Variables
Some device integrations support receiving certain variable values from cameras. For example, some thermal
devices send the temperature measurements as floating point numbers. In order to "catch" the data on the server
side, simply create variables for these cases. Afterwards, you will be able to use these variables in events: for
example, trigger events if the value is greater or less than certain threshold.
To create a new item, click the + New channel variable button on the upper panel. In the dialog box, choose the
source channel and fill in the settings.
Title: user-defined variable name
Channel: source channel (device integration must be supporting variables, please contact
[email protected] for details)
Variable: choose one from the list of available items (if none are available, the device has none or the
integration does not support variables)
Variable type: variable data type
For most variables, the data type is fixed, so you only need to choose the variable source and give it a name.
Data source variables are based on the pre-defined data source mappings. First, create some regex mappings for
your data sources as described in the corresponding section of this document. Then, create a data source variable in
the Variables subsection by clicking the drop-down arrow un the upper panel and selecting the + New data source
variable option.
The following settings are to be defined:
Title: user-defined variable name
Data source: choose one of your existing (pre-configured) data sources
Variable: choose one of the pre-configured mappings
Variable type: choose the data type of the selected variable (for further comparison in events)
Data ID: enter your POS identifier in case the data source delivers data from multiple terminals or other
sources
The Data ID field is optional and is only required if your data source has combined streams from multiple sources. If
there is only one data stream, leave the Data ID field empty.
10 Layout Templates
Layout templates are arrangements of empty viewports. These can be later filled with channels and maps in your
Luxriot EVO Monitor application and later saved as layouts. Each template can be used any number of times for
creating both local or shared layouts.
You can create your own, custom layout templates and then use them in any Luxriot EVO Monitor applications
connected to the target server.
To access layout templates via Luxriot EVO Console, go to the Configuration section in the bottom left panel
and select the Layout templates component in the menu on the left. Use the Search field in the upper-right-hand
corner to filter existing items; press Refresh button to reload the item list.
Layout templates
Click the + New layout template button on the upper panel to bring up the configuration dialog box.
11 Shared Layouts
Layout is a pre-configured viewport configuration with channels assigned for live view and archive playback.
Layouts are created in the Luxriot EVO Monitor application by filling a layout template with video channels. There
are two main groups of layouts: local, which are created and stored locally on the same computer where the Luxriot
EVO Monitor is installed, and shared, server-side layouts, which are are kept on each server and are available for
all users that are connected to the same server from other client computers. If the license or server policy limits the
number of max client connections to 1, layouts can still be shared between non-concurrent client connections from
different machines.
Layouts themselves are created via Luxriot EVO Monitor application but layout sharing should be pre-enabled from
Luxriot EVO Console. In order to make server users able to share and access this resource, shared layout groups
should be pre-created on the server side. Groups are used for handling user permissions and also for logical
arrangement of the shared layouts.
If no layout groups exist in the server configuration, layout sharing will be disabled for the target server
from the Luxriot EVO Monitor side.
To create a new group in Luxriot EVO Console, open the Configuration section and choose Layouts from the menu
on the left. Click the + New layout group button in the upper panel to bring up the shared layout group
creation dialog box.
All users with the View permission will be able to see and use the shared layouts from the target layout group.
However, visibility of the contents of each layout will depend on each user's channel and map permissions.
Shared layouts can be used in Layout Sequences in Luxriot EVO Monitor independently or combined with regular
layouts as well.
12 Maps
Maps are resources that allow you to use an image of the building plan or some area and place interactive markers
on it. Cameras, doors, user buttons, and other items put on maps can then be clicked in the Luxriot EVO Monitor
application to provide the desired interaction and facilitate the operators' work. Links to other maps help create
multi-layered building plans for better navigation.
To access map management via Luxriot EVO Console, select the Configuration section from the bottom-left-hand
menu and then click Maps in the menu on the left.
Two types of maps are available at this point: regular maps based on user image, and geo maps.
Create Map
Click the + New map button on the upper panel to bring up the map configuration dialog box.
Map details
On the map Details tab, enter a user-friendly name for your new map, then select the organisation it represents, if
applicable, and upload a picture that will be used as plan basis. All major raster picture formats are supported:
JPG/JPEG, BMP, PNG, TIF/TIFF and GIF.
There are the following limitative requirements for the pictures loaded as maps:
picture resolution should be less than 8.25MP
file size should be less than 5MB
Files not meeting these limitations will not be uploaded.
Map marking
Manipulate your map picture by zooming IN and OUT with the mouse wheel, dragging the picture with the left
mouse button and using the Reset and Fit buttons below. Reset a shows non-zoomed 100% size picture (or a picture
fragment, if it is larger than the window), and Fit zooms your picture so that it fits into the preview window.
To place a camera marker, drag the camera icon from the upper-left-hand corner and drop it on the scene.
Camera markers will allow you to pop up channels by double-clicking the markers in Luxriot EVO Monitor. They
will also have a red mark on them in the Luxriot EVO Monitor application if the target channel is offline (if the
Video lost event has been triggered): the channel's Video loss parameter is used as a timeout, which is 15s by default.
The following actions are possible:
select the camera by clicking the camera icon on the plan (and not the blue sector representing the
viewing area)
move the camera around by dragging it (the sensitive area is within the pink circle)
change coverage sector by dragging two pink dots on the sides of the blue sector: drag to the sides to adjust
the vertical angle up to fisheye (full circle)
correct camera position: drag the central pink dot to the sides to rotate camera, drag to/from the centre to
change radius
remove the marking by selecting it and pressing the Delete button on your keyboard or the recycle bin
button on the upper panel
The properties window on the right enables you to:
choose target device for the currently selected marking
view information about marking angles and radius
turn ON/OFF displaying of coverage area
change the marker icon colour and size
adjust the marker title colour and size
Other Markings
Several other marker types turn your map into a fully featured control panel.
Add map markers and use them as shortcuts to other maps: target maps will pop up when the corresponding map
markers are clicked in Luxriot EVO Monitor. To place a map marker, drag the map icon from the upper-left-
hand corner and drop it onto the scene.
Click a map marking and use the properties window on the right to browse for a map that you wish to be a target for
the current shortcut. Remove markers by selecting them and then hitting the Delete button on the keyboard.
In the same way you can also add user buttons to your map and trigger assigned actions by double-clicking the
buttons in Luxriot EVO Monitor. Select your desired user button on the map and then use the properties section on
the right to bind a user button to the marking.
Map markers
Similarly to individual channels, it is possible to place layout markers for shared layouts to be
displayed when double-clicked on the map in Luxriot EVO Monitor. The target shared layout and the icon style can
be defined in the properties section on the right.
Door markers are intended to be bound to doors from the access control integration: door statuses are then
displayed on the map in the Luxriot EVO Monitor application. The target door and icon styles for different door
stated is to be defined in the properties section on the right.
Finally, indicators are multi-state entities that can change their state - and, therefore, their colours on the maps
- based on events. These may be temperature ranges, condition states, or any other system component states that
have related events.
Just as other resources, maps can be grouped and assigned user permissions.
Map membership
In the Membership tab, you choose groups for this map to become a member of: select groups by double-clicking
items in both columns or by using the Add/Remove buttons below.
Map permissions
Permissions tab enables you to choose the users and user groups that will have access to this resource. Select at least
one permission to select a user/user group; uncheck all manually or using Clear button below to deselect.
Administer permission means user will be able to see, open and edit map via Luxriot EVO Console, and View only
allows user to load the map in Luxriot EVO Monitor.
When you have finished, click OK to save and close the dialog box. The newly created map will appear in the item list
of the Maps section.
Use the buttons on the upper panels to perform item-specific actions: remove, edit and quickly assign map group;
the filters on the bottom panel will help you switch between recently created/updated items and display maps/map
groups only.
It is also possible to use any part of the world map instead of user-defined pictures to put the markings on it. To
create a new geo map, click the drop-down arrow near the + New map button and select New geo map to bring up
the geo map creation dialog box.
Geo map functionality requires that constant Internet connection is present in order the world map to be
loaded from the remote server. Internet connection is required from Luxriot EVO Monitor as well to load the
map and present it to the end user.
Geo map creation is similar to the creation of a regular map, with the difference that you do not need to specify the
image to be used: instead, the world map is loaded from the server provided by Luxriot. You just need to find the
right place on the map by zooming IN/OUT and moving the map:
use your mouse wheel to zoom IN and OUT
click and drag with your left mouse button to move the map around
Use the Lock option in the right-hand-side panel to prevent users from moving or zooming the map IN/OUT
in the Luxriot EVO Monitor application.
Map groups can be used for easier management in Luxriot EVO Console. Note that map groups are not displayed in
Luxriot EVO Monitor; to group maps and geo maps in Luxriot EVO Console, use Visual Groups.
Click the drop-down arrow near the + New map button and select New map group to bring up the map
configuration dialog box.
13 User Buttons
User buttons are visual controls used in Luxriot EVO Monitor and Luxriot EVO Mobile for manual event triggering.
Once you create a user button, it will become available in the Event & Action Configurator and you will be able to
assign actions to the User button clicked event.
After a user button has been created and associated with at least one action, you will be able to use it in the following
ways:
bind the user button to a channel or channels so that it appears as a live video overlay control in the
Luxriot EVO Monitor application
place the user button marker onto maps
trigger it from the Luxriot EVO Monitor application from the user button list, from any map or from the
channel overlay controls
highlight it on a map or all maps where the corresponding marker is present
trigger it from the Luxriot EVO Mobile application
To access user button management via Luxriot EVO Console, select the Configuration section from the bottom left
menu and then click User buttons in the menu on the left.
Click the + New user button on the upper panel to bring up the configuration dialog box. On the Details tab, enter a
name for the resource and choose organisation attachment.
Starting from the software version 1.5.0, user buttons can be bound to one or more channels for their
presentation in Luxriot EVO Monitor. This means that once such a channel is put into a viewport, the related
user button automatically appears with it. The same user button can be also manually put into other viewports
and also removed from the bound channels in the live view without any limitations. Multiple user buttons per
channel are allowed.
In order to set this up, open the target user button for editing, go to the Membership tab and add the desired
channel(s) from the right-hand column (the same one that contains user button groups).
The Permissions tab allows you to choose which users and user groups will be privileged to have access to this
resource. Select at least one permission to select the user/user group; deselect by unmarking manually or using the
Clear button below.
When you are finished, click OK to save and close the dialog box. The newly created user button will appear in the
item list. Use the buttons on the upper panels to perform item-specific actions: remove, edit and quickly assign user
button group; filters on the bottom panel will help you switch between recently created/updated items and load user
buttons/button groups only.
For easier management, user buttons can be grouped together. Click the drop-down arrow next to the + New user
button and select New user button group to bring up the configuration dialog box.
14 Visual Groups
Device, channel and map groups are used solely for management and are only accessible in Luxriot EVO Console.; in
order to set up resource arrangement for Luxriot EVO Monitor, visual groups are used. They allow custom
grouping for channels and maps displayed in the connected Luxriot EVO Monitor applications. You can create
single-level or multi-level (nested) visual groups by putting them inside one another. Nested visual groups will also
appear in the Resources section of the Luxriot EVO Monitor application.
Starting from software version 1.17.0, visual groups are also available in the Archive Backup Wizard.
To access visual group management in Luxriot EVO Console, go to the Configuration section in the bottom left
panel and select the Visual Groups component in the menu on the left.
Please note that the location of dewarp settings has changed starting from the product version 1.5.0. For
previous software versions, the corresponding settings can be found in the general Channel Properties dialog
box.
Dewarp settings
You have the following options here:
Regular lens: choose this option if you wish to disable the dewarp engine (selected by default)
Immervision Enables® lens: choose this option if your camera has a Panomorph lens installed (you
can check this in the camera specification)
Fisheye lens: choose this option if your camera has a regular 360-degree view lens
Fisheye lens (large resolution): dewarp engine optimised for image resolutions of 6MP+
If your fisheye image has a resolution of 6 megapixels or higher, it is better to use the last option in the drop-
down list - fisheye lens optimised for high resolutions. This mode will provide smoother DPTZ experience with
the dewarped image. If your graphics card supports OpenCL version 1.2 or higher, this dewarp driver will use
GPU (you can check this in your video driver properties, or request info from the video card manufacturer).
Otherwise, more CPU time will be required, compared to the basic fisheye mode. We recommend that you do not use
this driver for smaller resolutions, as it may use more CPU yet there will be no difference for the user.
For devices having a Panomoph lens, choose the lens model from the drop-down list - you can find this information
in your camera specification or request it from the device manufacturer. You do not need to define any parameters
manually in this case; rather, you only need to choose your camera mounting position, and the dewarp engine will
automatically produce a correct dewarping result.
Note that the dewarp engine will fail to operate if you choose a wrong Panomorph lens model. Check with your
camera documentation and manufacturer for the precise lens model information.
For a generic fisheye lens, you are requested to define the fisheye sphere size and camera position by using the
overlay controls and settings on the right side:
Hemisphere diameter: click and drag any of the small pink circles on the overlay sphere to change its size
and align it with the actual fisheye sphere in the picture
Horizontal and vertical centre: automatically positioned in the picture centre, to change it click and
drag the small pink circle inside the sphere
Mounting direction: select camera mounting position from the drop-down list (wall/ceiling/floor)
For your convenience, the defined parameters are also displayed in the numeric form on the right side of the dialog
box. Use the button below the preview to reset all dewarp settings to the default ones.
In case you change the stream resolution at some point, its aspect ratio may also be changed and this will
affect dewarp operation. Therefore, check the dewarp settings after changing the resolution and adjust the
parameters, if necessary.
Note that all dimensions are given not in pixels but in reference to the video stream size, therefore, relative
values are used instead of absolute ones.
When finished, click OK to save the changes and close this dialog box and return to the general channel
configuration. Dewarp results will immediately become available in the Luxriot EVO Monitor application; you can
find the details on usage in the corresponding section of the Luxriot EVO Monitor documentation.
16 Audio
Luxriot EVO is capable of receiving audio streams from cameras, recording and playing them back, as well as
sending audio back to the cameras from Luxriot EVO Monitor stations. It is also possible to bind an external audio
source to a video channel.
There are a few conditions stipulating audio feature availability:
the target device should be capable of sending/receiving audio
relevant additional equipment should be plugged into the device (microphone and/or speakers), if
necessary (if these are not built in by design)
one-way or two-way audio should be enabled and set up on the device side so that it is available via device
Web interface
G.711 should be selected as audio codec on the target device side
audio should be enabled in the channel settings via Luxriot EVO Console (see below)
feature should be supported by Luxriot EVO integration for the target device (see the list of supported
devices and features provided by Luxriot)
in order to send audio to the device, Luxriot EVO Monitor workstation must have a microphone connected
to it - either a built-in or an external one
if you plan to use an external audio source, relevant audio capturing equipment should be plugged into the
server, to which the target device is connected, and enabled via Windows audio settings
G.726 and AAC audio codecs, which are often implemented on the camera side, are not supported at this
point, so please always select the G.711 option. Setting other codecs on the device side may result in Luxriot
EVO being unable to decode the incoming video stream.
Enabling Audio
If you plan to use camera-side audio and have not checked audio configuration on the camera side yet, go to the
device Web interface and adjust the audio settings, then make sure that audio is operable in the browser preview
(you may need to install an ActiveX control in order to get it working; please check with your device's user guide for
tips and browser requirements).
To enable audio for your desired device in Luxriot EVO Console, open the Configuration section and choose
Channels from the menu on the left. Then, open your target channel for editing - either by double-clicking it or by
selecting it with a single click and clicking the Edit button on the upper panel. In the channel properties dialog box,
switch to the Audio tab by selecting it on the left.
Attached: use an external audio source connected to the same server as the device, from which the
target channel originates
choose an audio input device from the drop-down list, if the target server has multiple ones
connected to it
all microphones recognised by Windows will appear here
External: use another channel's audio as audio for the current channel (see below for more details)
choose a channel to serve as audio source
When you have chosen your preferred option, click OK to save and close the Channel settings dialog box. You should
now be able to listen to live audio, record it along with the video stream and talk back to your camera via Luxriot
EVO Monitor and Luxriot EVO Mobile applications.
Luxriot EVO allows channels to use audio coming from a different channel in case the target channel does not have
its own incoming audio, or in case you wish to combine audio and video data from different sources. Such
combinations are used for both live and recording. A common example of this method is to use audio from intercom
channels in combination with nearby video cameras.
In order to do this, double-click the target channel (the one without audio) in the channel list to open it for editing,
then choose the Audio tab on the left.
Audio must be configured for the channel used as an external audio source via channel configuration as
described earlier. Both cameras and audio-only devices (intercoms) can be used as external audio sources.
17 Live Podcasts
Luxriot EVO channels can be shared by streaming over RTMP and thus be used for live casting - either with popular
streaming services or with your own RTMP server. This manual covers examples of how to set up live streaming for
Youtube and Wowza live casts - working with other RTMP servers is similar.
Before sharing a channel, check its settings and make sure that:
the channel is enabled in the configuration and video is available,
stream codec is H.264 (other codecs will not work!),
if you want to use substream and/or audio, make sure you have enabled them in the channel
properties.
Luxriot EVO free edition only allows 1 (one) podcast per server.
To access shared channel management in Luxriot EVO Console, go to the Configuration section in the bottom
left panel and select the Live Podcasts component in the menu on the left.
Click the + New live podcast button in the upper panel to bring up the shared channel creation dialog box.
Youtube live casting can use RTMP streams from your Luxriot EVO server for further streaming.
In order to set up live streaming with Youtube, log in to your account on youtube.com and go to Creator Studio tools
-> Live streaming -> Stream now. If you have never created any live casts before, you may have to verify your
account - just follow the guidelines on the website.
You need to have a valid Youtube (Google) account in order to be able to use this type of streaming, and
comply with Youtube live streaming conditions. Luxriot is not responsible for the third-party service
operability and policies.
Scroll down to the Encoder Setup section: you will need the link and the secret stream key in order to build the
RTMP link.
In Luxriot EVO Console, open the Shared Channels section and add a new shared channel, fill in the settings as
follows:
Sharing type: Youtube
Channel: target channel from the list of existing channels
Use substream: up to you
Enable audio: up to you
RTMP URL: rtmp://<server_URL>/<stream_key>, where
rtmp:// indicates that RTMP protocol will be used for streaming
<server_URL> is Server URL link provided by Youtube, e.g., a.rtmp.youtube.com/live2/
<stream_key> is Stream Name/Key generated by Youtube in the form of xxxx-xxxx-xxxx-xxxx
Wowza Streaming
Alike Youtube, Wowza streaming engine can receive video feeds from Luxriot EVO server and stream them out to
any device. You need to install Wowza Streaming Engine first and then configure live streaming as described below.
Luxriot EVO does not include any installation files or licenses for Wowza Media Systems software. Wowza
engine is used as a third-party agent capable of receiving RTMP streams; all installation, setup and
management of this engine is to be handled by you or your Wowza administrator, and Luxriot is not
responsible for the third-party engine operability and policies.
First, go to your Wowza Streaming Engine Manager and create a new application of the Live type.
Once you have created a new application, go to the Source Security settings of that application in your Wowza
Streaming Engine Manager and set RTMP Sources security to Open (no authentication). This is required as
Luxriot EVO currently does not support authentication for RTMP streaming.
Then, go to Luxriot EVO Console, open the Shared Channels section and add a new shared channel, then fill in the
settings as follows:
If you have trouble receiving the stream on the RTMP server side, check the following:
make sure all used software is allowed through the firewall(s),
restart the RTMP server,
refresh connection list on the RTMP server side or refresh the webpage;
remove the shared channel in Luxriot EVO Console and try sharing the channel anew.
To edit any of the previously created channel shares, double-click it in the item list or select any with single mouse
click and then hit the Edit button on the upper panel. Use the Search field in the upper-right-hand corner to quickly
find the existing items, and the Disable button to disable and enable channel sharing. Use the recycle bin
button in the upper-right-hand corner to remove one or multiple shares: hold CTRL or Shift to select several items
at once, or CTRL+A to select all (actual original channels will not be affected).
When you remove the original channel (with or without its originating device), all shared channels based on it
are removed from the configuration automatically as well.
Filters in the bottom panel allow you to load recently added/modified items.
18 Data Sources
This Luxriot EVO server functionality allows you to receive information in textual form from third-party serial
data providers like Point of Sale (POS) systems, bank machines and a multitude of other devices capable of
delivering data strings over the following connection types:
UDP port (remote connection)
TCP port (remote connection)
COM port (direct hardware connection to the server)
The procedure of configuring the data reception from these sources is briefly as follows:
create a data source, then
create a data source profile, then
go back to the data source settings and use the data source profile as a basis for the data source, and then
assign the data source to the desired channel(s).
Gathered data is then stored and displayed embedded with the video stream from the channel(s) you choose to
associate with it.
TCP/UDP Connection
Choose this option if your data provider is configured to feed the textual data into a specific TCP or UDP port.
You simply need to specify the incoming port for the server to listen to in the settings here. Make sure the port is
opened on all intermediate firewalls and not used by any other software on the server machine.
Choose this connection type if your data provider is connected directly into the Luxriot EVO server's COM port.
CR - carriage return
LF - line feed
CR+LF - both together
Custom - user-defined symbol or group of symbols
If line delimiter in use is one of the standard non-printable ones (LF, CR or CR+LF) but you are not sure, whichever
is used, press the Detect button for the software to identify automatically, which delimiter is present in the pre-
loaded text. If you know that the provided serial data does not include any standard delimiters, choose the Custom
option in the drop-down list and define your own delimiting character.
Mappings
Mappings are pre-defined character combinations expected in the data flow, which can serve different purposes.
There are three built-in mappings (existing by default and non-removable):
Transaction start: specify text that designates the beginning of the data block (transaction)
Transaction end: the very last data line of the expected data block
Data ID: use a regular expression to break a single data source profile into multiple data streams based
on some field (e.g., POS ID) and assign each one to different video channel
For the transaction start and end, you can specify a regular expression (regex rule) to define the start/end
pattern instead of static text. You can also copy and paste the strings for transaction start and end directly from the
sample preview field.
Additionally, you can create any number of mappings of the user variable type: this mapping uses a regular
expression to extract a specific piece of data into a variable for further usage in the E&A event Variable Condition.
Variables can be used, for instance, to detect exceptions in the cash operation in case the data source is a Point-of-
Sale system. To create a new variable, click the + New button in the Mappings section, fill in the settings on the
left and click Apply changes. The following settings are available:
Type: variable (cannot be changed)
Name: user-defined variable title
Text: a regular expression that defines what character combination should be extracted into the variable
Case sensitive: enable this if uppercase/lowercase is important (disabled by default)
Use the Test button to check if your settings work: if everything is fine with the setup, lines should be detected
correctly, transaction start and end marked as such and variables extracted as specified.
Click OK to save and close the profile configuration dialog box. The next step you need to take is to go back to your
data source settings and specify the newly created data source profile that was missing in the initial
configuration. You can use a single data source profile for different data sources.
Make sure the video from the target channel is available before setting up the text overlay in order to ensure
correct text placement.
Additional settings:
Line count: set the desired number of text lines to be fitted into the overlay area (default value is 20);
this will affect the text font size
Timeout: the amount of time in seconds for every line of data to stay on the screen at maximum (older
text will disappear and text will be shifted upwards)
Text colour: choose a colour for the overlay text from the standard palettes (default is white)
Data ID: data source identifier, if present (leave empty if not used)
In the Data ID field, you can enter the source identifier in case the serial data is being split between two or more
channels; leave the field blank if this channel is the only destination for all the data received from the selected data
source.
If there are data from multiple devices combined in a single Data source feed so that the text comes from the
same IP and port via the same protocol, it is possible to use the Data ID field in the Data source profile
configuration to differentiate between the transactions based on their source identifier and split the text
between multiple channels for further overlay.
Example: if the feed contains serial data from multiple Point-of-Sale terminals and their identifiers look like
POSxxxx where xxxx contains the terminal number so that the identifiers are POS0001, POS0002 and so on,
the following regular expression can be used to extract these IDs: ^.+?(POS\d+).+
In this case, the Data ID field in every channel configuration is to contain the actual POS ID: POS0001,
POS00023, POS6592 etc.
When ready, click OK to save and close the data overlay dialog box, then click OK to save and close the channel
configuration window.
Now your textual data from the data provider will be displayed overlaying the video stream in Luxriot EVO Monitor
and both live view and in the instant/regular archive playback mode in case the corresponding option is enabled in
the recording profile for the target channel; also, it will be possible to search through the recorded data.
If you wish the serial data to be available in the video playback mode in Luxriot EVO Monitor application,
make sure to set the Data stream to be recorded in the corresponding recording profile.
The overlay text will only be visible in live view and regular/instant playback, and will not be displayed in other
views (e.g., smart search). In order to export video from the archive with the text overlay, use MKV file format + VP8
compression + hard or soft subtitles.
19 Reports
Luxriot EVO Console application provides an opportunity to send automatic reports. There are two types of them:
Reports based on the counter data, which has been recorded with the video stream(s). Depending on the
collected information context, these reports can be used, for example, to estimate the average number of
customers during specific hours, compare the number of passing cars to the number of trucks etc. Counter
information is collected from Luxriot EVO Open VCA video analytics, camera-side VCA (for certain
manufacturers) and software counters.
Reports based on the facial recognition (FR) module data. These include the counted detections (by tag)
and miscellaneous estimators (age, gender, temperature, sentiment, etc.).
The report configuration process is similar to the manual procedure of reporting in the Luxriot EVO Monitor
application, with the difference that here the settings are defined once and then are used by the Luxriot EVO servers
for automatic report generation.
There are three report types: bar, line and pie diagram. Regardless of the chosen type, all reports are based on the
counters and have configurable report interval and days and times of interest. Counter values are compared for the
given period and with the specified scale, and the results are then reflected in the chart of the selected type. Reports
can be configured to be created automatically on a daily, weekly or monthly basis and then emailed to the
specified email address.
Regardless of the report settings, the report will be emailed after the selected report interval has ended.
Example 1: the report interval is previous day with time filter set to 8AM to 6PM. The report will be emailed
next day 12:01AM.
Example 2: the report interval is previous week with only working days selected (weekends deselected). The
report will be emailed 12:01AM next Monday, i.e., when the week is over.
Prerequisites
Reporting in Luxriot EVO Console is primarily aimed at automatic report sending via email. In order to achieve this,
you need to configure a mail server for the emails to be sent through, according to the steps explained in
the corresponding section of this document. You can do this prior or after the report setup. If you need a one-time
report for a custom time interval, you are welcome to use the reporting function in the Luxriot EVO Monitor
application.
For a counters report to be created successfully, there must be some counter data present in the database. You can
use Open VCA, camera-side VCA (for certain manufacturers) or software counters. Open VCA setup in Luxriot EVO
is described in a separate document provided by demand.
For the FR report to be created, you must have at least one channel being analyzed by facial recognition module for
the specified period, and the target FR service must be connected.
Report Configuration
In order to start report setup, go to the Configuration section of Luxriot EVO Console and choose Reports from the
menu on the left. Press the + New report button on the top panel to bring up the report configuration dialog box.
There are two options: new counters report and new external service report. These two types differ slightly.
This type of report is based on camera-side VCA, Open VCA, or software counters. The configuration options are
similar to those in Luxriot EVO Monitor when you create a graph in the Reports section.
Sum Choose whether you want each counter to be represented separately or all counters are Disabled
counters to be added up (for bar and line type diagrams only)
Show labels Display value labels on the chart Disabled
File type Choose whether you want the report to be in PDF of CSV format PDF
Automatic Generate the report and send it automatically to the specified email Disabled
Mail server A pre-configured SMTP server to be used for email sending (the setting is revealed [none]
when automatic report sending is enabled)
To Email recipient the report to be emailed to; enter exactly one valid email address here [empty]
(the setting is revealed when automatic report sending is enabled)
Next, switch to the Counters tab: here, you can select the required counters from the list.
For the exact list of supported camera-side VCA counters, kindly contact our support engineers at
[email protected].
When ready, hit the OK button in the bottom to save the report configuration based on your selected criteria. To edit
and remove reports, use the corresponding buttons on the upper panel.
This type of report is based on the data received from external services (specifically, detections and attributes
from the facial recognition module instances). The configuration options are similar to those in Luxriot EVO
Monitor when you create a graph in the FR section. The logic is analogous to that of the counters reports, yet the
settings are a bit different.
Specify the reporting criteria in the Details tab (other settings like target week days are available in the Filters
tab). The following settings are available:
Group by Main report values (targets): can be tags, temperature, age, sentiment, or gender Tag
estimation
Aggregation Results can be aggregated by months, weeks, days, hours or minutes (for bar and line Day
by type diagrams only)
Sum values Choose whether you want each target group to be represented separately or all values are Disabled
to be added up (for bar and line type diagrams only)
Show labels Display value labels on the chart Disabled
File type Choose between PDF or CSV PDF
Automatic Generate the report and send it automatically to the specified email Disabled
Mail server A pre-configured SMTP server to be used for email sending (the setting is revealed when [none]
automatic report sending is enabled)
To Email recipient the report to be emailed to; enter exactly one valid email address here [empty]
(the setting is revealed when automatic report sending is enabled)
The choice between absolute/relative/min/max/avg value is not present here; all values are relative, i.e., the chart
reflects the value change since the previous aggregation interval.
Next, switch to the Channels tab: here, you can select the target channels. The report will include the recognition
data from the specified channels.
On the Filters tab, you can limit the report sample range by (de)selecting various options. The filters include days,
time of the day, and attributes from the external service detections:
Tags from FR
Temperature range from the readings that were received by FR (works for certain camera integrations;
please refer to our for the exact vendor list)
Age, gender, and sentiment estimators
Week days: select days of the week that you want to be included in the report (e.g., ignore weekends)
(all days are selected by default)
Day time interval: choose the target audit interval to be analysed for each of the days in the selected
report interval
When ready, hit the OK button in the bottom to save the report configuration based on your selected criteria. To edit
and remove reports, use the corresponding buttons on the upper panel.
Report Preview
After you have created a report, you can check how it will look like by using the Preview and Test buttons on the
upper panel. The preview button will generate a report and display it on your screen; the test option will create a
report and email it to the specified address in PDF format immediately. In either case, the report preview will be
based on its configured time interval, so, if you get an empty report, make sure that counter data are present for the
previous day, week or month, whichever specified.
When you have created a new report and wish to test it, please wait about 10-30 seconds before pressing the
Test button: this time is required to retrieve the counter information from the database.
Report preview
On each diagram, the horizontal axis (X) represents time in the specified scale, and the vertical axis (Y) reflects
counter values. The counter values for each time interval are calculated based on the selected setting and can reflect
absolute, relative, average, minimum or maximum counter value for the given interval. In the pie diagram type,
each sector can represent either a time interval or a counter, depending on the aggregation setting parameter.
Each chart also contains a legend that provides information about colours used in the diagram:
if you have selected to analyse every counter separately, each counter will be represented with its own
colour and the legend will reflect counter titles
if you have chosen to sum the counter values:
bar diagram will have just one column for each interval, every column consisting of specified
counters and its total height reflecting the total
line diagram will contain graphs for each individual counter and the total
pie chart will reflect the counter sum for each time interval if aggregation by time intervals is chosen, so
the legend will contain timestamps; if aggregation by counters is selected, the pie will reflect the
proportion of the counter values for the whole selected audit interval
Apart from the diagram itself, each report in PDF format will also contain a table with the reference counter values.
Report execution status can be tracked from the Monitoring section of Luxriot EVO Console, by choosing Reports in
the menu on the left.
Report status
If a report has been sent at least once (by schedule, not as a test), the last execution time is shown here. For the
reports that are currently set to be emailed automatically, the next (scheduled) execution time is also displayed.
SMTP servers provided by popular free services and/or ISPs usually have limitations on the
number/frequency of emails going through them daily. Make sure you check with SMTP service provider to
learn about this.
To access mail server setup via Luxriot EVO Console, open the Configuration section and select Mail servers from
the menu on the left. Click the + New mail server button on the upper panel or double-click an existing mail server
from the item list to open the configuration dialog box.
Prior to Luxriot EVO version 1.7.0, mail server configuration was accessible via Events & Actions section of
Luxriot EVO Console.
Note that there are not any default (pre-configured) mail servers.
Setup here is similar to configuring an email client. The table below contains detailed information on the available
settings.
*Email aggregation can be used to accumulate alert notifications and send them in bunches rather than one at
a time. This decreases SMTP server load and does not 'spam' your notification inbox, making it easier to
search and analyze alerts, and is thus especially useful if the number or frequency of events is high.
Maximum [time/number of occurrences] in this context means that it will not be exceeded under any
circumstances. The actual time or number of occurrences may be either max or less - depending on
which aggregation parameter is triggered first.
Example: aggregation time is set to 60 seconds and aggregation count - to 15. If the notifications arrive
frequently, and 15 items are collected in under one minute, the email will be sent immediately. If there is just 1
or 2 notifications but 60 seconds have passed, an email will be sent, too.
Click OK to save mail server settings; newly created configuration will appear in the item list. Your mail server is
now ready to be used for sending notifications and reports.
Some mail servers require additional settings to be changed on the server side to allow third-party applications
to send emails through their SMTP service. For example, Google security requires that you log into your
account via a browser using the server that will be utilising the SMTP service in order to enable account access
from that computer.
If you can successfully use SMTP settings to send emails from the same computer, Luxriot EVO will also have
no trouble sending your notifications.
21 External Services
External modules are modules that have been integrated with Luxriot EVO, including these, which have been
designed to work with Luxriot EVO - license plate and face recognition engines. They operate either independently
or based on streams received from Luxriot EVO server, and Luxriot EVO server can receive event metadata from
these modules and then use these events for Event & Action configuration, as well as provide the opportunity to view
these events in both live and investigation mode in the Luxriot EVO Monitor application.
All the external modules can be connected using the same logic, the main important steps being as follows:
1. Prepare channels to be used for the target external module
2. Install the target external module
3. Connect to the Luxriot EVO server from the external module and enable HTTP notifications in it, if such an
option is explicitly available - this will make the external service automatically appear in Luxriot EVO Console
4. Create a group for external services in Luxriot EVO Console and add your external service to the group
5. External service will now be available for E&A configuration and its events will be visible in Luxriot EVO
Monitor
Important notice for Luxriot EVO Global systems: prior to Luxriot EVO version 1.15.0, external services only
operate via central management server.
Starting with 1.15.0, you can link external services directly to recording servers (Luxriot EVO Recording
Server instances). Note, however, that this functionality will not be covered for failover servers in case the
target Luxriot EVO Recording Server goes offline. When your external service is linked to Luxriot EVO Global,
streaming will automatically switch from/to failover.
This works for all kinds of external services, except for Camio, which is integrated in a slightly different way.
This administrator's manual covers an example on how to connect to the LPR (License Plate Recognition) module.
Other external services are added in a similar way, the only difference being the external module interface. Also, you
will find more details in LPR/FR own user guides.
Start LPR installation by double-clicking the installation package, and go through the wizard's steps. Activate LPR
using your purchased LPR license and run the software with empty configuration.
Please use LPR version 2.x with Luxriot EVO. If you already have an older LPR installation that works with
Luxriot VMS, you will need to re-install it to make it work with Luxriot EVO or use a separate LPR installation.
In the LPR module, add a new server connection and enter your Luxriot EVO server connection details. Make sure
that the target HTTP port is reachable and that the user account has the Login via HTTP permission granted.
Then, add your desired channels for LPR analysis and set up license plate recognition as usual. For details on the
setup, please refer to the LPR user manual.
In Luxriot EVO Console, go to the Configuration section and choose External Services from the left-hand-side
menu. On the upper panel, press the + New external service group button; in the dialog box, enter a group name
and click OK to save. The newly created group will appear in the item list.
From now on, your configured external service will become available in the Event & Action Configurator, and its
event streams will also become available for investigation in the Luxriot EVO Monitor application. Please refer to the
Luxriot EVO Monitor and LPR user guides for details on the investigation mode.
The current integration includes the following access control software: Keri, Feenics, Gallagher, Roger
RACS 5, and Visual Access System by GSF Corporation.
Luxriot EVO obtains the list of doors, their statuses (opened/closed, locked/unlocked), cardholder list and
relevant events, and enables you to lock and unlock the doors based on internal Luxriot EVO server events (e.g., user
button pressed) and also from the Luxriot EVO Monitor application. Information about doors, their events and
cardholders is searchable from Luxriot EVO Monitor application as well.
Supported functionality overview:
Receive events, door list and their status, list of cardholders (users)
Change door status by sending corresponding commands back
Live door status with linked video channels
Interactive markers on the maps and geographical maps
Notifications and other actions based on door events
Search event history based on doors, cardholders, and time
Get mobile app notifications
Lock and unlock doors from the mobile application
Integrations with different access control software are similar. However, there may be nuances in configuration. If
you encounter any difficulties with the setup, feel free to contact our support engineers at [email protected].
Prerequisites
Keri uses port 11000 as default and ports 11000 through 110xx for connections so these should be opened and
forwarded on the intermediate routers and firewalls.
Luxriot EVO connection to the Doors.NET system uses a certain license type – OnSSI. Make sure that your Keri
license includes this type of client license (at least one) and that it is not used by other client connections.
In earlier Luxriot EVO versions, a different Doors .NET license connection - RollCallClient - was used. It still
works but Kery Systems strongly recommend using the OnSSI license instead.
For Keep by Feenics, there are no special requirements. You just set it up as usual, and Luxriot EVO servers already
have a connection to api.feenicshosting.com via HTTP hard-coded. Make sure to allow this connection on your local
firewalls.
For Roger RACS 5, there are also no special configuration requirements, set up your VISO as usual. Just make sure
you have applied a valid license to the access control software. Without it, the integration services on the Roger side
will be inactive. You can check the license status by running the RACS Services Manager and then selecting License
service.
In Luxriot EVO Console, open the Configuration section and choose Access Control in the menu on the left. Here,
you need to create a connection to the Keri server: click the New access control configuration button on the upper
panel and fill in the settings, then click OK to save:
User-defined title
Type: select your access control software name
Host: access control server IP address (required for some types)
Add Doors
Next, click the arrow next to the New access control configuration button and select New door in the drop-down
list. Choose the access control configuration created on the previous step.
Monitoring
For all the doors that have been added it is possible to view their current states in the Luxriot EVO Console
application: to do so, switch to the Monitoring section and select Access Control in the list on the left.
Maps
Apart from the dedicated Access Control sections in Luxriot EVO Console, it is also possible to place door markers
onto maps – either regular ones or geo maps. Markers on the map will reflect door open state and lock state.
To do this, select Maps in the Configuration section of Luxriot EVO Console and create a map or open an existing
one. On the Marking tab, place as many markers as you need – the ones looking as doors – from the top panel. Click
any marker to edit its settings on the right side of the dialog box: assign a door to it and adjust colours and icons for
different door statuses.
For more details, please see the Maps section of this document.
Door Event
This event category is triggered when the specified code is received from the access control server. Choose the target
door as the event source here (the door must be added to the Luxriot EVO server configuration beforehand), then
select the code you wish to set up the reaction for.
Door event
The code list is retrieved from the access control software and contains possible event types that can be received
and understood by Luxriot EVO server. Choose the one you want to set up a reaction for.
Use this event type if the notifications from the access control are not door-specific.
Actions
Similarly, you can send notifications to the access control servers based on Luxriot EVO events. To do this: in
Luxriot EVO Console, choose Actions in the Events & Actions section and create a new one by pressing the New
action button on the upper panel. Alternatively, press the + New action button on the E&A Configurator. You will
need the Door action type.
Door action
As a target, specify the access control configuration added earlier. The specific door for this action will be chosen at
the rule creation step, allowing you to use this action for many different doors within the same access control
configuration.
Available action codes here are: lock, unlock, temporarily unlock, and lock down (standard access control door
states). Once the action is triggered, the corresponding command will be sent to the third party access control
module.
E&A Rules
Once you have created necessary events and actions, combine them into rules in the E&A Configurator. For door
related actions, remember that you need to specify the target door by using the Target door button in the bottom of
the middle column.
21.2 Gallagher
Luxriot EVO has several integrations with third-party access control software suites. This part of the documentation
provides details on how to make Luxriot EVO work together with your Gallagher Command Centre.
The integration ensures two-way information exchange between Luxriot EVO servers and access control software
servers:
Luxriot EVO server receives events, door list and status, and cardholder list
in Luxriot EVO Console, you can see door status, add them to maps and geo maps, as well as create door-
related events and actions
E&A events help monitor the changes in the door status
E&A actions and maps allow you to change the door status (lock/unlock)
in Luxriot EVO Monitor, you can search door and cardholder events for the desired period
The details below will help you set up Luxriot EVO to work with the Gallagher software. It is presumed that you
already have the Gallagher Command Centre up and running, and are familiar with its initial configuration process.
For details on the Gallagher software setup, please see its own supporting documentation.
Gallagher Configuration
For the two servers to be able to communicate, a few things should be first set up on the Gallagher side. The
integration operates over secure HTTP, therefore, from Gallagher's point of view, Luxriot EVO will act as a REST
API Client. The steps here describe the necessary settings in the Gallagher software.
Run Gallagher Configuration Client and log in using your username and password.
In the panel containing the main menu, go to File > Server Properties, and select Web Services on the left. Here,
turn ON the Enable REST API setting, and specify a HTTPS port for server-to-server communication.
Copy API key from the REST API Client settings to Luxriot EVO Console
The certificate thumbprint is hard-coded into Luxriot EVO and Luxriot is responsible for it renewal. You do not have
to obtain your own certificate; simply copy the alphanumeric string from the Gallagher configuration dialog box in
Luxriot EVO Console.
*For the REST API integration to work properly, the cardholder acting as operator here must have the
Advanced user privilege.
In your Luxriot EVO Console, open the Configuration section and choose the Access control component on the left.
Click the New access control configuration button on the upper panel and fill in the settings in the dialog box.
Title: user-defined service name, which will appear in Luxriot EVO Console
Access control type: Gallagher
Host: IP or hostname of the Gallagher server
Port: server base port from the REST API settings (as specified above)
API key: copy from Gallagher configuration, as shown above
Client certificate thumbprint: copy and paste it into Gallagher REST API Client settings, as described
above
Merge: enable this option if you have multiple access control systems and you want to have them all in a
single tab in the Luxriot EVO Monitor application
Add Doors
Once the Gallagher connection is created, you can start adding doors. To do so, stay in the same section of Luxriot
EVO Console (Configuration > Access control), click the drop-down list icon (down arrow) next to the New access
control configuration and select the New door option. A dialog box will pop up, allowing you to enter the door
configuration.
Note that an active connection to the target Gallagher instance must be present for Luxriot EVO to be able to
retrieve the current door list.
The following settings should be specified for each door:
Title: user-defined door name, which will appear in Luxriot EVO
Access control: select your Gallagher connection from the list
System ID: door identifier in the access control software; select one from the list
Channel: select one of your video channels to associate it with the target door (they will appear linked in
Luxriot EVO Monitor)
If the door list appears empty, check that:
the doors are present in the Gallagher configuration
you have added a REST API Client wit a privileged operator, and that it has the certificate thumbprint
copied from Luxriot EVO Console, as described above
you have copied the correct API key from that REST API Client into the Gallagher configuration in Luxriot
EVO Console
You can place door markers onto maps and geo maps. These markers will reflect the current door status in the
Luxriot EVO Monitor application, and provide interactive actions upon single or double click.
Luxriot EVO Event & Action Manager (E&A) provides support for both door events (status changes) and actions
(change door state).
Changes in the door status are sent from Gallagher to Luxriot EVO. You can set up different reactions for different
codes via Luxriot EVO E&A. Later, these events can be used for building rules, e.g., for logging the events in Luxriot
EVO, bookmarking them, automatically interacting with other system components etc.
The Lock and Unlock actions will only operate if the target door is the only one in the target access zone in
Gallagher configuration. If there are multiple doors in the same access zone, these actions will still be available
in Luxriot EVO Console but will not actually work. For multi-door areas, use the TempUnlock action (open
the door and close it automatically after a short timeout).
Finally, go to the Events & Actions section > choose Rules on the left > click the Open configurator button on the
upper panel to bring up the E&A Configurator dialog box.
Here, you can use all your events and actions, including those related to Gallagher, to build automated scenarios.
Every rule can also have modifiers: a delay timer, a condition, and a schedule.
Apart from this permission management via Luxriot EVO Console, you can hide the Access control tab from all users
via Luxriot EVO Monitor Restrictions (main menu Tools > Administration Tool).
Events
This section is almost identical to the Event Trail section in Gallagher Command Centre. Here, you will find door
events - status changes, lock/unlock operations etc. - as well as other Gallagher events, such as: database
maintenance notifications, configuration changes (e.g., new cardholder added), etc.
Enter the search time range and criteria in the bottom and click Search. The results will appear as a list. Use the
Reset button to discard any entered criteria and use the default search settings (any event type, past 24h).
Doors
This tab contains the list of doors retrieved from Gallagher. Each door will have its current state reflected in the
Status tab.
Click any door to see more details on the right:
see the live video from the associated video channel
click the Lock, Unlock, or Temporarily Unlock buttons to perform the corresponding action (similarly to
E&A actions, Lock/Unlock will only work for single door zones)
click the View door events button to switch to the Events tab: target door events for the past 24h will be
shown automatically
Cardholders
You will see all existing cardholders fetched from Gallagher here. As there are no cardholder associated actions,
the extra details here will be the name and picture.
Click the View cardholder events button to switch to the Events tab and see the related events for the past 24h. Use
the Refresh button in the bottom to reload the cardholder list and details - this comes useful if there have been
changes on the Gallagher side, which have not been synchronised with Luxriot EVO yet.
List of cardholders
Maps
If you have created maps with door markers on them, you will be able to use these maps in the Live and
Playback tabs, as usual. Each door marker, when clicked (or double-clicked, depending on your application setting),
will provide an opportunity to lock, unlock, or temporarily unlock the target door. This functionality is identical to
door actions in E&A and door buttons in the Access control tab.
21.3 Camio
Camio video analytics is a cloud service that can do intelligent video analytics based on the provided video stream.
Its integration with Luxriot EVO is built using REST API. To link Luxriot EVO server to your existing Camio
account, add it as an external service by following the steps below.
Luxriot EVO already has the Camio cloud service address. All you need to do is make sure you have added your
Camio box to the service Web interface, then add the service connection in Luxriot EVO Console and configure a
channel (or channels) to be processed. Luxriot EVO will then receive analytical events and will also allow searching
the result database. The architecture is such that your Luxriot EVO server connects to the Camio cloud service.
Then, Camio boxes accept H.264 RTSP streams from Luxriot EVO for video analysis. Whenever there is an event,
the box sends it to the Camio cloud service, and then it is forwarded to the Luxriot EVO server.
The steps described below will help you connect to Camio from your Luxriot EVO server and take advantage of its
video analytics. Note that this document does not provide detailed details on Camio services. For elaborate Camio
configuration and usage guidelines, please refer to its own supporting documentation and/or technical support.
Prepare Camio
Log into your Camio account via Web browser and add a box. You can do this by clicking your account name in the
upper right corner and then by clicking the Register Box button. This will allow you to add Luxriot EVO channels in
Luxriot EVO Console later.
Your Camio box must be in the same network as your Luxriot EVO S or Luxriot EVO Global server.
Luxriot EVO server address and HTTP port in the Camio Web interface settings
From the Luxriot EVO server side, make sure you have the external server address (Internet address) specified,
internet HTTP port enabled (different from zero) and opened on the firewall/router. A simple test to check if the
configuration is valid is to try entering your Luxriot EVO server URL into the browser address bar: you should be
able to see the streaming server interface. Use this address and port in the Camio Web interface to pair it with
Luxriot EVO server.
Example: if your Luxriot EVO address is 82.193.82.11 and internet HTTP port is set to 7865, enter
http://82.193.82.11:7865 into your browser (better test it from another computer, and another network) and verify
that you can see the Luxriot EVO Web client. If successful, use the same address for Camio Web.
In other words: Camio can connect to Luxriot EVO servers only using the HTTP API, which is available at the
same URL as the Luxriot EVO Web interface. So, in order for the system to function correctly, specify the
Luxriot EVO Web interface URL and the HTTP port in the Camio settings under API Client, on the same
screen where the token is generated.
Camio only supports H.264 RTSP streams. HEVC (H.265) or JPEG streams will have an error in the service
Web interface and will not be analysed.
Make sure the channel name does not have any special characters, especially backslashes, otherwise Camio
will be unable to parse the channel name.
If the box list appears empty, double-check your Camio connection parameters: the token may be incorrect. If the
connection does not work and you know the token is correct, try generating a new token via service Web interface
and then pasting the new token into Camio connection in Luxriot EVO Console.
Some channels may not have the live preview video alongside with the ON/Online status, no errors, and video
presence in Luxriot EVO Console and Luxriot EVO Monitor. This does not depend on Luxriot EVO. Usually,
this does not affect video analysis and you are able to see the search results. For troubleshooting this and other
Web-related issues, kindly contact Camio support.
Camio will now start analysing your video stream and send the results back to Luxriot EVO. You can also search the
event archive on the service Web.
Web Search
On Camio Web, click the Search button below the channel live preview to enter the search mode. The Web search for
your Luxriot EVO channels works in the same way as for any other channels in Camio.
You can change the grid size by selecting it from the drop-down list below the grid. The available options range from
1x1 and up to 6x6. The single viewport option will provide you will fully functional instant playback, and the rest of
the options (2x2..6x6) are similar to the result preview in Smart Search mode., allowing you to add bookmarks,
export the result video clips, and switch to the regular playback mode.
Use the arrows |< and >| to load the previous/next portion of the results. You can also do the same by browsing the
result list: upon clicking a result from the faraway time range, the target results and its neighbours will be placed
onto the preview area.
You can also save the list of your search results by clicking the Export CSV button in the bottom right corner.
Events from Camio service arrive with a 30-60s delay. This does not depend on the Luxriot EVO software.
Please keep this in mind when configuring rules with Camio events.
22 Health Monitoring
Luxriot EVO provides health monitoring data for servers, devices and channels, as well as live status of
connected user sessions and other resource information. In the Archive statistics section, it is possible to view the
stream details and also un-protect footage that has been locked via Luxriot EVO Monitor application.
To access the live monitoring data in Luxriot EVO Console, choose the Monitoring section in the bottom-left-hand
panel and switch between components using the menu on the left. Use the Search field in the upper-right-hand
menu to filter the records; press the Refresh button or F5 on your keyboard to reload the item list. The statistics
are not refreshed automatically, so do not forget to reload the list tin order to obtain the most recent information.
The contents of any subsection in Monitoring can be exported in CSV (comma-separated value) format using the
button on the upper panel.
Each section here contains a number of columns with miscellaneous information. Not all of them are available by
default; to modify the displayed details and their layout, use the grid icon in the upper right corner: an
additional configuration window will pop up. You can hide the fields you do not need, and also freeze the leftmost
columns for convenient horizontal scrolling. Hidden fields cannot be used for search or sorting.
The Details button (available for some of the sections) on the top panel allows you to view detailed information
about important events related to the target resource. For example, you can view the list of recent connection
and VCA license errors for every channel. The details are discarded after each server reboot.
All information written in plain black is informative. When things go wrong, there are two levels of errors here:
critical and warning. Critical errors are marked red; those usually indicate important stuff like missing main
stream video, no connection to services etc. Warnings are yellow and are used to highlight minor issues like missing
secondary stream, too long GOP period, or not enough space on the disk. You can ignore warnings by right-clicking
the selected items and selecting Ignore > (preference). This helps if the warning is irrelevant, e.g., if you do not use
substreams. Critical errors cannot be ignored as they need to be fixed for correct server operation.
Further in this chapter you will find a brief description of each information field.
Servers
The server status includes information about connection and synchronisation: both have numeric status code and
corresponding textual status.
Devices
The device summary provides configuration update status and the time of the last communication between the
server and device.
The following fields are available:
Title: device name
Status: current device condition
Normal: the device is functioning properly
Unknown: the device's channel is disabled, or the device core has not been loaded yet (may
appear shortly after server startup)
Server: current server that has this device assigned (may be regular recording server or failover)
Devices/model: device type or model
Status update time: last sync/connection attempt timestamp
Information: additional information, if any, will be displayed here (usually, errors; normally, the field is
empty)
Host: device IP address or hostname
Port: device HTTP/HTTPS port (from device settings, used to exchange service information, not data)
Channels
The channel monitoring section contains details about channel streams. Wherever relevant, there is information
about both main and secondary video streams in separate columns.
Channels can have critical errors (red) and/or warnings (yellow). Warnings usually appear due to minor issues -
e.g., missing substream, too big GOP length etc. You can ignore them by right-clicking item(s) and selecting Ignore
warnings > (preference). If you want the warnings to be shown again, right-click the items and select Reset
warnings. To reset all warnings, go to the Luxriot EVO Console application settings (main menu > Settings) and
select the corresponding option.
Note that Not activated recording status may both mean either that recording is not configured (disabled) or that
recording has not been activated according to a schedule. The Activated status will appear if at least one of the
channel streams is set to be recorded based on any configuration apart from No recording.
Streams
This section displays the properties of every recorded stream separately. For example, if a channel has both
main an secondary streams with audio activated, there will be three entries. Replication streams are also displayed
separately.
Channel: stream source, one of the existing enabled channels
Stream type: video, audio, motion, external data (from data sources), or VCA metadata
Status: current stream condition
Server: originating server
Device: originating device
Status time: last status update timestamp
Recording storage: target storage title
Recording directory: one of the target storages on the corresponding server
Last recording time: timestamp of the last recorded frame (useful for troubleshooting the recording)
Prerecording time: actual number of second held in the pre-recording buffer (may be lower then the
setting if not enough memory, or 0 when not required)
Information: additional information, if any, will be displayed here (usually, errors; normally, the field is
empty)
recording buffers; channels with largest frame cache size will have their buffers reduces first pf all
upon server startup, the buffer size is increased gradually for smoother start
Removed and disabled channels will not be shown under this section: only active recorder tasks are displayed
here.
Archive Statistics
Here, you can see recording statistics for every channel (all streams and all storages included):
Channel: configured channel title
Begin date: the time of the very first recording for the target channel
End date: the time of the very last channel's recording
Duration: total archive duration for each channel
Data size: total archive size per channel, based on the time boundaries mentioned above
Data size per day: an estimate of how much space one day's recordings will take (average per day,
calculated based on existing archive size)
Protected interval: total duration of the archive, which has been marked as protected, and will not be
removed (erased)
Protected data size: total size of the protected archive
Double-click any entry or use the View button on the top panel to display details for each channel: view the
recording statistics per storage and with detailed information on every stream including audio, motion, VCA and
external data feeds.
To review and unlock the footage that has been protected from erasing via Luxriot EVO Monitor application, select
the target channel(s) and click the Protected intervals button on the top panel.
From this dialog box, you can unlock the previously protected parts of the archive. If these recordings fall under
quotas (storage or duration, server wide or individual), they will be erased immediately.
Storages
Statistics, properties and status for each storage unit are displayed here.
Some of the storages may have warnings (marked yellow) in case there is not enough space on the disk. In that
case, check your assigned quotas in the storage management, and make sure you do not have too many protected
intervals in the Archive statistics (see above).
Title: storage label, either built-in or user-defined
Status: operation status of the target storage
Normal: the storage can be used for recording and there are no issues detected
Critical: the storage cannot be used for recording due to one or more serious errors, check the
Information column for description
Status update time: last time the storage status was obtained (use the F5 button on your keyboard to
refresh the list)
Path: storage path on its server of origin
Encrypted: yes/no
Free space: how much free space in gigabytes is left on the disk
Free space %: same but shown as percentage in reference to the total storage size
Total space: entire storage size
Information: additional details, if any (e.g., storage related errors)
Disk queue length: number of read/write requests (local storage only)*
All storage information is retrieved through the API of the underlying operating system. If you think some of
the information may be incorrect, check the same statistics via Windows interface - Task manager, Resource
monitor, or other utilities.
*The Disk queue length column is useful for assessing the storage condition. It reflects either the current or the
average queue length (whichever is higher) per disk. Generally, 5+ requests per disk indicate a bottleneck in the disk
subsystem. 2+ requests per disk for a long period of time may also indicate bottlenecks. For RAID storages, the
queue length is summarized, so, for example, for a system with 8 disks the queue length should not exceed 16. A
value of 0 means the storage is not overloaded. An absent value (empty) means it cannot be retrieved: the field will
be empty for network storages and for unreachable disks (e.g., server offline).
If one or more storages have issues (e.g., incorrect password), the corresponding section will have a red circle with
the number of detected issues next to the section name. Inaccessible storage units will have no total and free space
information.
User Sessions
This monitoring area displays currently active incoming Luxriot EVO Monitor connections via both TCP and HTTP
ports with the following details:
user account
remote address
remote (outgoing) port
session start time
type (Luxriot EVO Console/Luxriot EVO Monitor)
Disconnected sessions will automatically disappear from the list.
External Services
If License Plate Recognition, Face Recognition and/or other external services are connected, their session properties
will be displayed here: service name, remote address and used user account.
Reports
This section contains health monitoring data for automatic VCA and software counter reports.
Report status
If a report has been sent at least once (by schedule, not as a test), the last execution time is shown here. For the
reports that are currently set to be emailed automatically, the next (scheduled) execution time is also displayed.
Access control
If any third-party services are connected, their connection properties and status will be displayed here.
OPC
If any third-party OPC servers are connected, their connection properties and status will be displayed here.
Indicators
All indicators configured in your system will be displayed here, so that you can see their status - all in one place.
22.1 Audit
To access the global audit log in Luxriot EVO Console, choose Audit section in the bottom-left-hand panel.
The audit log contains detailed information about the most important user activities and server events. Events are
organised in a way similar to the Windows Event log, and can be filtered and sorted by any field just by clicking on
the relevant field. By default, entries are sorted by time, with latest on top. Use Search field in the upper-right-hand
menu to filter the records; press Refresh button to reload the item list.
Please note that your actual audited events may vary depending on the software license edition.
The log has two sections: Servers and Users; these can be accessed by clicking the corresponding items in the menu
on the left, when in the Audit section.
Servers
Configuration reset failed: an attempt to reset the recording server configuration was made
but failed for some reason
Configuration reset requested: recording server configuration reset was requested via
Luxriot EVO Console (this message will be normally followed by another entry reflecting the rest
status)
Configuration request succeeded: recording server configuration was successfully reset
Configuration saved: server configuration was saved to the database
Connected to mirroring server: central server successfully connected to its configured
mirror
Connected to recording server: central server successfully connected to a recording server
Disconnected from mirroring server: central server disconnected from its configured
mirror (e.g., because the mirror is no longer available)
Disconnected from recording server: central server disconnected from a recording server
Event action failed: an E&A action execution attempt was made but failed, double-click the
event entry for details
Event action succeeded: an E&A action was successfully executed, double-click the event
entry for details
External users added: an attempt to add new external users via AD/LDAP was made, see
additional information for status details
External users removed: external users were removed from the server configuration
External users updated: AD/LDAP user list was synchronised
Failover node activated: failover server changed its state from Idle and received
configuration to act instead of a recording server
Failover status changed: server was included or excluded from a failover cluster, or its status
changed from/to Unknown (see server health monitoring for details)
Number of external users exceeded maximum allowed: the number of imported
AD/LDAP users exceeds maximum allowed by the license
Open VCA notification received: server VCA engine event (e.g., VCA license error)
Remote update initiated: remote software update was initiated via Luxriot EVO Console
Server restarted by watchdog: server was restarted by the watchdog service (double-click
the event entry for the details about restart reason)
Server started: Luxriot EVO server service started
Server stopped: Luxriot EVO server service stopped
Synchronisation completed: central server has successfully synchronised configuration
data with the target recording server
Resource access
Archive
Bookmark added: a bookmark was added to the target channel on behalf of the
server (via E&A action, no user interaction)
Uncategorized
Permissions updated: user permissions were edited, double-click the event entry for details
Double-click any event to open it in a separate dialog box with additional information about event source, such
as: backup file path for the Automatic backup event, error code for the Open VCA notification event etc.
Users
The events related to user input (configuration via Luxriot EVO Console, resource access via client applications) are
available here. Some of these (mostly configuration related) are triggered by user actions in Luxriot EVO Console
and some (mostly related to resource access) are based on user actions in Luxriot EVO Monitor. The following
events are logged in this section:
Events & Actions
Rule modifiers: events related to rule schedules and conditions
Event condition added/removed/updated: a condition was modified
Event schedule added/removed/updated: a schedule was modified
Event schedule item added/removed/updated: an individual schedule item was
modified
Action added/removed/updated: an E&A action was modified
Event added/removed/updated: an E&A event was modified
Event-action rule added/removed/updated: a rule in the E&A table was modified
Global event added/removed/updated: a global event was modified
Mail server added/removed/updated: an SMTP server in E&A configuration was modified
External services: events associated with external services operating via HTTP API, such as FR, LPR
and third-party software integrations
External service added/removed/updated: external service connection was modified
External service group added/removed/updated: a group for external services was modified
via Luxriot EVO Console
Failover management
Failover cluster added/removed/updated: failover cluster settings were modified via Luxriot
EVO Console
Installation: events related to software installation and upgrade
Remote update requested: a user has requested remote server update via Luxriot EVO Console
(usually followed by the Remote update initiated event entry in the Server audit section)
Recording: changes to recording setup via Luxriot EVO Console
Recording configuration added/removed/updated
Recording profile added/removed/updated
Recording schedule added/removed/updated
Recording schedule item added/removed/updated
Resource access: user actions concerning all types of resource access from connected clients
Archive: playback related events triggered from different Luxriot EVO Monitor playback modes
Archive replication accessed: recordings from a channel replica were accessed
Archive search accessed: recordings from a channel were
Archive snapshot exported: a single or multichannel snapshot was exported from one
of the archive playback modes
Archive timeline accessed: archived data was accessed in a playback mode that has
timeline
Archived data accessed: available recordings from a channel were played back
Archived data exported: a video clip was exported (double-click the event entry for
details)
Bookmark added/removed: a new bookmark was appended to the channel timeline
or deleted from it
Bookmark popup confirmed: bookmark popup caused by E&A action was approved
by a user via Luxriot EVO Monitor application
Bookmark search accessed: bookmark were searched from the Luxriot EVO
Monitor playback mode
Live
Audio input received from device: audio IN was activated from live view
Audio output sent to device: audio OUT was activated from live view
External data accessed: information from Data sources was streamed with live video
Layout added/removed/updated: a layout was modified in Luxriot EVO Monitor
Live data accessed: live video stream was displayed
Motion data accessed: motion information was streamed with live video
VCA data accessed: Open VCA metadata was streamed with live video
PTZ: pan, tilt, zoom, focus, iris related actions, as well as PTZ presets and tours for the target
channel
Navigate: PTZ event from older database versions (backward compatibility)
PTZ auto-focus/auto-iris activated: device automatic focus/iris feature was
activated
PTZ focus/iris started/stopped: device manual focus/iris capability was used
PTZ pan/tilt started: device was panned/tilted
PTZ pan/tilt stopped: this event is generated after five seconds after the last pan/tilt
command (after the PTZ control was released)
PTZ preset saved/activated/deleted: PTZ preset was accessed
PTZ tour saved/activated/deactivated/deleted: PTZ tour was accessed
PTZ zoom started: device zoom IN/OUT capability was used
PTZ zoom stopped: this event is generated after five seconds after the last zoom
IN/OUT command (after the PTZ control was released)
User defined: this event is generated when an audit entry is created based on a user-defined
E&A action Write to audit log
Video walls: events based on video wall related user actions in Luxriot EVO Monitor via
Resources panel and/or Video Walls section
Video wall current layout saved as startup: the currently displayed layout was set
as startup for the target video wall display via video wall management
Video wall layout saved as startup: a layout was set as startup for the target video
wall display
Video wall layout sequence paused: the layout sequence currently assigned to a
video wall display was stopped
Video wall layout sequence set: a pre-saved layout sequence was assigned to a video
wall display
Video wall layout set: a pre-saved layout was assigned to a video wall display
Video wall object popped up: an E&A action that displays an object
(channel/map/layout) an a video wall screen has been executed
Video wall viewport updated: an individual viewport contents was changed within a
layout of a video wall display
Copied exported items: exported files were copied from the Luxriot EVO Monitor library to
an external destination
External data search accessed: archived information from Data sources was searched from
Luxriot EVO Monitor
External service search accessed: archived external service data was searched from Luxriot
EVO Monitor
Live snapshot exported: a snapshot was saved from the Luxriot EVO Monitor live view mode
VCA search accessed: archived VCA data was searched from the Luxriot EVO Monitor
playback mode
Resource administration: resource related events caused by user actions in Luxriot EVO Console
management application
Channels
Channel added/removed/updated: target channel was modified in the described
manner
Channel attached/detached: target channel was attached to/detached from its device
Channel enabled/disabled: target channel was activated/deactivated
Device channel group added/removed/updated: a channel group was modified in the
described manner
Data sources
Data source added/removed/updated: a serial data source was modified in the
described manner
Data source profile added/removed/updated: a profile for the data source was
modified
Devices
Administer: device management event from older database versions (backward
compatibility)
Device added/removed/updated: a device was modified in the described manner
Device group added/removed/updated: a device group was modified in the described
manner
Layouts and layout templates
Layout template added/removed/updated: a layout grid was modified
Layout group added/removed/updated: a group for shared layouts was modified
Live podcasts
Live podcast added/removed/updated: a live broadcast was modified
Live podcast enabled/disabled: a live broadcast was activated/deactivated
Maps
Geo map added/removed/updated: a map based on the world map was modified
Map added/removed/updated: a picture-based map was modified
Map group added/removed/updated: a map/geo map group was modified
Map item added/removed/updated: an individual map item (e.g., channel marker)
was modified on a map/geo map
Networks
Network added/removed/updated: a network connection was modified
Organisations
Organisation added/removed/updated: an organisation was modified
Servers
Connection updated: server connection (IP, port, SNMP settings) was modified (it is
added/removed together with the server)
Server added/removed/updated: a server was modified in the Luxriot EVO Global
configuration
Server configuration backed up: server configuration was backed up manually via
wizard (this event is only logged if the backup was run while Luxriot EVO server was
stopped)
Server configuration restored: server configuration was restored manually via
wizard (this event is only logged if the wizard was run while Luxriot EVO server was
stopped)
Server group added/removed/updated: a server group was modified
Software counters
Software counter added/removed/updated
User buttons
User button added/removed/updated: a user button was modified
User button group added/removed/updated: a user button was modified
Video walls
Video wall added/removed/modified: a video wall was modified
Video wall group added/removed/updated: a video wall was modified
Visual groups
Visual group added/removed/modified: a visual group was modified
Access control added/removed/updated, enabled/disabled
OPC client added/removed/updated, enabled/disabled
Server security: events related to server security, access and permission/policy/user management
Administration permissions updated: administrative permissions for Luxriot EVO Console
access were modified for a user or a user group
Audit log accessed: the Audit section of Luxriot EVO Console was accessed
Confirmed server warning notification: a popup warning from the server E&A action was
confirmed in Luxriot EVO Monitor
External user group added/removed/updated: AD/LDAP user group was modified
Client connection permissions updated: administrative permissions related to remote client
access were modified
Log in: a user has successfully logged into the target server
Log out: a user has logged out of the server or his session timed out
Monitoring data accessed: the Monitoring section of Luxriot EVO Console was accessed
Object added to group: some object in the server configuration was added into a group of the
corresponding type
Object removed from group: some object in the server configuration was deleted from a group
of the corresponding type
Permissions added/removed: user permissions were modified
Security policy added/removed/updated: server security policy was modified
Unsuccessful log in: a user has attempted to log into the server without success
User added/removed/updated: a user account was modified
User group added/removed/updated: user group settings were modified
Double-click an event entry to see details about the related resource, such as: resource name, the user who did
the changes or executed the action, destination path for the copied exported files etc.
Define Filter
Audit logs can be filtered for easier analysis. Click the Define filter button on the upper panel to bring up the dialog
box.
In the Set period tab, specify the time limits for log output. You can set the date and time manually or use automated
controls for preset time boundaries: last day/week/month, the whole time, and also set start/end boundaries equal
to the log beginning/end.
Make sure you run the Problem Report Wizard on the right computer: it gathers information from the
machine it has been launched on, and not from any of the servers connected via Luxriot EVO Console or
Luxriot EVO Monitor.
Problem description
If you were asked by support team to generate a problem report, copy the ticket ID from the email communication
and add it to the report by clicking the Problem description already provided button. This will help the support
team to classify your report faster, and it will also guarantee that your report will go directly to the team member
responsible for the thread.
Submitting report
If the server is offline, wizard will not be able to submit the report to Luxriot; instead, you will be invited to save the
generated report locally. Press the Finalise wizard without upload button to finish.
The archive will be copied to the computer that has Archive backup wizard running on it. Thus, if you are
connecting to a server remotely via Archive backup wizard, the archive copy will be downloaded to your
computer from the server. As footage may be of significant size, make sure you have the required bandwidth
available.
Start the Archive Backup Wizard from the Windows Start menu: Start -> All Apps -> Luxriot -> Archive
Backup Wizard (in Windows 7 and older versions, use Start -> All Programs -> software installation folder -> Tools
-> Archive Backup Wizard); alternatively, use Search to locate Archive Backup Wizard in the programs menu.
From the Luxriot EVO Monitor application, the wizard can be launched via main application menu by opening View
-> Archive Backup Wizard and choosing the server (one of the connected ones). The address of the server, and also
the username and password, will be taken from the currently configured server connection.
First, you will be asked to log into the target server: your user account must have an administrative permission to
make archive backups plus permissions to back up footage from individual channels/channel groups. You can create
archive backups from the local server or from any remote server (login procedure is analogous to Luxriot EVO
Console login), including individual recording servers. If you run the wizard from the Luxriot EVO Monitor
application, you will not be asked to log in; instead, your configured server connection will be used.
After you log in, you will be presented with the list of available recordings, grouped by channel and, if present,
by visual group. Select the channel(s) and/or visual groups you need by putting a checkmark next to each one;
specify the required time range above the channel list and click Next.
Backup progress
When ready, hit Next for the wizard to proceed with backing up the selected information. Depending on the size of
the selected archive, the backup procedure may take some time and its progress will be displayed in the wizard
window. When it is finished, you will get a confirmation with a short description of what has been done.
If, during the backup progress, you decide to stop it for some reason, simply hit the Cancel button in the bottom
right corner. You will then be presented with several options of how the wizard can proceed:
save the task and files: save your current backup progress and preserve the wizard state until the next time
you run it; you will be able to continue with the current backup item(s) then
save files only: leave the files that have been downloaded so far but discard the wizard settings so that the
next time you run it you will be presented with default choice
remove files: discard current backup task completely and remove the downloaded files
continue to download: go back and continue with the selected backup
Before configuring GPU acceleration, make sure you have installed the latest official drivers for all your graphics
cards. We also recommend having more memory for GPU (the more, the better). For integrated video cards, you
can change this setting in BIOS. For discrete graphics, choose ones with more onboard memory (1GB per display or
more).
For H.265: decoding is only available for the graphics cards that have HEVC support. Please check with the video
card manufacturer for the specifications.
On every client workstation where you want to enable GPU usage, launch the Renderer Test Utility by locating it in
the Start menu, or simply by typing a part of the name in the Windows search. You can also run this wizard from the
Luxriot EVO Monitor application itself via main menu Tools > GPU configuration wizard. The client application
will be closed during the test and then re-opened.
The first wizard screen is a summary. Here, you can select, which graphics cards will be used for decoding and for
3D rendering. To be able to do so, first run the GPU test so that Luxriot EVO can learn about your GPU capabilities
and determine the maximum possible load. During the test, each GPU is consequently loaded with test videos of
different resolutions, starting from bigger ones. As a result, a value list is created for each GPU, which is then used
by the Luxriot EVO Monitor application for load balancing.
We recommend that you re-run the GPU test after each system change that may be related to graphics, as
well as major OS updates (like feature updates) and Luxriot EVO software upgrade.
To run the performance test: hit the Test GPU button in the bottom left corner. In the list, mark all GPUs that you
wish to engage by putting check marks in the Test column. Then, select the target codecs, and click the Test button
below.
An example of Intel graphics card that has successfully passed the test for both h.264 and h.265 decoding.
Log colours:
red: most important (errors, failures)
yellow: warnings
blue: information
black: default
gray: trace, details or low importance
Flags used in the test log indicate GPU capabilities:
supported: graphics card is supported
unsupported: hardware decoding is not supported by OS for this GPU
legacy: video card is old or has old drivers, max resolution will be limited to 1080p
canDecode: the GPU is OK to be used for decoding
canRender: the GPU is OK to be used for rendering
As a result, the previously Not passed GPUs will change their status. GPUs that have passed the test, will be
available for decoding (putting a check mark in the Decode column). Below the table, you can choose, which GPU
will be used for rendering.
If you graphics card can decode both H.264 and H.265, you will have both codecs enabled after the test. However,
you can deselect H.265 if you do not wish it to be decoded by GPU. Do not forget to restart Luxriot EVO Monitor if
you have just opened the wizard to change the settings (without running the test).
Video output process on the Luxriot EVO Monitor side consists of two stages: decoding frames and rendering
for displaying them. After decoding, the frames are converted and passed for rendering. If decoding and
rendering operations happen on different GPUs, CPU is used in between so its load may grow a bit. Therefore,
if only one GPU is used for decoding, it may be wiser to use the same GPU for rendering. Same logic is to be
applied for cases when one GPU takes the most decoding load (this can be deduced from the GPU test log).
But, if you happen to have a GPU that does not support decoding, you may want to use it for rendering, so that
the total load is split between GPUs.
In general, according to our tests, Intel GPUs have better decoding capabilities (more channels can be
decoded by them), and Nvidia GPUs (hi-end) are good at 3D rendering.
Click OK to save the settings and exit. If you close the wizard by clicking Cancel or X, the GPU settings will not be
saved.
If you open the wizard and change any settings without running the test, please manually restart the
Luxriot EVO Monitor application for the changes to take effect.
You can re-open the wizard at any time to run the test again and/or change the settings.
After you have enabled GPU settings via wizard, the Luxriot EVO Monitor application on the same machine will be
able to use the GPU capabilities. Using GPU acceleration will significantly decrease the CPU load and will allow you
to output more channels simultaneously on the same workstation. By combining GPU acceleration with substream
usage you can gain even more, as using lower resolution streams for multichannel output is more efficient.
Luxriot EVO Monitor will automatically use GPUs enabled via wizard, you do not have to enable anything else in the
application settings. Limitations:
live view and DPTZ
fisheye dewarp (supported dewarp mode must be set in Luxriot EVO Console, as described above)
stream codec must be H.264 or H.265
stream resolution must be supported (see GPU test log for details), e.g., legacy GPUs will not be used for
resolutions greater than FullHD
If you want to check whether the decoding is currently performed by GPU, enable rendering info in the Luxriot EVO
Monitor application settings. In the main menu, choose Edit > Settings > select the Usability tab > enable the Show
decoder information option > Save.
Luxriot EVO Monitor will automatically switch to CPU decoding if the configured GPU is overloaded (more
than 80% of its decoder, renderer or memory is used).
Make sure you have at least 512MB of dedicated video memory per display (recommended minimum is 1GB
per display).
Troubleshooting
If, immediately after enabling hardware acceleration, your Luxriot EVO Monitor application behaves strangely,
crashes, or causes other problems, try running it without GPU decoding. To do so a single time - for
troubleshooting - use the Luxriot EVO Monitor without GPU decoding shortcut from the Start menu (similar icon
but in gray colours). This shortcut activates a so-called "safe mode" for the Luxriot EVO Monitor application,
which completely ignores the GPU settings configured via GPU test utility.
After launching the Luxriot EVO Monitor application in "safe mode", check if the issue is gone. If the no-GPU mode
helps, disable GPU decoding via Renderer test utility by de-selecting GPUs in the list (remove the check mark in the
Decode column). If you have multiple graphics cards, the issue may be caused by one of them, so a wise approach
would be to enable/disable the graphics adapters one by one in order to find out, which one is causing problems.