Document Reader SDK installation for a hardware reader in Linux

Summary

This guide describes two ways to work with a document reader device on Linux OS: directly using libraries or via the Local Service SDK.

• Working directly with libraries
• Working with Local Service SDK for Linux

Requirements

• Linux operating system (Ubuntu, Debian, CentOS)
• Internet connection to download packages
• Root permissions to install the software

Required Actions

Option 1: Working Directly with Libraries

1. Visit the documentation page: Linux - Desktop SDK
2. Install the following packages:
   • regula-reader — core libraries
   • regula-reader-dev — development kit
3. Explore the sample project RegulaDocumentReader, which demonstrates how to process data and get results in XML format. The relevant file is located at:

   /usr/share/regula/Examples/RegulaDocumentReader-src/documentreader.cpp

4. In the documentreader.cpp section, you can find examples of working with the optical module (PasspR) and RFID.
5. Sample code:

   long DocumentReader::ConnectPasspr() // connect to PasspR
   
   long DocumentReader::ConnectRFID // connect to RFID
   
   long DocumentReader::Process(intptr_t processingMode) // process optical part and RFID

Documentation

• Programmers Guide (en).pdf
• RFID SDK Programmer's Guide

Option 2: Working with Local Service SDK

1. Refer to the documentation: Linux - Desktop SDK (regulaforensics.com)
2. Install the following packages:
   • regula-reader
   • regula-reader-service
3. A JavaScript-based example demonstrating device interaction via the Local Service using the Socket.IO library is available at:

   /usr/share/regula/Examples/LocalServiceExample

4. You can test the service by opening the demo page in your browser: http://localhost:3000/

Verification

• When using libraries: verify that the functions ConnectPasspr, ConnectRFID, and Process execute successfully and return valid results.
• When using Local Service: make sure the service is running and the demo page http://localhost:3000/ is accessible.

Common Errors

• documentreader.cpp not found → Ensure the regula-reader-dev package is installed.
• Service fails to start → Check its status using command systemctl status regula-reader-service.
• No connection to the device → Verify the USB connection and user permissions.