Installation and Usage of the Regula Document Reader on Linux Ubuntu

• Summary
• Requirements
• Steps
• Verification
• Common errors

Summary

This article describes two ways to install and launch the Regula Document Reader demo application:

• via the prebuilt regula-reader package
• via manual compilation using CMake and Qt

Requirements

• Linux OS (Debian, Ubuntu, RHEL)
• Administrator privileges (sudo)
• Internet connection to install packages

Steps

Option 1: Installation via package

1. Install the base or developer package:

   sudo apt-get install regula-reader

   or

   sudo apt-get install regula-reader-dev

2. Navigate to the application directory:

   cd /usr/lib/regula/

3. Run the demo application:

   ./RegulaDocumentReader

4. Click Connect to connect the reader:

   

Option 2: Manual build using custom Qt

1. Install CMake and a Qt development package:

   sudo apt-get install cmake qtbase5-dev

   For RHEL:

   sudo yum install cmake qt5-qtbase-devel

   If using a custom build of Qt, make sure QTDIR or PATH is configured.

2. Run the build command:

   cmake -DCMAKE_BUILD_TYPE=Release -S /usr/share/regula/Examples/RegulaDocumentReader-src -B <BUILD_PATH>

   • <BUILD_PATH> — the directory where build files will be placed
3. Go to the build directory:

   cd <BUILD_PATH>

4. Launch the application:

   ./RegulaDocumentReader

5. Click Connect to connect the reader:

   

Verification

• The application launches without errors.
• The reader connects after clicking Connect.
• Place a document and click Process:

  

• You will see the document image and RFID binary result:

  

Common errors

• Application is unresponsive when connecting → Ensure there are no foreign objects in the reader’s scan area. Click Wait:

  

• Qt is not found by CMake → Manually specify the Qt path using -DCMAKE_PREFIX_PATH:

  cmake -S ... -DCMAKE_PREFIX_PATH=/opt/Qt/5.15.2/gcc_64