Files
ClassHelper/docs/get-started/client.md
T
LoveChengke b7cdc7c9ea fix(clients,client,web): 远控指令的两个修复 —— 执行失败不再谎报成功 + 「上次指令」让"点了没反应"可见(1.3.2)
背景:用户报「下发锁屏等等指令不生效」。先把服务端那条链路单独验了一遍
(模拟客户端:登记 → 下发 → 心跳带回 → 设备列表可见 → 回执 → 清除),**整条是通的**;
真正的问题在两处。

客户端:执行失败会谎报成功
- `spawn` 找不到可执行文件 / 没权限时**不抛异常**,而是在下一个 tick 发一个异步 `error` 事件 ——
  只包 `try/catch` 抓不到,代码一路走到 `return { ok: true }`,回执写着「已下达系统命令」,
  Web 端看起来一切正常而机器纹丝不动
- 现在等一个 200ms 的窗口确认没有立刻报错,失败如实回执(`client-agent.ts` 的 `executeCommand`)

Web 端:点了没生效,界面上什么都不说
- 一条命令被**取消 / 过期**之后就从 `pendingCommand` 里消失,页面留白 ——
  而最常见的两种"没反应"恰恰是「本机没人确认(客户端 60 秒自动按取消)」与「下达时机器离线」
- `GET /clients/devices` 增加 `lastCommand`(最近一条,不论状态);
  「客户端」页的设备表多一列「上次指令」,由 `commandStateText()` 翻成一句人话
  (已执行 / 本机用户取消 / 已过期 —— 下达时机器不在线 / 待执行)
- 下发成功的提示补上「60 秒内没人点确认就按取消处理」

文档
- AGENTS.md §5 第 69 条记下这两条,并写明排查同类反馈的顺序:**先看那台机器的客户端版本是否 ≥ 1.3.0**
  (远控命令的处理 `client-agent.ts` 是 1.3.0 才有的,旧客户端连心跳都不发)
- docs/reference.md 4.15 的表格补上「二次确认」的准确口径与新增的「上次指令」列

验收:`lint` / `typecheck` / `check:icons` / `docs:check` 全绿;
后端端到端 **247/247**、联动链路 **44/44**、插件静态契约 **76/76**、
Web 真实点击 **34/34**、客户端冒烟 **90/90**;
远控链路另用模拟客户端跑通,并确认新增的「上次指令」在待执行与已回执两种状态下都显示正确。
2026-10-11 17:00:11 +08:00

4.8 KiB
Raw Blame History

title, description
title description
装 ClassHelper 班级端 在教室机器上安装 ClassHelper桌面客户端,用班级码登录,并第一次跑通实时通知。

装 ClassHelper 班级端

桌面客户端装在教室的那台机器上(教室大屏、讲台电脑)。它是学生看课表作业的地方, 也是「消息到达的第一现场」—— 灵动岛就长在这一端。

1. 下载与安装

从 Releases 取:

产物 用途
ClassHelper-<版本>-x64-setup.exe 安装包(约 98 MB),装到本机并建快捷方式
ClassHelper-<版本>-x64-portable.exe 单文件便携版,双击即用,适合不改动机房机器

要自己打:

pnpm dist:win     # 安装包 + 便携版(两个都是成品,没有中间的解包目录)

双击没反应? 关窗只是隐藏到托盘,进程还在,再双击会因单实例锁秒退 —— 先从托盘右键退出。

2. 登录

打开客户端 → 填三项:

字段 填什么
服务器地址 http://<服务器IP>:4000(局域网用内网 IP,别用 localhost)
班级码 管理员在「班级管理」里给这个班设的码,例如 G203
班级密码 建班级时设的密码

旁边的「测试连接」可以先确认网络通。已登录过但服务器暂时不可达时,登录页会给一个「离线进入」—— 进去后看到的是上次缓存的课表 / 作业 / 通知(顶部会标「离线缓存」),网络恢复后自动刷新。

客户端没有改密码入口,这是刻意的:教室机器上误改班级密码会把别的机器锁在门外。 班级密码由管理员在 Web 端「班级管理 → 修改班级账号」维护。

3. 首次启动的六步向导

第一次启动会在登录页上自动弹一个向导:欢迎 → 连接服务器 → 登录班级 → 登录之后(主界面与离线缓存)→ 灵动岛提醒 → 完成。走完或跳过都会记为已完成,之后不再自动弹。

想重看:登录页的**「查看使用引导」**,或进去之后 设置 → 通用 → 使用引导。

4. 认一认主界面

左侧是四个一级项(课表 / 作业 / 通知 / 成绩)加上一个可展开的设置分组, 顶部汉堡按钮把整栏收成 64px 的图标导轨(折叠状态会记住)。「通知」项上有未读红点。

页面 一句话
课表 周视图 + 「今天」时间轴(大时钟 / 正在上什么 / 下一节)
作业 看板模式(按科目卡片、可全屏)/ 列表模式;教室机器还能录入作业
通知 未读红点、优先级标签、点开自动标为已读
成绩 班级账号看到的是全班总览(表格 + 柱状图 + 等级分布)
设置 通用 / 外观 / 灵动岛 / 提醒 / 账号 / 关于,六个子页

细节见应用帮助。

5. 在教室机器上把它调成"能看"的样子

教室大屏的观看距离和角度跟办公桌不一样,装完建议顺手做三件事:

  1. 开全屏作业看板 —— 作业页「全屏看板」,按屏幕尺寸自动排版,整个屏幕刚好放得下、不用滚动。
  2. 调灵动岛 —— 设置 → 灵动岛:高度、宽度、字号、主题色、停靠位置、视觉风格。 讲台机器上通常把字号调大一点、位置放到顶部居中。 触摸屏(希沃白板等)走的是另一套命中逻辑,客户端会自动识别,不用手动开。
  3. 选提醒弹在哪端 —— 设置 → 提醒:ClassHelper 与 ClassIsland 都弹 / 只在客户端 / 只在 ClassIsland。 这个选择会同步到班级记录,服务端据此决定要不要推 ClassIsland。

6. 确认实时链路是通的

在 Web 管理端给这个班发一条普通通知,教室机器上应该几秒内出现灵动岛胶囊。如果没有:

  • 客户端顶栏的实时通道状态是不是"已连接"?
  • 现在是上课时段吗?上课时段的普通通知只进队列、下课才弹,这是设计行为,不是故障。
  • 服务器与教室机器之间能互相 ping 通吗?防火墙放行 4000 了吗?

排查清单见常见问题。

下一步(可选):接入 ClassIsland。