Add installation docs

Author: fstachura

README.md

@@ -1,2 +1,33 @@
 # nfc-lock
 NFC door lock
+
+## Installation
+
+1. `apt install python3-pip python3-systemd build-essential openssl`
+2. `cd /opt/`
+3. `git clone https://github.com/KSIUJ/nfc-lock`
+4. `pip3 install -r requirements.txt`
+6. `mkdir crt`
+7. `openssl req -x509 -newkey rsa:4096 -keyout cert/$(hostname).key -out cert/$(hostname).crt -nodes -days 365` 
+5. `cp -r config-example/ config`, change relevant values in `config`
+6. Create `/etc/systemd/system/nfc-lock.service`, contents below
+7. `systemctl daemon-reload; systemctl restart nfc-lock`
+
+`/etc/systemd/system/nfc-lock.service`:
+```
+[Unit]
+Description=NFC door lock
+After=multi-user.target
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/nfc-lock
+ExecStart=/usr/bin/python3 -u /opt/nfc-lock/app.py
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Remember to adjust `WorkingDirectory` and `ExecStart`
+

config-example/erc_secret.py

@@ -1,2 +1,3 @@
+# Visible in ERC -> Clients 
 client_id = '1234567890asdgfghjklll'
-client_secret = '3434534534534535j3k4jhkj4h5k3jh45k3jh453'
+client_secret = '3434534534534535j3k4jhkj4h5k3jh45k3jh453'

config-example/main.py

@@ -1,31 +1,37 @@
+# Path to NFC reader USB device
 nfc_reader = {
     'input_device': '/dev/input/by-id/usb-IC_Reader_IC_Reader_08FF20171101-event-kbd'
 }
 
+# GPIO mappings for info LEDs. Skip if no LEDs were attached.
 led = {
     'green_gpio': 7,
     'green_reversed': False,
     'red_gpio': 11,
     'red_reversed': False
 }
 
+# Lock configuration
 lock = {
     'lock_gpio': 40,
     'opening_time': 5,
     'lock_reversed': True
 }
 
+# Configuration for a server that allows to remotely open the door
 server = {
     'port': 1234,
     'cert_file': '/opt/nfc-lock/cert/lock.crt',
     'key_file': '/opt/nfc-lock/cert/lock.key'
 }
 
+# ERC server endpoint
 erc = {
     'endpoint': 'https://ercendpoint.com'
 }
 
+# IDs of cards that can open the door when ERC is not available
 hardcoded_uid = [
     "12345678",
     "90abcdef"
-]
+]

config-example/server_secret.py

@@ -1 +1,2 @@
-password = 'password'
+# Secret password for some undocumented api that unlocks the door
+password = 'password'

requirements.txt

@@ -0,0 +1,3 @@
+evdev~=1.4.0
+requests~=2.25.1
+urllib3~=1.26.5