diff --git a/README.md b/README.md index c9c2da4..ec54111 100644 --- a/README.md +++ b/README.md @@ -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 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. -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