FabKey

Completely opensource Arduino-based access control system for FabLabs/Hackerspaces/any collaborative space which needs cheap access control Support Wiegand readers with keypad too (like Smartec ST-PR160EK) Based on software Ardiuno interrupts and timers. Easy control it via web browser or Telegram bot. Is possible to add customs scripts for opening doors (e.g. if you have two doors and you need to open it one by one for current balancing) Backend is based on Perl.

Features

• Two Wiegand readers: one with keypad for entrance and one without keypad for exit
• One door relay
• Multiple pins for alarms
• Support of 7 and 8 bit
• keypad code both (universal way of detecting end of transmission)
• Email or(and) Telegram notifications and alarms
• Universal (tested at Arduino Duemilanove + OrangePi but can work with any Arduino and single board linux computer)
• highly configurable code

Possible configuration

1. Single-board computer only. Use pigpio or WiringPi libraties for working with Wiegand protocol and control relays. This comfiguration strongly needs optoisolation cause diodes can't save SoC from damage by static electricity from Wiegand readers.
2. Arduino-only (Arduino Yun or Arduino Uno + Ethernet shield).
3. Single-board computer + Arduino or Arduino-based board. Database of users can be stored in Arduino (if not so much users) or in single-board computer.

For more information please check wiki

Running

The simplest way is to run from dockerizing

curl -sSL https://get.docker.com | sh - # install docker if not installed
cd data # go to dir where you want to place SQLite database
docker run -v ${PWD}:/fabkey/data pavelsr/fabkey:armhf perl db.pl -a deploy_db -d data/skud.db
docker run -v ${PWD}:/fabkey/data perl db.pl -a manage users insert telegram_username serikoff -d data/skud.db
docker run -v ${PWD}:/fabkey/data perl db.pl -a manage users update telegram_username serikoff  # add pin
docker run -v ${PWD}:/fabkey/data perl db.pl -a manage doors insert name Main_door -d data/skud.db
docker run -v ${PWD}:/fabkey/data perl db.pl -a manage doors update name Main_door # add gpio_pin or opening_script
# docker run -v ${PWD}:/fabkey/data pavelsr/fabkey:armhf perl db.pl -a demo_data -d data/skud.db # or simply execute instead last 4 strings for inserting demo data
docker run -d --restart=always --name fabkey -e "FABKEY_BOT_TOKEN=<paste_your_token_here>" -e "FABKEY_DBI=dbi:SQLite:dbname=data/skud.db" --privileged -v ${PWD}:/fabkey/data pavelsr/fabkey

You can add docker to upstart:

sudo systemctl enable docker

Managing users

Currently there is two possible options - bot commands or console. UI is in development

Bot commands

If is_admin = 1 user can add other users via /admin and /approve commands

To request an access each user can send /addme command

Also fabKey comes with db.pl script for managing database via console

List of all commands (for /setcommands of @BotFather):

open - Open selected door
users_in - Show who inside CMIT
checkin - Send this command when you just come to CMIT
checkout - Send this command when you are leaving CMIT
admin - Show all approval requests
approve - Approve particular user (forward admin message back to bot)

Console

Managing users:

docker exec -it db.pl -a manage [users|doors] [insert|update|delete]

Quick add/remove/update:

docker exec -it db.pl -a manage users delete telegram_username serikoff

Interactive mode:

docker exec -t -i fabkey db.pl -a manage add users

config.json (using in dev machine) example

{
 "FABKEY_BOT_TOKEN": "441592632:AAEACcNg6CXM_As4-zg4m68WrChis547ixt",
 "DBI": "dbi:SQLite:dbname=skud.db",
 "GPIO_MODE": "bcm",
 "DEFAULT_TIMEOUT_SEC": 3,
 "PERMSISSIONS_MODE": "allow",
 "TG_MESSAGE_ACTUALITY_SEC": 30,
 "MAIN_SRV_URL" : "http://127.0.0.1:3010"
}

Managing database via third-party tools

WebUI and API

Feature is in development :)

Since web ui is not ready yet, now you can use following options to manage database content from browser or terminal (ncurses-based guis)

sqlite-web

For now the best option is sqlite-web (unfortunately it doesn't allow to edit rows)

sudo apt-get install python-pip
sudo pip install sqlite-web
sqlite_web skud.db -x -d -H 0.0.0.0

For constant monitoring of your DB via web interface you can run docker container (run command below from folder where your database is stored)

sudo docker run -d --restart=always -v ${PWD}:/root -p 80:8080 pavelsr/sqlite_web:armhf skud.db

sqlcrush

I have no succeed with this, but you can try

sudo apt-get install postgresql libpq-dev
sudo pip install sqlcrush
sqlcrush -t sqlite -d skud.db

when editing a database I have a CRITICAL FAILURE... github issue

sqlectron (for MySQL and PostgreSQL only now)

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt install nodejs

App::DBBrowser

Also just view database content

sudo cpanm App::DBBrowser