From cc4329f220fb1cbee62297bd6b0fcf909b0f2f61 Mon Sep 17 00:00:00 2001 From: Dana Woodman Date: Sun, 4 Mar 2018 14:38:24 -0800 Subject: [PATCH] Readme --- readme.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 2cecfc8..0316da5 100644 --- a/readme.md +++ b/readme.md @@ -17,14 +17,26 @@ The RFID doorlock consists of a few components that allow us to have a offline c Currently, we are using Cobot to manage our membership as well as RFID card numbers (checkin tokens in Cobot parlance). -The doorlock consists of a Tessel microcontroller powered by node.js (JavaScript). The doorlock has an attached USB adapter with an SD card to store the member's cards (in `json` format). A USB powered RFID card reader (125khz) is plugged into the other Tessel USB port. This reader behaves like a keyboard; when a card is scanned it sends a string of card numbers as keys with a newline character. +### Tessel Microcontroller + +The doorlock consists of a Tessel microcontroller powered by node.js (JavaScript). The doorlock has an attached USB adapter with an SD card to store the member's cards (in `json` format). + +### USB RFID Reader + +A USB powered RFID card reader (125khz) is plugged into the other Tessel USB port. This reader behaves like a keyboard; when a card is scanned it sends a string of card numbers as keys with a newline character. The application listens for card scan events and when one if found, it looks the card number up in a local database (the above mentioned `json` file). If it finds a card, it opens the door, if not it shows an error message. +### Door Latch + To open the door, we use a relay (or optionally a TIP120 transistor) which powers a 12v door latch. If no power is sent to the door latch, it remains locked. When it gets a 12v current it opens and allows the member entry. +### OLED Display + Whether a success or failure, we should details on an attached OLED display as well as when the card list updates or other unexpected issues. +### API Member RFID Card Sync + When the device first turns on it connects to WiFi and then fetches all the member RFID cards from the Cobot checkin token API and then updates the `json` card file. It completely overwrites the existing list of cards. If there is a failure getting the cards, we keep the original card list as a fallback. Eventually, we can remove Cobot and swap it with our own service if we desire.