How to Configure Suprema Devices to Integrate with MicroEngine Controllers

Problem (Issue) Statement:	How to configure Suprema devices to integrate with MicroEngine controllers
Description:	This article will guide user to configure the Suprema devices to integrate with MicroEngine controllers.
Related Software:	xPortalNet v1.5
Related Hardware:	MicroEngine controllers that support wiegand output, Suprema FaceStation2, Suprema FaceLite, Suprema BioEntry Plus, Suprema BioLite Net
System Application:	NIL
Symptom and Finding:	NIL
Cause:	For first time guide to configure Suprema devices to integrate with MicroEngine controllers.
Solution:	Pre-requisites / requirements xPortalNet PS v1.5.19.187 and above. This module is enabled in Demo version. However, a license dongle is required in order to activate the module in full software version. 'MicroEngine Suprema Comm Services' is required for the integration to work. This services can only be installed on 64-bit OS and must be installed on the same machine as xPortalNet Services. The Suprema device's IP settings must be configured by referring to Suprema manual. Otherwise, the SDK is not able to connect. Summary: Install Suprema Communication Services. Configure in and out reader. Retrieve device info / settings. . Step-by-step Guide: Install Suprema Communication Services: Step 1: Run MicroEngine Suprema Comm. Services.exe file. When the installation wizard window is opened, click Next. Figure 1: MicroEngine Suprema Comm Services InstallShield Wizard Step 2: As the wizard is ready to begin the installation, click Install. Figure 2: Ready to Install the Program Window Step 3: Wait while the installation wizard installs the MicroEngine Suprema Comm. Services. Figure 3: Installing MicroEngine Suprema Comm Services Step 4: Click *Finish* after completed the installation. Figure 4: InstallShield Wizard Completed Window Step 5: MicroEngine Suprema Communication Services should be started automatically after completely installed the service. You should be able to see MicroEngine Suprema Comm. Services in Windows Services. Figure 5: MicroEngine Suprema Comm Services Running . . Configure in and out reader: Step 1: In xPortalNet Server software, go to Server Admin > System Device Setup > Door. Make sure to select "Suprema" as Model No. and "Standard Wiegand 26 Bit" as Reader Type. Select the right TTL In Reader No. and TTL Out Reader No.: I) Select TTL In Reader No. for entry door. You can get valid entry transaction upon access granted at Suprema device. ii) Select TTL Out Reader No. for exit door. You can get valid exit transaction upon access granted at Suprema device. Reminder Make sure to connect Suprema device wiegand output to the right TTL port on the contoller. Example: If TTL In Reader No.* is configured as 1, then connect the Suprema device wiegand output to Reader 1 TTL port on the controller. If it is 2, then connect it to Reader 2 TTL port.* . . Enter the Suprema device ID for In Reader and/or Out Reader. Click OK to save the door settings. Figure 6: Configure Door Setting and Suprema Device in Door Setup. . Note You can find the Suprema device ID* from the original packaging box of the device.* . . Step 2: After configured the door or controller settings in xPortalNet Server, send door controller settings to controller(s) and device(s). xPortalNet Client > Device Comm > Send Door Setting . . Retrieve device info / settings Step 1: Retrieve the device settings (i.e.: Version, Date Time) from Suprema device to make sure that you have configured the device correctly. xPortalNet Client >Device Comm > Retrieve Device Setting Figure 7: Retrieve Version from Suprema Devices Figure 8: Retrieve Current Date and Time from Suprema Devices . Knowledge Base Link If users encountered the "Failed to retrieved settings from Suprema device due to 'Device not connected'?" message, users can refer to How to Troubleshoot the Issue Where the "Device not connected" Error Message is Shown during Send or Retrieve Settings for Suprema Devices to troubleshoot the issue. . . Troubleshooting tips You can check the Suprema logs for troubleshooting purpose. The log files can be found from the default path "C:\ProgramData\MicroEngine\xPortalNet v1\Server\Suprema\Logs". If you wish to change the Suprema log folder, read How to Change Log Folder Directory for MicroEngine Suprema Communication Services* article.* . . Figure 9: Suprema FR / Fingerprint Device Setup Flow
Common Issues:	NIL
Porting Date:	05/04/2020 (Rev 1.0)