1. Installing and configuring system software


1.1. Communication servers for Arcade network (gkHost, gkAgent) and service-monitoring utilities (gk3Tools, gk3NetMonitor) should be installed on the server computer with Windows OS.

1.2. Copy folders gkAgent, gkHost, gkOther from the installation package to the main server computer (into C:\game-keeper\gkInstall\software or C:\GK\ folder).

1.2.1. Default location is C:\GK\

1.3. In folder gkAgent_gkHost find a file gkHost.ini and make following configurations:

[log]

  Name = gk3Host.log

  level = 10

  debugLevel = 10

  ByMonthes=1

  ByDays=1

  ByHours=1

 

[log.protocol]

  Name  = gk3Host.protocol.log

  level = 10

  debugLevel = 10

  stampKind = 4145

  ByMonthes=1

  ByDays=1

  ByHours=1

[telnet]

port = 5556

[gk3]

  ip = 172.31.32.64     // here print IP-address of the server

  port = 18251

  net = 172.31.32.0     // here print address of the common network (like server address, but “0” in the end)

  mask = 255.255.0.0

1.4. In folder gkAgent_gkHost find a file gkAgent.ini, here also make necessary configurations:

[gkAgent]

  PriceMsg = "GAME-KEEPER"      Game price   %GAMEPRICE%   //a message that's shown at a playing machine display

  DemoModeCardFilter = 790=1=*

  :DemoModeCardFilter =*

  BadCardMsg = Game Keeper Card, please!

  Mode = 4

  Hosts = 127.0.0.1:5556

  MainMsgTime=7000

  PriceMsgTime=120000

  MsgFrequency=5000

  ConnectionString = Provider=SQLOLEDB.1;Persist Security Info=False;User ID=sa;Initial Catalog=gkArcade;Data Source=GK_LOCAL

  TestModeFreq=300

  autohide = 0

; CmdCheckFreq = 10

[DbConnect]

ServerName = GK_LOCAL

DbName = gkArcade

UserName=sa

Password=083204044C3D3D5012202010720A0C76            //encrypted default password for SQL Server (123456)

[Singularity]

 Check = 2

 MutexName = gkAgent

[log]

  ;name = gkAgent.log

  level = 5

  debuglevel = 10

  byhours=1

1.5. Run install_services.bat in the folder gkAgent_gkHost. The programs will be installed as services - UCS gkHost (gk3Host.exe) and UCS gkAgent (gk3Agent.exe).

1.5.1. Type of running will be “Auto”.

1.5.2. gkAgent service will be depended from gkHost and "MS SQL Server" services to ensure right running order.

1.5.3. gkHost should be starting after "MS SQL Server".


2. Hardware


2.1. Change IP-address on controller

2.1.1. Run gk3NetMonitor program. In opened window press [START] button. As result the program has to show IP-address of controller.

Marked row is an address of our controller. If it's not shown or hard to understand whether it present or not, switch off power of controller and then switch on it. After that you'll see the connected controller in the program. Usually default IP-address of controller is 172.31.32.1, GK-address is 2001.

·        Now it's necessary to configure IP-address of interface-computer (if it's not configured yet) so that it belongs to the network with this controller (for example, controller have address 172.31.32.11, so the interface-computer should have address like 172.31.32.64, last value may differ)

2.1.2. Run GK3Tools, press [START]. On the page Install print two last blocks of IP-address found in GK3Monitor, then press [set] button and make restart ([Restart] button in lower part of window).

·        Press [Refresh] button (two green round arrows). Below will appear data contained in controller firmware (IP-address, MAC-address, Gateway).  In a field GK-address print two last blocks of new IP-address in hexadecimal numeral system. After that press “button without name”, then save data pressing [Save] button.

Make sure that IP-address is changed. For that restart program gk3Tools and input an address of new host in Install bookmark, then press [set] and [Restart]. After a time in a Log window should to appear a row that confirms connection of controller with new address. Other way to check new address is using gk3NetMonitor program.

