@camstack/addon-provider-rtsp 1.2.69 → 1.2.71
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 +483 -1
- package/dist/addon.mjs +483 -1
- package/package.json +1 -1
package/dist/addon.js
CHANGED
|
@@ -23,7 +23,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
23
23
|
//#endregion
|
|
24
24
|
let node_net = require("node:net");
|
|
25
25
|
node_net = __toESM(node_net);
|
|
26
|
-
//#region ../types/dist/event-category-
|
|
26
|
+
//#region ../types/dist/event-category-zAv7pMUz.mjs
|
|
27
27
|
var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
28
28
|
EventCategory["SystemBoot"] = "system.boot";
|
|
29
29
|
EventCategory["SystemAddonsReady"] = "system.addons-ready";
|
|
@@ -395,6 +395,13 @@ var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
|
395
395
|
*/
|
|
396
396
|
EventCategory["BatteryOnStatusChanged"] = "battery.onStatusChanged";
|
|
397
397
|
/**
|
|
398
|
+
* Cap event fired by every device that registers the `network-link`
|
|
399
|
+
* capability. Mirrors the cap definition's `onStatusChanged`. Carries
|
|
400
|
+
* `{ deviceId, status: NetworkLinkStatus }` — a link switch or a signal
|
|
401
|
+
* reading that moved.
|
|
402
|
+
*/
|
|
403
|
+
EventCategory["NetworkLinkOnStatusChanged"] = "network-link.onStatusChanged";
|
|
404
|
+
/**
|
|
398
405
|
* Emitted by the battery cap provider WHEN `wakeForStream` enters the
|
|
399
406
|
* "wake in progress" window — between the Baichuan wake-up issue and
|
|
400
407
|
* the camera's first dialed-back RTP packet. The stream-broker
|
|
@@ -23909,6 +23916,88 @@ onStatusChanged: { data: object({
|
|
|
23909
23916
|
volatileStateFields: ["lastUpdated"]
|
|
23910
23917
|
};
|
|
23911
23918
|
/**
|
|
23919
|
+
* Network-link snapshot. Same shape for every provider (a Reolink wifi
|
|
23920
|
+
* camera, a Home Assistant device with a signal-strength sensor, a Tapo
|
|
23921
|
+
* plug): one slice under `device.runtimeState['network-link']`, one badge,
|
|
23922
|
+
* one Home Assistant projection.
|
|
23923
|
+
*/
|
|
23924
|
+
var NetworkLinkStatusSchema = object({
|
|
23925
|
+
/** The link the device is on. `'unknown'` = not read yet, not "no link". */
|
|
23926
|
+
type: _enum([
|
|
23927
|
+
"wifi",
|
|
23928
|
+
"ethernet",
|
|
23929
|
+
"cellular",
|
|
23930
|
+
"unknown"
|
|
23931
|
+
]),
|
|
23932
|
+
/**
|
|
23933
|
+
* Link quality, 0..100 inclusive, normalised by the provider from whatever
|
|
23934
|
+
* the firmware reports (bars, RSSI, a vendor scale). **`null` means NOT
|
|
23935
|
+
* KNOWN or NOT APPLICABLE** — a wired link has no signal, and a wireless
|
|
23936
|
+
* one whose reading has not landed must not be drawn at 0 %. Consumers
|
|
23937
|
+
* SKIP a null rather than coerce it.
|
|
23938
|
+
*/
|
|
23939
|
+
signalPercent: number().min(0).max(100).nullable(),
|
|
23940
|
+
/** Raw received signal strength in dBm, when the firmware reports one. */
|
|
23941
|
+
rssiDbm: number().optional(),
|
|
23942
|
+
/** Network name of a wireless link, when the firmware reports it. */
|
|
23943
|
+
ssid: string().optional(),
|
|
23944
|
+
/** Ms epoch of the last observation. Lets consumers reason about freshness. */
|
|
23945
|
+
lastUpdated: number()
|
|
23946
|
+
});
|
|
23947
|
+
var networkLinkCapability = {
|
|
23948
|
+
name: "network-link",
|
|
23949
|
+
scope: "device",
|
|
23950
|
+
deviceNative: true,
|
|
23951
|
+
mode: "singleton",
|
|
23952
|
+
deviceTypes: [
|
|
23953
|
+
DeviceType.Camera,
|
|
23954
|
+
DeviceType.Sensor,
|
|
23955
|
+
DeviceType.Button,
|
|
23956
|
+
DeviceType.Switch,
|
|
23957
|
+
DeviceType.Light,
|
|
23958
|
+
DeviceType.Lock,
|
|
23959
|
+
DeviceType.Siren
|
|
23960
|
+
],
|
|
23961
|
+
methods: {},
|
|
23962
|
+
events: {
|
|
23963
|
+
/**
|
|
23964
|
+
* Emitted whenever the cached status changes (a link switch, a signal
|
|
23965
|
+
* reading that moved). Mirrored on the parent chain by the
|
|
23966
|
+
* DeviceEventPropagator like `battery.onStatusChanged`.
|
|
23967
|
+
*/
|
|
23968
|
+
onStatusChanged: { data: object({
|
|
23969
|
+
deviceId: number(),
|
|
23970
|
+
status: NetworkLinkStatusSchema
|
|
23971
|
+
}) } },
|
|
23972
|
+
status: {
|
|
23973
|
+
schema: NetworkLinkStatusSchema,
|
|
23974
|
+
kind: "push",
|
|
23975
|
+
empty: {
|
|
23976
|
+
type: "unknown",
|
|
23977
|
+
signalPercent: null,
|
|
23978
|
+
lastUpdated: 0
|
|
23979
|
+
}
|
|
23980
|
+
},
|
|
23981
|
+
/**
|
|
23982
|
+
* Runtime-state slice — every provider stores the same shape under
|
|
23983
|
+
* `device.runtimeState['network-link']`, read once by the badge and the
|
|
23984
|
+
* Home Assistant projector regardless of the driver.
|
|
23985
|
+
*/
|
|
23986
|
+
runtimeState: NetworkLinkStatusSchema,
|
|
23987
|
+
/**
|
|
23988
|
+
* Runtime-state durability: **restored** — a link reading is slow to
|
|
23989
|
+
* change and a sleeping battery camera may not report for hours; the
|
|
23990
|
+
* restored slice is what the badge shows until the next read.
|
|
23991
|
+
*
|
|
23992
|
+
* See `RuntimeStateDurability`. Enforced by
|
|
23993
|
+
* `scripts/check-runtime-state-durability.ts`.
|
|
23994
|
+
*/
|
|
23995
|
+
durability: "restored",
|
|
23996
|
+
/** Clock fields: written, but excluded from the compare that decides
|
|
23997
|
+
* whether persisting is worth a SQLite commit. */
|
|
23998
|
+
volatileStateFields: ["lastUpdated"]
|
|
23999
|
+
};
|
|
24000
|
+
/**
|
|
23912
24001
|
* Generic boolean sensor — last-resort fallback when no domain-
|
|
23913
24002
|
* specific binary cap fits (Home Assistant `binary_sensor` without a
|
|
23914
24003
|
* known `device_class`, or a domain we haven't typed yet). Pure
|
|
@@ -29026,6 +29115,287 @@ var ptzAutotrackCapability = {
|
|
|
29026
29115
|
*/
|
|
29027
29116
|
durability: "session"
|
|
29028
29117
|
};
|
|
29118
|
+
/**
|
|
29119
|
+
* `navigation` — a device-scoped capability that natively expresses the FULL
|
|
29120
|
+
* navigation / action surface of a robot that DRIVES ITSELF and carries an
|
|
29121
|
+
* on-board camera (the Dreame robot-vacuum camera is the first provider).
|
|
29122
|
+
*
|
|
29123
|
+
* Why a NEW cap rather than overloading `ptz`:
|
|
29124
|
+
* - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
|
|
29125
|
+
* robot vacuum has no gimbal — the whole chassis drives, turns and spins.
|
|
29126
|
+
* The two are different physical models: PTZ is absolute-position + presets,
|
|
29127
|
+
* navigation is momentary drive nudges + discrete robot ACTIONS
|
|
29128
|
+
* (dock / spot-clean / follow-pet / go-to-point / …).
|
|
29129
|
+
* - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
|
|
29130
|
+
* the reverse:
|
|
29131
|
+
* 1. a native CamStack navigation panel (data-driven from `listActions`
|
|
29132
|
+
* / `getOptions`), and
|
|
29133
|
+
* 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
|
|
29134
|
+
* robot camera shows up in the existing PTZ control path without every
|
|
29135
|
+
* PTZ provider learning about robots. The mapping lives in the adapter,
|
|
29136
|
+
* not here (see the addon design note):
|
|
29137
|
+
* ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
|
|
29138
|
+
* ptz.stop() → navigation.stop()
|
|
29139
|
+
* ptz.goHome() → navigation.runAction('goHome')
|
|
29140
|
+
* ptz.getPresets() → navigation.listActions() (id→preset)
|
|
29141
|
+
* ptz.goToPreset(id) → navigation.runAction(id)
|
|
29142
|
+
*
|
|
29143
|
+
* ## Continuous drive
|
|
29144
|
+
*
|
|
29145
|
+
* `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
|
|
29146
|
+
* sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
|
|
29147
|
+
* one `stop()` on release — exactly like the robot app's remote-drive joystick.
|
|
29148
|
+
* The provider forwards EACH `move` to one drive write; it must NOT debounce or
|
|
29149
|
+
* coalesce them. The UI owns the cadence.
|
|
29150
|
+
*
|
|
29151
|
+
* ## The action dictionary
|
|
29152
|
+
*
|
|
29153
|
+
* The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
|
|
29154
|
+
* are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
|
|
29155
|
+
* carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
|
|
29156
|
+
* native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
|
|
29157
|
+
* vendor-specific list. `kind: 'action'` entries are triggered with
|
|
29158
|
+
* `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
|
|
29159
|
+
* (the entry carries the `soundId` to pass). The general primitives — `move`,
|
|
29160
|
+
* `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
|
|
29161
|
+
*
|
|
29162
|
+
* NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
|
|
29163
|
+
* `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
|
|
29164
|
+
* that the currently-published `@apocaliss92/nodedreame` already exposes on
|
|
29165
|
+
* every device handle. A future nodedreame publish adds a typed
|
|
29166
|
+
* `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
|
|
29167
|
+
* provider can then swap the raw calls for the typed methods with no change to
|
|
29168
|
+
* THIS contract.
|
|
29169
|
+
*/
|
|
29170
|
+
/**
|
|
29171
|
+
* A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
|
|
29172
|
+
* keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
|
|
29173
|
+
* halts it.
|
|
29174
|
+
*
|
|
29175
|
+
* - `pan` — turn: negative = left, positive = right, 0 = straight.
|
|
29176
|
+
* - `tilt` — throttle: positive = forward, negative = spin / turn-around.
|
|
29177
|
+
* - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
|
|
29178
|
+
* vector by it (drivers without proportional drive ignore it).
|
|
29179
|
+
*
|
|
29180
|
+
* `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
|
|
29181
|
+
* axis alone; an all-undefined nudge is a no-op.
|
|
29182
|
+
*/
|
|
29183
|
+
var NavigationMoveCommandSchema = object({
|
|
29184
|
+
pan: number().min(-1).max(1).optional(),
|
|
29185
|
+
tilt: number().min(-1).max(1).optional(),
|
|
29186
|
+
speed: number().min(0).max(1).optional()
|
|
29187
|
+
});
|
|
29188
|
+
/**
|
|
29189
|
+
* The enumerated discrete actions a navigation-capable robot can perform via
|
|
29190
|
+
* `runAction`. This is the CLOSED vocabulary; a given device advertises the
|
|
29191
|
+
* subset it supports through `listActions`. Sounds are NOT here — they go through
|
|
29192
|
+
* `playSound` (see the `sound` dictionary entries).
|
|
29193
|
+
*/
|
|
29194
|
+
var NavigationActionIdSchema = _enum([
|
|
29195
|
+
"goHome",
|
|
29196
|
+
"locate",
|
|
29197
|
+
"spotClean",
|
|
29198
|
+
"findPet",
|
|
29199
|
+
"personFollow",
|
|
29200
|
+
"stop",
|
|
29201
|
+
"startClean",
|
|
29202
|
+
"pauseClean",
|
|
29203
|
+
"dockWash",
|
|
29204
|
+
"autoEmpty",
|
|
29205
|
+
"flashOn",
|
|
29206
|
+
"flashOff"
|
|
29207
|
+
]);
|
|
29208
|
+
/** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
|
|
29209
|
+
var NavigationEntryKindSchema = _enum(["action", "sound"]);
|
|
29210
|
+
/**
|
|
29211
|
+
* One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
|
|
29212
|
+
* native panel and the PTZ mimic render as a button.
|
|
29213
|
+
*
|
|
29214
|
+
* - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
|
|
29215
|
+
* (pass to `runAction`); for `kind:'sound'` it is a namespaced id
|
|
29216
|
+
* (`sound:meow`) whose `soundId` is passed to `playSound`.
|
|
29217
|
+
* - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
|
|
29218
|
+
* - `label` — operator-facing English label.
|
|
29219
|
+
* - `soundId` — wire sound id, present only on `kind:'sound'` entries.
|
|
29220
|
+
* - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
|
|
29221
|
+
* PTZ render ONLY enabled entries. Data-driven: the provider
|
|
29222
|
+
* flips it from config, never by editing code.
|
|
29223
|
+
*/
|
|
29224
|
+
var NavigationActionEntrySchema = object({
|
|
29225
|
+
id: string(),
|
|
29226
|
+
kind: NavigationEntryKindSchema,
|
|
29227
|
+
label: string(),
|
|
29228
|
+
icon: string(),
|
|
29229
|
+
/** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
|
|
29230
|
+
soundId: number().int().optional(),
|
|
29231
|
+
/** Per-device feature flag — render this entry only when true. */
|
|
29232
|
+
enabled: boolean()
|
|
29233
|
+
});
|
|
29234
|
+
/** Coordinates for `goToPoint` — a point on the robot's live map. */
|
|
29235
|
+
var NavigationPointSchema = object({
|
|
29236
|
+
x: number(),
|
|
29237
|
+
y: number()
|
|
29238
|
+
});
|
|
29239
|
+
/**
|
|
29240
|
+
* Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
|
|
29241
|
+
* The cap reports which are enabled so the UI / PTZ render only the controls
|
|
29242
|
+
* that are turned on for THIS device. Data-driven: the provider derives these
|
|
29243
|
+
* from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
|
|
29244
|
+
* live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
|
|
29245
|
+
* that are not dictionary entries.
|
|
29246
|
+
*
|
|
29247
|
+
* - `move` / `stop` — the momentary drive joystick.
|
|
29248
|
+
* - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
|
|
29249
|
+
* map-coordinate plumbing is wired.
|
|
29250
|
+
* - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
|
|
29251
|
+
* - `playSound` — the sound buttons (dictionary `kind:'sound'`).
|
|
29252
|
+
* - `light` — the on/off fill-light toggle (works anytime).
|
|
29253
|
+
* - `lightMode` — the auto/manual selector + manual level slider (a
|
|
29254
|
+
* camera-service control; needs an active stream).
|
|
29255
|
+
*/
|
|
29256
|
+
var NavigationFeaturesSchema = object({
|
|
29257
|
+
move: boolean(),
|
|
29258
|
+
stop: boolean(),
|
|
29259
|
+
goToPoint: boolean(),
|
|
29260
|
+
runAction: boolean(),
|
|
29261
|
+
playSound: boolean(),
|
|
29262
|
+
light: boolean(),
|
|
29263
|
+
lightMode: boolean()
|
|
29264
|
+
});
|
|
29265
|
+
/** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
|
|
29266
|
+
var NavigationLightModeSchema = _enum(["auto", "manual"]);
|
|
29267
|
+
/**
|
|
29268
|
+
* Live navigation state so the UI can reflect what the robot is doing:
|
|
29269
|
+
* - `mode` — coarse activity (idle / cleaning / following / …).
|
|
29270
|
+
* - `following` — person/pet follow is currently armed.
|
|
29271
|
+
* - `flash` — the on-camera fill light is on.
|
|
29272
|
+
* - `lightMode` — auto vs manual fill-light mode.
|
|
29273
|
+
* - `lightLevel` — manual fill-light level (40..100); meaningful when
|
|
29274
|
+
* `lightMode === 'manual'`.
|
|
29275
|
+
*/
|
|
29276
|
+
var NavigationStatusSchema = object({
|
|
29277
|
+
mode: _enum([
|
|
29278
|
+
"idle",
|
|
29279
|
+
"cleaning",
|
|
29280
|
+
"spot",
|
|
29281
|
+
"following",
|
|
29282
|
+
"goto",
|
|
29283
|
+
"returning",
|
|
29284
|
+
"paused",
|
|
29285
|
+
"unknown"
|
|
29286
|
+
]),
|
|
29287
|
+
following: boolean(),
|
|
29288
|
+
flash: boolean(),
|
|
29289
|
+
lightMode: NavigationLightModeSchema,
|
|
29290
|
+
lightLevel: number().min(40).max(100),
|
|
29291
|
+
/** Ms epoch when the slice was last updated. */
|
|
29292
|
+
lastChangedAt: number()
|
|
29293
|
+
});
|
|
29294
|
+
/**
|
|
29295
|
+
* Runtime-state slice owned by this cap (kernel-managed: validated, mirrored,
|
|
29296
|
+
* observable). Adds `lastFetchedAt` on top of the status shape per the
|
|
29297
|
+
* convention.
|
|
29298
|
+
*/
|
|
29299
|
+
var NavigationRuntimeStateSchema = NavigationStatusSchema.extend({ lastFetchedAt: number() });
|
|
29300
|
+
var navigationCapability = {
|
|
29301
|
+
name: "navigation",
|
|
29302
|
+
scope: "device",
|
|
29303
|
+
deviceNative: true,
|
|
29304
|
+
mode: "singleton",
|
|
29305
|
+
deviceTypes: [DeviceType.Camera],
|
|
29306
|
+
deviceConfig: { ui: {
|
|
29307
|
+
kind: "widget",
|
|
29308
|
+
widgetId: "host/navigation-panel",
|
|
29309
|
+
tab: "navigation",
|
|
29310
|
+
topTab: true,
|
|
29311
|
+
label: "Navigation",
|
|
29312
|
+
order: 0
|
|
29313
|
+
} },
|
|
29314
|
+
methods: {
|
|
29315
|
+
/**
|
|
29316
|
+
* Momentary drive nudge (the robot moves). `protected` — mirrors
|
|
29317
|
+
* `ptz.continuousMove` so the Viewer navigation panel (and the PTZ-mimic
|
|
29318
|
+
* path) works for any authenticated user, not admin-only. The UI sends
|
|
29319
|
+
* these at ~1 Hz while a control is held; the provider forwards each one to
|
|
29320
|
+
* a single drive write WITHOUT debouncing.
|
|
29321
|
+
*/
|
|
29322
|
+
move: method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29323
|
+
/** Halt all motion immediately (zero drive vector). */
|
|
29324
|
+
stop: method(object({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29325
|
+
/** Send the robot to a point on its live map. */
|
|
29326
|
+
goToPoint: method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29327
|
+
/**
|
|
29328
|
+
* Enumerate the discrete controls THIS device supports (data-driven UI +
|
|
29329
|
+
* PTZ mimic). Camera-probed subset of {@link NAVIGATION_ACTION_CATALOG}.
|
|
29330
|
+
*/
|
|
29331
|
+
listActions: method(object({ deviceId: number() }), array(NavigationActionEntrySchema)),
|
|
29332
|
+
/**
|
|
29333
|
+
* Run one discrete action (a `kind:'action'` dictionary entry). Invalid /
|
|
29334
|
+
* unsupported action ids are rejected by the provider.
|
|
29335
|
+
*/
|
|
29336
|
+
runAction: method(object({
|
|
29337
|
+
deviceId: number(),
|
|
29338
|
+
actionId: NavigationActionIdSchema
|
|
29339
|
+
}), _void(), { kind: "mutation" }),
|
|
29340
|
+
/** Play a sound by its wire id (the `soundId` of a `kind:'sound'` entry). */
|
|
29341
|
+
playSound: method(object({
|
|
29342
|
+
deviceId: number(),
|
|
29343
|
+
soundId: number().int()
|
|
29344
|
+
}), _void(), { kind: "mutation" }),
|
|
29345
|
+
/**
|
|
29346
|
+
* Turn the on-camera fill light on / off (the `OpenFullLight` control —
|
|
29347
|
+
* works anytime, no active stream required).
|
|
29348
|
+
*/
|
|
29349
|
+
setLightOn: method(object({
|
|
29350
|
+
deviceId: number(),
|
|
29351
|
+
on: boolean()
|
|
29352
|
+
}), _void(), { kind: "mutation" }),
|
|
29353
|
+
/**
|
|
29354
|
+
* Set the fill-light mode (auto vs manual). `manual` optionally carries the
|
|
29355
|
+
* initial `level`. The auto/manual + level control is a CAMERA-service
|
|
29356
|
+
* action that generally needs an active camera stream/monitor session — the
|
|
29357
|
+
* UI shows the manual level slider ONLY when `mode === 'manual'`.
|
|
29358
|
+
*/
|
|
29359
|
+
setLightMode: method(object({
|
|
29360
|
+
deviceId: number(),
|
|
29361
|
+
mode: NavigationLightModeSchema,
|
|
29362
|
+
level: number().min(40).max(100).optional()
|
|
29363
|
+
}), _void(), { kind: "mutation" }),
|
|
29364
|
+
/** Set the MANUAL fill-light level (40..100). Implies `manual` mode. */
|
|
29365
|
+
setLightLevel: method(object({
|
|
29366
|
+
deviceId: number(),
|
|
29367
|
+
level: number().min(40).max(100)
|
|
29368
|
+
}), _void(), { kind: "mutation" }),
|
|
29369
|
+
/**
|
|
29370
|
+
* Per-device FEATURE-FLAG report for the general primitives — drives which
|
|
29371
|
+
* controls the UI shows (the per-entry flags for the dictionary come back on
|
|
29372
|
+
* `listActions`).
|
|
29373
|
+
*/
|
|
29374
|
+
getFeatures: method(object({ deviceId: number() }), NavigationFeaturesSchema)
|
|
29375
|
+
},
|
|
29376
|
+
events: { onStatusChanged: { data: object({
|
|
29377
|
+
deviceId: number(),
|
|
29378
|
+
status: NavigationStatusSchema
|
|
29379
|
+
}) } },
|
|
29380
|
+
status: {
|
|
29381
|
+
schema: NavigationStatusSchema,
|
|
29382
|
+
kind: "push"
|
|
29383
|
+
},
|
|
29384
|
+
/**
|
|
29385
|
+
* Runtime-state slice mirrored by the kernel. The navigation panel watches it
|
|
29386
|
+
* for live mode / follow / flash changes.
|
|
29387
|
+
*/
|
|
29388
|
+
runtimeState: NavigationRuntimeStateSchema,
|
|
29389
|
+
/**
|
|
29390
|
+
* Runtime-state durability: **session** — like `vacuum-control`, a restored
|
|
29391
|
+
* `mode: cleaning` / `following: true` is a robot that is not actually doing
|
|
29392
|
+
* that. The live handle re-publishes on connect.
|
|
29393
|
+
*
|
|
29394
|
+
* See `RuntimeStateDurability`. Enforced by
|
|
29395
|
+
* `scripts/check-runtime-state-durability.ts`.
|
|
29396
|
+
*/
|
|
29397
|
+
durability: "session"
|
|
29398
|
+
};
|
|
29029
29399
|
DeviceType.Camera, DeviceType.Sensor, DeviceType.Switch, method(object({ deviceId: number().int().nonnegative() }), object({ success: literal(true) }), {
|
|
29030
29400
|
kind: "mutation",
|
|
29031
29401
|
auth: "admin"
|
|
@@ -32301,6 +32671,8 @@ var DEVICE_LOCAL_STATE_CAPS = {
|
|
|
32301
32671
|
motionTrigger: motionTriggerCapability,
|
|
32302
32672
|
motionZones: motionZonesCapability,
|
|
32303
32673
|
nativeObjectDetection: nativeObjectDetectionCapability,
|
|
32674
|
+
navigation: navigationCapability,
|
|
32675
|
+
networkLink: networkLinkCapability,
|
|
32304
32676
|
notifier: notifierCapability,
|
|
32305
32677
|
numericSensor: numericSensorCapability,
|
|
32306
32678
|
petFeeder: petFeederCapability,
|
|
@@ -36220,6 +36592,66 @@ Object.freeze({
|
|
|
36220
36592
|
addonId: null,
|
|
36221
36593
|
access: "create"
|
|
36222
36594
|
},
|
|
36595
|
+
"navigation.getFeatures": {
|
|
36596
|
+
capName: "navigation",
|
|
36597
|
+
capScope: "device",
|
|
36598
|
+
addonId: null,
|
|
36599
|
+
access: "view"
|
|
36600
|
+
},
|
|
36601
|
+
"navigation.goToPoint": {
|
|
36602
|
+
capName: "navigation",
|
|
36603
|
+
capScope: "device",
|
|
36604
|
+
addonId: null,
|
|
36605
|
+
access: "create"
|
|
36606
|
+
},
|
|
36607
|
+
"navigation.listActions": {
|
|
36608
|
+
capName: "navigation",
|
|
36609
|
+
capScope: "device",
|
|
36610
|
+
addonId: null,
|
|
36611
|
+
access: "view"
|
|
36612
|
+
},
|
|
36613
|
+
"navigation.move": {
|
|
36614
|
+
capName: "navigation",
|
|
36615
|
+
capScope: "device",
|
|
36616
|
+
addonId: null,
|
|
36617
|
+
access: "create"
|
|
36618
|
+
},
|
|
36619
|
+
"navigation.playSound": {
|
|
36620
|
+
capName: "navigation",
|
|
36621
|
+
capScope: "device",
|
|
36622
|
+
addonId: null,
|
|
36623
|
+
access: "create"
|
|
36624
|
+
},
|
|
36625
|
+
"navigation.runAction": {
|
|
36626
|
+
capName: "navigation",
|
|
36627
|
+
capScope: "device",
|
|
36628
|
+
addonId: null,
|
|
36629
|
+
access: "create"
|
|
36630
|
+
},
|
|
36631
|
+
"navigation.setLightLevel": {
|
|
36632
|
+
capName: "navigation",
|
|
36633
|
+
capScope: "device",
|
|
36634
|
+
addonId: null,
|
|
36635
|
+
access: "create"
|
|
36636
|
+
},
|
|
36637
|
+
"navigation.setLightMode": {
|
|
36638
|
+
capName: "navigation",
|
|
36639
|
+
capScope: "device",
|
|
36640
|
+
addonId: null,
|
|
36641
|
+
access: "create"
|
|
36642
|
+
},
|
|
36643
|
+
"navigation.setLightOn": {
|
|
36644
|
+
capName: "navigation",
|
|
36645
|
+
capScope: "device",
|
|
36646
|
+
addonId: null,
|
|
36647
|
+
access: "create"
|
|
36648
|
+
},
|
|
36649
|
+
"navigation.stop": {
|
|
36650
|
+
capName: "navigation",
|
|
36651
|
+
capScope: "device",
|
|
36652
|
+
addonId: null,
|
|
36653
|
+
access: "create"
|
|
36654
|
+
},
|
|
36223
36655
|
"networkAccess.getEndpoint": {
|
|
36224
36656
|
capName: "network-access",
|
|
36225
36657
|
capScope: "system",
|
|
@@ -40315,6 +40747,56 @@ Object.freeze({
|
|
|
40315
40747
|
form: "single",
|
|
40316
40748
|
optional: false
|
|
40317
40749
|
}],
|
|
40750
|
+
"navigation.getFeatures": [{
|
|
40751
|
+
name: "deviceId",
|
|
40752
|
+
form: "single",
|
|
40753
|
+
optional: false
|
|
40754
|
+
}],
|
|
40755
|
+
"navigation.goToPoint": [{
|
|
40756
|
+
name: "deviceId",
|
|
40757
|
+
form: "single",
|
|
40758
|
+
optional: false
|
|
40759
|
+
}],
|
|
40760
|
+
"navigation.listActions": [{
|
|
40761
|
+
name: "deviceId",
|
|
40762
|
+
form: "single",
|
|
40763
|
+
optional: false
|
|
40764
|
+
}],
|
|
40765
|
+
"navigation.move": [{
|
|
40766
|
+
name: "deviceId",
|
|
40767
|
+
form: "single",
|
|
40768
|
+
optional: false
|
|
40769
|
+
}],
|
|
40770
|
+
"navigation.playSound": [{
|
|
40771
|
+
name: "deviceId",
|
|
40772
|
+
form: "single",
|
|
40773
|
+
optional: false
|
|
40774
|
+
}],
|
|
40775
|
+
"navigation.runAction": [{
|
|
40776
|
+
name: "deviceId",
|
|
40777
|
+
form: "single",
|
|
40778
|
+
optional: false
|
|
40779
|
+
}],
|
|
40780
|
+
"navigation.setLightLevel": [{
|
|
40781
|
+
name: "deviceId",
|
|
40782
|
+
form: "single",
|
|
40783
|
+
optional: false
|
|
40784
|
+
}],
|
|
40785
|
+
"navigation.setLightMode": [{
|
|
40786
|
+
name: "deviceId",
|
|
40787
|
+
form: "single",
|
|
40788
|
+
optional: false
|
|
40789
|
+
}],
|
|
40790
|
+
"navigation.setLightOn": [{
|
|
40791
|
+
name: "deviceId",
|
|
40792
|
+
form: "single",
|
|
40793
|
+
optional: false
|
|
40794
|
+
}],
|
|
40795
|
+
"navigation.stop": [{
|
|
40796
|
+
name: "deviceId",
|
|
40797
|
+
form: "single",
|
|
40798
|
+
optional: false
|
|
40799
|
+
}],
|
|
40318
40800
|
"networkQuality.getDeviceStats": [{
|
|
40319
40801
|
name: "deviceId",
|
|
40320
40802
|
form: "single",
|
package/dist/addon.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import net from "node:net";
|
|
2
|
-
//#region ../types/dist/event-category-
|
|
2
|
+
//#region ../types/dist/event-category-zAv7pMUz.mjs
|
|
3
3
|
var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
4
4
|
EventCategory["SystemBoot"] = "system.boot";
|
|
5
5
|
EventCategory["SystemAddonsReady"] = "system.addons-ready";
|
|
@@ -371,6 +371,13 @@ var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
|
371
371
|
*/
|
|
372
372
|
EventCategory["BatteryOnStatusChanged"] = "battery.onStatusChanged";
|
|
373
373
|
/**
|
|
374
|
+
* Cap event fired by every device that registers the `network-link`
|
|
375
|
+
* capability. Mirrors the cap definition's `onStatusChanged`. Carries
|
|
376
|
+
* `{ deviceId, status: NetworkLinkStatus }` — a link switch or a signal
|
|
377
|
+
* reading that moved.
|
|
378
|
+
*/
|
|
379
|
+
EventCategory["NetworkLinkOnStatusChanged"] = "network-link.onStatusChanged";
|
|
380
|
+
/**
|
|
374
381
|
* Emitted by the battery cap provider WHEN `wakeForStream` enters the
|
|
375
382
|
* "wake in progress" window — between the Baichuan wake-up issue and
|
|
376
383
|
* the camera's first dialed-back RTP packet. The stream-broker
|
|
@@ -23885,6 +23892,88 @@ onStatusChanged: { data: object({
|
|
|
23885
23892
|
volatileStateFields: ["lastUpdated"]
|
|
23886
23893
|
};
|
|
23887
23894
|
/**
|
|
23895
|
+
* Network-link snapshot. Same shape for every provider (a Reolink wifi
|
|
23896
|
+
* camera, a Home Assistant device with a signal-strength sensor, a Tapo
|
|
23897
|
+
* plug): one slice under `device.runtimeState['network-link']`, one badge,
|
|
23898
|
+
* one Home Assistant projection.
|
|
23899
|
+
*/
|
|
23900
|
+
var NetworkLinkStatusSchema = object({
|
|
23901
|
+
/** The link the device is on. `'unknown'` = not read yet, not "no link". */
|
|
23902
|
+
type: _enum([
|
|
23903
|
+
"wifi",
|
|
23904
|
+
"ethernet",
|
|
23905
|
+
"cellular",
|
|
23906
|
+
"unknown"
|
|
23907
|
+
]),
|
|
23908
|
+
/**
|
|
23909
|
+
* Link quality, 0..100 inclusive, normalised by the provider from whatever
|
|
23910
|
+
* the firmware reports (bars, RSSI, a vendor scale). **`null` means NOT
|
|
23911
|
+
* KNOWN or NOT APPLICABLE** — a wired link has no signal, and a wireless
|
|
23912
|
+
* one whose reading has not landed must not be drawn at 0 %. Consumers
|
|
23913
|
+
* SKIP a null rather than coerce it.
|
|
23914
|
+
*/
|
|
23915
|
+
signalPercent: number().min(0).max(100).nullable(),
|
|
23916
|
+
/** Raw received signal strength in dBm, when the firmware reports one. */
|
|
23917
|
+
rssiDbm: number().optional(),
|
|
23918
|
+
/** Network name of a wireless link, when the firmware reports it. */
|
|
23919
|
+
ssid: string().optional(),
|
|
23920
|
+
/** Ms epoch of the last observation. Lets consumers reason about freshness. */
|
|
23921
|
+
lastUpdated: number()
|
|
23922
|
+
});
|
|
23923
|
+
var networkLinkCapability = {
|
|
23924
|
+
name: "network-link",
|
|
23925
|
+
scope: "device",
|
|
23926
|
+
deviceNative: true,
|
|
23927
|
+
mode: "singleton",
|
|
23928
|
+
deviceTypes: [
|
|
23929
|
+
DeviceType.Camera,
|
|
23930
|
+
DeviceType.Sensor,
|
|
23931
|
+
DeviceType.Button,
|
|
23932
|
+
DeviceType.Switch,
|
|
23933
|
+
DeviceType.Light,
|
|
23934
|
+
DeviceType.Lock,
|
|
23935
|
+
DeviceType.Siren
|
|
23936
|
+
],
|
|
23937
|
+
methods: {},
|
|
23938
|
+
events: {
|
|
23939
|
+
/**
|
|
23940
|
+
* Emitted whenever the cached status changes (a link switch, a signal
|
|
23941
|
+
* reading that moved). Mirrored on the parent chain by the
|
|
23942
|
+
* DeviceEventPropagator like `battery.onStatusChanged`.
|
|
23943
|
+
*/
|
|
23944
|
+
onStatusChanged: { data: object({
|
|
23945
|
+
deviceId: number(),
|
|
23946
|
+
status: NetworkLinkStatusSchema
|
|
23947
|
+
}) } },
|
|
23948
|
+
status: {
|
|
23949
|
+
schema: NetworkLinkStatusSchema,
|
|
23950
|
+
kind: "push",
|
|
23951
|
+
empty: {
|
|
23952
|
+
type: "unknown",
|
|
23953
|
+
signalPercent: null,
|
|
23954
|
+
lastUpdated: 0
|
|
23955
|
+
}
|
|
23956
|
+
},
|
|
23957
|
+
/**
|
|
23958
|
+
* Runtime-state slice — every provider stores the same shape under
|
|
23959
|
+
* `device.runtimeState['network-link']`, read once by the badge and the
|
|
23960
|
+
* Home Assistant projector regardless of the driver.
|
|
23961
|
+
*/
|
|
23962
|
+
runtimeState: NetworkLinkStatusSchema,
|
|
23963
|
+
/**
|
|
23964
|
+
* Runtime-state durability: **restored** — a link reading is slow to
|
|
23965
|
+
* change and a sleeping battery camera may not report for hours; the
|
|
23966
|
+
* restored slice is what the badge shows until the next read.
|
|
23967
|
+
*
|
|
23968
|
+
* See `RuntimeStateDurability`. Enforced by
|
|
23969
|
+
* `scripts/check-runtime-state-durability.ts`.
|
|
23970
|
+
*/
|
|
23971
|
+
durability: "restored",
|
|
23972
|
+
/** Clock fields: written, but excluded from the compare that decides
|
|
23973
|
+
* whether persisting is worth a SQLite commit. */
|
|
23974
|
+
volatileStateFields: ["lastUpdated"]
|
|
23975
|
+
};
|
|
23976
|
+
/**
|
|
23888
23977
|
* Generic boolean sensor — last-resort fallback when no domain-
|
|
23889
23978
|
* specific binary cap fits (Home Assistant `binary_sensor` without a
|
|
23890
23979
|
* known `device_class`, or a domain we haven't typed yet). Pure
|
|
@@ -29002,6 +29091,287 @@ var ptzAutotrackCapability = {
|
|
|
29002
29091
|
*/
|
|
29003
29092
|
durability: "session"
|
|
29004
29093
|
};
|
|
29094
|
+
/**
|
|
29095
|
+
* `navigation` — a device-scoped capability that natively expresses the FULL
|
|
29096
|
+
* navigation / action surface of a robot that DRIVES ITSELF and carries an
|
|
29097
|
+
* on-board camera (the Dreame robot-vacuum camera is the first provider).
|
|
29098
|
+
*
|
|
29099
|
+
* Why a NEW cap rather than overloading `ptz`:
|
|
29100
|
+
* - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
|
|
29101
|
+
* robot vacuum has no gimbal — the whole chassis drives, turns and spins.
|
|
29102
|
+
* The two are different physical models: PTZ is absolute-position + presets,
|
|
29103
|
+
* navigation is momentary drive nudges + discrete robot ACTIONS
|
|
29104
|
+
* (dock / spot-clean / follow-pet / go-to-point / …).
|
|
29105
|
+
* - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
|
|
29106
|
+
* the reverse:
|
|
29107
|
+
* 1. a native CamStack navigation panel (data-driven from `listActions`
|
|
29108
|
+
* / `getOptions`), and
|
|
29109
|
+
* 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
|
|
29110
|
+
* robot camera shows up in the existing PTZ control path without every
|
|
29111
|
+
* PTZ provider learning about robots. The mapping lives in the adapter,
|
|
29112
|
+
* not here (see the addon design note):
|
|
29113
|
+
* ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
|
|
29114
|
+
* ptz.stop() → navigation.stop()
|
|
29115
|
+
* ptz.goHome() → navigation.runAction('goHome')
|
|
29116
|
+
* ptz.getPresets() → navigation.listActions() (id→preset)
|
|
29117
|
+
* ptz.goToPreset(id) → navigation.runAction(id)
|
|
29118
|
+
*
|
|
29119
|
+
* ## Continuous drive
|
|
29120
|
+
*
|
|
29121
|
+
* `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
|
|
29122
|
+
* sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
|
|
29123
|
+
* one `stop()` on release — exactly like the robot app's remote-drive joystick.
|
|
29124
|
+
* The provider forwards EACH `move` to one drive write; it must NOT debounce or
|
|
29125
|
+
* coalesce them. The UI owns the cadence.
|
|
29126
|
+
*
|
|
29127
|
+
* ## The action dictionary
|
|
29128
|
+
*
|
|
29129
|
+
* The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
|
|
29130
|
+
* are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
|
|
29131
|
+
* carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
|
|
29132
|
+
* native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
|
|
29133
|
+
* vendor-specific list. `kind: 'action'` entries are triggered with
|
|
29134
|
+
* `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
|
|
29135
|
+
* (the entry carries the `soundId` to pass). The general primitives — `move`,
|
|
29136
|
+
* `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
|
|
29137
|
+
*
|
|
29138
|
+
* NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
|
|
29139
|
+
* `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
|
|
29140
|
+
* that the currently-published `@apocaliss92/nodedreame` already exposes on
|
|
29141
|
+
* every device handle. A future nodedreame publish adds a typed
|
|
29142
|
+
* `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
|
|
29143
|
+
* provider can then swap the raw calls for the typed methods with no change to
|
|
29144
|
+
* THIS contract.
|
|
29145
|
+
*/
|
|
29146
|
+
/**
|
|
29147
|
+
* A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
|
|
29148
|
+
* keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
|
|
29149
|
+
* halts it.
|
|
29150
|
+
*
|
|
29151
|
+
* - `pan` — turn: negative = left, positive = right, 0 = straight.
|
|
29152
|
+
* - `tilt` — throttle: positive = forward, negative = spin / turn-around.
|
|
29153
|
+
* - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
|
|
29154
|
+
* vector by it (drivers without proportional drive ignore it).
|
|
29155
|
+
*
|
|
29156
|
+
* `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
|
|
29157
|
+
* axis alone; an all-undefined nudge is a no-op.
|
|
29158
|
+
*/
|
|
29159
|
+
var NavigationMoveCommandSchema = object({
|
|
29160
|
+
pan: number().min(-1).max(1).optional(),
|
|
29161
|
+
tilt: number().min(-1).max(1).optional(),
|
|
29162
|
+
speed: number().min(0).max(1).optional()
|
|
29163
|
+
});
|
|
29164
|
+
/**
|
|
29165
|
+
* The enumerated discrete actions a navigation-capable robot can perform via
|
|
29166
|
+
* `runAction`. This is the CLOSED vocabulary; a given device advertises the
|
|
29167
|
+
* subset it supports through `listActions`. Sounds are NOT here — they go through
|
|
29168
|
+
* `playSound` (see the `sound` dictionary entries).
|
|
29169
|
+
*/
|
|
29170
|
+
var NavigationActionIdSchema = _enum([
|
|
29171
|
+
"goHome",
|
|
29172
|
+
"locate",
|
|
29173
|
+
"spotClean",
|
|
29174
|
+
"findPet",
|
|
29175
|
+
"personFollow",
|
|
29176
|
+
"stop",
|
|
29177
|
+
"startClean",
|
|
29178
|
+
"pauseClean",
|
|
29179
|
+
"dockWash",
|
|
29180
|
+
"autoEmpty",
|
|
29181
|
+
"flashOn",
|
|
29182
|
+
"flashOff"
|
|
29183
|
+
]);
|
|
29184
|
+
/** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
|
|
29185
|
+
var NavigationEntryKindSchema = _enum(["action", "sound"]);
|
|
29186
|
+
/**
|
|
29187
|
+
* One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
|
|
29188
|
+
* native panel and the PTZ mimic render as a button.
|
|
29189
|
+
*
|
|
29190
|
+
* - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
|
|
29191
|
+
* (pass to `runAction`); for `kind:'sound'` it is a namespaced id
|
|
29192
|
+
* (`sound:meow`) whose `soundId` is passed to `playSound`.
|
|
29193
|
+
* - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
|
|
29194
|
+
* - `label` — operator-facing English label.
|
|
29195
|
+
* - `soundId` — wire sound id, present only on `kind:'sound'` entries.
|
|
29196
|
+
* - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
|
|
29197
|
+
* PTZ render ONLY enabled entries. Data-driven: the provider
|
|
29198
|
+
* flips it from config, never by editing code.
|
|
29199
|
+
*/
|
|
29200
|
+
var NavigationActionEntrySchema = object({
|
|
29201
|
+
id: string(),
|
|
29202
|
+
kind: NavigationEntryKindSchema,
|
|
29203
|
+
label: string(),
|
|
29204
|
+
icon: string(),
|
|
29205
|
+
/** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
|
|
29206
|
+
soundId: number().int().optional(),
|
|
29207
|
+
/** Per-device feature flag — render this entry only when true. */
|
|
29208
|
+
enabled: boolean()
|
|
29209
|
+
});
|
|
29210
|
+
/** Coordinates for `goToPoint` — a point on the robot's live map. */
|
|
29211
|
+
var NavigationPointSchema = object({
|
|
29212
|
+
x: number(),
|
|
29213
|
+
y: number()
|
|
29214
|
+
});
|
|
29215
|
+
/**
|
|
29216
|
+
* Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
|
|
29217
|
+
* The cap reports which are enabled so the UI / PTZ render only the controls
|
|
29218
|
+
* that are turned on for THIS device. Data-driven: the provider derives these
|
|
29219
|
+
* from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
|
|
29220
|
+
* live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
|
|
29221
|
+
* that are not dictionary entries.
|
|
29222
|
+
*
|
|
29223
|
+
* - `move` / `stop` — the momentary drive joystick.
|
|
29224
|
+
* - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
|
|
29225
|
+
* map-coordinate plumbing is wired.
|
|
29226
|
+
* - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
|
|
29227
|
+
* - `playSound` — the sound buttons (dictionary `kind:'sound'`).
|
|
29228
|
+
* - `light` — the on/off fill-light toggle (works anytime).
|
|
29229
|
+
* - `lightMode` — the auto/manual selector + manual level slider (a
|
|
29230
|
+
* camera-service control; needs an active stream).
|
|
29231
|
+
*/
|
|
29232
|
+
var NavigationFeaturesSchema = object({
|
|
29233
|
+
move: boolean(),
|
|
29234
|
+
stop: boolean(),
|
|
29235
|
+
goToPoint: boolean(),
|
|
29236
|
+
runAction: boolean(),
|
|
29237
|
+
playSound: boolean(),
|
|
29238
|
+
light: boolean(),
|
|
29239
|
+
lightMode: boolean()
|
|
29240
|
+
});
|
|
29241
|
+
/** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
|
|
29242
|
+
var NavigationLightModeSchema = _enum(["auto", "manual"]);
|
|
29243
|
+
/**
|
|
29244
|
+
* Live navigation state so the UI can reflect what the robot is doing:
|
|
29245
|
+
* - `mode` — coarse activity (idle / cleaning / following / …).
|
|
29246
|
+
* - `following` — person/pet follow is currently armed.
|
|
29247
|
+
* - `flash` — the on-camera fill light is on.
|
|
29248
|
+
* - `lightMode` — auto vs manual fill-light mode.
|
|
29249
|
+
* - `lightLevel` — manual fill-light level (40..100); meaningful when
|
|
29250
|
+
* `lightMode === 'manual'`.
|
|
29251
|
+
*/
|
|
29252
|
+
var NavigationStatusSchema = object({
|
|
29253
|
+
mode: _enum([
|
|
29254
|
+
"idle",
|
|
29255
|
+
"cleaning",
|
|
29256
|
+
"spot",
|
|
29257
|
+
"following",
|
|
29258
|
+
"goto",
|
|
29259
|
+
"returning",
|
|
29260
|
+
"paused",
|
|
29261
|
+
"unknown"
|
|
29262
|
+
]),
|
|
29263
|
+
following: boolean(),
|
|
29264
|
+
flash: boolean(),
|
|
29265
|
+
lightMode: NavigationLightModeSchema,
|
|
29266
|
+
lightLevel: number().min(40).max(100),
|
|
29267
|
+
/** Ms epoch when the slice was last updated. */
|
|
29268
|
+
lastChangedAt: number()
|
|
29269
|
+
});
|
|
29270
|
+
/**
|
|
29271
|
+
* Runtime-state slice owned by this cap (kernel-managed: validated, mirrored,
|
|
29272
|
+
* observable). Adds `lastFetchedAt` on top of the status shape per the
|
|
29273
|
+
* convention.
|
|
29274
|
+
*/
|
|
29275
|
+
var NavigationRuntimeStateSchema = NavigationStatusSchema.extend({ lastFetchedAt: number() });
|
|
29276
|
+
var navigationCapability = {
|
|
29277
|
+
name: "navigation",
|
|
29278
|
+
scope: "device",
|
|
29279
|
+
deviceNative: true,
|
|
29280
|
+
mode: "singleton",
|
|
29281
|
+
deviceTypes: [DeviceType.Camera],
|
|
29282
|
+
deviceConfig: { ui: {
|
|
29283
|
+
kind: "widget",
|
|
29284
|
+
widgetId: "host/navigation-panel",
|
|
29285
|
+
tab: "navigation",
|
|
29286
|
+
topTab: true,
|
|
29287
|
+
label: "Navigation",
|
|
29288
|
+
order: 0
|
|
29289
|
+
} },
|
|
29290
|
+
methods: {
|
|
29291
|
+
/**
|
|
29292
|
+
* Momentary drive nudge (the robot moves). `protected` — mirrors
|
|
29293
|
+
* `ptz.continuousMove` so the Viewer navigation panel (and the PTZ-mimic
|
|
29294
|
+
* path) works for any authenticated user, not admin-only. The UI sends
|
|
29295
|
+
* these at ~1 Hz while a control is held; the provider forwards each one to
|
|
29296
|
+
* a single drive write WITHOUT debouncing.
|
|
29297
|
+
*/
|
|
29298
|
+
move: method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29299
|
+
/** Halt all motion immediately (zero drive vector). */
|
|
29300
|
+
stop: method(object({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29301
|
+
/** Send the robot to a point on its live map. */
|
|
29302
|
+
goToPoint: method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }),
|
|
29303
|
+
/**
|
|
29304
|
+
* Enumerate the discrete controls THIS device supports (data-driven UI +
|
|
29305
|
+
* PTZ mimic). Camera-probed subset of {@link NAVIGATION_ACTION_CATALOG}.
|
|
29306
|
+
*/
|
|
29307
|
+
listActions: method(object({ deviceId: number() }), array(NavigationActionEntrySchema)),
|
|
29308
|
+
/**
|
|
29309
|
+
* Run one discrete action (a `kind:'action'` dictionary entry). Invalid /
|
|
29310
|
+
* unsupported action ids are rejected by the provider.
|
|
29311
|
+
*/
|
|
29312
|
+
runAction: method(object({
|
|
29313
|
+
deviceId: number(),
|
|
29314
|
+
actionId: NavigationActionIdSchema
|
|
29315
|
+
}), _void(), { kind: "mutation" }),
|
|
29316
|
+
/** Play a sound by its wire id (the `soundId` of a `kind:'sound'` entry). */
|
|
29317
|
+
playSound: method(object({
|
|
29318
|
+
deviceId: number(),
|
|
29319
|
+
soundId: number().int()
|
|
29320
|
+
}), _void(), { kind: "mutation" }),
|
|
29321
|
+
/**
|
|
29322
|
+
* Turn the on-camera fill light on / off (the `OpenFullLight` control —
|
|
29323
|
+
* works anytime, no active stream required).
|
|
29324
|
+
*/
|
|
29325
|
+
setLightOn: method(object({
|
|
29326
|
+
deviceId: number(),
|
|
29327
|
+
on: boolean()
|
|
29328
|
+
}), _void(), { kind: "mutation" }),
|
|
29329
|
+
/**
|
|
29330
|
+
* Set the fill-light mode (auto vs manual). `manual` optionally carries the
|
|
29331
|
+
* initial `level`. The auto/manual + level control is a CAMERA-service
|
|
29332
|
+
* action that generally needs an active camera stream/monitor session — the
|
|
29333
|
+
* UI shows the manual level slider ONLY when `mode === 'manual'`.
|
|
29334
|
+
*/
|
|
29335
|
+
setLightMode: method(object({
|
|
29336
|
+
deviceId: number(),
|
|
29337
|
+
mode: NavigationLightModeSchema,
|
|
29338
|
+
level: number().min(40).max(100).optional()
|
|
29339
|
+
}), _void(), { kind: "mutation" }),
|
|
29340
|
+
/** Set the MANUAL fill-light level (40..100). Implies `manual` mode. */
|
|
29341
|
+
setLightLevel: method(object({
|
|
29342
|
+
deviceId: number(),
|
|
29343
|
+
level: number().min(40).max(100)
|
|
29344
|
+
}), _void(), { kind: "mutation" }),
|
|
29345
|
+
/**
|
|
29346
|
+
* Per-device FEATURE-FLAG report for the general primitives — drives which
|
|
29347
|
+
* controls the UI shows (the per-entry flags for the dictionary come back on
|
|
29348
|
+
* `listActions`).
|
|
29349
|
+
*/
|
|
29350
|
+
getFeatures: method(object({ deviceId: number() }), NavigationFeaturesSchema)
|
|
29351
|
+
},
|
|
29352
|
+
events: { onStatusChanged: { data: object({
|
|
29353
|
+
deviceId: number(),
|
|
29354
|
+
status: NavigationStatusSchema
|
|
29355
|
+
}) } },
|
|
29356
|
+
status: {
|
|
29357
|
+
schema: NavigationStatusSchema,
|
|
29358
|
+
kind: "push"
|
|
29359
|
+
},
|
|
29360
|
+
/**
|
|
29361
|
+
* Runtime-state slice mirrored by the kernel. The navigation panel watches it
|
|
29362
|
+
* for live mode / follow / flash changes.
|
|
29363
|
+
*/
|
|
29364
|
+
runtimeState: NavigationRuntimeStateSchema,
|
|
29365
|
+
/**
|
|
29366
|
+
* Runtime-state durability: **session** — like `vacuum-control`, a restored
|
|
29367
|
+
* `mode: cleaning` / `following: true` is a robot that is not actually doing
|
|
29368
|
+
* that. The live handle re-publishes on connect.
|
|
29369
|
+
*
|
|
29370
|
+
* See `RuntimeStateDurability`. Enforced by
|
|
29371
|
+
* `scripts/check-runtime-state-durability.ts`.
|
|
29372
|
+
*/
|
|
29373
|
+
durability: "session"
|
|
29374
|
+
};
|
|
29005
29375
|
DeviceType.Camera, DeviceType.Sensor, DeviceType.Switch, method(object({ deviceId: number().int().nonnegative() }), object({ success: literal(true) }), {
|
|
29006
29376
|
kind: "mutation",
|
|
29007
29377
|
auth: "admin"
|
|
@@ -32277,6 +32647,8 @@ var DEVICE_LOCAL_STATE_CAPS = {
|
|
|
32277
32647
|
motionTrigger: motionTriggerCapability,
|
|
32278
32648
|
motionZones: motionZonesCapability,
|
|
32279
32649
|
nativeObjectDetection: nativeObjectDetectionCapability,
|
|
32650
|
+
navigation: navigationCapability,
|
|
32651
|
+
networkLink: networkLinkCapability,
|
|
32280
32652
|
notifier: notifierCapability,
|
|
32281
32653
|
numericSensor: numericSensorCapability,
|
|
32282
32654
|
petFeeder: petFeederCapability,
|
|
@@ -36196,6 +36568,66 @@ Object.freeze({
|
|
|
36196
36568
|
addonId: null,
|
|
36197
36569
|
access: "create"
|
|
36198
36570
|
},
|
|
36571
|
+
"navigation.getFeatures": {
|
|
36572
|
+
capName: "navigation",
|
|
36573
|
+
capScope: "device",
|
|
36574
|
+
addonId: null,
|
|
36575
|
+
access: "view"
|
|
36576
|
+
},
|
|
36577
|
+
"navigation.goToPoint": {
|
|
36578
|
+
capName: "navigation",
|
|
36579
|
+
capScope: "device",
|
|
36580
|
+
addonId: null,
|
|
36581
|
+
access: "create"
|
|
36582
|
+
},
|
|
36583
|
+
"navigation.listActions": {
|
|
36584
|
+
capName: "navigation",
|
|
36585
|
+
capScope: "device",
|
|
36586
|
+
addonId: null,
|
|
36587
|
+
access: "view"
|
|
36588
|
+
},
|
|
36589
|
+
"navigation.move": {
|
|
36590
|
+
capName: "navigation",
|
|
36591
|
+
capScope: "device",
|
|
36592
|
+
addonId: null,
|
|
36593
|
+
access: "create"
|
|
36594
|
+
},
|
|
36595
|
+
"navigation.playSound": {
|
|
36596
|
+
capName: "navigation",
|
|
36597
|
+
capScope: "device",
|
|
36598
|
+
addonId: null,
|
|
36599
|
+
access: "create"
|
|
36600
|
+
},
|
|
36601
|
+
"navigation.runAction": {
|
|
36602
|
+
capName: "navigation",
|
|
36603
|
+
capScope: "device",
|
|
36604
|
+
addonId: null,
|
|
36605
|
+
access: "create"
|
|
36606
|
+
},
|
|
36607
|
+
"navigation.setLightLevel": {
|
|
36608
|
+
capName: "navigation",
|
|
36609
|
+
capScope: "device",
|
|
36610
|
+
addonId: null,
|
|
36611
|
+
access: "create"
|
|
36612
|
+
},
|
|
36613
|
+
"navigation.setLightMode": {
|
|
36614
|
+
capName: "navigation",
|
|
36615
|
+
capScope: "device",
|
|
36616
|
+
addonId: null,
|
|
36617
|
+
access: "create"
|
|
36618
|
+
},
|
|
36619
|
+
"navigation.setLightOn": {
|
|
36620
|
+
capName: "navigation",
|
|
36621
|
+
capScope: "device",
|
|
36622
|
+
addonId: null,
|
|
36623
|
+
access: "create"
|
|
36624
|
+
},
|
|
36625
|
+
"navigation.stop": {
|
|
36626
|
+
capName: "navigation",
|
|
36627
|
+
capScope: "device",
|
|
36628
|
+
addonId: null,
|
|
36629
|
+
access: "create"
|
|
36630
|
+
},
|
|
36199
36631
|
"networkAccess.getEndpoint": {
|
|
36200
36632
|
capName: "network-access",
|
|
36201
36633
|
capScope: "system",
|
|
@@ -40291,6 +40723,56 @@ Object.freeze({
|
|
|
40291
40723
|
form: "single",
|
|
40292
40724
|
optional: false
|
|
40293
40725
|
}],
|
|
40726
|
+
"navigation.getFeatures": [{
|
|
40727
|
+
name: "deviceId",
|
|
40728
|
+
form: "single",
|
|
40729
|
+
optional: false
|
|
40730
|
+
}],
|
|
40731
|
+
"navigation.goToPoint": [{
|
|
40732
|
+
name: "deviceId",
|
|
40733
|
+
form: "single",
|
|
40734
|
+
optional: false
|
|
40735
|
+
}],
|
|
40736
|
+
"navigation.listActions": [{
|
|
40737
|
+
name: "deviceId",
|
|
40738
|
+
form: "single",
|
|
40739
|
+
optional: false
|
|
40740
|
+
}],
|
|
40741
|
+
"navigation.move": [{
|
|
40742
|
+
name: "deviceId",
|
|
40743
|
+
form: "single",
|
|
40744
|
+
optional: false
|
|
40745
|
+
}],
|
|
40746
|
+
"navigation.playSound": [{
|
|
40747
|
+
name: "deviceId",
|
|
40748
|
+
form: "single",
|
|
40749
|
+
optional: false
|
|
40750
|
+
}],
|
|
40751
|
+
"navigation.runAction": [{
|
|
40752
|
+
name: "deviceId",
|
|
40753
|
+
form: "single",
|
|
40754
|
+
optional: false
|
|
40755
|
+
}],
|
|
40756
|
+
"navigation.setLightLevel": [{
|
|
40757
|
+
name: "deviceId",
|
|
40758
|
+
form: "single",
|
|
40759
|
+
optional: false
|
|
40760
|
+
}],
|
|
40761
|
+
"navigation.setLightMode": [{
|
|
40762
|
+
name: "deviceId",
|
|
40763
|
+
form: "single",
|
|
40764
|
+
optional: false
|
|
40765
|
+
}],
|
|
40766
|
+
"navigation.setLightOn": [{
|
|
40767
|
+
name: "deviceId",
|
|
40768
|
+
form: "single",
|
|
40769
|
+
optional: false
|
|
40770
|
+
}],
|
|
40771
|
+
"navigation.stop": [{
|
|
40772
|
+
name: "deviceId",
|
|
40773
|
+
form: "single",
|
|
40774
|
+
optional: false
|
|
40775
|
+
}],
|
|
40294
40776
|
"networkQuality.getDeviceStats": [{
|
|
40295
40777
|
name: "deviceId",
|
|
40296
40778
|
form: "single",
|