From e79eecf3abb4cd1756e2cdad3da58d9f975d79f1 Mon Sep 17 00:00:00 2001
From: chris <chris@noreply.gitea.crescentec.ch>
Date: Thu, 9 Oct 2025 20:24:12 +0200
Subject: [PATCH] readme

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d930be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Presence detector for esp32-C6
+
+This project is a the implementation of a presence detector. It runs on an esp32-C6 with an HMMD wave sensor both from waveshare. It sends a signal to zigbee using the ZigbeeOccupancySensor library. 
+
+## Complilation on arduino
+
+The following config should be enabled on arduino to compile and upload the code on your board
+
+![Arduino configuration](/arduino_config.png)
+
+## Zigbee2MQTT
+
+- Add manually the device to zigbee by adding the following to the devices.yaml file (usually found in opt/zigbee2mqtt/data, if not present, create it). Dont forget to change the device_id with yours :
+
+```yaml
+'device_id':
+  friendly_name: "ESP32 Presence Detector"
+  model: "Presence detector"
+  manufacturer: "EspressIf"
+  description: "Custom ESP32 Zigbee Occupancy Sensor"
+  exposes: [
+    {
+      "name": "occupancy",
+      "property": "occupancy",
+      "type": "binary",
+      "access": 1,
+      "description": "Indicates whether the area is occupied",
+      "value_on": true,
+      "value_off": false
+    }
+  ]
+  options: []
+```
+
+
+
+- On zigbee, you will have to bind the device to the coordinator
+![Zigbee bind configuration](/zigbee_bind.png)
+
+- Then you will have to add a reporting
+![Zigbee reporting configuration](/zigbee_reporting.png)
\ No newline at end of file