From 2892da8005ecfd658839b0fad9626ed6a95f712c Mon Sep 17 00:00:00 2001
From: Filip B P <bpfilip@gmail.com>
Date: Mon, 14 Aug 2023 10:50:38 +0200
Subject: [PATCH] Added MQTT api

---
 API.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..c523020
--- /dev/null
+++ b/API.md
@@ -0,0 +1,81 @@
+# API
+
+* Motion sensor
+
+	Topic: `motion`
+
+	Data example:
+
+	```json
+	{
+		"deviceId": 0,
+		"value": true
+	}
+	```
+
+* Light sensor
+
+	Topic: `light`
+
+	Data example:
+
+	```json
+	{
+		"deviceId": 0,
+		"value": 1024
+	}
+	```
+
+* Temperature sensor
+
+	Topic: `temperature`
+
+	Data example:
+
+	```json
+	{
+		"deviceId": 0,
+		"value": 20.4
+	}
+	```
+
+* Door lock
+
+	Topic: `door/lock/{deviceId}/lock`
+
+* Door unlocklock
+
+	Topic: `door/lock/{deviceId}/unlock`
+
+* Door state changed
+
+	Topic: `door/status/{deviceId}`
+
+	Data example:
+
+	```json
+	{
+		"deviceId": 0,
+		"open": true
+	}
+	```
+
+* Alarm state
+
+	Topic: `alarm/state`
+
+	Statuses:
+
+	- `Armed`
+	- `Disarmed`
+	- `Triggered`
+	- `Arming`
+	- `Disarming`
+
+	Data example:
+
+	```json
+	{
+		"status": "Disarmed"
+	}
+	```