View source for AEOS (Nedap) - ICX-AlphaCom integration

== Functional Specifications ==
The AEOS <-> AlphaCom interface is a bi-directional connection, based on the Socket interface on the AEOS side and a EDO/EDI connection on the AlphaCom side.
The link is actualized on the basis of local intercom server ICX-500/ICX-Core to AEOS, without the inclusion of AlphaNet.

It is also possible to log in directly to the AEpu (door controller), but this is not included in this document.
The functionalities below become available with this interface:

# Opening doors in AEOS environment during an intercom conversation (ICX-AlphaCom to AEOS) after providing the “open door” command in ICX-AlphaCom and playing a prerecorded audio message on the intercom when the door is opened by AEOS. By default, this involves pressing the “6” key during an intercom conversation.
# Play a prerecorded audio message in an intercom station or make a call when an access key or badge is authorized or denied (AEOS to ICX-AlphaCom).
<br>

=== Requirements Zenitel ===
<br>

==== Compatability list ====

*AlphaCom XE AMC version 11.2.3.11 (or higher).
*ICX 500/ICX-core Server FW 1.2.3.9. (or higher).
*AlphaPro 11.7 when using AC XE 
*AlphaPro 12.1.3 (or higher) for AC ICX 500/ICX-CORE.
<br>

==== Zenitel (ICX-AlphaCom) License for Interfacing ====
*1002602400 ILI-IF Interface Enabling license for ICX 500/ICX-CORE.
*1002604000 (basic) or 1002604100 (enhanced) Audio Messaging License for ICX 500/ICX-core (Depending on the desired number of audio messages).
*1009648500 (basic) or 1009648501 (enhanced) Audio Messaging License for AlphaCom XE (Depending on the desired number of audio messages).
<br>

=== Requirements AEOS ===
<br>

==== Compatibility list Nedap ====
*AEOS version 2021.X (or higher)
*System user credentials
<br>

==== Nedap (AEOS) License for Interfacing ====
*No additional License(s) needed.
<br>

=== Connection settings / Logins ===
Communication runs through TCP/IP on eth0 or eth1 of the ICX-AlphaCom exchange. IP addresses should be determined on project requirements.
Settings for the ICX-AlphaCom and Nedap controller:

*IP-address AlphaCom 			xxx.xxx.xxx.xxx  (eth0 or eth1)
*IP-address AEOS Server			xxx.xxx.xxx.xxx
*IP-address Nedap door controller	xxx.xxx.xxx.xxx


The TCP port used is 8035 (default port socket interface AEOS), where the AlphaCom acts as a client and logs in to the AEOS server. TCP port 8035 must be added to the filter settings of the intercom center (via web interface of the server)
Display texts of the stations must be the same as the service name of the AEpu (door controller)
<br>


== Communication from ICX-AlphaCom to AEOS ==

The following relates to a test setup, but can be used as a template for the solution in a production environment.
<br>

=== Login === 

To establish a connection with the Socket interface in AEOS, the ICX-AlphaCom needs to log in to AEOS. An event must be created in the Event Handler to log in.
The commands below are sent to AEOS.

*String: EDO 1 "login(socketuser,socketpw)\x3B\r\n"
*Login		=login command
*Socketuser	=username
*Socketpw	=user password

*String: EDO 1 "setRmiCommandConnection(true)\x3B\r\n"
*setRmiCommandConnection 	= activate commands to the socket interface

*String: EDO 1 "setRmiEventConnection(true)\x3B\r\n"
* setRmiEventConnection(true) 	= enable receiving events from the socket interface
<br>

=== Door control (opening) ===

During a conversation, a main intercom station can activate the door control by pressing digit “6” during the conversation. The command below is sent by ICX-AlphaCom to the socket interface of AEOS 
to establish door opening.

*EDO 1 "executeArgs(provideAccess\,[]\,\"aepu1:frontdoor\")\x3B\n\r"  

*Aepu1		=  The name of the  AEpu (door controller “Hostname” in AEOS )

*frontdoor 	=  The service name / Display text of door on the Aepu1 (“Access Point” in AEOS)
<br>

== Messages from AEOS to ICX-AlphaCom ==

When an access control badge is denied or allowed, one or more actions can be performed using the link. Likely actions are a call to reception in the event of an expired or blocked badge, or a welcome message when access has been granted.

