berhsi/doorstatus
Archived
1
0
Fork 1
Code Issues 2 Pull requests Releases Wiki Activity

Compare commits

base: berhsi:33cde3e602ca67a8e2c72c794770193edbe2e0d9
Branches Tags
berhsi:master
...
compare: berhsi:8b2362e3a357cab6bfb20a795082b423f2938c69
Branches Tags
berhsi:master

3 commits
33cde3e602 ... 8b2362e3a3

Author SHA1 Message Date
berhsi 8b2362e3a3 Merge pull request 'documentation' (#5) from fiveop/doorstatus:documentation into master 
Reviewed-on: http://git.nr18.space:3000/berhsi/doorstatus/pulls/5
 2020-12-11 14:57:36 +01:00
Philipp Matthias Schaefer d959e044fd Mention Space API 2020-11-26 09:15:31 +01:00
Philipp Matthias Schaefer 868c0bd285 Change Arduino's description from broadcast to UDP req/resp 2020-11-26 09:15:31 +01:00
1 changed files with 6 additions and 6 deletions
Show stats Expand all files Collapse all files

12
README.md
View file

@ -8,16 +8,16 @@ 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 door, a Python script on a local server, and an API file served on by web
server. server.
The Arduino broadcasts the current state of the door lock to our LAN. The state The Arduino provides the current state of the door lock upon request via UDP.
is determined by a reed sensor in the door lock. In addition, it controls an The state is determined by a reed sensor in the door lock. In addition, it
RGB LED matrix shield that provides a visual indication of the door locks's controls an RGB LED matrix shield that provides a visual indication of the door
state in the room. locks's state in the room.
The python script polls the broadcast state and pushes changes to Twitter, The python script polls the broadcast state and pushes changes to Twitter,
Mastodon and our API file. Mastodon and our API file.
The API file is just that, a JSON file. It contains, among other things, the The API file follows the [Space API](http://spaceapi.net) specification, which
current state of the door lock. includes a field indicating whether the space is open or closed.
## Arduino ## Arduino