docs: 文档同步(README/API/架构/部署)

This commit is contained in:
2026-08-11 08:27:33 +08:00
parent 5ccf622942
commit a0d1a533c6
4 changed files with 201 additions and 38 deletions
+42 -9
View File
@@ -200,7 +200,11 @@ adb disconnect + STF release(释放设备)
| `cron` | 定时启动:到 cron 时间点自动启动所有目标设备 |
| `cron_stop` | 定时启停:启动 cron 到点启动,停止 cron 到点停止本任务 worker |
cron 表达式为标准 5 段格式:`分 时 日 月 周`(如 `0 9 * * *` = 每天 9:00)
**简单设置**:编辑任务时选"定时启动/定时启动+停止"后,频率用下拉选择——每天(选时间)、每小时(整点)、每隔 N 小时、每周(选星期+时间)——cron 表达式自动生成,不需要懂 cron 语法。老手可在"自定义 cron(高级)"里直接填。
cron 表达式为标准 5 段格式:`分 时 日 月 周`(如 `0 9 * * *` = 每天 9:00,`0 */2 * * *` = 每 2 小时整点,周 `0`/`7` 均为周日)
**运行窗口**:任务可勾选"启用运行窗口",设置每天允许运行的时间段(如 `21:00-09:00` = 晚 9 点到次日早 9 点,支持跨午夜)。窗口外**定时触发和手动执行都不会启动**(手动执行会提示"当前不在运行窗口内")。典型用法:`每小时`定时 + 窗口 `09:00-21:00`,即只在白天每小时跑一次。
### 设备分组
@@ -241,15 +245,34 @@ self.set_progress(done=5, total=80, unit="视频",
### 页面结构
单页应用(`templates/admin/monitor.html`),5 个 Tab:
单页应用(`templates/admin/monitor.html`),6 个 Tab:
| Tab | 功能 |
|-----|------|
| 监控 | 设备状态大屏:在线/离线、运行任务、当前动作、进度条、前台 App、截图、停止 |
| 任务 | 任务计划 CRUD:新建/编辑/删除/启用停用/立即执行 |
| 分组 | 设备分组管理:创建/编辑/删除分组 |
| 日志 | 实时日志查看:按模块切换(core/task/web/action) |
| 用户 | 用户管理:创建/删除/修改密码 |
| Tab | 功能 | 可见性 |
|-----|------|--------|
| 监控 | 设备状态大屏:在线/离线、运行任务、当前动作、进度条、前台 App、截图、停止 | 所有登录用户(设备操作按钮需"设备控制"权限) |
| 任务 | 任务计划 CRUD:新建/编辑/删除/启用停用/立即执行 | 所有登录用户可看,写操作需"任务管理"权限 |
| 应用 | APK 上传/安装/删除 | 需"应用管理"权限 |
| 分组 | 设备分组管理:创建/编辑/删除分组 | 所有登录用户可看,写操作需"任务管理"权限 |
| 日志 | 实时日志查看:按模块切换(core/task/web/action) | 需"日志查看"权限 |
| 用户 | 用户管理:创建/删除/修改密码/分配权限 | 仅管理员 |
| 维护 | STF 容器一键重启、adb 远程终端(设备快捷选择/自动 `-s`、卸载 STF agent、重连设备) | 仅管理员 |
### 用户与权限
默认账号 `admin` / `admin123`(管理员,拥有全部权限)。管理员可在"用户"Tab 创建普通用户并分配权限:
| 权限位 | 说明 | 覆盖功能 |
|--------|------|---------|
| 任务管理 `tasks` | 任务/自定义动作/分组的增删改、启停、立即执行 | 任务 Tab、分组 Tab 的写操作 |
| 设备控制 `devices` | 停止设备、释放占用、清除异常、前台扫描、元素抓取 | 监控 Tab 的设备操作按钮、步骤编辑器的"抓取元素" |
| 应用管理 `apks` | APK 上传、安装、删除 | 应用 Tab |
| 日志查看 `logs` | 日志页 | 日志 Tab |
规则:
- **管理员拥有全部权限**,不受权限位限制
- 查看类接口(设备/任务/分组列表、状态、截图)所有登录用户可用
- **用户管理仅管理员可用**;不能删除/取消最后一个管理员
- 无权限的 tab 和按钮在界面上自动隐藏(后端同样拦截,返回 403)
### 前台 App 扫描
@@ -298,7 +321,17 @@ self.set_progress(done=5, total=80, unit="视频",
| 步骤类型 | 说明 |
|---------|------|
| `open_app` | 启动 App(指定包名,可选等待首页) |
| `stop_app` | 强制结束 App(am force-stop,清后台,下次打开冷启动) |
| `screen_on` | 亮屏(息屏时唤醒并滑动解锁) |
| `screen_off` | 息屏 |
| `keep_screen` | 保持亮屏/恢复自动息屏(充电时屏幕常亮,适合长任务) |
| `key_event` | 按键:返回/Home/回车/菜单等(退出评论、返回上一页) |
| `swipe` | 滑动(上/下/左/右,可配置时长) |
| `swipe_until` | 滑动直到元素出现(最多 N 次,可选找到后点击) |
| `click_xy` | 点击坐标(屏幕百分比,无选择器时兜底) |
| `long_click` | 长按元素(选择器 + 时长) |
| `wait_el` | 等待元素出现(条件等待,替代固定时长) |
| `input_text` | 输入文字(随机候选/指定文字,可选输入前先清空) |
| `click` | 点击元素(支持 xpath/description/resourceId/text 选择器) |
| `input_text` | 输入文字(随机候选/固定文字) |
| `wait` | 等待(可配置时长范围) |