From 5d1d9e09e3fd26228230bb325ca3d5ddf2576070 Mon Sep 17 00:00:00 2001 From: xengineering Date: Mon, 27 Mar 2023 17:33:05 +0200 Subject: 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. --- README.md | 31 +++++++++++++++++++++++++++++++ README.txt | 35 ----------------------------------- 2 files changed, 31 insertions(+), 35 deletions(-) create mode 100644 README.md delete mode 100644 README.txt 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/ diff --git a/README.txt b/README.txt deleted file mode 100644 index a78de7c..0000000 --- a/README.txt +++ /dev/null @@ -1,35 +0,0 @@ - - ------- -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/ -- cgit v1.2.3-70-g09d2