@camstack/addon-terminal 0.1.75 → 0.1.77

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/addon.js CHANGED
@@ -5438,6 +5438,12 @@ Object.fromEntries([
5438
5438
  icon: "move",
5439
5439
  order: 40
5440
5440
  },
5441
+ {
5442
+ id: "navigation",
5443
+ label: "Navigation",
5444
+ icon: "compass",
5445
+ order: 41
5446
+ },
5441
5447
  {
5442
5448
  id: "consumables",
5443
5449
  label: "Consumables",
@@ -29113,6 +29119,287 @@ var ptzAutotrackCapability = {
29113
29119
  */
29114
29120
  durability: "session"
29115
29121
  };
29122
+ /**
29123
+ * `navigation` — a device-scoped capability that natively expresses the FULL
29124
+ * navigation / action surface of a robot that DRIVES ITSELF and carries an
29125
+ * on-board camera (the Dreame robot-vacuum camera is the first provider).
29126
+ *
29127
+ * Why a NEW cap rather than overloading `ptz`:
29128
+ * - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
29129
+ * robot vacuum has no gimbal — the whole chassis drives, turns and spins.
29130
+ * The two are different physical models: PTZ is absolute-position + presets,
29131
+ * navigation is momentary drive nudges + discrete robot ACTIONS
29132
+ * (dock / spot-clean / follow-pet / go-to-point / …).
29133
+ * - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
29134
+ * the reverse:
29135
+ * 1. a native CamStack navigation panel (data-driven from `listActions`
29136
+ * / `getOptions`), and
29137
+ * 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
29138
+ * robot camera shows up in the existing PTZ control path without every
29139
+ * PTZ provider learning about robots. The mapping lives in the adapter,
29140
+ * not here (see the addon design note):
29141
+ * ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
29142
+ * ptz.stop() → navigation.stop()
29143
+ * ptz.goHome() → navigation.runAction('goHome')
29144
+ * ptz.getPresets() → navigation.listActions() (id→preset)
29145
+ * ptz.goToPreset(id) → navigation.runAction(id)
29146
+ *
29147
+ * ## Continuous drive
29148
+ *
29149
+ * `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
29150
+ * sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
29151
+ * one `stop()` on release — exactly like the robot app's remote-drive joystick.
29152
+ * The provider forwards EACH `move` to one drive write; it must NOT debounce or
29153
+ * coalesce them. The UI owns the cadence.
29154
+ *
29155
+ * ## The action dictionary
29156
+ *
29157
+ * The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
29158
+ * are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
29159
+ * carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
29160
+ * native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
29161
+ * vendor-specific list. `kind: 'action'` entries are triggered with
29162
+ * `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
29163
+ * (the entry carries the `soundId` to pass). The general primitives — `move`,
29164
+ * `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
29165
+ *
29166
+ * NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
29167
+ * `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
29168
+ * that the currently-published `@apocaliss92/nodedreame` already exposes on
29169
+ * every device handle. A future nodedreame publish adds a typed
29170
+ * `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
29171
+ * provider can then swap the raw calls for the typed methods with no change to
29172
+ * THIS contract.
29173
+ */
29174
+ /**
29175
+ * A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
29176
+ * keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
29177
+ * halts it.
29178
+ *
29179
+ * - `pan` — turn: negative = left, positive = right, 0 = straight.
29180
+ * - `tilt` — throttle: positive = forward, negative = spin / turn-around.
29181
+ * - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
29182
+ * vector by it (drivers without proportional drive ignore it).
29183
+ *
29184
+ * `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
29185
+ * axis alone; an all-undefined nudge is a no-op.
29186
+ */
29187
+ var NavigationMoveCommandSchema = object({
29188
+ pan: number().min(-1).max(1).optional(),
29189
+ tilt: number().min(-1).max(1).optional(),
29190
+ speed: number().min(0).max(1).optional()
29191
+ });
29192
+ /**
29193
+ * The enumerated discrete actions a navigation-capable robot can perform via
29194
+ * `runAction`. This is the CLOSED vocabulary; a given device advertises the
29195
+ * subset it supports through `listActions`. Sounds are NOT here — they go through
29196
+ * `playSound` (see the `sound` dictionary entries).
29197
+ */
29198
+ var NavigationActionIdSchema = _enum([
29199
+ "goHome",
29200
+ "locate",
29201
+ "spotClean",
29202
+ "findPet",
29203
+ "personFollow",
29204
+ "stop",
29205
+ "startClean",
29206
+ "pauseClean",
29207
+ "dockWash",
29208
+ "autoEmpty",
29209
+ "flashOn",
29210
+ "flashOff"
29211
+ ]);
29212
+ /** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
29213
+ var NavigationEntryKindSchema = _enum(["action", "sound"]);
29214
+ /**
29215
+ * One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
29216
+ * native panel and the PTZ mimic render as a button.
29217
+ *
29218
+ * - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
29219
+ * (pass to `runAction`); for `kind:'sound'` it is a namespaced id
29220
+ * (`sound:meow`) whose `soundId` is passed to `playSound`.
29221
+ * - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
29222
+ * - `label` — operator-facing English label.
29223
+ * - `soundId` — wire sound id, present only on `kind:'sound'` entries.
29224
+ * - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
29225
+ * PTZ render ONLY enabled entries. Data-driven: the provider
29226
+ * flips it from config, never by editing code.
29227
+ */
29228
+ var NavigationActionEntrySchema = object({
29229
+ id: string(),
29230
+ kind: NavigationEntryKindSchema,
29231
+ label: string(),
29232
+ icon: string(),
29233
+ /** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
29234
+ soundId: number().int().optional(),
29235
+ /** Per-device feature flag — render this entry only when true. */
29236
+ enabled: boolean()
29237
+ });
29238
+ /** Coordinates for `goToPoint` — a point on the robot's live map. */
29239
+ var NavigationPointSchema = object({
29240
+ x: number(),
29241
+ y: number()
29242
+ });
29243
+ /**
29244
+ * Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
29245
+ * The cap reports which are enabled so the UI / PTZ render only the controls
29246
+ * that are turned on for THIS device. Data-driven: the provider derives these
29247
+ * from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
29248
+ * live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
29249
+ * that are not dictionary entries.
29250
+ *
29251
+ * - `move` / `stop` — the momentary drive joystick.
29252
+ * - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
29253
+ * map-coordinate plumbing is wired.
29254
+ * - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
29255
+ * - `playSound` — the sound buttons (dictionary `kind:'sound'`).
29256
+ * - `light` — the on/off fill-light toggle (works anytime).
29257
+ * - `lightMode` — the auto/manual selector + manual level slider (a
29258
+ * camera-service control; needs an active stream).
29259
+ */
29260
+ var NavigationFeaturesSchema = object({
29261
+ move: boolean(),
29262
+ stop: boolean(),
29263
+ goToPoint: boolean(),
29264
+ runAction: boolean(),
29265
+ playSound: boolean(),
29266
+ light: boolean(),
29267
+ lightMode: boolean()
29268
+ });
29269
+ /** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
29270
+ var NavigationLightModeSchema = _enum(["auto", "manual"]);
29271
+ /**
29272
+ * Live navigation state so the UI can reflect what the robot is doing:
29273
+ * - `mode` — coarse activity (idle / cleaning / following / …).
29274
+ * - `following` — person/pet follow is currently armed.
29275
+ * - `flash` — the on-camera fill light is on.
29276
+ * - `lightMode` — auto vs manual fill-light mode.
29277
+ * - `lightLevel` — manual fill-light level (40..100); meaningful when
29278
+ * `lightMode === 'manual'`.
29279
+ */
29280
+ var NavigationStatusSchema = object({
29281
+ mode: _enum([
29282
+ "idle",
29283
+ "cleaning",
29284
+ "spot",
29285
+ "following",
29286
+ "goto",
29287
+ "returning",
29288
+ "paused",
29289
+ "unknown"
29290
+ ]),
29291
+ following: boolean(),
29292
+ flash: boolean(),
29293
+ lightMode: NavigationLightModeSchema,
29294
+ lightLevel: number().min(40).max(100),
29295
+ /** Ms epoch when the slice was last updated. */
29296
+ lastChangedAt: number()
29297
+ });
29298
+ /**
29299
+ * Runtime-state slice owned by this cap (kernel-managed: validated, mirrored,
29300
+ * observable). Adds `lastFetchedAt` on top of the status shape per the
29301
+ * convention.
29302
+ */
29303
+ var NavigationRuntimeStateSchema = NavigationStatusSchema.extend({ lastFetchedAt: number() });
29304
+ var navigationCapability = {
29305
+ name: "navigation",
29306
+ scope: "device",
29307
+ deviceNative: true,
29308
+ mode: "singleton",
29309
+ deviceTypes: [DeviceType.Camera],
29310
+ deviceConfig: { ui: {
29311
+ kind: "widget",
29312
+ widgetId: "host/navigation-panel",
29313
+ tab: "navigation",
29314
+ topTab: true,
29315
+ label: "Navigation",
29316
+ order: 0
29317
+ } },
29318
+ methods: {
29319
+ /**
29320
+ * Momentary drive nudge (the robot moves). `protected` — mirrors
29321
+ * `ptz.continuousMove` so the Viewer navigation panel (and the PTZ-mimic
29322
+ * path) works for any authenticated user, not admin-only. The UI sends
29323
+ * these at ~1 Hz while a control is held; the provider forwards each one to
29324
+ * a single drive write WITHOUT debouncing.
29325
+ */
29326
+ move: method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
29327
+ /** Halt all motion immediately (zero drive vector). */
29328
+ stop: method(object({ deviceId: number() }), _void(), { kind: "mutation" }),
29329
+ /** Send the robot to a point on its live map. */
29330
+ goToPoint: method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
29331
+ /**
29332
+ * Enumerate the discrete controls THIS device supports (data-driven UI +
29333
+ * PTZ mimic). Camera-probed subset of {@link NAVIGATION_ACTION_CATALOG}.
29334
+ */
29335
+ listActions: method(object({ deviceId: number() }), array(NavigationActionEntrySchema)),
29336
+ /**
29337
+ * Run one discrete action (a `kind:'action'` dictionary entry). Invalid /
29338
+ * unsupported action ids are rejected by the provider.
29339
+ */
29340
+ runAction: method(object({
29341
+ deviceId: number(),
29342
+ actionId: NavigationActionIdSchema
29343
+ }), _void(), { kind: "mutation" }),
29344
+ /** Play a sound by its wire id (the `soundId` of a `kind:'sound'` entry). */
29345
+ playSound: method(object({
29346
+ deviceId: number(),
29347
+ soundId: number().int()
29348
+ }), _void(), { kind: "mutation" }),
29349
+ /**
29350
+ * Turn the on-camera fill light on / off (the `OpenFullLight` control —
29351
+ * works anytime, no active stream required).
29352
+ */
29353
+ setLightOn: method(object({
29354
+ deviceId: number(),
29355
+ on: boolean()
29356
+ }), _void(), { kind: "mutation" }),
29357
+ /**
29358
+ * Set the fill-light mode (auto vs manual). `manual` optionally carries the
29359
+ * initial `level`. The auto/manual + level control is a CAMERA-service
29360
+ * action that generally needs an active camera stream/monitor session — the
29361
+ * UI shows the manual level slider ONLY when `mode === 'manual'`.
29362
+ */
29363
+ setLightMode: method(object({
29364
+ deviceId: number(),
29365
+ mode: NavigationLightModeSchema,
29366
+ level: number().min(40).max(100).optional()
29367
+ }), _void(), { kind: "mutation" }),
29368
+ /** Set the MANUAL fill-light level (40..100). Implies `manual` mode. */
29369
+ setLightLevel: method(object({
29370
+ deviceId: number(),
29371
+ level: number().min(40).max(100)
29372
+ }), _void(), { kind: "mutation" }),
29373
+ /**
29374
+ * Per-device FEATURE-FLAG report for the general primitives — drives which
29375
+ * controls the UI shows (the per-entry flags for the dictionary come back on
29376
+ * `listActions`).
29377
+ */
29378
+ getFeatures: method(object({ deviceId: number() }), NavigationFeaturesSchema)
29379
+ },
29380
+ events: { onStatusChanged: { data: object({
29381
+ deviceId: number(),
29382
+ status: NavigationStatusSchema
29383
+ }) } },
29384
+ status: {
29385
+ schema: NavigationStatusSchema,
29386
+ kind: "push"
29387
+ },
29388
+ /**
29389
+ * Runtime-state slice mirrored by the kernel. The navigation panel watches it
29390
+ * for live mode / follow / flash changes.
29391
+ */
29392
+ runtimeState: NavigationRuntimeStateSchema,
29393
+ /**
29394
+ * Runtime-state durability: **session** — like `vacuum-control`, a restored
29395
+ * `mode: cleaning` / `following: true` is a robot that is not actually doing
29396
+ * that. The live handle re-publishes on connect.
29397
+ *
29398
+ * See `RuntimeStateDurability`. Enforced by
29399
+ * `scripts/check-runtime-state-durability.ts`.
29400
+ */
29401
+ durability: "session"
29402
+ };
29116
29403
  DeviceType.Camera, DeviceType.Sensor, DeviceType.Switch, method(object({ deviceId: number().int().nonnegative() }), object({ success: literal(true) }), {
29117
29404
  kind: "mutation",
29118
29405
  auth: "admin"
@@ -32388,6 +32675,7 @@ var DEVICE_LOCAL_STATE_CAPS = {
32388
32675
  motionTrigger: motionTriggerCapability,
32389
32676
  motionZones: motionZonesCapability,
32390
32677
  nativeObjectDetection: nativeObjectDetectionCapability,
32678
+ navigation: navigationCapability,
32391
32679
  networkLink: networkLinkCapability,
32392
32680
  notifier: notifierCapability,
32393
32681
  numericSensor: numericSensorCapability,
@@ -35875,6 +36163,66 @@ Object.freeze({
35875
36163
  addonId: null,
35876
36164
  access: "create"
35877
36165
  },
36166
+ "navigation.getFeatures": {
36167
+ capName: "navigation",
36168
+ capScope: "device",
36169
+ addonId: null,
36170
+ access: "view"
36171
+ },
36172
+ "navigation.goToPoint": {
36173
+ capName: "navigation",
36174
+ capScope: "device",
36175
+ addonId: null,
36176
+ access: "create"
36177
+ },
36178
+ "navigation.listActions": {
36179
+ capName: "navigation",
36180
+ capScope: "device",
36181
+ addonId: null,
36182
+ access: "view"
36183
+ },
36184
+ "navigation.move": {
36185
+ capName: "navigation",
36186
+ capScope: "device",
36187
+ addonId: null,
36188
+ access: "create"
36189
+ },
36190
+ "navigation.playSound": {
36191
+ capName: "navigation",
36192
+ capScope: "device",
36193
+ addonId: null,
36194
+ access: "create"
36195
+ },
36196
+ "navigation.runAction": {
36197
+ capName: "navigation",
36198
+ capScope: "device",
36199
+ addonId: null,
36200
+ access: "create"
36201
+ },
36202
+ "navigation.setLightLevel": {
36203
+ capName: "navigation",
36204
+ capScope: "device",
36205
+ addonId: null,
36206
+ access: "create"
36207
+ },
36208
+ "navigation.setLightMode": {
36209
+ capName: "navigation",
36210
+ capScope: "device",
36211
+ addonId: null,
36212
+ access: "create"
36213
+ },
36214
+ "navigation.setLightOn": {
36215
+ capName: "navigation",
36216
+ capScope: "device",
36217
+ addonId: null,
36218
+ access: "create"
36219
+ },
36220
+ "navigation.stop": {
36221
+ capName: "navigation",
36222
+ capScope: "device",
36223
+ addonId: null,
36224
+ access: "create"
36225
+ },
35878
36226
  "networkAccess.getEndpoint": {
35879
36227
  capName: "network-access",
35880
36228
  capScope: "system",
@@ -39970,6 +40318,56 @@ Object.freeze({
39970
40318
  form: "single",
39971
40319
  optional: false
39972
40320
  }],
40321
+ "navigation.getFeatures": [{
40322
+ name: "deviceId",
40323
+ form: "single",
40324
+ optional: false
40325
+ }],
40326
+ "navigation.goToPoint": [{
40327
+ name: "deviceId",
40328
+ form: "single",
40329
+ optional: false
40330
+ }],
40331
+ "navigation.listActions": [{
40332
+ name: "deviceId",
40333
+ form: "single",
40334
+ optional: false
40335
+ }],
40336
+ "navigation.move": [{
40337
+ name: "deviceId",
40338
+ form: "single",
40339
+ optional: false
40340
+ }],
40341
+ "navigation.playSound": [{
40342
+ name: "deviceId",
40343
+ form: "single",
40344
+ optional: false
40345
+ }],
40346
+ "navigation.runAction": [{
40347
+ name: "deviceId",
40348
+ form: "single",
40349
+ optional: false
40350
+ }],
40351
+ "navigation.setLightLevel": [{
40352
+ name: "deviceId",
40353
+ form: "single",
40354
+ optional: false
40355
+ }],
40356
+ "navigation.setLightMode": [{
40357
+ name: "deviceId",
40358
+ form: "single",
40359
+ optional: false
40360
+ }],
40361
+ "navigation.setLightOn": [{
40362
+ name: "deviceId",
40363
+ form: "single",
40364
+ optional: false
40365
+ }],
40366
+ "navigation.stop": [{
40367
+ name: "deviceId",
40368
+ form: "single",
40369
+ optional: false
40370
+ }],
39973
40371
  "networkQuality.getDeviceStats": [{
39974
40372
  name: "deviceId",
39975
40373
  form: "single",
package/dist/addon.mjs CHANGED
@@ -5415,6 +5415,12 @@ Object.fromEntries([
5415
5415
  icon: "move",
5416
5416
  order: 40
5417
5417
  },
5418
+ {
5419
+ id: "navigation",
5420
+ label: "Navigation",
5421
+ icon: "compass",
5422
+ order: 41
5423
+ },
5418
5424
  {
5419
5425
  id: "consumables",
5420
5426
  label: "Consumables",
@@ -29090,6 +29096,287 @@ var ptzAutotrackCapability = {
29090
29096
  */
29091
29097
  durability: "session"
29092
29098
  };
29099
+ /**
29100
+ * `navigation` — a device-scoped capability that natively expresses the FULL
29101
+ * navigation / action surface of a robot that DRIVES ITSELF and carries an
29102
+ * on-board camera (the Dreame robot-vacuum camera is the first provider).
29103
+ *
29104
+ * Why a NEW cap rather than overloading `ptz`:
29105
+ * - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
29106
+ * robot vacuum has no gimbal — the whole chassis drives, turns and spins.
29107
+ * The two are different physical models: PTZ is absolute-position + presets,
29108
+ * navigation is momentary drive nudges + discrete robot ACTIONS
29109
+ * (dock / spot-clean / follow-pet / go-to-point / …).
29110
+ * - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
29111
+ * the reverse:
29112
+ * 1. a native CamStack navigation panel (data-driven from `listActions`
29113
+ * / `getOptions`), and
29114
+ * 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
29115
+ * robot camera shows up in the existing PTZ control path without every
29116
+ * PTZ provider learning about robots. The mapping lives in the adapter,
29117
+ * not here (see the addon design note):
29118
+ * ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
29119
+ * ptz.stop() → navigation.stop()
29120
+ * ptz.goHome() → navigation.runAction('goHome')
29121
+ * ptz.getPresets() → navigation.listActions() (id→preset)
29122
+ * ptz.goToPreset(id) → navigation.runAction(id)
29123
+ *
29124
+ * ## Continuous drive
29125
+ *
29126
+ * `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
29127
+ * sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
29128
+ * one `stop()` on release — exactly like the robot app's remote-drive joystick.
29129
+ * The provider forwards EACH `move` to one drive write; it must NOT debounce or
29130
+ * coalesce them. The UI owns the cadence.
29131
+ *
29132
+ * ## The action dictionary
29133
+ *
29134
+ * The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
29135
+ * are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
29136
+ * carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
29137
+ * native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
29138
+ * vendor-specific list. `kind: 'action'` entries are triggered with
29139
+ * `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
29140
+ * (the entry carries the `soundId` to pass). The general primitives — `move`,
29141
+ * `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
29142
+ *
29143
+ * NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
29144
+ * `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
29145
+ * that the currently-published `@apocaliss92/nodedreame` already exposes on
29146
+ * every device handle. A future nodedreame publish adds a typed
29147
+ * `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
29148
+ * provider can then swap the raw calls for the typed methods with no change to
29149
+ * THIS contract.
29150
+ */
29151
+ /**
29152
+ * A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
29153
+ * keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
29154
+ * halts it.
29155
+ *
29156
+ * - `pan` — turn: negative = left, positive = right, 0 = straight.
29157
+ * - `tilt` — throttle: positive = forward, negative = spin / turn-around.
29158
+ * - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
29159
+ * vector by it (drivers without proportional drive ignore it).
29160
+ *
29161
+ * `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
29162
+ * axis alone; an all-undefined nudge is a no-op.
29163
+ */
29164
+ var NavigationMoveCommandSchema = object({
29165
+ pan: number().min(-1).max(1).optional(),
29166
+ tilt: number().min(-1).max(1).optional(),
29167
+ speed: number().min(0).max(1).optional()
29168
+ });
29169
+ /**
29170
+ * The enumerated discrete actions a navigation-capable robot can perform via
29171
+ * `runAction`. This is the CLOSED vocabulary; a given device advertises the
29172
+ * subset it supports through `listActions`. Sounds are NOT here — they go through
29173
+ * `playSound` (see the `sound` dictionary entries).
29174
+ */
29175
+ var NavigationActionIdSchema = _enum([
29176
+ "goHome",
29177
+ "locate",
29178
+ "spotClean",
29179
+ "findPet",
29180
+ "personFollow",
29181
+ "stop",
29182
+ "startClean",
29183
+ "pauseClean",
29184
+ "dockWash",
29185
+ "autoEmpty",
29186
+ "flashOn",
29187
+ "flashOff"
29188
+ ]);
29189
+ /** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
29190
+ var NavigationEntryKindSchema = _enum(["action", "sound"]);
29191
+ /**
29192
+ * One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
29193
+ * native panel and the PTZ mimic render as a button.
29194
+ *
29195
+ * - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
29196
+ * (pass to `runAction`); for `kind:'sound'` it is a namespaced id
29197
+ * (`sound:meow`) whose `soundId` is passed to `playSound`.
29198
+ * - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
29199
+ * - `label` — operator-facing English label.
29200
+ * - `soundId` — wire sound id, present only on `kind:'sound'` entries.
29201
+ * - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
29202
+ * PTZ render ONLY enabled entries. Data-driven: the provider
29203
+ * flips it from config, never by editing code.
29204
+ */
29205
+ var NavigationActionEntrySchema = object({
29206
+ id: string(),
29207
+ kind: NavigationEntryKindSchema,
29208
+ label: string(),
29209
+ icon: string(),
29210
+ /** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
29211
+ soundId: number().int().optional(),
29212
+ /** Per-device feature flag — render this entry only when true. */
29213
+ enabled: boolean()
29214
+ });
29215
+ /** Coordinates for `goToPoint` — a point on the robot's live map. */
29216
+ var NavigationPointSchema = object({
29217
+ x: number(),
29218
+ y: number()
29219
+ });
29220
+ /**
29221
+ * Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
29222
+ * The cap reports which are enabled so the UI / PTZ render only the controls
29223
+ * that are turned on for THIS device. Data-driven: the provider derives these
29224
+ * from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
29225
+ * live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
29226
+ * that are not dictionary entries.
29227
+ *
29228
+ * - `move` / `stop` — the momentary drive joystick.
29229
+ * - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
29230
+ * map-coordinate plumbing is wired.
29231
+ * - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
29232
+ * - `playSound` — the sound buttons (dictionary `kind:'sound'`).
29233
+ * - `light` — the on/off fill-light toggle (works anytime).
29234
+ * - `lightMode` — the auto/manual selector + manual level slider (a
29235
+ * camera-service control; needs an active stream).
29236
+ */
29237
+ var NavigationFeaturesSchema = object({
29238
+ move: boolean(),
29239
+ stop: boolean(),
29240
+ goToPoint: boolean(),
29241
+ runAction: boolean(),
29242
+ playSound: boolean(),
29243
+ light: boolean(),
29244
+ lightMode: boolean()
29245
+ });
29246
+ /** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
29247
+ var NavigationLightModeSchema = _enum(["auto", "manual"]);
29248
+ /**
29249
+ * Live navigation state so the UI can reflect what the robot is doing:
29250
+ * - `mode` — coarse activity (idle / cleaning / following / …).
29251
+ * - `following` — person/pet follow is currently armed.
29252
+ * - `flash` — the on-camera fill light is on.
29253
+ * - `lightMode` — auto vs manual fill-light mode.
29254
+ * - `lightLevel` — manual fill-light level (40..100); meaningful when
29255
+ * `lightMode === 'manual'`.
29256
+ */
29257
+ var NavigationStatusSchema = object({
29258
+ mode: _enum([
29259
+ "idle",
29260
+ "cleaning",
29261
+ "spot",
29262
+ "following",
29263
+ "goto",
29264
+ "returning",
29265
+ "paused",
29266
+ "unknown"
29267
+ ]),
29268
+ following: boolean(),
29269
+ flash: boolean(),
29270
+ lightMode: NavigationLightModeSchema,
29271
+ lightLevel: number().min(40).max(100),
29272
+ /** Ms epoch when the slice was last updated. */
29273
+ lastChangedAt: number()
29274
+ });
29275
+ /**
29276
+ * Runtime-state slice owned by this cap (kernel-managed: validated, mirrored,
29277
+ * observable). Adds `lastFetchedAt` on top of the status shape per the
29278
+ * convention.
29279
+ */
29280
+ var NavigationRuntimeStateSchema = NavigationStatusSchema.extend({ lastFetchedAt: number() });
29281
+ var navigationCapability = {
29282
+ name: "navigation",
29283
+ scope: "device",
29284
+ deviceNative: true,
29285
+ mode: "singleton",
29286
+ deviceTypes: [DeviceType.Camera],
29287
+ deviceConfig: { ui: {
29288
+ kind: "widget",
29289
+ widgetId: "host/navigation-panel",
29290
+ tab: "navigation",
29291
+ topTab: true,
29292
+ label: "Navigation",
29293
+ order: 0
29294
+ } },
29295
+ methods: {
29296
+ /**
29297
+ * Momentary drive nudge (the robot moves). `protected` — mirrors
29298
+ * `ptz.continuousMove` so the Viewer navigation panel (and the PTZ-mimic
29299
+ * path) works for any authenticated user, not admin-only. The UI sends
29300
+ * these at ~1 Hz while a control is held; the provider forwards each one to
29301
+ * a single drive write WITHOUT debouncing.
29302
+ */
29303
+ move: method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
29304
+ /** Halt all motion immediately (zero drive vector). */
29305
+ stop: method(object({ deviceId: number() }), _void(), { kind: "mutation" }),
29306
+ /** Send the robot to a point on its live map. */
29307
+ goToPoint: method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
29308
+ /**
29309
+ * Enumerate the discrete controls THIS device supports (data-driven UI +
29310
+ * PTZ mimic). Camera-probed subset of {@link NAVIGATION_ACTION_CATALOG}.
29311
+ */
29312
+ listActions: method(object({ deviceId: number() }), array(NavigationActionEntrySchema)),
29313
+ /**
29314
+ * Run one discrete action (a `kind:'action'` dictionary entry). Invalid /
29315
+ * unsupported action ids are rejected by the provider.
29316
+ */
29317
+ runAction: method(object({
29318
+ deviceId: number(),
29319
+ actionId: NavigationActionIdSchema
29320
+ }), _void(), { kind: "mutation" }),
29321
+ /** Play a sound by its wire id (the `soundId` of a `kind:'sound'` entry). */
29322
+ playSound: method(object({
29323
+ deviceId: number(),
29324
+ soundId: number().int()
29325
+ }), _void(), { kind: "mutation" }),
29326
+ /**
29327
+ * Turn the on-camera fill light on / off (the `OpenFullLight` control —
29328
+ * works anytime, no active stream required).
29329
+ */
29330
+ setLightOn: method(object({
29331
+ deviceId: number(),
29332
+ on: boolean()
29333
+ }), _void(), { kind: "mutation" }),
29334
+ /**
29335
+ * Set the fill-light mode (auto vs manual). `manual` optionally carries the
29336
+ * initial `level`. The auto/manual + level control is a CAMERA-service
29337
+ * action that generally needs an active camera stream/monitor session — the
29338
+ * UI shows the manual level slider ONLY when `mode === 'manual'`.
29339
+ */
29340
+ setLightMode: method(object({
29341
+ deviceId: number(),
29342
+ mode: NavigationLightModeSchema,
29343
+ level: number().min(40).max(100).optional()
29344
+ }), _void(), { kind: "mutation" }),
29345
+ /** Set the MANUAL fill-light level (40..100). Implies `manual` mode. */
29346
+ setLightLevel: method(object({
29347
+ deviceId: number(),
29348
+ level: number().min(40).max(100)
29349
+ }), _void(), { kind: "mutation" }),
29350
+ /**
29351
+ * Per-device FEATURE-FLAG report for the general primitives — drives which
29352
+ * controls the UI shows (the per-entry flags for the dictionary come back on
29353
+ * `listActions`).
29354
+ */
29355
+ getFeatures: method(object({ deviceId: number() }), NavigationFeaturesSchema)
29356
+ },
29357
+ events: { onStatusChanged: { data: object({
29358
+ deviceId: number(),
29359
+ status: NavigationStatusSchema
29360
+ }) } },
29361
+ status: {
29362
+ schema: NavigationStatusSchema,
29363
+ kind: "push"
29364
+ },
29365
+ /**
29366
+ * Runtime-state slice mirrored by the kernel. The navigation panel watches it
29367
+ * for live mode / follow / flash changes.
29368
+ */
29369
+ runtimeState: NavigationRuntimeStateSchema,
29370
+ /**
29371
+ * Runtime-state durability: **session** — like `vacuum-control`, a restored
29372
+ * `mode: cleaning` / `following: true` is a robot that is not actually doing
29373
+ * that. The live handle re-publishes on connect.
29374
+ *
29375
+ * See `RuntimeStateDurability`. Enforced by
29376
+ * `scripts/check-runtime-state-durability.ts`.
29377
+ */
29378
+ durability: "session"
29379
+ };
29093
29380
  DeviceType.Camera, DeviceType.Sensor, DeviceType.Switch, method(object({ deviceId: number().int().nonnegative() }), object({ success: literal(true) }), {
29094
29381
  kind: "mutation",
29095
29382
  auth: "admin"
@@ -32365,6 +32652,7 @@ var DEVICE_LOCAL_STATE_CAPS = {
32365
32652
  motionTrigger: motionTriggerCapability,
32366
32653
  motionZones: motionZonesCapability,
32367
32654
  nativeObjectDetection: nativeObjectDetectionCapability,
32655
+ navigation: navigationCapability,
32368
32656
  networkLink: networkLinkCapability,
32369
32657
  notifier: notifierCapability,
32370
32658
  numericSensor: numericSensorCapability,
@@ -35852,6 +36140,66 @@ Object.freeze({
35852
36140
  addonId: null,
35853
36141
  access: "create"
35854
36142
  },
36143
+ "navigation.getFeatures": {
36144
+ capName: "navigation",
36145
+ capScope: "device",
36146
+ addonId: null,
36147
+ access: "view"
36148
+ },
36149
+ "navigation.goToPoint": {
36150
+ capName: "navigation",
36151
+ capScope: "device",
36152
+ addonId: null,
36153
+ access: "create"
36154
+ },
36155
+ "navigation.listActions": {
36156
+ capName: "navigation",
36157
+ capScope: "device",
36158
+ addonId: null,
36159
+ access: "view"
36160
+ },
36161
+ "navigation.move": {
36162
+ capName: "navigation",
36163
+ capScope: "device",
36164
+ addonId: null,
36165
+ access: "create"
36166
+ },
36167
+ "navigation.playSound": {
36168
+ capName: "navigation",
36169
+ capScope: "device",
36170
+ addonId: null,
36171
+ access: "create"
36172
+ },
36173
+ "navigation.runAction": {
36174
+ capName: "navigation",
36175
+ capScope: "device",
36176
+ addonId: null,
36177
+ access: "create"
36178
+ },
36179
+ "navigation.setLightLevel": {
36180
+ capName: "navigation",
36181
+ capScope: "device",
36182
+ addonId: null,
36183
+ access: "create"
36184
+ },
36185
+ "navigation.setLightMode": {
36186
+ capName: "navigation",
36187
+ capScope: "device",
36188
+ addonId: null,
36189
+ access: "create"
36190
+ },
36191
+ "navigation.setLightOn": {
36192
+ capName: "navigation",
36193
+ capScope: "device",
36194
+ addonId: null,
36195
+ access: "create"
36196
+ },
36197
+ "navigation.stop": {
36198
+ capName: "navigation",
36199
+ capScope: "device",
36200
+ addonId: null,
36201
+ access: "create"
36202
+ },
35855
36203
  "networkAccess.getEndpoint": {
35856
36204
  capName: "network-access",
35857
36205
  capScope: "system",
@@ -39947,6 +40295,56 @@ Object.freeze({
39947
40295
  form: "single",
39948
40296
  optional: false
39949
40297
  }],
40298
+ "navigation.getFeatures": [{
40299
+ name: "deviceId",
40300
+ form: "single",
40301
+ optional: false
40302
+ }],
40303
+ "navigation.goToPoint": [{
40304
+ name: "deviceId",
40305
+ form: "single",
40306
+ optional: false
40307
+ }],
40308
+ "navigation.listActions": [{
40309
+ name: "deviceId",
40310
+ form: "single",
40311
+ optional: false
40312
+ }],
40313
+ "navigation.move": [{
40314
+ name: "deviceId",
40315
+ form: "single",
40316
+ optional: false
40317
+ }],
40318
+ "navigation.playSound": [{
40319
+ name: "deviceId",
40320
+ form: "single",
40321
+ optional: false
40322
+ }],
40323
+ "navigation.runAction": [{
40324
+ name: "deviceId",
40325
+ form: "single",
40326
+ optional: false
40327
+ }],
40328
+ "navigation.setLightLevel": [{
40329
+ name: "deviceId",
40330
+ form: "single",
40331
+ optional: false
40332
+ }],
40333
+ "navigation.setLightMode": [{
40334
+ name: "deviceId",
40335
+ form: "single",
40336
+ optional: false
40337
+ }],
40338
+ "navigation.setLightOn": [{
40339
+ name: "deviceId",
40340
+ form: "single",
40341
+ optional: false
40342
+ }],
40343
+ "navigation.stop": [{
40344
+ name: "deviceId",
40345
+ form: "single",
40346
+ optional: false
40347
+ }],
39950
40348
  "networkQuality.getDeviceStats": [{
39951
40349
  name: "deviceId",
39952
40350
  form: "single",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-terminal",
3
- "version": "0.1.75",
3
+ "version": "0.1.77",
4
4
  "description": "Interactive terminal sessions (pty + xterm) as a CamStack addon",
5
5
  "keywords": [
6
6
  "camstack",