Skip to content

Configuring Miwa Lock ALV3 and Adapter

This page describes the setup procedure for integrating Kiosk with MIWA LOCK's Hotel Lock System (ALV3).

UNIVERGE Integration Platform MIWA adapter support is for a specific model of the MIWA key card encoder. Instructions and 3rd party software described in this guide are for the Japan region only.

Setup Flow

Per Kiosk Client Settings (Terminal)

  1. Install NFC USB Reader driver for DWHL-V3UA01
  2. Install application for Miwa ALV3 control
  3. Configure ALV3 Control App
  4. Configure MIWA Proxy
  5. Configure firewall for Windows OS
  6. Reboot Kiosk terminal

UIP Settings (Overall)

  1. Import ALV3 Config to UIP
  2. Import MIWA Adapter using UIP Adapter Store
  3. Configure Miwa Workflow & Miwa Adapter at UIP

Preparation / Procurement

Buy from Miwa lock:

  1. ALV3・API * 1 pcs
  2. DWHL-V3UA01 * Same as number of terminals

Info

ALV3API is a Windows Application that runs on Kiosk.DWHL-V3UA01 is an RFID card writer

Installation site conditions

  1. The ALV3 series of MIWA LOCK must be installed.
  2. MIFARE 1k card must be used as the key card.

Other

  1. Purchase a USB hub if the Kiosk terminal does not have an available USB port.
  2. The space at the Kiosk terminal must be large enough to accommodate the card writer and key card.
  3. Means or facilities for the secure storage of returned key cards. (e.g. a mailbox-type return box)

Step-by-Step Guide

Kiosk Client

NFC USB Reader Driver

This section describes the USB driver installation procedure.

  • Download NFC USB Reader Driver from the following URL https://ftdichip.com/drivers/d2xx-drivers/
  • Insert the ALV3・API CD-ROM into the drive.
  • Connect Kiosk Terminal to DWHL-V3UA01 by USB Cable
  • From the Start menu, search for "Device Manager" and click "Device Manager".
  • Click "Update Driver" from right click context menu of "FT230X Basic UART" or "USB Serial Converter".
  • Click "Browse my computer for drivers"
  • Browse the downloaded driver file path

  • Click "Next".

    //

  • Verify that the driver was installed successfully.

  • "USB Serial Port(COM x)" is displayed on Device Manager.

    //

Miwa ALV3 Control App

Install ALV3・API

  • Insert the ALV3・API CD-ROM into the drive.

    //

  • Double-click "setup.exe" to start the installer.

  • Click “Next>”

    //

  • Click “Browse ...”

    //

  • Edit the Folder and set the following path.

    • C: \Users[user name]\AppData\Roaming\alv2api

    Info

    The reason for saving to AppData here is that ALV2 exec() another time file called Alv2Ctrl.exe from the DLL.It also creates a temporary file in the same hierarchy.

  • Click “OK”

    //

  • Confirm that the folder path has been rewritten.

  • Click “Next>”

    //

  • Click “Next>”.

    //

  • Click “Close”.

    //

Install MiwaProxy
  • Double-click "miwa-proxy.msi" to start it.

  • Click “Next”

    //

  • Do not change the installation destination and click “Next”.

    //

  • Click “Install”.

    //

  • Click “Finish”.

    //

Configure ALV3 Control App

Set the INI file of the ALV3 control app.

  • Start Notepad and open the following INI file. C:\Users[user name]\AppData\Roaming\alv2api\64bit\ALVHInf.ini

    • Enter the EDL-ID in the EDL_ID = “” line. * EDL-ID is a 14-character alphanumerical character provided by Miwa Lock Co., Ltd. Example: “0123-4567-ABCD”
    • (Optional) Enter the DcrBuzzer. This setting specifies whether the NFC USB reader buzzes or not. 0: Disable buzzer sound, 1: Enable buzzer sound

    //

  • Select "File" F "" or "Overwrite (S)" from the top menu and save. After closing Notepad, the INI file settings are complete.

Configure MIWA Proxy

Set the configuration file of the MIWA Proxy.

  • Start Notepad with "Run as  administrator" and open the following configuration file. C:\ProgramData\NEC\miwaproxy\appsettings.json

    • Enter the KioskConfigFile. Specify path of the Kiosk Position file. *  Need to escape the "\" mark in the path, replace the “\” mark with “\”.
    • Enter the KioskRouterToken. Specify a Kiosk Router token of any value. This value is used when configuring the MIWA adapter.

    //

  • Select "File" F "" or "Overwrite (S)" from the top menu and save. After closing Notepad, the setting file settings are complete.

Configure Firewall

This section describes the procedure for allowing an application to pass through the firewall. There are various ways, the following is an example.

Apps that require permission:

  1. “C:\Users\{login user name}\AppData\Roaming\alv2api\64bit\ALVHAPI\ALV2Ctl.exe"
