Skip to content

Linux

Prerequisites

To install the SDK, you need a 64-bit version of one of the following supported OS versions:

Ubuntu

  • Ubuntu 16.04 (xenial)
  • Ubuntu 18.04 (bionic)
  • Ubuntu 20.04 (focal)

Debian

  • Debian 9 (Stretch)
  • Debian 10 (Buster)
  • Debian 11 (Bullseye)

CentOS

  • CentOS 7
  • CentOS 8

Info

The SDK is supported onx86_64or(amd64)architectures.

Available packages

regula-reader

Core SDK for support of optical and RFID reader devices.

regula-reader-dev

Resources for developers:

  • documentation
  • examples
  • headers

Documentation and examples can be found in the following folder:

/usr/share/regula

regula-reader-service

A local web service to communicate with reader devices via JavaScript calls using the Socket.IO library. You can view an example web page by opening http://localhost:3000/. You can find the source code of the page here:

/usr/share/regula/Examples/LocalServiceExample

Install SDK

Install using the repository

Set up the repository

1. Update the apt package index and install packages to allow apt using the repository over HTTPS:

sudo apt-get update
sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

2. Add the Regula official GPG key:

curl -fsSL https://downloads.regulaforensics.com/repo/ubuntu/regula.gpg | sudo apt-key add -

3. Use the following command to set up the stable repository:

sudo add-apt-repository \
    "deb [arch=amd64] https://downloads.regulaforensics.com/repo/ubuntu \
    $(lsb_release -cs) \
    stable"

Install SDK

1. Update the apt package index and install the latest version of the SDK, or go to the next step to install a specific version:

sudo apt-get update
sudo apt-get install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required version:

a. List the versions available in your repo:

apt-cache madison regula-reader

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader=<VERSION>

Set up the repository

1. Update the apt package index and install packages to allow apt using the repository over HTTPS:

sudo apt-get update
sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

2. Add the Regula official GPG key:

curl -fsSL https://downloads.regulaforensics.com/repo/debian/regula.gpg | sudo apt-key add -

3. Use the following command to set up the stable repository:

sudo add-apt-repository \
    "deb [arch=amd64] https://downloads.regulaforensics.com/repo/debian \
    $(lsb_release -cs) \
    stable"

Install SDK

1. Update the apt package index and install the latest version of SDK, or go to the next step to install a specific version:

sudo apt-get update
sudo apt-get install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required version:

a. List the versions available in your repo:

apt-cache madison regula-reader

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader=<VERSION>

Set up the repository

Install the yum-utils package (which provides the yum-config-manager utility) and set up the stable repository:

sudo yum install -y yum-utils
sudo yum-config-manager \
    --add-repo \
    https://downloads.regulaforensics.com/repo/centos/regula.repo

Install SDK

1. Install the latest version of the SDK or go to the next step to install a specific version::

sudo yum install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required version:

a. List the versions available in your repo:

sudo yum list regula-reader --showduplicates | sort -r

b. Install a specific version by its fully qualified package name:

sudo yum install regula-reader-<VERSION>

Install from a package

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: debconf (>= 0.2.26), libusb-1.0-0 (>= 2:1.0.20), udev, pcscd, libccid.

1. Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader/, browse the required package dir and download the .deb file for the SDK version you want to install:

wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader/<package>.deb

2. Install the SDK:

sudo dpkg -i <package>.deb

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: debconf (>= 0.2.26), libusb-1.0-0 (>= 2:1.0.20), udev, pcscd, libccid.

1. Open https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader/, browse the required package dir and download the .deb file for the SDK version you want to install:

wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader/<package>.deb

2. Install the SDK:

sudo dpkg -i <package>.deb

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: libusb, pcsc-lite.

1. Open https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/ and download the .rpm file for the SDK version you want to install:

wget https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/<package>.rpm

2. Install the SDK:

sudo rpm -ivh <package>.rpm
Back to top