VeKey Bridge Tool Manual (Windows)

1. About VeKey Bridge Tool

VeKey Bridge Tool is a connection bridge between VeKey and Web application powered by VeChain. Through restful api you can get VeKey serial number list, public information (address, public key), device information (hardware version, firmware version, alias), signature of VeKey. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/39fe798-1-2.png”, “1-2.png”, 368, 497, “#f7faf4” ] } ] } [/block] 2. VeKey Bridge Tool Overview

2.1. Tool Feature List

  1. Offering Local Http service
  2. Display VeKey device information
  3. Offering related restful API
  4. VeKey Bridge Tool upgrade on-line
  5. Support VeKey device firmware upgrade on-line

2.2. Requirements

  1. Platform: Windows 10+、.NET Framework 4.6.1+
  2. Hardware: VeKey I (for test only) or VeKey II
  3. Software: VeKey Bridge tool [block:image] { “images”: [ { “image”: [ “https://files.readme.io/2d67119-1-4.png”, “1-4.png”, 233, 270, “#e6e7e7” ], “caption”: “VeKey I(for test only)” } ] } [/block]

[block:image] { “images”: [ { “image”: [ “https://files.readme.io/77daa68-1-3.png”, “1-3.png”, 572, 283, “#cec2b9” ], “caption”: “VeKey II” } ] } [/block] 3. Instructions for VeKey Bridge Tool

3.1. Install VeKey Bridge Tool

  1. Download and install VeKey Bridge Tool (for example: VeKeyBridge 1.0.2 Setup.exe). VeKeyBridge 1.0.2 Setup.exe
  2. Double click and install according prompt content.

3.2 VeKey Bridge Tool Operation

  1. Launch VeKey Bridge Tool, central button can enable (default) or disable http service. The local http service provides lots of restful APIs, which you can communicate with the VeKey device. More detail about restful APIs, please contact bd@vechain.com. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/4225bbc-1-6.png”, “1-6.png”, 1056, 704, “#f8f9f7” ] } ] } [/block]
  2. Plug in VeKey device, then input password and select signature mode. VeKey Bridge Tool can show VeKey device type and address in the bottom zone, and you can click 99b8a465-2a70-4573-a102-f9de63e93d7d-image.png to copy the address. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/b7e7eef-1-7.png”, “1-7.png”, 954, 682, “#bfc1c0” ] } ] } [/block]

3.3 Windows tray zone

  1. When you minimize UI, application is still running at windows tray zone, double-click below icon, UI is displayed at normal status. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/567206a-1-8.png”, “1-8.png”, 324, 200, “#51575e” ] } ] } [/block]

3.4 VeKey device firmware upgrade

  1. In the bottom left-hand corner, you can find yellow icon (optional upgrade mode) or red icon (force upgrade mode) when new firmware version of VeKey is available on remote server. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/5de9e1f-1-9.png”, “1-9.png”, 1032, 688, “#f6f7f3” ] } ] } [/block]
  2. At optional upgrade mode, you can skip current upgrade. At force upgrade mode, you have to quit application or upgrade directly.

3.5 VeKey Bridge Tool upgrade

  1. If new version of VeKey Bridge Tool is available on remote server, below message pop up when you open tool or click “Check for updates” menu. If the VeKey Bridge Tool upgrade is optional, you can skip. Otherwise, you have to quit application or upgrade directly.
  2. Follow the VeKey Bridge Tool upgrading guidance, press “Next” and “Yes” to finish new version installation.

3.6 VeKey Bridge Tool Menu

  1. Click Settings and show “About”,”Check for update”,”Port Setting” and “Quit”. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/de251cc-1-10.png”, “1-10.png”, 231, 141, “#f2f2f2” ] } ] } [/block]
  2. “About” menu shows the current VeKey Brige Tool version.
  3. “Check for updates” menu shows the latest VeKey Bridge Tool version on remote server.
  4. “Port Setting” menu shows the current http service port. The default port is 8099. If the port is conflict with other service port, you can modify it between 0 –65535. Note: Stop http service in advance before you want to modify port setting.
  5. Click “Quit” menu to leave the application.

3.7. Other settings

  1. When you press Ctrl + Alt + D, debug mode is open or close. You can find log file at C:\Users{your name }\AppData\Roaming\VeKeyBridge\log\ for the further analysis. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/ab79caa-1-11.png”, “1-11.png”, 368, 497, “#f6f8f3” ] } ] } [/block]
  2. TEST icon will be shown in the top of right-hand corner when VeKey I plugs in and in signature mode.

[block:image] { “images”: [ { “image”: [ “https://files.readme.io/6c89fbe-1-12.png”, “1-12.png”, 368, 497, “#f6f9f3” ] } ] } [/block] 3. After VeKey II plugs in and in signature mode, you can click icon in the bottom righthand corner to get VeKey device information and modify alias. [block:image] { “images”: [ { “image”: [ “https://files.readme.io/7e57a28-1-13.png”, “1-13.png”, 368, 497, “#f4f6f1” ] } ] } [/block]