Confirmation of network type

Check the network type to which the Kiosk terminal belongs.

  • From the Start menu, search for "Windows Defender Firewall" and click "Windows Defender Firewall".

  • Check the network type that is "Connected" and has a valid network interface registered on the Kiosk terminal.

    //

This completes the confirmation of the network type to which the Kiosk terminal belongs.

Application communication permission settings

Set the communication permission of the application.

  • From the Start menu, search for "Windows Firewall" and click "Allow an app or feature through Windows Defender Firewall".
  • Click "Allow another app..".
  • Click “Browse..”.
  • Go to “C:\Users{login user name}\AppData\Roaming\alv2api\64bit\ALVHAPI”. Select "ALV2Ctl.exe" and click Open.
  • Click “Network types..”
  • Check the network type to which the Kiosk terminal belongs and allow it.
  • Click "OK". * In a general environment, check "Public".
  • Click “Add”.

  • Click “OK”.

    //

This completes the procedure for setting up Windows Firewall.

Restart Windows

After completing the steps up to this point, restart the Windows OS of the Kiosk terminal. If you have multiple Kiosk terminals, make the same settings for other Kiosk terminals.

UIP

Import ALV2 ConfigureThe following describes the import procedure of "uip-miwa-alv2-keycard.json".

  • Access the UIP address and open the UIP Administrator application. Select Import from the menu on the left. Leave the default settings and click Browse.

  • Select the target JSON file and click “Import”.

    //

  • After the import is completed, the import summary will be displayed.

    //

This completes the import procedure for "uip-miwa-alv2-keycard.json".

Add MIWA Adapter

  • Go to the UIP address and open the UIP Administrator Page. From the left menu, click on "Adapter Types".

  • Click on "Adapter Store"

    //

  • Click "Add" on the "MIWA" adapter.

    //

  • The adapter type 'MIWA' has been successfully added. will be displayed.

    //

This completes the MIWA adapter installation procedure. Next, configure the Workflow.

Configure Workflow

Preparations

Obtain the "Hotel Code" and "EDL-ID" of the hotel you are installing from Miwa Lock Co., Ltd.

Setting procedure
  • Access the UIP address and open the UIP Administrator application. From the menu on the left, select Workflow. Click Edit on the same line as "MiwaKeycard".
  • The "MiwaKeycard" workflow edit screen is displayed.

  • Click the "Setting Options" step and setup the Hotel Code and Second Room.

    • Enter Hotel Code  in "Properties"-> "hotelCode" on the right menu.

      Enter the "Hotel Code" listed in "HotelCode.txt" of ALV3 API.

    • Enter the Second Room in "Properties"-> "secondRoom" on the right menu.

      The second room is an option. Please put a second room on the hotel side if requested. If you do not have a second room, skip this step.

      Tip

      The second room only supports numbers from 1 to 6 digits.

    //

  • When you have finished editing the workflow, click Save. The message "Workflow'MiwaKeycard'has been updated successfully." Is displayed. This completes the UIP workflow setup procedure.

    //

Configure MIWA Adapter

Preparations

A MIWA adapter must be created and configured for eachof Kiosk terminal. Please confirm the following information for each Kiosk terminal in advance.

  • Kiosk ID
    • It is found in "KioskId" of the Kiosk Position file.
  • Kiosk Router Token
    • It is found in "KioskRouterToken" of the MIWA Proxy configuration file (C:\ProgramData\NEC\miwaproxy\appsettings.json).
Setting procedure

  • Access the UIP address and open the UIP Administrator application. From the menu on the left, select 'Adapters' and click 'Add Adapter'.

    //

  • From the Add Adapter screen, click on the type "Select..." and select "MIWA".

    //

  • Fill in the following information and click "Save".

    No. Parameter Name Set Value
    1 Type MIWA
    2 Name Kiosk ID
    3 External check
    4 Adapter Hub The Adapter Hub Name will be the one entered when configuring the adapter hub. It can be found on the "Adapter Hubs" page.
    5 Kiosk Router Mode check
    6 Kiosk URI/Kiosk Server URL https://[IP Address of Kiosk Server]:8080/
    7 User Name/Kiosk Position Kiosk ID
    8 Password/Router Token Kiosk Router Token
    9 Client Certificate The adapter client certificate (PEM format). Copy from the Certificate of UIP Adapter Connection in NEC Kiosk Admin.
    10 Client Private Key The private key for the adapter client certificate (PEM format). Copy from the Private Key of UIP Adapter Connection on NEC Kiosk Admin.

    //

This completes the MIWA adapter setup procedure for one Kiosk terminal, please repeat the MIWA adapter setup procedure for the number of Kiosk terminals.

Tip

After setting up the adapter, you will need to reboot it according to the message that prompts you to reboot this adapter.