2.2. Change software running on controller

2.2.1. There are several ways of controller usage and hence different software to be saved to controller internal memory. Firmware files (.fw) are available from UCS FTP server.

2.2.2. GK3Tools.exe software to be used for software uploading.

2.2.3. Connect to controller and go to "install" tab.

2.2.4. Select necessary software image (choose: game machine or ticket station, for example) and "upload" that.

2.2.5. Check that new version appears on customer display connected to that controller after "Restart AppFW"->"Restart" functions call.

2.3. Change controller firmware

2.3.1. External programmer AVR910 (or compaible) with repared cable (or some 10<->6 adapter) to be used for firmware burning process. If you have different programmer tool, read p.2.3.7.

2.3.1.1. Cable stub with 10-pin connectors to be used for both controller ('X6' internal port on board) and programmer connection. But controller has 6-pin socket - that's why you should remake cord (in some cases you may buy 10 to 6 pin cable, but check that to fit the scheme given below).

2.3.1.2. You have to prepare cable like shown below , standart direct cable doesn't fit - do not connect that to controller board as is.

10-pin cord:

6-pin cord:

2.3.1.3. Cut cord in the middle and put parts near each other like shown on picture - with control lug up. Number cores left to right (01 -10) if look from connector side.

2.3.1.4. Make bind of the following cores:

To programmer (10-pin) To controller (pins 5 to 10) Real controller board pins (1 to 6) Purpose
10 5 6 GND
9 10 1 MISO
7 8 3 SCK
5 6 5 RST
2 9 2 VCC
1 7 4 MOSI

On-cord connector layout:

2.3.1.5. Controller connector must be eat away near core #10 side in order to be able to plug that to device board (carefully). Controller side cord connector pin holes 1-4 are not in use due to 6-pin board socket and upside-down self-made connector orientation.

On-board connector pins (pin 1 has writing '1' on board):

2.3.1.6. Mind that we connect our custom cord connector upside-down, with lug faced to board center (original 6-pin cord will be connected with control lug faced outside).

2.3.2. External software like Avr-Osp to be used for firmware burning.

2.3.2.1. Choose the following options in that program:

2.3.2.1.1. Device=ATmega64 (for AVR910).

2.3.3. You have to get firmware image from UCS (eth_bootloader_3_0_0_11.hex).

2.3.4. You must install windows USB->COM driver that comes from programmer supplier in order to work with programmer from windows application (that uses COM port protocol).

2.3.5. It is recommended to "erase" device before saving new firmware.

2.3.6. Check your new firmware version on boot on customer display.

2.3.7. USBasp programmer

2.3.7.1. Use 'eXtreme Burner' software to burn firmware to controller with 'USBasp' tool. In case of some other programmer device, find suitable burning software yourself.

2.3.7.1.1. Install USBasp driver. Make sure in your OS disabled digital signature check.

2.3.7.1.2. Install eXtreme Burner with installer. Tested version 1.4.3.

2.3.7.1.3. Start application and select chip

2.3.7.2. Other operations, like program update using Gk3tools and NIC setup, are the same (or very similar to AVR910) in case you use different programmer device.

2.4. Controller ports

2.4.1. Modern UCS GK controller board has 6 external ports as shown below.

2.4.2. You have to connect controller to game machine using DATA port.


3. Protocol


3.1. Arcade

3.1.1. GK network has default address 172.31.0.0. and mask 255.255.0.0.

3.1.2. GK address is last two bytes in HEX format

3.1.2.1. Server default address is 172.31.0.1 , which GK address is 00 01

3.1.2.2. Game machine controller default (initial) GK addr is 20 01 (IP=172.31.32.1)

3.1.3. GK uses UDP protocol over IP.

3.1.3.1. Default UDP port is 18251 (= GK bytes) for server and controller-client the same.

3.1.4. Messages

3.1.4.1. Send "DISPLAY" from Agent to Controller : 03 41 00 01 ff a1 + 16*2 bytes of text