From 367191aa5d917b465bda312104283cc1d7f8f941 Mon Sep 17 00:00:00 2001
From: Filip B P <bpfilip@gmail.com>
Date: Wed, 30 Aug 2023 10:50:59 +0200
Subject: [PATCH] Added problemformulering, devices and card reader section

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 54 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 19e8b02..29156c1 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,57 @@
 
 ## Problemformulering
 
-Vi ønsker at lave et alarm system. 
-Systemet skal kunne styre låse, reagere på bevægelses sensorer, lyde en alarm, blinke en led og låses op med nøglekort og en simpel web-interface til låsning og oplåsning.
+We want to make an alarm system.
+The system must be able to control locks, react to motion sensors, sound an alarm, flash a LED and be unlocked with a key card and a simple web interface for locking and unlocking.
+
+## Løsningmodel
+
+## Udfordringer
+
+## Devices
+
+- [card-reader](#card-reader)
+- [display](#display)
+- [door-sensor](#door-sensor)
+- [motion-sensor](#motion-sensor)
+
+### Card reader
+
+The card reader consists of an ESP8266 Wemos D1 Mini board and a PN-5180-NFC reader.
+When a card is read the device sends a MQTT message to the broker.
+The controller runnning on the Pi subscribes on the event and unlocks the door and if the alarm is armed disarms it.
+
+The NFC reader reads the serial number of the NFC card or tag and transmits it, the controller checks the serial against a list of known serial numbers.
+
+#### Source code
+
+The source code can be found at https://git.bpfilip.dk/HFJ/alarm-card-reader
+
+#### Hardware connections
+
+| ESP8266 | PN-5180-NFC |
+| ------- | ----------- |
+| 3.3v    | 3.3v        |
+| 5v      | 5v          |
+| D1      | RST         |
+| D2      | NSS         |
+| D7      | MOSI        |
+| D6      | MISO        |
+| D5      | SCK         |
+| D0      | BUSY        |
+| GND     | GND         |
+
+### Display
+
+The display module consists 
+
+#### Source code
+
+The source code can be found at https://git.bpfilip.dk/HFJ/alarm-card-reader
+
+#### Hardware connections
+
+| ESP8266 | 16x2 LCD Display |
+| ------- | ---------------- |
+| 3.3v    | 3.3v             |
+| GND     | GND              |