add more documents

This commit is contained in:
Vector Von 2022-07-04 21:01:19 +08:00
parent 59aa8c6c1c
commit 8e81f0ce49
3 changed files with 31313 additions and 4 deletions

View File

@ -4,9 +4,11 @@
[用户手册](doc/user_manual.md)
[开发者手册](doc/develop.md)
## 什么是 Topuino
Topuino 是一个桌面小摆件,可以实现通用服务器或计算机的数据监控,包括 CPU 占用、RAM 占用、两个硬盘的可用空间、硬盘读写速度、网络 IO 速率。
Topuino 是一个桌面小摆件,可以显示服务器或电脑的项性能监控数据,包括 CPU 占用、RAM 占用、两个硬盘的可用空间、硬盘读写速度、网络 IO 速率。
![](https://img.vvzero.com/ih/5d606a6c-926f-4690-8924-8931ec0f5f97.jpg)
@ -16,8 +18,24 @@ Topuino 是一个桌面小摆件,可以实现通用服务器或计算机的数
在选型的时候,为了兼顾开发效率和成本,项目选用了大名鼎鼎的 ESP8266 单片机,配合了 Arduino 开发框架Arduino 则是 Topuino 中 uino 的由来。
## 快速上手
将 Topuino 通过 USB 线连在 Windows 电脑上,运行 Windows 客户端,即可显示当前 Windows 电脑的各项性能监控数据。
## Topuino 的工作原理
- 服务端使用了 Flask维护一个内存数据库实际上是 Python 的字典保存着从站被监控服务器UUID 与运行参数的映射关系。主站接收从站的运行数据,并向 Topuino 回传数据;
- 客户端采用 python 的 psutil 库,获取所有的运行数据;
- 硬件端使用了 ESP-12F 作为 MCU显示采用 LED 阵列和数码管,显示驱动是 TM1638 芯片。
Topuino 可以工作在三种模式下,分别为 USB 模式、在线模式和本地模式,可通过按键在三个模式间切换。
### USB 模式
Topuino 自带一个 USB 转串口芯片,客户端扫描连接到本机的串口,如果扫描到 Topuino就会向它直接发送电脑性能监控数据并显示在面板上。
### 在线模式
服务端使用了 Flask维护一个内存数据库实际上是 Python 的字典保存着客户端被监控服务器UUID 与运行参数的映射关系。服务端接收客户端的性能监控数据,并向 Topuino 回传数据。
### 本地模式
在本地模式下,连接上 WiFi 后的 Topuino 会显示其自身的 IP。在填写好 Topuino 的 IP 后,客户端就会以 UDP 的形式向 Topuino 发送性能监控数据。
更多信息请访问开头的用户手册和开发者手册。

3
doc/develop.md Normal file
View File

@ -0,0 +1,3 @@
# Topuino 开发者手册
[原理图](schematic.pdf)

31288
doc/schematic.pdf Normal file

File diff suppressed because it is too large Load Diff