From 102ff439e6fc289bff495d3618ca0f7ca1e733f9 Mon Sep 17 00:00:00 2001 From: Villivateur Von Date: Mon, 6 Sep 2021 12:40:07 +0800 Subject: [PATCH] init user manual --- doc/user_manual.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/user_manual.md b/doc/user_manual.md index 650ecd0..532fc12 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -1,9 +1,36 @@ -# Topuino 用户操作手册 +# Topuino 用户操作手册 V0.3 ## 使用前准备 +1. Topuino 依赖 2.4G Wi-Fi 连接互联网，并且不支持 5G Wi-Fi，所以你需要有一个可以连接互联网的 2.4G Wi-Fi 接入点，并且 SSID 不可以包含特殊字符（包括中文字符），且必须有密码； +2. Topuino 通过 HTTP 协议与 iot.vvzero.com 通讯以获取实时监控数据，所以请确保网络链路中不存在拦截、缓存等异常行为； +3. Topuino 使用 USB TypeC 接口供电，供电电压为 5V，市面上绝大多数手机充电器、电脑 USB 输出均可； +4. 被监控机器上需要运行一个 python 脚本以向 iot.vvzero.com 上传监控数据，所以请安装 python3； +5. 被监控机器与 Topuino 之间通过一个 UUID 绑定，所以请提前准备好一个 UUID，如果不知道怎么生成 UUID，可以看看 + ## 待监控的服务器/电脑配置 +1. 安装 python 依赖包 requests 和 psutil，注意 psutil 在某些机器上可能因为缺少某些库而 build 失败（比如 armbian），请用搜索引擎搜索对应的报错信息，一般很容易解决； +2. 下载 [监控用的 python 脚本文件](https://git.vvzero.com/villivateur/TopuinoServer/raw/branch/master/slave/main.py)； +3. 修改 main.py，将准备好的 UUID 填入 main.py 的指定位置；同时请填入需要监控的两个磁盘挂载点； +4. 直接使用 python3 运行 main.py，将会每隔 1s 向 iot.vvzero.com 报告当前监控数据； +5. 如果需要配置自动启动和 daemon，建议参考 [这个 systemd 服务文件](https://git.vvzero.com/villivateur/TopuinoServer/raw/branch/master/slave/topuino_slave.service) + ## Topuino 配置 +1. Topuino 初次上电后，右上角的红色状态灯应当以 0.5 Hz 闪烁（一亮一灭表示一个周期），表示正在等待配置； +2. 以安卓手机配置为例，请先把准备好的 UUID 复制到剪切板中； +3. 为避免某些手机的自动网络优化，请暂时关闭数据流量； +4. 请暂时关闭手机上的任何代理软件； +5. 打开 Wi-Fi，并连接 SSID 为 `Topuino` 的接入点，密码是 `vvzero.com`。 如果系统提示该网络无法访问互联网，请忽略并继续保持连接； +6. 打开一个正常的浏览器，访问 192.168.1.1； +7. 在网页中填入 Topuino 可连接的、可访问互联网的 2.4G Wi-Fi 接入点的 SSID 和密码，并粘贴你刚刚复制的 UUID； +8. 点击提交后，页面会返回一个 OK； +9. 此时 Topuino 的状态灯应当以 2Hz 闪烁，等待几秒至十几秒后，状态灯熄灭，面板开始正常显示。 + ## 常见问题分析 + +- Q：我遇到问题了怎么办？A：请再认真读一遍该手册，如果无法解决，请继续往下看。 +- Q：上电后闪灯状态不对怎么办？A：请先短按 RESET 键并观察，如果不行，请长按 FUNC 键 6 秒以上，再次观察，如果还是不行，请联系开发者。 +- Q：我在配置 Topuino 时输错了 SSID、密码或 UUID 怎么办？A：请长按 FUNC 键 6 秒以上，重新配置。 +- Q：我想换一台服务器监控怎么办？A：一样的，长按 FUNC 键 6 秒以上，重新配置。