summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9b7181
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+
+# webiot
+
+A small webserver for my personal Internet of Things (IoT). This software is
+tailor-made for my personal need supporting only the devices I actually use.
+Nevertheless it could be interesting for you if you want to use my code for
+your project.
+
+
+## Supported IoT devices
+
+Currently only this device is supported:
+
+- tp-link HS100 WiFi plug [1]
+
+
+## Architecture
+
+There are three device categories relevant for the architecture:
+
+- IoT devices
+- webiot server
+- web clients connecting to webiot
+
+The basic idea is that the central webiot server is compatible with each IoT
+device via its native protocol (TCP, HTTP, MQTT, etc.). The user interaction is
+done only via the web interface.
+
+
+[1]: https://www.tp-link.com/en/home-networking/smart-plug/hs100/