The connection from AEOS is also verified on heartbeat. When no heartbeat is determined, ICX-AlphaCom will attempt to log in again once per minute.

The string from the AEOS is made up of several fields, each separated by one “|”.
E.g.: 

*Event: GE|40|AEOS|210|nvc2522aepu1:voordeur|1015|20240105|154723|NedapXS Cards 3|Pietje Puk||0||#003;

*Field numbers: Event: -- 1 -- | -- 2 -- |-- 3 -- |-- 4 -- |-- 5 -- |-- 6 -- |-- 7 -- |-- 8 -- |-- 9 -- |-- 10 -- | -- 11 -- |#003;

In the ICX-AlphaCom event handler, the various fields are filtered from the string and the desired action is performed based on the content.
<br>

=== Heartbeat ===

AEOS sends a heartbeat once per minute as a live check, see string below. 
ICX-AlphaCom filters on “HB” in the string. If the heartbeat is not detected and timeout occurs, ICX-AlphaCom will try to log in again to the AEOS socket interface (see section 2.1).

String:
*Event:HB|3||#003;#015 #012#015
*HB = heartbeat

When the heartbeat is detected, the timer for L699 (test device) is reset to 61 sec.
<br>
 
=== Access granted ===
When access is granted after presenting a valid access badge, a corresponding message is sent from AEOS to which ICX-AlphaCom can respond with a selected audio message or other action.
The AlphaCom filters on the code 1015 (field 6) in the string. 1015 stands for “Authorized Badge Access” in AEOS.

String:
*Event:GE|40|AEOS|210|nvc2522aepu1:voordeur|1015|20240105|154723|NedapXS Cards 3|Pietje Puk||0||#003;#015 #012#015

*voordeur 	= The service name of the door in the Aepu1.

*1015		= Access granted.
<br> 

=== Access denied ===
If access is denied after presenting an access badge, a corresponding message is sent from AEOS to which the AlphaCom can respond with a selected audio message or other action.
The AlphaCom filters on the code 1201 (field 6) of the string.

1201 stands for “BadgeNoAccesEvent” in AEOS.

String:

*Event:GE|42|AEOS|210|nvc2522aepu1:voordeur|1201|20240105|154823|NedapXS Cards 7|Darthvader||0||#003;#015 #012#015
*voordeur 	= The service name of the door in the Aepu1.
*1201		= No Access 
<br>

=== Door control from ICX-AlphaCom ===

When a conversation has been established between a secondary intercom station and e.g. the main station at the reception, the door can also be opened from the main station. (6)
With this action, an “Execute command” is sent from AlphaCom to AEOS, containing the device ID and the relevant AEOS controller.

String from AlphaCom to AEOS (triggered by event type-2):

*EDO 1 "executeArgs(provideAccess\,[]\,\"nvc2522aepu1: %1.NAM\")\x3B\n\r"
*%1.NAM		= The display name of the intercom device in question
*nvc2522aepu1	= The relevant door controller. 

AEOS responds to this string with a feedback message that the DoorOpenAction has been carried out.
ICX-AlphaCom filters this string on the code 1196 (field 6).

1196 stands for “ProvideAccesEvent” in AEOS.

String from AEOS to AlphaCom:
*Event:GE|33|AEOS|210|nvc2522aepu1:voordeur|1196|20240105|154435||||0||#003;#015 #012#015
*voordeur 	= The service name of the door in the Aepu1
*1196		= Access granted. 

ICX-AlphaCom then triggers an event that controls the visual indication on the intercom relay LED (relay control) and plays a voice message on the relevant intercom.
<br>


=== AEOS Socket interface documentation ===

For more information about the Socket interface and the associated events, please refer to the online documents from Nedap:  https://portal.nedapsecurity.com/robohelp?file=index.htm
<br>


== Description configuration/events AlphaCom ==
<br>
=== EDIO serial port configuration === 

Create an EDIO port in AlphaPro under “Exchange & system - Serial Ports - EDIO” with the following settings: 

*Port type: 	TCP/IP Client
*IP address: 	IP-address of AEOS server  	
*Port:	    	8035
*Keep Alive:	Checked
*Write option:	Connect at AlphaCom startup

