From e5109815e75bd146fb09d57a72e263c08de7b1a7 Mon Sep 17 00:00:00 2001 From: Philipp Matthias Schaefer Date: Wed, 18 Nov 2020 21:56:24 +0100 Subject: [PATCH] Add README.md including overview and headings for detailed sections. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..06cb652 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# KrautStatus + +This repository contains documentation and sources of KrautStatus. KrautStatus +is the n-th iteration of a software/hardware project to communicate whether +Jena's Krautspace is open or closed. + +KrautStatus consists of three components: an Arduino-sensor-combination at the +door, a Python script on a local server, and an API file served on by web +server. + +The Arduino broadcasts the current state of the door lock to our LAN. The state +is determined by a reed sensor in the door lock. In addition, it controls an +RGB LED matrix shield that provides a visual indication of the door locks's +state in the room. + +The python script polls the broadcast state and pushes changes to Twitter, +Mastodon and our API file. + +The API file is just that, a JSON file. It contains, among other things, the +current state of the door lock. + +## Arduino + +## Python Script + +## API