diff options
| author | xengineering <me@xengineering.eu> | 2023-03-27 17:33:05 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2023-03-27 17:33:05 +0200 |
| commit | 5d1d9e09e3fd26228230bb325ca3d5ddf2576070 (patch) | |
| tree | b71d36738059411a6b4f1a07d2f4bde45a2c7b9d /README.md | |
| parent | 99298a40a29473940e3b1b96940187d6b34cf55c (diff) | |
| download | webiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.tar webiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.tar.zst webiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.zip | |
Reformat README from plaintext to Markdown
Syntax highlighting is a nice thing and READMEs could be rendered in the
future via a CI-like build automation system.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
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/ |