From 21ad62a1f8c421734189c78cf55dd4448d99f363 Mon Sep 17 00:00:00 2001 From: Dana Woodman Date: Sun, 4 Mar 2018 14:41:54 -0800 Subject: [PATCH] Readme --- readme.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 6a66da1..6f8c5b7 100644 --- a/readme.md +++ b/readme.md @@ -33,14 +33,20 @@ To open the door, we use a relay (or optionally a TIP120 transistor) which power #### 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. +Whether a success or failure, we show 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. +We periodically sync this list every few minutes (configurable). + Eventually, we can remove Cobot and swap it with our own service if we desire. +#### Access Log + +We log every door open event so we can keep and eye on usage. We log an entry containing the member name, datetime and RFID card number in a `json` file. This list is sent to Cobot periodically so we can create a "checkin" for a member. Once the list is pushed successfully we clear out the file. + ## Development First, follow the [start guide][start] on [Tessel.io][tessel].