TOUCHLAB SDK
JENETRIC GmbH

--- Documentation ---
The API documentation is provided in the subfolder "help" under the TOUCHLAB SDK <INSTALLATION_FOLDER>. 
Execute "index.html" to read the documentation.

--- CHECKBOX Documentation ---
The CHECKBOX tool documentation is provided online in the JENETRIC Support Center. 

--- Update of Scanner ---
Prior to the update, you need to install the scanner driver!

The firmware updater you can find under:
<INSTALLATION_FOLDER>\FirmwareUpdater.exe

Options:
  -h [ --help ]         Print help messages
  -u [ --update ] arg   Update using the update.json file <arg>
  -s [ --silent ]       Updates silently without confirmation
  -o [ --override ]     Update regardless of version constraints
  -i [ --info ]         Info (provide scanner information)

Please use the "<INSTALLATION_FOLDER>\firmware_files\" folder (incl. the config file named: update.json and all necessary files)

Sample call to get all information form the connected scanner:
FirmwareUpdater.exe -i

Sample call of a normal update:
FirmwareUpdater.exe -u .\firmware_files\update.json

Sample call of a silent update:
FirmwareUpdater.exe -u .\firmware_files\update.json -s

Sample call of an override update (for override the same version or downgrade version):
FirmwareUpdater.exe -u .\firmware_files\update.json -o

The possible error codes:
    STATUS_NO_ERROR              = 0: no error
    STATUS_INVALID_ARGUMENT      = 1: invalid argument or parameter
    STATUS_FILE_NOT_FOUND        = 2: file not found
    STATUS_INVALID_CONFIG        = 3: invalid configuration file
    STATUS_NO_SCANNER            = 4: no scanner detected or scanner is already in use by another program
    STATUS_INVALID_SCANNER_COUNT = 5: more than one scanner detected - only a single one is allowed
    STATUS_CONNECTION_ERROR      = 6: scanner connection was interrupted
    STATUS_INVALID_CHECKSUM      = 7: invalid checksum of file
    STATUS_USER_CANCELED         = 8: user canceled the update
    STATUS_INCORRECT_VERSION     = 9: provided firmware version is equal or lower than the installed firmware
    STATUS_INVALID_REVISION      = 10: provided firmware does not match to hardware revision
    STATUS_UNKNOWN               = 11: unknown error
    STATUS_JAM_NOT_SUPPORTED     = 12: writing the provided JAM file is not supported

--- Driver ---
The TOUCHLAB SDK installation packages contain signed drivers for 32-bit and 64-bit operating systems and SDK binaries compiled for x86 and x64 CPUs.
We provide several setup variants as MSI package:
- setup_touchlab_sdk_<version>_drv32_x86.msi
- setup_touchlab_sdk_<version>_drv64_x86.msi
- setup_touchlab_sdk_<version>_drv64_x64.msi

Note: The suffixes "_drv32" or "_drv64" describe the driver version inside the installer package.
The SDK API architecture itself is denoted by "_x86" and "_x64" suffixes.

Installation of "setup_touchlab_sdk_<version>_<os_arch>_<sdk_arch>.msi".
This package contains an appropriate driver either for 32-bit or for 64-bit Windows operating systems. This driver will be installed automatically! 

To manually install the driver kindly execute the following steps:
    1)   Go to the device manager and search for FX3 device.
    2)   Right-click on FX3 and select installing driver.
    3)   Select driver from computer than go to <INSTALLATION_FOLDER>\driver\x86 or <INSTALLATION_FOLDER>\driver\x64 (depending on operating system architecture).
    4)   Confirm the security warning by clicking Install.
    5)   Done. Now you should find JENETRIC device in the device manager.