Skip to main content
如果你刚接触 SDK,希望在手动集成任何内容之前先在本地成功运行一个脚手架应用,请阅读本页。 如果你想看完整的路线图(rPPG 为主、EEG 可选、通过蓝牙连接头带),以及脚手架、分步教程和概览之间的对比,请参阅 SDK 概览。 目标很简单:在本地运行一个可用的应用,了解每个模板对应哪种传感器流程,并知道下一步去哪里。

你将构建什么

你将使用 @elata-biosciences/create-elata-demo 创建一个已发布的入门应用。 选择与你的目标相符的模板:
  • rppg-demo:主要:基于摄像头的脉搏/rPPG 应用
  • eeg-demo:浏览器 EEG 处理,支持 Muse Web Bluetooth
  • eeg-ble:以蓝牙为主、面向 Muse 兼容头带的 EEG 入门应用
  • ppg-demo:通过 Muse 头带的 PPG 传感器获取心率和 HRV
  • pulse-game:运行在沙箱 iframe 中并保存分数的 rPPG 游戏,与应用在 Elata 中的运行方式相同

为什么从这里开始

这是推荐的默认方式,因为它为你提供:
  • 可运行的应用结构
  • 固定的兼容包版本
  • 可以与你自己的应用对比的参考实现
请在将 SDK 集成到现有应用之前先完成这一步。

第 1 步:选择模板

使用以下决策表: 如果不确定,就从 rppg-demo 开始。

第 2 步:创建应用

使用交互式选择器开始:
如果你更喜欢直接使用默认路径,可以直接创建 rppg-demo:
如果想先查看完整的模板列表:
完整的别名和模板对照见 create-elata-demo。

第 3 步:安装并运行

复制其中一列(pnpm 或 npm),然后按顺序运行每一行:

第 4 步:确认你得到了什么

应用启动后,确认以下预期行为:
  • rppg-demo:请求摄像头权限并开始脉搏会话
  • eeg-demo:在浏览器中加载 EEG 处理并显示由合成数据驱动的输出
  • eeg-ble:在 EEG 基础上增加受支持的 Muse 兼容头带的蓝牙配对和数据流
  • ppg-demo:连接 Muse 头带并显示 BPM、RMSSD 和实时 PPG 诊断
  • pulse-game:在沙箱 iframe 中运行游戏,并通过本地宿主保存分数,与 Elata 的方式相同
如果你只是在评估,先停在这里,从生成的应用中学习,然后再集成到现有代码库中。

第 5 步:理解生成的应用

每个脚手架应用都为你提供:
  • 一个精简的 Vite + React 外壳
  • 已接入的 Elata 包
  • 包含模板说明的 README.md
  • 用于确认应用能干净编译的 build 脚本
  • 将应用打包以上传到 Elata的 build:zip 脚本
它就是你确认可用的基线。 当之后的手动集成出问题时,先把你的应用与这个生成的应用进行对比,再判断是不是包有问题。

常见问题:在另一个 pnpm 工作区中创建项目

如果你在一个已有 pnpm-workspace.yaml 的仓库中创建 my-app,pnpm install 可能会关联到父级工作区,而不是生成的应用。 在父目录中逐行运行以下命令(必要时调整 my-app):

下一步

你已经有了一个运行中的脚手架应用。推荐的顺序是:先做摄像头 rPPG(大多数人的主要应用),如果产品需要脑电信号再做浏览器 EEG,然后通过 Web Bluetooth 连接头带(EEG 之上的传输层)。每一步都分为两种情况:继续基于脚手架,或集成到你已有的应用中。

下一步:摄像头(rPPG):主要

选择与你情况相符的一行:

然后:浏览器 EEG:可选(暂不需要头带)

然后:启用蓝牙头带(Muse 兼容)

完整路线图

如需按优先顺序(rPPG、EEG、蓝牙)在一个地方查看这些选择,请参阅 SDK 概览。

示例应用

示例应用

完整的产品级参考实现

选择合适的包

包选择指南