summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2025-12-20 15:08:32 +0100
committerxengineering <me@xengineering.eu>2025-12-20 15:08:32 +0100
commit248fc6d1ef0a40c691a341589c5327f7e995ef14 (patch)
treed01463e756790c27af0defe20161102a9e90681f
parentfe3d36791e3fa97d4f03639b6c7f8a2d61e28a0b (diff)
downloadsia-server-248fc6d1ef0a40c691a341589c5327f7e995ef14.tar
sia-server-248fc6d1ef0a40c691a341589c5327f7e995ef14.tar.zst
sia-server-248fc6d1ef0a40c691a341589c5327f7e995ef14.zip
Add README with description and hardware support
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eaa4841
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Sia server
+
+Sia server is an Internet of Things (IoT) server. It should be compatible with
+multiple devices from different vendors. The user interface should be
+implemented by apps connecting to this central Sia server.
+
+## Supported vendors and devices
+
+Currently only [Homematic IP][1] as a vendor and the [OpenCCU][2] as interface
+is supported.
+
+The currently only supported device is:
+
+- [HmIP-SWDO-2][3] - optical window or door contact
+
+Further device support is planned.
+
+[1]: https://homematic-ip.com/
+[2]: https://openccu.de/
+[3]: https://homematic-ip.com/en/product/window-and-door-contact-optical