[[File:AEOS1.png|thumb|center|700px]]


Create port filter 8035 (TCP) for the AEOS interface. Choose the appropriate ethernet connection.
(eth0 or eth1 or both)
<br>

[[File:AEOS2.png|thumb|center|800px]]
<br>

=== Configuration intercom devices ===

To carry out actions after events from AEOS, it is important that the intercom devices have the same name as the service name of AEpu ( = door controller Nedap). 
This name is compared with the incoming data from the events. See the example below:


[[File:AEOS3.png|thumb|center|800px]]



Event:GE|33|AEOS|210|nvc2522aepu1:voordeur|1196|20240105|154435||||0||#003;

'''The display text must be written exactly the same as the name in field 5 of the string.
'''
<br>


=== Programming events in ICX-AlphaCom ===
<br>
==== System communications between AEOS - AlphaCom ====

The event below is triggered when a text string is offered to the EDIO port by the AEOS server.

*Owner Type: 		EDI text config
*Event-type: 		28 
*Subevent: 		1 (Refers to EDIO port 1)
*When changed to:	--


[[File:AEOS4.png|thumb|center|800px]]


Various functions are completed in this event:

*Heartbeat Control.
*Logging into AEOS and Command Connection handling bi-directional.
*Action for “access denied” with access badge presentation.			(1201)
*Action for “door control allowed” door opening is initiated from AlphaCom.	(1196)
*Action for “access permitted” with access badge presentation.		        (1015)

'''Important: if %op(%tmp(7),=,5)                          / Last Physical Number Intercoms Reached'''

'''Change the value of the last available physical number in the event; this occurs three times in this event. In the example below, the event stops at 5, considering that there can be maximum 552 available in ICX-AlphaCom.
''' 

[[File:AEOS8.PNG|thumb|center|800px]]
[[File:AEOS9.PNG|thumb|center|800px]]
<br>

==== Init Timer Heartbeat ====

The event below is used to initialize the heartbeat timer at system start-up.

Owner Type: 		n.a.
Event-type: 		27 – System status 
Sub-event: 		65
When changed to:	ON


[[File:AEOS5.png|thumb|center|800px]]



Action:
$ST L699 W800				Start Timer for 80 seconds. To check heartbeat.
<br>

==== Timeout heartbeat ==== 

The event below is used to log into the AEOS socket Interface again when no heartbeat has been received from AEOS. The timer is also restarted for 61 seconds.

Owner Type: 		Test device
Event-type: 		21 – Event time out
Subevent: 		-
When changed to:	ON


[[File:AEOS6.png|thumb|center|800px]]



Action:

LOG "timer heartbeat afgelopen"
LOG "login(socketuser,socketpw)\x3B"
EDO 1 "login(socketuser,socketpw)\x3B\r\n"
$ST L%1.dir W610
<br>


==== Door control ICX-AlphaCom to AEOS ====

The event below is used to control (open) a door in the AEOS environment from ICX-AlphaCom.
This event is triggered by pressing digit “6” (or any other programmed door-open key) on the main Intercom during a conversation with the corresponding door intercom. 

Owner Type: 		Intercom with door control (relays)
Event-type: 		2 – Door opening
Subevent: 		-
When changed to:	ON


[[File:AEOS7.png|thumb|center|800px]]


Action:
EDO 1 "executeArgs(provideAccess\,[]\,\"nvc2522aepu1:voordeur\")\x3B\n\r"
LOG "Deuropen naar AEOS"
<br>

== Nedap AEOS Settings ==

Start web services
In AEOS, under system properties, look up section “44.15 SOAP WebService” and check if ticked. If not, tick it on and restart the application service of AEOS (Under Services on the server).

Check whether the webs services are functioning properly. This can be reviewed by going on to the next link (Example with QRS): https://192.168.10.250:8443/aeosws?wsdl

If you see the following page there, it is in order:

[[File:AEOS8.jpg|thumb|center|800px]]
<br>

=== Nedap AEOS Documentation ===

For more information about the interface with Zenitel, see the link to the Tech WebHelp of Nedap.
In here you can find any further Nedap AEOS related information [https://portal.nedapsecurity.com/user/login?destination=/robohelp%3Ffile%3Dindex.htm AEOS Technical support]

[[Category:3rd party integration]]