diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9d2dad --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Topuino + +[English](doc/README_en.md) + +[用户手册](doc/user_manual.md) + +## 什么是 Topuino + +Topuino 是一个桌面小摆件,可以实现通用服务器或计算机的数据监控,包括 CPU 占用、RAM 占用、两个硬盘的可用空间、硬盘读写速度、网络 IO 速率。 + +![](https://img.vvzero.com/blog/Topuino-the-wonderful-Knickknack-for-server-monitoring/1.png) + +## 为什么叫 Topuino + +在 Linux 系列服务器上,通常使用 top 命令查看 CPU 内存占用,本项目最初的设想也是将 top 命令实物化,这就是 Topuino 中 Top 的由来。 + +在选型的时候,为了兼顾开发效率和成本,项目选用了大名鼎鼎的 ESP8266 单片机,配合了 Arduino 开发框架,Arduino 则是 Topuino 中 uino 的由来。 + +## Topuino 的工作原理 + +- 服务器部分:主站使用了 Flask,维护一个数据库,保存着从站(被监控服务器)UUID 与运行参数的映射关系(实际上现在是用 python 的字典简单实现的)。主站接收从站的运行数据,并向 Topuino 回传数据; +- 服务器从站采用 python 的 psutil 库,获取所有的运行数据; +- Topuino 硬件部分使用了 ESP-12F 作为 MCU,显示采用 LED 整列和数码管,显示驱动是 TM1638 芯片。 diff --git a/doc/README_en.md b/doc/README_en.md new file mode 100644 index 0000000..2750f6b --- /dev/null +++ b/doc/README_en.md @@ -0,0 +1,5 @@ +# Topuino + +Topunio is a wonderful knickknack for server monitoring. CPU usage, RAM usage, disk usage, disk I/O and network I/O can be displayed on Topuino. + +![](https://img.vvzero.com/blog/Topuino-the-wonderful-Knickknack-for-server-monitoring/1.png) diff --git a/doc/user_manual.md b/doc/user_manual.md new file mode 100644 index 0000000..5780750 --- /dev/null +++ b/doc/user_manual.md @@ -0,0 +1,3 @@ +# Topuino 用户操作手册 + +TODO...