@nestor-home/satellite

中文文档
0.3.0发布于 2026/11/02MITTypeScriptES Module构建来源已验证

TypeScript SDK用于编写Nestor卫星,在浏览器和Node:配对中,WebRTC音频和Nestor数据通道。

中文使用文档

@nestor-home /卫星

要写的TypeScript SDK 卫星 用于 长者,在浏览器和 节点:与Nestor配对的设备(壁挂式平板电脑上的标签、树莓派扬声器、机器人) 服务器,流式音频通过WebRTC,执行其意图和报告他们观察到的,遵循 nestor.satellite/1 协议。它不依赖于Nestor服务器。

文档: nestorhome.dev / docs / sdk /打印稿 (节点,配对选项,QR码,命令,一致性)。

pnpm add @nestor-home/satellite
pnpm add @roamhq/wrtc   # in Node only

卫星标签:作为卫星的标签:

import {
  AUDIO_CAPTURE,
  AUDIO_PLAYBACK,
  browserWebRtc,
  IDENTIFY,
  LocalStorageTokenStore,
  Manifest,
  Satellite,
} from "@nestor-home/satellite";

const satellite = new Satellite({
  core: location.origin,
  manifest: Manifest.of(
    { id: "tablette-cuisine", model: "browser", room: "cuisine" },
    AUDIO_CAPTURE,
    AUDIO_PLAYBACK,
    IDENTIFY,
  ),
  tokens: new LocalStorageTokenStore(),
  webrtc: browserWebRtc(),
  pairing: {
    // the device code to type in Nestor; `code` is null once it is no longer needed
    display: (code, text) => {
      document.querySelector("#code")!.textContent = code ?? "";
      document.querySelector("#status")!.textContent = text;
    },
  },
  body: {
    behavior: (behavior) => (document.body.dataset.behavior = behavior),
    identify: () => document.body.animate([{ opacity: 0.2 }, { opacity: 1 }], { duration: 500, iterations: 6 }),
  },
});
button.onclick = () => satellite.run(); // a click: browsers only play sound after a gesture

在Node中,机器的麦克风和扬声器,没有什么可写的:

NESTOR_PAIRING_URI='nestor+http://nestor.local:8471/?code=K7QF2M9X' npx nestor-satellite run --room salon

设备码录音在CC BY 4.0下共享:参见 voice/LICENSE.

开发

pnpm install
pnpm lint && pnpm typecheck && pnpm test
pnpm conformance   # the published server's conformance suite (uvx; version in .nestor-version)

许可证

麻省理工学院

版本与发布记录

@nestor-home/satellite 共发布 4 个版本,首次发布于 2026/11/01;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.0latest2026/11/021 天前
0.2.02026/11/021 天前
0.1.02026/11/011 天前
0.0.0-stage2026/11/011 天前

关于 @nestor-home/satellite 的常见问题

@nestor-home/satellite 是什么?

TypeScript SDK用于编写Nestor卫星,在浏览器和Node:配对中,WebRTC音频和Nestor数据通道。

如何安装 @nestor-home/satellite?

在项目目录运行 npm install @nestor-home/satellite,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 nestor-satellite,可以用 npx nestor-satellite 直接运行。

@nestor-home/satellite 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@nestor-home/satellite 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@nestor-home/satellite 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@nestor-home/satellite 可以商用吗?

@nestor-home/satellite 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@nestor-home/satellite 还在维护吗?

最新版本 0.3.0 发布于 2026/11/02(1 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/11/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。