@nestor-home/satellite 0.1.0 → 0.2.0

package/README.md

@@ -1,93 +1,19 @@
 # @nestor-home/satellite
 
-TypeScript SDK to write **satellites** for [Nestor](https://github.com/nestor-home/nestor), in
-browsers and in Node: devices (a tab on a wall tablet, a Raspberry Pi speaker, a robot) that pair
-with a Nestor core, stream audio over WebRTC, carry out the core's intents and report what they
-observe, following the `nestor.satellite/2` protocol. The SDK does not depend on the Nestor server.
+TypeScript SDK to write **satellites** for [Nestor](https://nestorhome.dev), in browsers and in
+Node: devices (a tab on a wall tablet, a Raspberry Pi speaker, a robot) that pair with a Nestor
+server, stream audio over WebRTC, carry out its intents and report what they observe, following the
+`nestor.satellite/1` protocol. It does not depend on the Nestor server.
 
-## Pairing
-
-A person pairs a satellite from Nestor's admin, with one of two proofs:
-
-- an **enrollment code** (`K7QF-2M9X`, or the pairing URI `nestor+http://nestor.local:7860/?code=K7QF2M9X`)
-  made in the admin and handed to the device: set in its configuration, typed on it, or scanned;
-- a **device code** (6 digits) the device presents, on its screen, aloud or in its log, and the
-  person types in the admin.
-
-The SDK uses the enrollment code it is given; otherwise it asks for a device code and presents it
-through every output the driver provides, and always in the log. While it waits, `satellite.enroll()`
-still takes an enrollment code; whichever proof the core accepts first wins. A refused enrollment code
-is never sent again, even after a restart: its SHA-256 hash is kept in the token store, never the code.
-
-The manifest's `pairing_methods` follow from what the device can do, never declared by hand:
-
-| Method                    | When                                                                                                                                                                                                           |
-| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `enrollment.provisioning` | always                                                                                                                                                                                                         |
-| `device_code.display`     | `pairing.display` is given                                                                                                                                                                                     |
-| `device_code.speech`      | `pairing.speak` is given, or the device has a speaker (`audio.playback`) and no `display`: the SDK then says the code itself, offline, with recorded clips (`pairing.voice: true` to also do it with a screen) |
-| `enrollment.input`        | `pairing.accepts: ["enrollment.input"]`                                                                                                                                                                        |
-| `enrollment.qr`           | `pairing.scanner` reads QR codes with a camera (`@nestor-home/satellite/qr`, browsers)                                                                                                                         |
-
-What the device says to people is translated (English and French, Fluent catalogues): `locale`
-option, else the platform's language. The bundled voice has English and French clips; another
-language is said in English.
-
-## In Node, headless
-
-`pnpm add @nestor-home/satellite @roamhq/wrtc`. Add a satellite in Nestor with an enrollment code, and
-hand its pairing URI to the device:
+**Documentation:** [nestorhome.dev/docs/sdks/typescript](https://nestorhome.dev/docs/sdks/typescript/)
+(Node, pairing options, QR codes, the command, conformance).
 
 ```bash
-NESTOR_PAIRING_URI='nestor+http://nestor.local:7860/?code=K7QF2M9X' npx @nestor-home/satellite run --room salon
-# or
-npx @nestor-home/satellite run --room salon --pairing-uri 'nestor+http://nestor.local:7860/?code=K7QF2M9X'
-```
-
-The URI gives the core's address; with a bare code (`--pairing-code K7QF-2M9X`, or
-`NESTOR_PAIRING_CODE`), give it with `--core`. Without either, the satellite says a device code to
-type in Nestor on its speaker, and logs it (`--output none`: only logs it). The token is kept in `~/.config/nestor-satellite/<id>.json` (mode 600); see
-`nestor-satellite --help`.
-
-The same in code:
-
-```ts
-import { AUDIO_CAPTURE, AUDIO_PLAYBACK, EXPRESSION, Manifest, Satellite } from "@nestor-home/satellite";
-import {
-  CommandSink,
-  CommandSource,
-  FileTokenStore,
-  languagesFromEnv,
-  nodeWebRtc,
-  provisioningFromEnv,
-} from "@nestor-home/satellite/node";
-
-const provisioning = provisioningFromEnv(); // NESTOR_PAIRING_URI or NESTOR_PAIRING_CODE, if set
-const satellite = new Satellite({
-  core: provisioning?.core ?? "http://nestor.local:7860",
-  manifest: Manifest.of(
-    { id: "enceinte-salon", model: "raspberry-pi-4", room: "salon" },
-    AUDIO_CAPTURE,
-    AUDIO_PLAYBACK,
-    EXPRESSION,
-  ),
-  tokens: new FileTokenStore("~/.config/salon.json"), // mode 600
-  webrtc: nodeWebRtc({
-    source: new CommandSource("arecord -q -t raw -f S16_LE -c 1 -r 48000"),
-    sink: new CommandSink("aplay -q -t raw -f S16_LE -c 1 -r 48000"),
-  }),
-  pairing: { enrollment: provisioning?.enrollment }, // no screen: the device code is said on the sink, and logged
-  locale: languagesFromEnv(), // LC_ALL, LC_MESSAGES, LANG
-  body: { expression: (expression) => console.log("expression:", expression) },
-});
-const stop = new AbortController();
-process.once("SIGINT", () => stop.abort());
-await satellite.run(stop.signal); // pairs the first time, then reconnects forever
+pnpm add @nestor-home/satellite
+pnpm add @roamhq/wrtc   # in Node only
 ```
 
-## In a browser, with a screen
-
-Served over `https:` or `localhost`, from the core's origin or through a proxy:
+A tab as a satellite:
 
 ```ts
 import {
@@ -99,8 +25,6 @@ import {
   Manifest,
   Satellite,
 } from "@nestor-home/satellite";
-import { cameraQrScanner } from "@nestor-home/satellite/qr"; // needs `pnpm add zxing-wasm`
-import wasmUrl from "zxing-wasm/reader/zxing_reader.wasm?url"; // Vite: served by the page, not a CDN
 
 const satellite = new Satellite({
   core: location.origin,
@@ -113,50 +37,35 @@ const satellite = new Satellite({
   tokens: new LocalStorageTokenStore(),
   webrtc: browserWebRtc(),
   pairing: {
-    // The device code and what to do with it; `code` is null once it is no longer needed.
+    // 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;
     },
-    voice: true, // optional: says the code aloud too, with the bundled voice (Web Audio)
-    accepts: ["enrollment.input"], // an enrollment code can be typed in the page
-    scanner: cameraQrScanner({ wasmUrl }), // optional: reads the pairing URI's QR code with the camera
   },
   body: {
     behavior: (behavior) => (document.body.dataset.behavior = behavior),
     identify: () => document.body.animate([{ opacity: 0.2 }, { opacity: 1 }], { duration: 500, iterations: 6 }),
   },
 });
-form.onsubmit = async () => console.log(await satellite.enroll(input.value)); // approved, refused…
 button.onclick = () => satellite.run(); // a click: browsers only play sound after a gesture
 ```
 
-A tab as a satellite: `NESTOR_CORE=http://nestor.local:7860 pnpm example`, then open the page
-(`?pairing_uri=…` pairs it with an enrollment code, `?lang=fr` speaks French, `?speak` says the code,
-`?qr` scans QR codes).
-
-QR codes are decoded by [`zxing-wasm`](https://github.com/Sec-ant/zxing-wasm) (ZXing-C++ in
-WebAssembly, MIT, an optional peer dependency; its reader is about 1 MB of WebAssembly, fetched from
-jsDelivr unless `wasmUrl` says where the page serves it). Node has no camera, so a Node satellite never
-declares `enrollment.qr`.
+In Node, the machine's microphone and speaker, with nothing to write:
 
-## The bundled voice
-
-`voice/` holds the clips the SDK says a device code with (16 kHz mono WAV, about 500 KB), identical in
-the Python SDK, which records them with Kokoro-82M. They are shared under CC BY 4.0: see
-[`voice/LICENSE`](voice/LICENSE) for the attribution. A driver with a voice of its own passes
-`pairing.speak`, which gets the whole sentence.
+```bash
+NESTOR_PAIRING_URI='nestor+http://nestor.local:7860/?code=K7QF2M9X' npx nestor-satellite run --room salon
+```
 
-In Node, WebRTC is [`@roamhq/wrtc`](https://github.com/WonderInventions/node-webrtc), an optional
-peer dependency: libwebrtc, as in browsers, with Opus and RTCP built in, prebuilt for Linux and
-macOS (x64, arm64) and Windows x64.
+The recorded voice that says device codes is shared under CC BY 4.0: see
+[`voice/LICENSE`](voice/LICENSE).
 
 ## Development
 
 ```bash
 pnpm install
 pnpm lint && pnpm typecheck && pnpm test
-pnpm conformance   # the server's conformance suite; needs ../nestor with its venv
+pnpm conformance   # the published server's conformance suite (uvx; version in .nestor-version)
 ```
 
 ## License

package/dist/codes.d.ts

@@ -1,5 +1,5 @@
 /**
- * The codes of `nestor.satellite/2` pairing, and the pairing URI that carries an enrollment code.
+ * The codes of `nestor.satellite/1` pairing, and the pairing URI that carries an enrollment code.
  *
  * Device code: 6 decimal digits the core gives the device, which presents them (screen, voice, log)
  * for a person to type in the admin.

package/dist/codes.js

@@ -1,5 +1,5 @@
 /**
- * The codes of `nestor.satellite/2` pairing, and the pairing URI that carries an enrollment code.
+ * The codes of `nestor.satellite/1` pairing, and the pairing URI that carries an enrollment code.
  *
  * Device code: 6 decimal digits the core gives the device, which presents them (screen, voice, log)
  * for a person to type in the admin.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Write a Nestor satellite in TypeScript: pair with the core, stream audio over WebRTC, carry out
- * its intents and report observations, following the `nestor.satellite/2` protocol.
+ * its intents and report observations, following the `nestor.satellite/1` protocol.
  *
  * This entry point runs anywhere (browsers, Node, workers): it touches no platform API until a
  * `WebRtc` adapter does. Node's adapter, audio and token file live in `@nestor-home/satellite/node`.

package/dist/index.js

@@ -1,6 +1,6 @@
 /**
  * Write a Nestor satellite in TypeScript: pair with the core, stream audio over WebRTC, carry out
- * its intents and report observations, following the `nestor.satellite/2` protocol.
+ * its intents and report observations, following the `nestor.satellite/1` protocol.
  *
  * This entry point runs anywhere (browsers, Node, workers): it touches no platform API until a
  * `WebRtc` adapter does. Node's adapter, audio and token file live in `@nestor-home/satellite/node`.

package/dist/pairing.d.ts

@@ -1,5 +1,5 @@
 /**
- * Pairing (`nestor.satellite/2`, rules P1 to P7): get a token from the core with either proof.
+ * Pairing (`nestor.satellite/1`, rules P1 to P7): get a token from the core with either proof.
  *
  *     POST /satellites/pairings                         manifest [+ enrollment code] → ticket
  *     POST /satellites/pairings/{pairing_id}/enrollment enrollment code              → state

package/dist/pairing.js

@@ -1,5 +1,5 @@
 /**
- * Pairing (`nestor.satellite/2`, rules P1 to P7): get a token from the core with either proof.
+ * Pairing (`nestor.satellite/1`, rules P1 to P7): get a token from the core with either proof.
  *
  *     POST /satellites/pairings                         manifest [+ enrollment code] → ticket
  *     POST /satellites/pairings/{pairing_id}/enrollment enrollment code              → state

package/dist/protocol.d.ts

@@ -1,9 +1,9 @@
 /**
- * The values of the satellite protocol `nestor.satellite/2`: a device, what it can do, how it can
+ * The values of the satellite protocol `nestor.satellite/1`: a device, what it can do, how it can
  * be paired, and the intents it receives. They mirror the JSON Schemas shipped in `schemas/`,
  * published by the server.
  */
-export declare const PROTOCOL = "nestor.satellite/2";
+export declare const PROTOCOL = "nestor.satellite/1";
 export declare const AUDIO_CAPTURE = "audio.capture";
 export declare const AUDIO_PLAYBACK = "audio.playback";
 export declare const EXPRESSION = "expression.emotion";
@@ -29,7 +29,7 @@ export type PairingMethod = (typeof PAIRING_METHODS)[number];
 /** The methods that bring an enrollment code to the device. */
 export declare const ENROLLMENT_METHODS: readonly ["enrollment.input", "enrollment.provisioning", "enrollment.qr"];
 export type EnrollmentMethod = (typeof ENROLLMENT_METHODS)[number];
-/** Something that does not follow `nestor.satellite/2`. */
+/** Something that does not follow `nestor.satellite/1`. */
 export declare class ProtocolError extends Error {
     name: string;
 }

package/dist/protocol.js

@@ -1,10 +1,10 @@
 /**
- * The values of the satellite protocol `nestor.satellite/2`: a device, what it can do, how it can
+ * The values of the satellite protocol `nestor.satellite/1`: a device, what it can do, how it can
  * be paired, and the intents it receives. They mirror the JSON Schemas shipped in `schemas/`,
  * published by the server.
  */
 import { SDK_NAME, SDK_VERSION } from "./version.js";
-export const PROTOCOL = "nestor.satellite/2";
+export const PROTOCOL = "nestor.satellite/1";
 // Capabilities the core knows today; a driver may declare others (`family.feature`).
 export const AUDIO_CAPTURE = "audio.capture";
 export const AUDIO_PLAYBACK = "audio.playback";
@@ -36,7 +36,7 @@ export const PAIRING_METHODS = [
 ];
 /** The methods that bring an enrollment code to the device. */
 export const ENROLLMENT_METHODS = ["enrollment.input", "enrollment.provisioning", "enrollment.qr"];
-/** Something that does not follow `nestor.satellite/2`. */
+/** Something that does not follow `nestor.satellite/1`. */
 export class ProtocolError extends Error {
     name = "ProtocolError";
 }

package/dist/version.d.ts

@@ -1,4 +1,4 @@
 /** Sent in the manifest (`sdk`). release-please keeps the version equal to `package.json`. */
 export declare const SDK_NAME = "@nestor-home/satellite";
-export declare const SDK_VERSION = "0.1.0";
+export declare const SDK_VERSION = "0.2.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,4 +1,4 @@
 /** Sent in the manifest (`sdk`). release-please keeps the version equal to `package.json`. */
 export const SDK_NAME = "@nestor-home/satellite";
-export const SDK_VERSION = "0.1.0"; // x-release-please-version
+export const SDK_VERSION = "0.2.0"; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestor-home/satellite",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK to write Nestor satellites, in browsers and in Node: pairing, WebRTC audio and the nestor data channel.",
   "keywords": [
     "nestor",
@@ -9,7 +9,7 @@
     "webrtc",
     "home automation"
   ],
-  "homepage": "https://nestor.mathislambert.fr",
+  "homepage": "https://nestorhome.dev",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nestor-home/nestor-satellite-typescript.git"

package/schemas/ack.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/ack.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/ack.json",
   "title": "The intent `of` was received (carrying it out is the device's business).",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_core",
   "type": "object",
   "properties": {

package/schemas/hello.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/hello.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/hello.json",
   "title": "First message of a connection: the device's manifest (its id must be the paired one).",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_core",
   "type": "object",
   "properties": {

package/schemas/intent.beat.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/intent.beat.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/intent.beat.json",
   "title": "A word is being played: a light speech accent.",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_satellite",
   "type": "object",
   "properties": {

package/schemas/intent.behavior.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/intent.behavior.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/intent.behavior.json",
   "title": "The assistant's attitude changed: show it until the next one.",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_satellite",
   "type": "object",
   "properties": {

package/schemas/intent.expression.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/intent.expression.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/intent.expression.json",
   "title": "An expression, sent as the matching audio is played (a laugh when the laugh is heard).",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_satellite",
   "type": "object",
   "properties": {

package/schemas/intent.identify.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/intent.identify.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/intent.identify.json",
   "title": "A person asks the device to make itself noticed for a few seconds (blink, wiggle, chime).",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_satellite",
   "type": "object",
   "properties": {

package/schemas/manifest.json

@@ -1,12 +1,12 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/manifest.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/manifest.json",
   "title": "Satellite manifest",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "protocol": {
-      "const": "nestor.satellite/2"
+      "const": "nestor.satellite/1"
     },
     "device": {
       "type": "object",

package/schemas/observation.person.detected.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/observation.person.detected.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/observation.person.detected.json",
   "title": "People seen by the device's own detector, now (no image leaves the device).",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_core",
   "type": "object",
   "properties": {

package/schemas/observation.speech.activity.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/observation.speech.activity.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/observation.speech.activity.json",
   "title": "Voice activity detected on the device started (`active`) or stopped.",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_core",
   "type": "object",
   "properties": {

package/schemas/pairing.enrollment.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/pairing.enrollment.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/pairing.enrollment.json",
   "title": "POST /satellites/pairings/{pairing_id}/enrollment: a pending device's code",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "enrollment_code": {

package/schemas/pairing.error.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/pairing.error.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/pairing.error.json",
   "title": "Error answer of the pairing endpoints",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "error": {

package/schemas/pairing.request.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/pairing.request.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/pairing.request.json",
   "title": "POST /satellites/pairings: a device asks to pair",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "manifest": {

package/schemas/pairing.state.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/pairing.state.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/pairing.state.json",
   "title": "GET /satellites/pairings/{pairing_id}: where a pairing stands",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "status": {

package/schemas/pairing.ticket.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/pairing.ticket.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/pairing.ticket.json",
   "title": "201 answer to a pairing request",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "type": "object",
   "properties": {
     "pairing_id": {

package/schemas/welcome.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://nestor.mathislambert.fr/schemas/satellite/2/welcome.json",
+  "$id": "https://nestorhome.dev/schemas/satellite/1/welcome.json",
   "title": "Answer to `hello`: where the device is and what it was allowed to do.",
-  "x-protocol": "nestor.satellite/2",
+  "x-protocol": "nestor.satellite/1",
   "x-direction": "to_satellite",
   "type": "object",
   "properties": {

package/src/codes.ts

@@ -1,5 +1,5 @@
 /**
- * The codes of `nestor.satellite/2` pairing, and the pairing URI that carries an enrollment code.
+ * The codes of `nestor.satellite/1` pairing, and the pairing URI that carries an enrollment code.
  *
  * Device code: 6 decimal digits the core gives the device, which presents them (screen, voice, log)
  * for a person to type in the admin.

package/src/index.ts

@@ -1,6 +1,6 @@
 /**
  * Write a Nestor satellite in TypeScript: pair with the core, stream audio over WebRTC, carry out
- * its intents and report observations, following the `nestor.satellite/2` protocol.
+ * its intents and report observations, following the `nestor.satellite/1` protocol.
  *
  * This entry point runs anywhere (browsers, Node, workers): it touches no platform API until a
  * `WebRtc` adapter does. Node's adapter, audio and token file live in `@nestor-home/satellite/node`.

package/src/pairing.ts

@@ -1,5 +1,5 @@
 /**
- * Pairing (`nestor.satellite/2`, rules P1 to P7): get a token from the core with either proof.
+ * Pairing (`nestor.satellite/1`, rules P1 to P7): get a token from the core with either proof.
  *
  *     POST /satellites/pairings                         manifest [+ enrollment code] → ticket
  *     POST /satellites/pairings/{pairing_id}/enrollment enrollment code              → state

package/src/protocol.ts

@@ -1,12 +1,12 @@
 /**
- * The values of the satellite protocol `nestor.satellite/2`: a device, what it can do, how it can
+ * The values of the satellite protocol `nestor.satellite/1`: a device, what it can do, how it can
  * be paired, and the intents it receives. They mirror the JSON Schemas shipped in `schemas/`,
  * published by the server.
  */
 
 import { SDK_NAME, SDK_VERSION } from "./version.js";
 
-export const PROTOCOL = "nestor.satellite/2";
+export const PROTOCOL = "nestor.satellite/1";
 
 // Capabilities the core knows today; a driver may declare others (`family.feature`).
 export const AUDIO_CAPTURE = "audio.capture";
@@ -49,7 +49,7 @@ export type PairingMethod = (typeof PAIRING_METHODS)[number];
 export const ENROLLMENT_METHODS = ["enrollment.input", "enrollment.provisioning", "enrollment.qr"] as const;
 export type EnrollmentMethod = (typeof ENROLLMENT_METHODS)[number];
 
-/** Something that does not follow `nestor.satellite/2`. */
+/** Something that does not follow `nestor.satellite/1`. */
 export class ProtocolError extends Error {
   override name = "ProtocolError";
 }

package/src/version.ts

@@ -1,3 +1,3 @@
 /** Sent in the manifest (`sdk`). release-please keeps the version equal to `package.json`. */
 export const SDK_NAME = "@nestor-home/satellite";
-export const SDK_VERSION = "0.1.0"; // x-release-please-version
+export const SDK_VERSION = "0.2.0"; // x-release-please-version