From 868c0bd28554437231549bd075aacd7abff8d5d8 Mon Sep 17 00:00:00 2001 From: Philipp Matthias Schaefer Date: Sat, 21 Nov 2020 21:42:24 +0100 Subject: [PATCH 1/2] Change Arduino's description from broadcast to UDP req/resp --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c9c2da4..e1d9d36 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ 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 Arduino provides the current state of the door lock upon request via UDP. +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. From d959e044fde94ba031c4a01f3f3806633f3c1132 Mon Sep 17 00:00:00 2001 From: Philipp Matthias Schaefer Date: Sat, 21 Nov 2020 21:43:07 +0100 Subject: [PATCH 2/2] Mention Space API --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1d9d36..ec54111 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ 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. +The API file follows the [Space API](http://spaceapi.net) specification, which +includes a field indicating whether the space is open or closed. ## Arduino