ClassHelper/docs/get-started/classisland.md

---
title: 接入 ClassIsland
description: 把教室里的 ClassIsland 接上 ClassHelper：下课表上报、大屏提醒下发、课表镜像三个方向。
---

# 接入 ClassIsland

课堂里真正"知道现在第几节、在上什么课"的是 [ClassIsland](https://classisland.tech)。
它跟 ClassHelper管的事情不重叠，接起来之后两边各拿各的好处：

| 方向                            | 做什么                                                                              | 老师在哪看                               |
| ------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------- |
| ClassIsland → ClassHelper        | 上报**课表 + 节次时间 + 上课状态**（现在上什么 / 下一节 / 本节起止），写进本班课表  | Web 端「ClassIsland 联动」的实时状态卡片 |
| ClassHelper → ClassIsland        | 老师发一条**提醒** → 落库 → 教室插件取回 → ClassIsland 上**全屏弹出**（可语音朗读） | Web 端「ClassIsland 联动 → 下发提醒」    |
| （可选）班级 → ClassIsland 镜像 | 把小助手这边排好的课表**镜像**回 ClassIsland，新建一份档案，不动老师原有的课表      | 同一页的「开镜像」开关                   |

> 没接 ClassIsland 也能用 ClassHelper，只是教室里少一个大屏播报的出口。**这一步是可选的。**

## 前置：ClassIsland 装好了

本插件按 ClassIsland 插件 API 2.0 编写，ClassIsland 2.0.x 与 2.1.0.x 都能加载。
先确认教室机器上 ClassIsland 本身能正常显示课表。

## 第一步：在 Web 端签发设备令牌

**ClassIsland 联动**页（管理员 / 本班班主任）→「接入新设备」→ 选班级 → 生成令牌。

令牌形如 `chci_xxxxxxxx…`，**明文只显示这一次**：服务端只存它的 sha256 与一个前缀提示
（`chci_80fa1c…`），用来在设备列表里人眼区分。丢了就重置一个。

## 第二步：在教室机器上装插件并填令牌

### 装插件

从 [Releases](https://github.com/LoveChengke/classhelper/releases) 取
`ClassHelper.ClassIslandPlugin.cipx`：

- **推荐**：在 ClassIsland 里直接安装这个 `.cipx`（插件页有「从文件安装」）。
- 或者手工解压：把包里的 `ClassHelper.ClassIslandPlugin/` 目录整个丢进
  `<ClassIsland 数据目录>\Plugins\`，然后重启 ClassIsland。

> **ClassIsland 运行时会锁住 DLL**。要覆盖升级插件，必须先完全退出 ClassIsland 再覆盖，
> 否则写入会被拒。插件配置在 `Config\Plugins\<插件 id>\Settings.json`，
> 里面存着服务器地址与设备令牌 —— **升级时别覆盖这个文件**。
> 另外改配置要在 ClassIsland 退出时改，运行中改会被内存里的副本回写覆盖。

### 填令牌

ClassIsland 的**设置 → ClassHelper 联动**里填：

| 设置项                       | 说明                                                            |
| ---------------------------- | --------------------------------------------------------------- |
| 后端地址                     | `http://<服务器IP>:4000`                                        |
| 设备令牌                     | 上一步生成的 `chci_…`                                           |
| 上报课表到小助手             | 打开后才会把 ClassIsland 的课表同步过来                         |
| 接收小助手提醒               | 关掉就收不到老师发的提醒                                        |
| 提醒轮询间隔                 | 默认 10 秒（可调到 5 秒）。上报本身就是心跳，轮询只是顺带取提醒 |
| 把班级课表镜像回 ClassIsland | 见下面「镜像」一节                                              |

填完点**「立即上报」**。

## 第三步：验证

回到 Web 端的「ClassIsland 联动」页，应该出现设备卡片和「在线」标记，实时状态卡上会显示这台机器
现在上什么课。到这一步链路就通了。

如果一直离线：先看插件的日志，再看服务端能不能从教室机器访问到（**别让系统代理拦住内网地址** ——
插件对本地 / 内网做了强制直连，但填错地址一样连不上）。

## 提醒弹在哪个端：由教室客户端自己选

教室机器的**客户端**「设置 → 提醒」里选，选择会同步到班级记录：

| 选择                                      | ClassHelper 客户端             | ClassIsland |
| ----------------------------------------- | ------------------------------ | ----------- |
| `ClassHelper 与 ClassIsland 都弹`（默认） | 弹窗 + 灵动岛                  | 全屏提醒    |
| `只在 ClassHelper 客户端弹`               | 弹窗 + 灵动岛                  | 不推送      |
| `只在 ClassIsland 上弹`                   | 只进通知中心（不弹窗、不上岛） | 全屏提醒    |

规则只有一条，**任何入口都遵守**：通知发布页、叫人、联动页的「下发提醒」三个入口共用同一份推送实现，
不存在"某个页面发的通知不联动"。

## 两个方向各需要哪些开关

| 要同步的内容                     | 需要打开                                                                        |
| -------------------------------- | ------------------------------------------------------------------------------- |
| 服务端 → ClassIsland（镜像课表） | ① 插件设置「把班级课表镜像回 ClassIsland」+ ② Web 端该设备的「镜像课表」        |
| ClassIsland → 服务端（上报课表） | 插件设置「上报课表到 ClassHelper」                                                |
| 提醒下发                         | ① 教室客户端的「通知显示位置」不是"只在 ClassHelper" + ② 插件「接收小助手提醒」 |

## 上课时段：两边同一套规则

老师在**上课时段**发通知时，教室里的两个端遵守同一条规则，否则会出现"学生在客户端看不到、
却在 ClassIsland 上被打断"的怪事：

| 提醒类型                                               | 上课时段                     | 下课 / 放学 |
| ------------------------------------------------------ | ---------------------------- | ----------- |
| 通知类（`kind=notification`：通知发布页 / 联动页下发） | **暂存不弹**（两边都先收着） | 自动补弹    |
| 主动通知：**紧急提醒**、**叫人**（`kind=call`）        | **立刻弹**                   | 立刻弹      |

ClassIsland 侧的暂存由插件实现：它订阅课程服务，下课后把暂存的提醒补弹出来；未弹出前不回执，
所以服务端会一直保留着待提醒，教室机器断网也不丢。

## 上报课表是"双向对齐"的

插件每次全量上报时，服务端只清理**「来源是 ClassIsland 且这次没再上报」**的课表行。于是：

- 老师在 ClassIsland 里删掉 / 挪动一节 → 小助手这边跟着同步；
- 老师在小助手这边手排的课 → 一律不删。

## 镜像：把小助手的课表写回 ClassIsland

开启后，插件会新建一份名为 `ClassHelper-<班级名>` 的档案课表，**不动老师原有的课表**。

镜像时会连节次时间一起带过去，并且**每两节之间补一段课间、最后一节之后不补**（放学）。
这一步不做的话，ClassIsland 的课表会整体错位 —— 表现为"看着有内容、每节课都对不上"。

细节与实现见[ClassIsland 插件](../dev/classisland-plugin.md)。

下一步：[发布第一条内容](first-content.md)。