From 5f2d0a126ba7f30738505e15284d57340750b44b Mon Sep 17 00:00:00 2001 From: Lech Perczak Date: Thu, 6 Sep 2018 00:16:33 +0200 Subject: [PATCH] Docs: Add README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e7ffcd --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Introduction + +An implementation of electric door lock controller. Currently based on Arduino. +Supporting NFC card and iButton devices as authentication keys. +Currently uses built-in key database as authentication source, but remote source is planned, +as defined in interfaces. + +# Building + +Arduino v1.8.5 or later is required as a base platform. +Required libraries: +- MFRC522 v1.3.6 or later +- OneWire v2.3.3 or later +Previous verions may work, but are untested. + + +# Further development +It is planned to abstract Arduino out, and move to +more capable platform, not depending on Arduino. +Also, LDAP support is planned instead of hardcoded key database, +over TLS-secured connection, possibly with client certificate.