Skip to content

Self-service access control device. Reads barcodes, connecs to a REST API, and sends an electric impulse to a relay.

License

Notifications You must be signed in to change notification settings

Hypernova-Oy/SSAuthenticator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SSAuthenticator

SSAuthenticator is a system daemon that controls access to a library using Koha instance's REST API and its local cache as fallback.

This is part of the emb-toveri repository, which explaings the hardware configuration and assembly.

Installation

Prerequisites:

  • Barcode reader that has a serial interface. The device should show up in the following format /dev/ttyACM?, where '?' is some integer.

  • If using Datalogic GFS4400 you should put the device to serial mode by scanning the QR code provided in the manual for interface 'USB-COM'.

  • The reading from the barcode scanner should end in a newline character ('\n').

Raspian:

$ wget https://raspberry.znix.com/hipifiles/hipi-install
$ sudo perl hipi-install

# Download debian package from https://github.com/KohaSuomi/SSAuthenticator/releases, for example:
$ wget https://github.com/KohaSuomi/SSAuthenticator/releases/download/v0.10/authenticator_0.10-1_all.deb

$ sudo dpkg -i authenticator_<version>_all.deb
$ sudo apt-get install -f

# Edit configure file (mandatory)
# Instructions on how to do that are provided in that file
$ sudo $EDITOR /etc/authenticator/daemon.conf

# Finally reboot in order for the barcodescanner udev rules to take place
$ sudo reboot

Development

For development and packaging you want the following packages:

Rasbian:

$ sudo apt-get install perl libtest-simple-perl libtest-mockmodule-perl \
libmodern-perl-perl libconfig-simple-perl libdbm-deep-perl \
libwww-perl libjson-perl libsys-sigaction-perl libdatetime-perl \
libdatetime-format-http-perl libdigest-sha-perl

Release process

$ git clone https://github.com/KohaSuomi/SSAuthenticator --depth=1

$ cd SSAuthenticator

# Update version number in lib/SSAuthenticator.pm
$ $EDITOR lib/SSAuthenticator.pm

# Update Debian changelog (see how the old entries are and copy&paste
# new entry to the changelog). Most important thing is to modify the version.
# The version should be in the format X.XX-1 where X.XX is your version.
$ $EDITOR debian/changelog

# Build .deb package
# The package will be in ../SSAuthenticator-packaging/ (if everything went fine)
$ ./release.sh

After that you can create in Github a new release and attach the generated Debian package to it. Use format vX.XX for the release tag (where X.XX is the version number)

License

SSAuthenticator is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

SSAuthenticator is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with SSAuthenticator; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

About

Self-service access control device. Reads barcodes, connecs to a REST API, and sends an electric impulse to a relay.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •