View source for IntelliVision audio analytics - Zenitel Connect Pro integration

{{C}}
=Introduction=

This article describes how to create a Linux Ubuntu machine and use it for installing the Audio Event Detection Server.<br>
The audio event detection server must run in an Zenitel Connect Pro environment as the WAMP communication protocol is used for message transfer and event signaling.<br>   
The audio event detection software package consists of two types of elements:

*A container for audio event detection from an incoming audio stream which.
*A container implementing a web-service for configuring the audio event detection server.

=Prerequisites=
*Intellivision audio analytics valid licence.
*Zenitel Connect Pro up and running.
*Ubuntu 24.04.2 LTS
*Internet access

=Checklist=
Please ensure that every point from list below is completed :
*Zenitel Connect Pro port 8087 open in firewall. This port is used for communication between ZCP and audio event configurator.
*Ensure that the firewall of the Audio Event Server is open for udp stream. Use the  '''"sudo ufw allow xxxx:yyyy/udp"''' command to allow udp for ports xxxx to yyyy.
*To allow all communication between audio event server and ZCP, use : '''sudo ufw allow from <ZCP_IP>''' 
*Factory resetting the device before setup is recommended.
*Strong password for Zenitel Link user-between 8 and 12 alphanumeric characters
A system setup is shown on the picture below:<br>
<br>
[[File:AED_TestSetup_v2.jpg|thumb|left|700px|AED Test Setup]]
<br style="clear:both;" />
<br>

=Downloading audio analytics server=
<br>
To install audio analytics server execute the following steps:<br>
*Download latest version of "AAS-Server <br>
*Downloaded file will be in following format ‘’'''AAS-Server.ova'''’’
*Open VirtualBox and click on "File" tab, followed by  "Import Appliance" .
*In interface, choose the .ova image you downloaded in step 1.
<br>
<br>
[[File:aas3.png|thumb|left|700px|Virutal box interface]]
<br style="clear:both;" />
<br>

=Installing Audio Analytics=
{{Warn|Ensure ZCP is up and running before starting installation process.}}
{{Warn|ZCP validates certificate based on GMT time zone. it's recommended to wait 24 hours before installation process if you are setting up ZCP for the first time .}}
Once you have downloaded and imported audio analytics server, you will be prompted with terminal.
*Enter your username (AAS-Server by default)
*Enter your password (alphaadmin by default)
*use command ./start.sh to start the installation process.

<br>
[[File:aas1.png|thumb|left|700px|Starting installation process ]]
<br style="clear:both;" />
<br>
Setup process is designed in a way that it automatically checks for dependencies (such as docker) that are needed to run audio analytics. Upon running the program you will be asked for password you set up in chapter one, enter the password to start the process.
<br>
[[File:PassInput.png|thumb|left|700px|Password input]]
<br style="clear:both;" />
<br>
'''''Note: You will not see letters as you type the password, this is standard security feature in Linux based systems. If you think you wrote wrong password, press enter and try again.
'''
''
Some dependencies may already exist on your system and you will be asked to overwrite them, type ‘’y’’ and press enter if you want to do so.
<br>
[[File:DependencyOverwrite.png|thumb|left|700px|Dependency overwrite]]
<br style="clear:both;" />
<br> 


During the installation procedure, you will be required to input the information relevant to installation:
*Zenitel Connect Pro server IP address
*Zenitel Connect Pro server username (MUST BE ZENITEL LINK USER)
*Zenitel Connect Pro server password
*IP address of audio analytics server
*Number of audio detectors you plan to use

<br>
[[File:Aas2.png|thumb|left|700px|Required information]]
<br style="clear:both;" />
<br> 
*'''''Note: Choose IP address based on number in front of relevant IP address. In example above press number 1 if you want to use 10.8.36.134 as IP address of audio analytics server. ’’'''''
*'''''Note: Take note of MAC address that will be shown in installation. Pass that MAC address to your license administrator, as licences are based on MAC address. ’’'''''
*'''''Note: AED stands for ‘’Audio Event Detector’’'''''
*'''''Note: The user which you define in setup must be Zenitel link user.'''''
*'''''Note: It's recommended that Zenitel link user password contains combination of number and letters’’'''''

After the installation is completed, you will get a notification in a terminal.
<br>

=Configuring Audio Event Detector=
Once you finished the installation process, you can access the Audio Event Configurator from another machine (Windows in this case) by typing IP addresses fetched in step above into web browser.<br>
Upon entering web page of the configurator for the first time, default credentials are being shown, change them to credentials of Zenitel Connect Pro configured on Ubuntu system in steps above.

<br>
[[File:image.png|thumb|left|700px|Login page]]
<br style="clear:both;" />
<br> 

Press on '''''Disconnect''''', enter your credentials and press on '''''Reconnect''''', system will start connecting to Zenitel Connect server which takes between 10 and 15 seconds

After connecting, home page is shown with the list of devices and their properties. If you login for the first time, few devices serving as detectors will be shown as template how configured device should look like. Feel free to delete them and add your own devices.<br>
In '''''license''''' field, enter the license you got from your sales representative, press '''''save''''' and '''''update server'''''<br>
Make sure you pressed start button next to device you wish to use as detector.
<br>
[[File:ConfigHome.png|thumb|left|900px|Configurator home page]]
<br style="clear:both;" />
<br> 
If your machine has multiple MAC addresses i.e. multiple networks, choose the MAC address which is tied to your license from the dropdown
==Adding devices==
Pressing on '''''Add Device''''' will open a new interface for adding device, on the left side is device configuration such as directory number, gain and stream port and on right side is event probability tuning. <br>
It is recommended to use the following settings:
<br>
*"Gain": 10-12 (dB).
<br>
From ZCP Configuration web it is recommended to use:
<br>
*Internal Microphone: 4 (dB).
*Disable signal processing (Echo Cancelling and Automatic Gain Control). 
<br>

Type and name of a device will be automatically filled based on selected directory number
<br>
[[File:NewDevice.png|thumb|left|700px|New device interface]]
<br style="clear:both;" />
<br> 

'''''Note: If device directory number is incomplete, refresh page for the system to fetch devices again<br>'''''

===License Key===
The status of the currently installed license key is shown.
In case the license key has become invalid - a new license key has to be applied.
<br>
The license is created from a MAC address available on the server. Press "---Available MAC-addresses ---" and select one from the list. Handle the MAC address to the license administrator for creating a new one.
<br>
'''"Save"''' - Pushing this button will save the license key inserted in the edit window "Install New License Key" in the configuration data base.

'''Note: After saving you need to send the license key to the server by pushing "Update Server".'''
<br>

===Intellivision recommendations===
Intellivision tested audio analytics with our TCIV device, per their recommendations: 
*Probability values should be kept above 85%.
*Updated engineconfig.ini, tailored for our devices: [[File:Engineconfig.ini.zip]]





<br>
[[File:License.png|thumb|left|700px|Valid license]]
<br style="clear:both;" />
<br>

=Registered event=
<br>
[[File:glass.png|thumb|left|700px|Glass break event]]
<br style="clear:both;" />
<br> 

[[Category: Zenitel Connect Pro]]
[[Category: Zenitel Connect Pro Integrations]]
[[Category:3rd party integration]]