summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2022-05-15 11:53:40 +0200
committerxengineering <me@xengineering.eu>2022-05-15 11:56:00 +0200
commit466dd4caeac90dace337c6604e770f0470aee495 (patch)
tree0f9cbde1a5e67f62ca90e045cf1f3d0c7ea4ff18 /README.txt
downloadwebiot-466dd4caeac90dace337c6604e770f0470aee495.tar
webiot-466dd4caeac90dace337c6604e770f0470aee495.tar.zst
webiot-466dd4caeac90dace337c6604e770f0470aee495.zip
Publish code
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..a78de7c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,35 @@
+
+
+------
+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/