Hilde/doorstatus
1
0
Fork 0
forked from Krautspace/doorstatus
Code Pull requests Activity

Add README.md including overview and headings for detailed sections.

Browse source
This commit is contained in:
Philipp Matthias Schaefer 2020-11-18 21:56:24 +01:00
parent 3d824a1c4c
commit e5109815e7
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md Normal file
View file

@ -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