@camstack/addon-decoder-nodeav 1.2.78 → 1.2.80
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/index.js +488 -355
- package/dist/index.mjs +488 -355
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3,7 +3,7 @@ Object.defineProperties(exports, {
|
|
|
3
3
|
[Symbol.toStringTag]: { value: "Module" }
|
|
4
4
|
});
|
|
5
5
|
let node_crypto = require("node:crypto");
|
|
6
|
-
//#region ../types/dist/event-category-
|
|
6
|
+
//#region ../types/dist/event-category-CnLqLOKs.mjs
|
|
7
7
|
var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
8
8
|
EventCategory["SystemBoot"] = "system.boot";
|
|
9
9
|
EventCategory["SystemAddonsReady"] = "system.addons-ready";
|
|
@@ -198,6 +198,19 @@ var EventCategory = /* @__PURE__ */ function(EventCategory) {
|
|
|
198
198
|
EventCategory["ProcessCrashed"] = "process.crashed";
|
|
199
199
|
EventCategory["ProcessRestartScheduled"] = "process.restart_scheduled";
|
|
200
200
|
EventCategory["ProcessRestarted"] = "process.restarted";
|
|
201
|
+
/**
|
|
202
|
+
* The SET of storage locations changed — one was created, edited, enabled,
|
|
203
|
+
* disabled or deleted through `storage.upsertLocation` / `deleteLocation`.
|
|
204
|
+
*
|
|
205
|
+
* Telemetry, not a transaction (D8/D11): every consumer that re-resolves on
|
|
206
|
+
* it must also converge on its own periodic path, because a dropped event
|
|
207
|
+
* must not leave a node writing to yesterday's disk set forever. It exists
|
|
208
|
+
* because there was NO signal at all — an operator who added a second
|
|
209
|
+
* recordings disk in the admin UI got nothing, and the recorder kept its
|
|
210
|
+
* resolved locations until something else happened to re-resolve them
|
|
211
|
+
* (D387). Payload `StorageLocationsChangedPayload`.
|
|
212
|
+
*/
|
|
213
|
+
EventCategory["StorageLocationsChanged"] = "storage.locations-changed";
|
|
201
214
|
EventCategory["RecordingStarted"] = "recording.started";
|
|
202
215
|
EventCategory["RecordingStopped"] = "recording.stopped";
|
|
203
216
|
EventCategory["RecordingError"] = "recording.error";
|
|
@@ -7615,111 +7628,6 @@ var CameraSwitchGroupSchema = object({
|
|
|
7615
7628
|
fetchedAt: number()
|
|
7616
7629
|
});
|
|
7617
7630
|
/**
|
|
7618
|
-
* Per-component log CHANNELS — the gate a hot path consults, and the registry
|
|
7619
|
-
* an addon declares its channels in.
|
|
7620
|
-
*
|
|
7621
|
-
* ## Two axes, deliberately separated
|
|
7622
|
-
*
|
|
7623
|
-
* - **DECLARATION** — which channels exist. Only the addon knows:
|
|
7624
|
-
* `stream-broker` knows webrtc/ICE/RTP, `provider-reolink` knows
|
|
7625
|
-
* baichuan/handshake. A hand-wired central list rots at the first addition,
|
|
7626
|
-
* and rots silently. So a channel is declared where it is consulted, and the
|
|
7627
|
-
* `log-channels` capability enumerates the declarations.
|
|
7628
|
-
* - **VALUE** — at which level, for which scope, until when. That stays ONE
|
|
7629
|
-
* thing: the logging settings document on the `system` cap. Two authorities
|
|
7630
|
-
* over the values is the exact defect
|
|
7631
|
-
* `docs/design/plans/2026-08-26-logging-per-componente.md` was written to
|
|
7632
|
-
* remove; re-introducing it from the cure side would be grotesque.
|
|
7633
|
-
*
|
|
7634
|
-
* Nothing in this file reads a clock, an env var or a store. The registry is
|
|
7635
|
-
* a MIRROR: it is moved only by {@link LogChannelRegistry.apply}, called off
|
|
7636
|
-
* the hot path with a value somebody actually read, and by
|
|
7637
|
-
* {@link LogChannelRegistry.tick}, called on a timer. A store read that fails
|
|
7638
|
-
* never reaches here, so it can neither disarm an armed channel nor arm a
|
|
7639
|
-
* disarmed one (D49).
|
|
7640
|
-
*
|
|
7641
|
-
* ## The canonical call shape
|
|
7642
|
-
*
|
|
7643
|
-
* ```ts
|
|
7644
|
-
* if (CH_RTP.on && CH_RTP.wants(deviceId)) {
|
|
7645
|
-
* CH_RTP.log(logger, 'rtp subscriber added', { tags: { deviceId }, meta: { ssrc } })
|
|
7646
|
-
* }
|
|
7647
|
-
* ```
|
|
7648
|
-
*
|
|
7649
|
-
* `on` is a plain boolean FIELD — never a getter — and it is the FIRST thing
|
|
7650
|
-
* read. Disarmed, a call site costs one load and one branch, and the `extras`
|
|
7651
|
-
* object literal is never constructed because it lives inside the branch. It
|
|
7652
|
-
* is the same shape already proven in production at `stream-broker.ts:1650`,
|
|
7653
|
-
* and the same discipline `LoggingGate.allowsDestination` uses for the
|
|
7654
|
-
* destination floor (measured at 1.93 ns/call when off).
|
|
7655
|
-
*
|
|
7656
|
-
* ## Why a channel emits at `info`
|
|
7657
|
-
*
|
|
7658
|
-
* `loki-logging.addon.ts` pins the destination default at `info` and
|
|
7659
|
-
* `loki-destination.ts` drops everything below it, so a line emitted at
|
|
7660
|
-
* `debug` never reaches Loki and the hub's in-memory ring only holds ~35
|
|
7661
|
-
* minutes. A diagnostic that cannot be read an hour later is worse than no
|
|
7662
|
-
* diagnostic, because it looks done. {@link LogChannelGate.log} therefore
|
|
7663
|
-
* emits at the channel's declared level, whose schema floor is `info`.
|
|
7664
|
-
*/
|
|
7665
|
-
/**
|
|
7666
|
-
* The level a channel writes at once armed.
|
|
7667
|
-
*
|
|
7668
|
-
* `debug` is absent ON PURPOSE and not by omission: below `info` the line does
|
|
7669
|
-
* not leave the process for Loki, and the whole point of arming a channel is
|
|
7670
|
-
* to read it later.
|
|
7671
|
-
*/
|
|
7672
|
-
var LogChannelLevelSchema = _enum([
|
|
7673
|
-
"info",
|
|
7674
|
-
"warn",
|
|
7675
|
-
"error"
|
|
7676
|
-
]);
|
|
7677
|
-
/**
|
|
7678
|
-
* What an addon declares about one channel. No value, no state — a
|
|
7679
|
-
* declaration is inert.
|
|
7680
|
-
*/
|
|
7681
|
-
var LogChannelDescriptorSchema = object({
|
|
7682
|
-
/**
|
|
7683
|
-
* Dotted `area.thing`, unique across the workspace. `area` is conventionally
|
|
7684
|
-
* the addon's short name so an operator reading a channel list can tell who
|
|
7685
|
-
* owns it without a second lookup.
|
|
7686
|
-
*/
|
|
7687
|
-
name: string().min(3).regex(/^[a-z0-9-]+(\.[a-z0-9-]+)+$/, "a channel name is dotted lower-kebab, e.g. area.thing"),
|
|
7688
|
-
/** One sentence: what the operator will SEE after arming it. */
|
|
7689
|
-
description: string().min(1),
|
|
7690
|
-
/** The level its lines are emitted at. Never below `info`. */
|
|
7691
|
-
defaultLevel: LogChannelLevelSchema,
|
|
7692
|
-
/**
|
|
7693
|
-
* Whether this channel can be narrowed to a camera.
|
|
7694
|
-
*
|
|
7695
|
-
* `true` is a PROMISE with two halves, and both must hold: the gate is
|
|
7696
|
-
* consulted with the numeric device id, AND every line the channel admits
|
|
7697
|
-
* carries `tags: { deviceId }` with that same numeric id. The second half is
|
|
7698
|
-
* what makes `| json | deviceId="617"` work in Loki — `loki-payload.ts`
|
|
7699
|
-
* keeps `deviceId` out of the stream labels for cardinality, so the tag in
|
|
7700
|
-
* the body is the only way to filter.
|
|
7701
|
-
*
|
|
7702
|
-
* A channel whose lines carry the device only in `meta` (or not at all) is
|
|
7703
|
-
* declared `false`. Declaring it `true` anyway would be a lie the UI repeats:
|
|
7704
|
-
* the operator narrows to one camera, sees nothing, and concludes the code
|
|
7705
|
-
* path was never taken.
|
|
7706
|
-
*/
|
|
7707
|
-
perDevice: boolean()
|
|
7708
|
-
});
|
|
7709
|
-
/**
|
|
7710
|
-
* An armed window over one channel, as the document hands it to a mirror.
|
|
7711
|
-
*
|
|
7712
|
-
* A window is a DEADLINE, never a flag (ADR-0244): a channel somebody forgot
|
|
7713
|
-
* expires by itself, which is the one failure a boolean cannot avoid.
|
|
7714
|
-
*/
|
|
7715
|
-
var LogChannelWindowSchema = object({
|
|
7716
|
-
channel: string().min(1),
|
|
7717
|
-
/** Epoch ms the window closes at. */
|
|
7718
|
-
armedUntilMs: number(),
|
|
7719
|
-
/** `null` = every camera. A non-empty list narrows to those numeric ids. */
|
|
7720
|
-
deviceIds: array(number().int()).readonly().nullable()
|
|
7721
|
-
});
|
|
7722
|
-
/**
|
|
7723
7631
|
* Ops-log — the durable, append-only operations audit shared by the
|
|
7724
7632
|
* recordings and events management surfaces.
|
|
7725
7633
|
*
|
|
@@ -8641,6 +8549,21 @@ var StorageCleanupJobSchema = object({
|
|
|
8641
8549
|
});
|
|
8642
8550
|
var StorageCleanupStatusInputSchema = object({ jobId: string().optional() });
|
|
8643
8551
|
/**
|
|
8552
|
+
* The one typed state of a storage location. Authoritative Zod schema — the TS
|
|
8553
|
+
* alias below is `z.infer<>` of it, never a second spelling.
|
|
8554
|
+
*/
|
|
8555
|
+
var StorageLocationModeSchema = _enum([
|
|
8556
|
+
"active",
|
|
8557
|
+
"readonly",
|
|
8558
|
+
"drain",
|
|
8559
|
+
"disabled"
|
|
8560
|
+
]);
|
|
8561
|
+
_enum([
|
|
8562
|
+
"normal",
|
|
8563
|
+
"never",
|
|
8564
|
+
"drain"
|
|
8565
|
+
]);
|
|
8566
|
+
/**
|
|
8644
8567
|
* `StorageLocationType` — an addon-declared id that identifies the *kind* of
|
|
8645
8568
|
* storage a location serves. Defined here (not in `capabilities/storage.cap.ts`)
|
|
8646
8569
|
* so the persisted record schema and the consumer-facing cap can both consume it
|
|
@@ -8665,8 +8588,11 @@ var StorageLocationTypeSchema = string().regex(/^[a-z][a-zA-Z0-9-]*$/);
|
|
|
8665
8588
|
* `STORAGE_LOCATION_CARDINALITY` map has been removed.
|
|
8666
8589
|
*
|
|
8667
8590
|
* `id` is a stable namespaced string of the form `<type>:<slug>`.
|
|
8668
|
-
* The
|
|
8669
|
-
*
|
|
8591
|
+
* The seed names its first instance `<type>:default` — a NAME, not a flag.
|
|
8592
|
+
* There is no default location any more (D383): `enabled` is the whole write
|
|
8593
|
+
* model, and a bare type ref resolves to the sole location of the type, or —
|
|
8594
|
+
* transitionally, only while legacy NULL-stamped rows exist — to the row whose
|
|
8595
|
+
* slug is `default`.
|
|
8670
8596
|
*
|
|
8671
8597
|
* `isSystem` is a legacy persisted flag. Seed still creates the initial
|
|
8672
8598
|
* `<type>:default` locations; the flag is no longer a lock, a badge, or a
|
|
@@ -8687,23 +8613,37 @@ var StorageLocationSchema = object({
|
|
|
8687
8613
|
* flag at upsert time, not here (the schema is provider-agnostic).
|
|
8688
8614
|
*/
|
|
8689
8615
|
nodeId: string().optional(),
|
|
8690
|
-
isDefault: boolean().default(false),
|
|
8691
8616
|
isSystem: boolean().default(false),
|
|
8692
8617
|
/**
|
|
8693
|
-
*
|
|
8694
|
-
*
|
|
8695
|
-
*
|
|
8696
|
-
*
|
|
8697
|
-
*
|
|
8618
|
+
* THE write switch, and the only one (D383). `enabled: true` means every
|
|
8619
|
+
* consumer that chooses a write target for this type may write here, and all
|
|
8620
|
+
* enabled locations of a type are used TOGETHER; `false` means read-only —
|
|
8621
|
+
* still read, still played back, still age-swept, still drained, never
|
|
8622
|
+
* written.
|
|
8698
8623
|
*
|
|
8699
|
-
* OPTIONAL
|
|
8700
|
-
*
|
|
8701
|
-
*
|
|
8702
|
-
*
|
|
8703
|
-
*
|
|
8704
|
-
*
|
|
8624
|
+
* OPTIONAL only for the wire: an upsert that omits it means "leave what is
|
|
8625
|
+
* stored" on an update and "born inert unless it is the first location of its
|
|
8626
|
+
* type" on a create. On a PERSISTED row absence is legacy and it means
|
|
8627
|
+
* enabled — {@link isLocationEnabled} is the one place that says so, and the
|
|
8628
|
+
* orchestrator stamps every flagless row `true` once at hydrate so absence
|
|
8629
|
+
* stops existing rather than being re-derived on every read.
|
|
8705
8630
|
*/
|
|
8706
8631
|
enabled: boolean().optional(),
|
|
8632
|
+
/**
|
|
8633
|
+
* THE state of this location (D385), and the only authority on what may be
|
|
8634
|
+
* written, read or evicted here. Interpreted in exactly one place —
|
|
8635
|
+
* `storage-location-mode.ts` — which also folds the legacy
|
|
8636
|
+
* `enabled` / `config.readOnly` pair into a mode so an old row is never
|
|
8637
|
+
* ambiguous.
|
|
8638
|
+
*
|
|
8639
|
+
* OPTIONAL only for the wire and for rows written before D385: absence is
|
|
8640
|
+
* resolved by `resolveLocationMode`, and the orchestrator stamps every
|
|
8641
|
+
* unstamped row ONCE at hydrate so absence stops existing rather than being
|
|
8642
|
+
* re-derived on every read. `enabled` survives one release as a DERIVED
|
|
8643
|
+
* mirror (`mode === 'active'`); `withLocationMode` is the only writer of
|
|
8644
|
+
* either, so the two cannot disagree.
|
|
8645
|
+
*/
|
|
8646
|
+
mode: StorageLocationModeSchema.optional(),
|
|
8707
8647
|
/** COMPUTED at read time by the orchestrator (statfs of the backing volume
|
|
8708
8648
|
* for node-local locations it can reach) — never persisted, absent when the
|
|
8709
8649
|
* volume is remote/unreachable. The single capacity truth every UI reads. */
|
|
@@ -8711,13 +8651,50 @@ var StorageLocationSchema = object({
|
|
|
8711
8651
|
totalBytes: number(),
|
|
8712
8652
|
availableBytes: number()
|
|
8713
8653
|
}).nullable().optional(),
|
|
8654
|
+
/**
|
|
8655
|
+
* How much of that volume CamStack ITSELF holds on this location (D388) —
|
|
8656
|
+
* COMPUTED at read time from the `storage-occupancy` providers' own figures,
|
|
8657
|
+
* never persisted, never a filesystem walk.
|
|
8658
|
+
*
|
|
8659
|
+
* **ABSENT MEANS UNKNOWN, never zero.** No provider has reported for this
|
|
8660
|
+
* location yet — nobody stores here, the owning addon is down, or the first
|
|
8661
|
+
* refresh has not completed. A UI must omit the segment rather than draw it
|
|
8662
|
+
* at zero, which would claim we occupy nothing (D315). It is an OBJECT and
|
|
8663
|
+
* not a bare number precisely so that a `?? 0` on the consuming side has to
|
|
8664
|
+
* be spelled out loud instead of appearing by accident.
|
|
8665
|
+
*
|
|
8666
|
+
* `measuredAtMs` is the OLDEST contributing measurement, so it is honest
|
|
8667
|
+
* about the whole figure rather than about its freshest part.
|
|
8668
|
+
*/
|
|
8669
|
+
owned: object({
|
|
8670
|
+
bytes: number().int().nonnegative(),
|
|
8671
|
+
measuredAtMs: number().int().nonnegative()
|
|
8672
|
+
}).optional(),
|
|
8714
8673
|
createdAt: number(),
|
|
8715
8674
|
updatedAt: number()
|
|
8716
8675
|
});
|
|
8676
|
+
object({ isDefault: boolean().optional() });
|
|
8677
|
+
/**
|
|
8678
|
+
* How far a `drain` has got (D386) — the read a UI renders, and nothing more.
|
|
8679
|
+
*
|
|
8680
|
+
* `estimatedEmptyAtMs` is derived from the growth the ratchet has actually
|
|
8681
|
+
* OBSERVED and is `null` when it has observed none. Never a fabricated date: a
|
|
8682
|
+
* drain with no observed growth has no honest ETA, and inventing one is how an
|
|
8683
|
+
* operator learns not to believe the screen.
|
|
8684
|
+
*/
|
|
8685
|
+
var StorageDrainProgressSchema = object({
|
|
8686
|
+
locationId: string(),
|
|
8687
|
+
startedAtMs: number(),
|
|
8688
|
+
startBytes: number(),
|
|
8689
|
+
bytesRemaining: number(),
|
|
8690
|
+
drained: boolean(),
|
|
8691
|
+
estimatedEmptyAtMs: number().nullable()
|
|
8692
|
+
});
|
|
8717
8693
|
/**
|
|
8718
8694
|
* Reference accepted by consumer-facing `api.storage.*` calls.
|
|
8719
8695
|
* Either:
|
|
8720
|
-
* - a `StorageLocationType` (e.g. `'backups'`) →
|
|
8696
|
+
* - a `StorageLocationType` (e.g. `'backups'`) → the sole location of that type
|
|
8697
|
+
* (transitionally, the `<type>:default`-slugged row when several exist)
|
|
8721
8698
|
* - a fully-qualified id (e.g. `'backups:nas-01'`) → addresses a specific instance
|
|
8722
8699
|
*
|
|
8723
8700
|
* The orchestrator's `resolveRef(ref)` handles both cases.
|
|
@@ -8893,6 +8870,111 @@ var DecoderSessionConfigSchema = object({
|
|
|
8893
8870
|
*/
|
|
8894
8871
|
debug: boolean().optional()
|
|
8895
8872
|
});
|
|
8873
|
+
/**
|
|
8874
|
+
* Per-component log CHANNELS — the gate a hot path consults, and the registry
|
|
8875
|
+
* an addon declares its channels in.
|
|
8876
|
+
*
|
|
8877
|
+
* ## Two axes, deliberately separated
|
|
8878
|
+
*
|
|
8879
|
+
* - **DECLARATION** — which channels exist. Only the addon knows:
|
|
8880
|
+
* `stream-broker` knows webrtc/ICE/RTP, `provider-reolink` knows
|
|
8881
|
+
* baichuan/handshake. A hand-wired central list rots at the first addition,
|
|
8882
|
+
* and rots silently. So a channel is declared where it is consulted, and the
|
|
8883
|
+
* `log-channels` capability enumerates the declarations.
|
|
8884
|
+
* - **VALUE** — at which level, for which scope, until when. That stays ONE
|
|
8885
|
+
* thing: the logging settings document on the `system` cap. Two authorities
|
|
8886
|
+
* over the values is the exact defect
|
|
8887
|
+
* `docs/design/plans/2026-08-26-logging-per-componente.md` was written to
|
|
8888
|
+
* remove; re-introducing it from the cure side would be grotesque.
|
|
8889
|
+
*
|
|
8890
|
+
* Nothing in this file reads a clock, an env var or a store. The registry is
|
|
8891
|
+
* a MIRROR: it is moved only by {@link LogChannelRegistry.apply}, called off
|
|
8892
|
+
* the hot path with a value somebody actually read, and by
|
|
8893
|
+
* {@link LogChannelRegistry.tick}, called on a timer. A store read that fails
|
|
8894
|
+
* never reaches here, so it can neither disarm an armed channel nor arm a
|
|
8895
|
+
* disarmed one (D49).
|
|
8896
|
+
*
|
|
8897
|
+
* ## The canonical call shape
|
|
8898
|
+
*
|
|
8899
|
+
* ```ts
|
|
8900
|
+
* if (CH_RTP.on && CH_RTP.wants(deviceId)) {
|
|
8901
|
+
* CH_RTP.log(logger, 'rtp subscriber added', { tags: { deviceId }, meta: { ssrc } })
|
|
8902
|
+
* }
|
|
8903
|
+
* ```
|
|
8904
|
+
*
|
|
8905
|
+
* `on` is a plain boolean FIELD — never a getter — and it is the FIRST thing
|
|
8906
|
+
* read. Disarmed, a call site costs one load and one branch, and the `extras`
|
|
8907
|
+
* object literal is never constructed because it lives inside the branch. It
|
|
8908
|
+
* is the same shape already proven in production at `stream-broker.ts:1650`,
|
|
8909
|
+
* and the same discipline `LoggingGate.allowsDestination` uses for the
|
|
8910
|
+
* destination floor (measured at 1.93 ns/call when off).
|
|
8911
|
+
*
|
|
8912
|
+
* ## Why a channel emits at `info`
|
|
8913
|
+
*
|
|
8914
|
+
* `loki-logging.addon.ts` pins the destination default at `info` and
|
|
8915
|
+
* `loki-destination.ts` drops everything below it, so a line emitted at
|
|
8916
|
+
* `debug` never reaches Loki and the hub's in-memory ring only holds ~35
|
|
8917
|
+
* minutes. A diagnostic that cannot be read an hour later is worse than no
|
|
8918
|
+
* diagnostic, because it looks done. {@link LogChannelGate.log} therefore
|
|
8919
|
+
* emits at the channel's declared level, whose schema floor is `info`.
|
|
8920
|
+
*/
|
|
8921
|
+
/**
|
|
8922
|
+
* The level a channel writes at once armed.
|
|
8923
|
+
*
|
|
8924
|
+
* `debug` is absent ON PURPOSE and not by omission: below `info` the line does
|
|
8925
|
+
* not leave the process for Loki, and the whole point of arming a channel is
|
|
8926
|
+
* to read it later.
|
|
8927
|
+
*/
|
|
8928
|
+
var LogChannelLevelSchema = _enum([
|
|
8929
|
+
"info",
|
|
8930
|
+
"warn",
|
|
8931
|
+
"error"
|
|
8932
|
+
]);
|
|
8933
|
+
/**
|
|
8934
|
+
* What an addon declares about one channel. No value, no state — a
|
|
8935
|
+
* declaration is inert.
|
|
8936
|
+
*/
|
|
8937
|
+
var LogChannelDescriptorSchema = object({
|
|
8938
|
+
/**
|
|
8939
|
+
* Dotted `area.thing`, unique across the workspace. `area` is conventionally
|
|
8940
|
+
* the addon's short name so an operator reading a channel list can tell who
|
|
8941
|
+
* owns it without a second lookup.
|
|
8942
|
+
*/
|
|
8943
|
+
name: string().min(3).regex(/^[a-z0-9-]+(\.[a-z0-9-]+)+$/, "a channel name is dotted lower-kebab, e.g. area.thing"),
|
|
8944
|
+
/** One sentence: what the operator will SEE after arming it. */
|
|
8945
|
+
description: string().min(1),
|
|
8946
|
+
/** The level its lines are emitted at. Never below `info`. */
|
|
8947
|
+
defaultLevel: LogChannelLevelSchema,
|
|
8948
|
+
/**
|
|
8949
|
+
* Whether this channel can be narrowed to a camera.
|
|
8950
|
+
*
|
|
8951
|
+
* `true` is a PROMISE with two halves, and both must hold: the gate is
|
|
8952
|
+
* consulted with the numeric device id, AND every line the channel admits
|
|
8953
|
+
* carries `tags: { deviceId }` with that same numeric id. The second half is
|
|
8954
|
+
* what makes `| json | deviceId="617"` work in Loki — `loki-payload.ts`
|
|
8955
|
+
* keeps `deviceId` out of the stream labels for cardinality, so the tag in
|
|
8956
|
+
* the body is the only way to filter.
|
|
8957
|
+
*
|
|
8958
|
+
* A channel whose lines carry the device only in `meta` (or not at all) is
|
|
8959
|
+
* declared `false`. Declaring it `true` anyway would be a lie the UI repeats:
|
|
8960
|
+
* the operator narrows to one camera, sees nothing, and concludes the code
|
|
8961
|
+
* path was never taken.
|
|
8962
|
+
*/
|
|
8963
|
+
perDevice: boolean()
|
|
8964
|
+
});
|
|
8965
|
+
/**
|
|
8966
|
+
* An armed window over one channel, as the document hands it to a mirror.
|
|
8967
|
+
*
|
|
8968
|
+
* A window is a DEADLINE, never a flag (ADR-0244): a channel somebody forgot
|
|
8969
|
+
* expires by itself, which is the one failure a boolean cannot avoid.
|
|
8970
|
+
*/
|
|
8971
|
+
var LogChannelWindowSchema = object({
|
|
8972
|
+
channel: string().min(1),
|
|
8973
|
+
/** Epoch ms the window closes at. */
|
|
8974
|
+
armedUntilMs: number(),
|
|
8975
|
+
/** `null` = every camera. A non-empty list narrows to those numeric ids. */
|
|
8976
|
+
deviceIds: array(number().int()).readonly().nullable()
|
|
8977
|
+
});
|
|
8896
8978
|
var MODEL_FORMATS = [
|
|
8897
8979
|
"onnx",
|
|
8898
8980
|
"coreml",
|
|
@@ -21687,7 +21769,7 @@ method(object({
|
|
|
21687
21769
|
downloadId: string(),
|
|
21688
21770
|
offset: number(),
|
|
21689
21771
|
length: number()
|
|
21690
|
-
}), _instanceof(Uint8Array)), method(object({ downloadId: string() }), _void(), { kind: "mutation" }), method(object({ type: StorageLocationTypeSchema.optional() }), array(StorageLocationSchema).readonly()), method(
|
|
21772
|
+
}), _instanceof(Uint8Array)), method(object({ downloadId: string() }), _void(), { kind: "mutation" }), method(object({ type: StorageLocationTypeSchema.optional() }), array(StorageLocationSchema).readonly()), method(_void(), array(StorageLocationDeclarationSchema).readonly()), method(StorageLocationSchema.omit({
|
|
21691
21773
|
createdAt: true,
|
|
21692
21774
|
updatedAt: true
|
|
21693
21775
|
}), StorageLocationSchema, {
|
|
@@ -21699,7 +21781,7 @@ method(object({
|
|
|
21699
21781
|
}), _void(), {
|
|
21700
21782
|
kind: "mutation",
|
|
21701
21783
|
auth: "admin"
|
|
21702
|
-
}), method(object({ id: string() }), object({
|
|
21784
|
+
}), method(_void(), array(StorageDrainProgressSchema).readonly()), method(object({ id: string() }), object({
|
|
21703
21785
|
ok: boolean(),
|
|
21704
21786
|
error: string().optional()
|
|
21705
21787
|
}), { auth: "admin" }), method(_void(), array(ProviderListEntrySchema).readonly()), method(object({
|
|
@@ -21769,6 +21851,51 @@ method(StorageMigrationInputSchema, StorageMigrationPlanSchema, { auth: "admin"
|
|
|
21769
21851
|
kind: "mutation",
|
|
21770
21852
|
auth: "admin"
|
|
21771
21853
|
}), method(object({}), array(StorageMigrationJobSchema).readonly(), { auth: "admin" });
|
|
21854
|
+
/**
|
|
21855
|
+
* `storage-occupancy` — how many bytes an addon actually HOLDS on a storage
|
|
21856
|
+
* location (D388).
|
|
21857
|
+
*
|
|
21858
|
+
* ## Why this is not `storage-evictable`
|
|
21859
|
+
*
|
|
21860
|
+
* `storage-evictable.getEvictableUsage` looks like the same question and is
|
|
21861
|
+
* not, in two ways that both matter and both bite hardest on the locations an
|
|
21862
|
+
* operator most wants a figure for:
|
|
21863
|
+
*
|
|
21864
|
+
* - it reports the whole eviction DOMAIN, not the location. `recordings:default`
|
|
21865
|
+
* and `recordingsLow:default` deliberately share one root and evict as one
|
|
21866
|
+
* oldest-first pool, so both answer with the SAME combined total. As an
|
|
21867
|
+
* occupancy figure that double-counts the disk.
|
|
21868
|
+
* - it reports ZERO for a location whose eviction policy is `never` (D385) —
|
|
21869
|
+
* a `readonly` or `disabled` disk. Those are exactly the disks an operator
|
|
21870
|
+
* is retiring and staring at.
|
|
21871
|
+
*
|
|
21872
|
+
* So this is its own contract with its own quantity, and the quantity is
|
|
21873
|
+
* OCCUPIED: every byte the addon holds on that location, whether or not it
|
|
21874
|
+
* would ever be willing to delete it. A provider that can only answer
|
|
21875
|
+
* "evictable" must not register here — a number that silently means different
|
|
21876
|
+
* things per class is worse than no number.
|
|
21877
|
+
*
|
|
21878
|
+
* ## Absence is an answer
|
|
21879
|
+
*
|
|
21880
|
+
* A location nobody reports for is UNKNOWN, never zero (D315). The orchestrator
|
|
21881
|
+
* stamps `StorageLocation.owned` only for locations it has a report for, and
|
|
21882
|
+
* the field is an OBJECT rather than a bare number so that a `?? 0` on the
|
|
21883
|
+
* consuming side has to be written out loud instead of appearing by accident.
|
|
21884
|
+
*
|
|
21885
|
+
* `internal: true` — consumed by the orchestrator's `listLocations` stamp, never
|
|
21886
|
+
* a public client surface. Clients read the stamped `StorageLocation.owned`.
|
|
21887
|
+
*/
|
|
21888
|
+
/** One provider's occupancy answer for one location. */
|
|
21889
|
+
var StorageOccupancyReportSchema = object({
|
|
21890
|
+
locationId: string(),
|
|
21891
|
+
/** Bytes this provider holds on THAT location — not its eviction domain, and
|
|
21892
|
+
* not net of what it is willing to delete. */
|
|
21893
|
+
ownedBytes: number().int().nonnegative(),
|
|
21894
|
+
/** When the provider last actually measured this. The orchestrator carries it
|
|
21895
|
+
* through so a UI can say how old the figure is instead of implying "now". */
|
|
21896
|
+
measuredAtMs: number().int().nonnegative()
|
|
21897
|
+
});
|
|
21898
|
+
method(object({ locationIds: array(string()).readonly() }), array(StorageOccupancyReportSchema).readonly(), { auth: "admin" });
|
|
21772
21899
|
var ProviderInfoSchema = discriminatedUnion("shouldSaveDiskSpace", [object({
|
|
21773
21900
|
providerId: string().min(1),
|
|
21774
21901
|
displayName: string().min(1),
|
|
@@ -23404,39 +23531,6 @@ DeviceType.Camera, DeviceType.Sensor, DeviceType.Button, DeviceType.Switch, meth
|
|
|
23404
23531
|
deviceId: number(),
|
|
23405
23532
|
status: BatteryStatusSchema
|
|
23406
23533
|
});
|
|
23407
|
-
/**
|
|
23408
|
-
* Network-link snapshot. Same shape for every provider (a Reolink wifi
|
|
23409
|
-
* camera, a Home Assistant device with a signal-strength sensor, a Tapo
|
|
23410
|
-
* plug): one slice under `device.runtimeState['network-link']`, one badge,
|
|
23411
|
-
* one Home Assistant projection.
|
|
23412
|
-
*/
|
|
23413
|
-
var NetworkLinkStatusSchema = object({
|
|
23414
|
-
/** The link the device is on. `'unknown'` = not read yet, not "no link". */
|
|
23415
|
-
type: _enum([
|
|
23416
|
-
"wifi",
|
|
23417
|
-
"ethernet",
|
|
23418
|
-
"cellular",
|
|
23419
|
-
"unknown"
|
|
23420
|
-
]),
|
|
23421
|
-
/**
|
|
23422
|
-
* Link quality, 0..100 inclusive, normalised by the provider from whatever
|
|
23423
|
-
* the firmware reports (bars, RSSI, a vendor scale). **`null` means NOT
|
|
23424
|
-
* KNOWN or NOT APPLICABLE** — a wired link has no signal, and a wireless
|
|
23425
|
-
* one whose reading has not landed must not be drawn at 0 %. Consumers
|
|
23426
|
-
* SKIP a null rather than coerce it.
|
|
23427
|
-
*/
|
|
23428
|
-
signalPercent: number().min(0).max(100).nullable(),
|
|
23429
|
-
/** Raw received signal strength in dBm, when the firmware reports one. */
|
|
23430
|
-
rssiDbm: number().optional(),
|
|
23431
|
-
/** Network name of a wireless link, when the firmware reports it. */
|
|
23432
|
-
ssid: string().optional(),
|
|
23433
|
-
/** Ms epoch of the last observation. Lets consumers reason about freshness. */
|
|
23434
|
-
lastUpdated: number()
|
|
23435
|
-
});
|
|
23436
|
-
DeviceType.Camera, DeviceType.Sensor, DeviceType.Button, DeviceType.Switch, DeviceType.Light, DeviceType.Lock, DeviceType.Siren, object({
|
|
23437
|
-
deviceId: number(),
|
|
23438
|
-
status: NetworkLinkStatusSchema
|
|
23439
|
-
});
|
|
23440
23534
|
object({
|
|
23441
23535
|
on: boolean(),
|
|
23442
23536
|
/** Ms epoch of the last transition. 0 if never observed. */
|
|
@@ -25790,6 +25884,236 @@ DeviceType.Camera, method(object({
|
|
|
25790
25884
|
detection: NativeDetectionSchema
|
|
25791
25885
|
});
|
|
25792
25886
|
/**
|
|
25887
|
+
* `navigation` — a device-scoped capability that natively expresses the FULL
|
|
25888
|
+
* navigation / action surface of a robot that DRIVES ITSELF and carries an
|
|
25889
|
+
* on-board camera (the Dreame robot-vacuum camera is the first provider).
|
|
25890
|
+
*
|
|
25891
|
+
* Why a NEW cap rather than overloading `ptz`:
|
|
25892
|
+
* - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
|
|
25893
|
+
* robot vacuum has no gimbal — the whole chassis drives, turns and spins.
|
|
25894
|
+
* The two are different physical models: PTZ is absolute-position + presets,
|
|
25895
|
+
* navigation is momentary drive nudges + discrete robot ACTIONS
|
|
25896
|
+
* (dock / spot-clean / follow-pet / go-to-point / …).
|
|
25897
|
+
* - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
|
|
25898
|
+
* the reverse:
|
|
25899
|
+
* 1. a native CamStack navigation panel (data-driven from `listActions`
|
|
25900
|
+
* / `getOptions`), and
|
|
25901
|
+
* 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
|
|
25902
|
+
* robot camera shows up in the existing PTZ control path without every
|
|
25903
|
+
* PTZ provider learning about robots. The mapping lives in the adapter,
|
|
25904
|
+
* not here (see the addon design note):
|
|
25905
|
+
* ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
|
|
25906
|
+
* ptz.stop() → navigation.stop()
|
|
25907
|
+
* ptz.goHome() → navigation.runAction('goHome')
|
|
25908
|
+
* ptz.getPresets() → navigation.listActions() (id→preset)
|
|
25909
|
+
* ptz.goToPreset(id) → navigation.runAction(id)
|
|
25910
|
+
*
|
|
25911
|
+
* ## Continuous drive
|
|
25912
|
+
*
|
|
25913
|
+
* `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
|
|
25914
|
+
* sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
|
|
25915
|
+
* one `stop()` on release — exactly like the robot app's remote-drive joystick.
|
|
25916
|
+
* The provider forwards EACH `move` to one drive write; it must NOT debounce or
|
|
25917
|
+
* coalesce them. The UI owns the cadence.
|
|
25918
|
+
*
|
|
25919
|
+
* ## The action dictionary
|
|
25920
|
+
*
|
|
25921
|
+
* The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
|
|
25922
|
+
* are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
|
|
25923
|
+
* carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
|
|
25924
|
+
* native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
|
|
25925
|
+
* vendor-specific list. `kind: 'action'` entries are triggered with
|
|
25926
|
+
* `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
|
|
25927
|
+
* (the entry carries the `soundId` to pass). The general primitives — `move`,
|
|
25928
|
+
* `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
|
|
25929
|
+
*
|
|
25930
|
+
* NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
|
|
25931
|
+
* `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
|
|
25932
|
+
* that the currently-published `@apocaliss92/nodedreame` already exposes on
|
|
25933
|
+
* every device handle. A future nodedreame publish adds a typed
|
|
25934
|
+
* `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
|
|
25935
|
+
* provider can then swap the raw calls for the typed methods with no change to
|
|
25936
|
+
* THIS contract.
|
|
25937
|
+
*/
|
|
25938
|
+
/**
|
|
25939
|
+
* A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
|
|
25940
|
+
* keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
|
|
25941
|
+
* halts it.
|
|
25942
|
+
*
|
|
25943
|
+
* - `pan` — turn: negative = left, positive = right, 0 = straight.
|
|
25944
|
+
* - `tilt` — throttle: positive = forward, negative = spin / turn-around.
|
|
25945
|
+
* - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
|
|
25946
|
+
* vector by it (drivers without proportional drive ignore it).
|
|
25947
|
+
*
|
|
25948
|
+
* `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
|
|
25949
|
+
* axis alone; an all-undefined nudge is a no-op.
|
|
25950
|
+
*/
|
|
25951
|
+
var NavigationMoveCommandSchema = object({
|
|
25952
|
+
pan: number().min(-1).max(1).optional(),
|
|
25953
|
+
tilt: number().min(-1).max(1).optional(),
|
|
25954
|
+
speed: number().min(0).max(1).optional()
|
|
25955
|
+
});
|
|
25956
|
+
/**
|
|
25957
|
+
* The enumerated discrete actions a navigation-capable robot can perform via
|
|
25958
|
+
* `runAction`. This is the CLOSED vocabulary; a given device advertises the
|
|
25959
|
+
* subset it supports through `listActions`. Sounds are NOT here — they go through
|
|
25960
|
+
* `playSound` (see the `sound` dictionary entries).
|
|
25961
|
+
*/
|
|
25962
|
+
var NavigationActionIdSchema = _enum([
|
|
25963
|
+
"goHome",
|
|
25964
|
+
"locate",
|
|
25965
|
+
"spotClean",
|
|
25966
|
+
"findPet",
|
|
25967
|
+
"personFollow",
|
|
25968
|
+
"stop",
|
|
25969
|
+
"startClean",
|
|
25970
|
+
"pauseClean",
|
|
25971
|
+
"dockWash",
|
|
25972
|
+
"autoEmpty",
|
|
25973
|
+
"flashOn",
|
|
25974
|
+
"flashOff"
|
|
25975
|
+
]);
|
|
25976
|
+
/** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
|
|
25977
|
+
var NavigationEntryKindSchema = _enum(["action", "sound"]);
|
|
25978
|
+
/**
|
|
25979
|
+
* One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
|
|
25980
|
+
* native panel and the PTZ mimic render as a button.
|
|
25981
|
+
*
|
|
25982
|
+
* - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
|
|
25983
|
+
* (pass to `runAction`); for `kind:'sound'` it is a namespaced id
|
|
25984
|
+
* (`sound:meow`) whose `soundId` is passed to `playSound`.
|
|
25985
|
+
* - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
|
|
25986
|
+
* - `label` — operator-facing English label.
|
|
25987
|
+
* - `soundId` — wire sound id, present only on `kind:'sound'` entries.
|
|
25988
|
+
* - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
|
|
25989
|
+
* PTZ render ONLY enabled entries. Data-driven: the provider
|
|
25990
|
+
* flips it from config, never by editing code.
|
|
25991
|
+
*/
|
|
25992
|
+
var NavigationActionEntrySchema = object({
|
|
25993
|
+
id: string(),
|
|
25994
|
+
kind: NavigationEntryKindSchema,
|
|
25995
|
+
label: string(),
|
|
25996
|
+
icon: string(),
|
|
25997
|
+
/** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
|
|
25998
|
+
soundId: number().int().optional(),
|
|
25999
|
+
/** Per-device feature flag — render this entry only when true. */
|
|
26000
|
+
enabled: boolean()
|
|
26001
|
+
});
|
|
26002
|
+
/** Coordinates for `goToPoint` — a point on the robot's live map. */
|
|
26003
|
+
var NavigationPointSchema = object({
|
|
26004
|
+
x: number(),
|
|
26005
|
+
y: number()
|
|
26006
|
+
});
|
|
26007
|
+
/**
|
|
26008
|
+
* Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
|
|
26009
|
+
* The cap reports which are enabled so the UI / PTZ render only the controls
|
|
26010
|
+
* that are turned on for THIS device. Data-driven: the provider derives these
|
|
26011
|
+
* from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
|
|
26012
|
+
* live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
|
|
26013
|
+
* that are not dictionary entries.
|
|
26014
|
+
*
|
|
26015
|
+
* - `move` / `stop` — the momentary drive joystick.
|
|
26016
|
+
* - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
|
|
26017
|
+
* map-coordinate plumbing is wired.
|
|
26018
|
+
* - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
|
|
26019
|
+
* - `playSound` — the sound buttons (dictionary `kind:'sound'`).
|
|
26020
|
+
* - `light` — the on/off fill-light toggle (works anytime).
|
|
26021
|
+
* - `lightMode` — the auto/manual selector + manual level slider (a
|
|
26022
|
+
* camera-service control; needs an active stream).
|
|
26023
|
+
*/
|
|
26024
|
+
var NavigationFeaturesSchema = object({
|
|
26025
|
+
move: boolean(),
|
|
26026
|
+
stop: boolean(),
|
|
26027
|
+
goToPoint: boolean(),
|
|
26028
|
+
runAction: boolean(),
|
|
26029
|
+
playSound: boolean(),
|
|
26030
|
+
light: boolean(),
|
|
26031
|
+
lightMode: boolean()
|
|
26032
|
+
});
|
|
26033
|
+
/** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
|
|
26034
|
+
var NavigationLightModeSchema = _enum(["auto", "manual"]);
|
|
26035
|
+
/**
|
|
26036
|
+
* Live navigation state so the UI can reflect what the robot is doing:
|
|
26037
|
+
* - `mode` — coarse activity (idle / cleaning / following / …).
|
|
26038
|
+
* - `following` — person/pet follow is currently armed.
|
|
26039
|
+
* - `flash` — the on-camera fill light is on.
|
|
26040
|
+
* - `lightMode` — auto vs manual fill-light mode.
|
|
26041
|
+
* - `lightLevel` — manual fill-light level (40..100); meaningful when
|
|
26042
|
+
* `lightMode === 'manual'`.
|
|
26043
|
+
*/
|
|
26044
|
+
var NavigationStatusSchema = object({
|
|
26045
|
+
mode: _enum([
|
|
26046
|
+
"idle",
|
|
26047
|
+
"cleaning",
|
|
26048
|
+
"spot",
|
|
26049
|
+
"following",
|
|
26050
|
+
"goto",
|
|
26051
|
+
"returning",
|
|
26052
|
+
"paused",
|
|
26053
|
+
"unknown"
|
|
26054
|
+
]),
|
|
26055
|
+
following: boolean(),
|
|
26056
|
+
flash: boolean(),
|
|
26057
|
+
lightMode: NavigationLightModeSchema,
|
|
26058
|
+
lightLevel: number().min(40).max(100),
|
|
26059
|
+
/** Ms epoch when the slice was last updated. */
|
|
26060
|
+
lastChangedAt: number()
|
|
26061
|
+
});
|
|
26062
|
+
NavigationStatusSchema.extend({ lastFetchedAt: number() });
|
|
26063
|
+
DeviceType.Camera, method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), _void(), { kind: "mutation" }), method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), array(NavigationActionEntrySchema)), method(object({
|
|
26064
|
+
deviceId: number(),
|
|
26065
|
+
actionId: NavigationActionIdSchema
|
|
26066
|
+
}), _void(), { kind: "mutation" }), method(object({
|
|
26067
|
+
deviceId: number(),
|
|
26068
|
+
soundId: number().int()
|
|
26069
|
+
}), _void(), { kind: "mutation" }), method(object({
|
|
26070
|
+
deviceId: number(),
|
|
26071
|
+
on: boolean()
|
|
26072
|
+
}), _void(), { kind: "mutation" }), method(object({
|
|
26073
|
+
deviceId: number(),
|
|
26074
|
+
mode: NavigationLightModeSchema,
|
|
26075
|
+
level: number().min(40).max(100).optional()
|
|
26076
|
+
}), _void(), { kind: "mutation" }), method(object({
|
|
26077
|
+
deviceId: number(),
|
|
26078
|
+
level: number().min(40).max(100)
|
|
26079
|
+
}), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), NavigationFeaturesSchema), object({
|
|
26080
|
+
deviceId: number(),
|
|
26081
|
+
status: NavigationStatusSchema
|
|
26082
|
+
});
|
|
26083
|
+
/**
|
|
26084
|
+
* Network-link snapshot. Same shape for every provider (a Reolink wifi
|
|
26085
|
+
* camera, a Home Assistant device with a signal-strength sensor, a Tapo
|
|
26086
|
+
* plug): one slice under `device.runtimeState['network-link']`, one badge,
|
|
26087
|
+
* one Home Assistant projection.
|
|
26088
|
+
*/
|
|
26089
|
+
var NetworkLinkStatusSchema = object({
|
|
26090
|
+
/** The link the device is on. `'unknown'` = not read yet, not "no link". */
|
|
26091
|
+
type: _enum([
|
|
26092
|
+
"wifi",
|
|
26093
|
+
"ethernet",
|
|
26094
|
+
"cellular",
|
|
26095
|
+
"unknown"
|
|
26096
|
+
]),
|
|
26097
|
+
/**
|
|
26098
|
+
* Link quality, 0..100 inclusive, normalised by the provider from whatever
|
|
26099
|
+
* the firmware reports (bars, RSSI, a vendor scale). **`null` means NOT
|
|
26100
|
+
* KNOWN or NOT APPLICABLE** — a wired link has no signal, and a wireless
|
|
26101
|
+
* one whose reading has not landed must not be drawn at 0 %. Consumers
|
|
26102
|
+
* SKIP a null rather than coerce it.
|
|
26103
|
+
*/
|
|
26104
|
+
signalPercent: number().min(0).max(100).nullable(),
|
|
26105
|
+
/** Raw received signal strength in dBm, when the firmware reports one. */
|
|
26106
|
+
rssiDbm: number().optional(),
|
|
26107
|
+
/** Network name of a wireless link, when the firmware reports it. */
|
|
26108
|
+
ssid: string().optional(),
|
|
26109
|
+
/** Ms epoch of the last observation. Lets consumers reason about freshness. */
|
|
26110
|
+
lastUpdated: number()
|
|
26111
|
+
});
|
|
26112
|
+
DeviceType.Camera, DeviceType.Sensor, DeviceType.Button, DeviceType.Switch, DeviceType.Light, DeviceType.Lock, DeviceType.Siren, object({
|
|
26113
|
+
deviceId: number(),
|
|
26114
|
+
status: NetworkLinkStatusSchema
|
|
26115
|
+
});
|
|
26116
|
+
/**
|
|
25793
26117
|
* network-quality — system-scoped singleton capability tracking RTT,
|
|
25794
26118
|
* jitter, and observed/peak bandwidth per device + per client.
|
|
25795
26119
|
*
|
|
@@ -27031,203 +27355,6 @@ DeviceType.Camera, method(object({ deviceId: number() }), PtzAutotrackStatusSche
|
|
|
27031
27355
|
deviceId: number(),
|
|
27032
27356
|
status: PtzAutotrackStatusSchema
|
|
27033
27357
|
});
|
|
27034
|
-
/**
|
|
27035
|
-
* `navigation` — a device-scoped capability that natively expresses the FULL
|
|
27036
|
-
* navigation / action surface of a robot that DRIVES ITSELF and carries an
|
|
27037
|
-
* on-board camera (the Dreame robot-vacuum camera is the first provider).
|
|
27038
|
-
*
|
|
27039
|
-
* Why a NEW cap rather than overloading `ptz`:
|
|
27040
|
-
* - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
|
|
27041
|
-
* robot vacuum has no gimbal — the whole chassis drives, turns and spins.
|
|
27042
|
-
* The two are different physical models: PTZ is absolute-position + presets,
|
|
27043
|
-
* navigation is momentary drive nudges + discrete robot ACTIONS
|
|
27044
|
-
* (dock / spot-clean / follow-pet / go-to-point / …).
|
|
27045
|
-
* - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
|
|
27046
|
-
* the reverse:
|
|
27047
|
-
* 1. a native CamStack navigation panel (data-driven from `listActions`
|
|
27048
|
-
* / `getOptions`), and
|
|
27049
|
-
* 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
|
|
27050
|
-
* robot camera shows up in the existing PTZ control path without every
|
|
27051
|
-
* PTZ provider learning about robots. The mapping lives in the adapter,
|
|
27052
|
-
* not here (see the addon design note):
|
|
27053
|
-
* ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
|
|
27054
|
-
* ptz.stop() → navigation.stop()
|
|
27055
|
-
* ptz.goHome() → navigation.runAction('goHome')
|
|
27056
|
-
* ptz.getPresets() → navigation.listActions() (id→preset)
|
|
27057
|
-
* ptz.goToPreset(id) → navigation.runAction(id)
|
|
27058
|
-
*
|
|
27059
|
-
* ## Continuous drive
|
|
27060
|
-
*
|
|
27061
|
-
* `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
|
|
27062
|
-
* sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
|
|
27063
|
-
* one `stop()` on release — exactly like the robot app's remote-drive joystick.
|
|
27064
|
-
* The provider forwards EACH `move` to one drive write; it must NOT debounce or
|
|
27065
|
-
* coalesce them. The UI owns the cadence.
|
|
27066
|
-
*
|
|
27067
|
-
* ## The action dictionary
|
|
27068
|
-
*
|
|
27069
|
-
* The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
|
|
27070
|
-
* are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
|
|
27071
|
-
* carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
|
|
27072
|
-
* native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
|
|
27073
|
-
* vendor-specific list. `kind: 'action'` entries are triggered with
|
|
27074
|
-
* `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
|
|
27075
|
-
* (the entry carries the `soundId` to pass). The general primitives — `move`,
|
|
27076
|
-
* `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
|
|
27077
|
-
*
|
|
27078
|
-
* NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
|
|
27079
|
-
* `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
|
|
27080
|
-
* that the currently-published `@apocaliss92/nodedreame` already exposes on
|
|
27081
|
-
* every device handle. A future nodedreame publish adds a typed
|
|
27082
|
-
* `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
|
|
27083
|
-
* provider can then swap the raw calls for the typed methods with no change to
|
|
27084
|
-
* THIS contract.
|
|
27085
|
-
*/
|
|
27086
|
-
/**
|
|
27087
|
-
* A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
|
|
27088
|
-
* keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
|
|
27089
|
-
* halts it.
|
|
27090
|
-
*
|
|
27091
|
-
* - `pan` — turn: negative = left, positive = right, 0 = straight.
|
|
27092
|
-
* - `tilt` — throttle: positive = forward, negative = spin / turn-around.
|
|
27093
|
-
* - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
|
|
27094
|
-
* vector by it (drivers without proportional drive ignore it).
|
|
27095
|
-
*
|
|
27096
|
-
* `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
|
|
27097
|
-
* axis alone; an all-undefined nudge is a no-op.
|
|
27098
|
-
*/
|
|
27099
|
-
var NavigationMoveCommandSchema = object({
|
|
27100
|
-
pan: number().min(-1).max(1).optional(),
|
|
27101
|
-
tilt: number().min(-1).max(1).optional(),
|
|
27102
|
-
speed: number().min(0).max(1).optional()
|
|
27103
|
-
});
|
|
27104
|
-
/**
|
|
27105
|
-
* The enumerated discrete actions a navigation-capable robot can perform via
|
|
27106
|
-
* `runAction`. This is the CLOSED vocabulary; a given device advertises the
|
|
27107
|
-
* subset it supports through `listActions`. Sounds are NOT here — they go through
|
|
27108
|
-
* `playSound` (see the `sound` dictionary entries).
|
|
27109
|
-
*/
|
|
27110
|
-
var NavigationActionIdSchema = _enum([
|
|
27111
|
-
"goHome",
|
|
27112
|
-
"locate",
|
|
27113
|
-
"spotClean",
|
|
27114
|
-
"findPet",
|
|
27115
|
-
"personFollow",
|
|
27116
|
-
"stop",
|
|
27117
|
-
"startClean",
|
|
27118
|
-
"pauseClean",
|
|
27119
|
-
"dockWash",
|
|
27120
|
-
"autoEmpty",
|
|
27121
|
-
"flashOn",
|
|
27122
|
-
"flashOff"
|
|
27123
|
-
]);
|
|
27124
|
-
/** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
|
|
27125
|
-
var NavigationEntryKindSchema = _enum(["action", "sound"]);
|
|
27126
|
-
/**
|
|
27127
|
-
* One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
|
|
27128
|
-
* native panel and the PTZ mimic render as a button.
|
|
27129
|
-
*
|
|
27130
|
-
* - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
|
|
27131
|
-
* (pass to `runAction`); for `kind:'sound'` it is a namespaced id
|
|
27132
|
-
* (`sound:meow`) whose `soundId` is passed to `playSound`.
|
|
27133
|
-
* - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
|
|
27134
|
-
* - `label` — operator-facing English label.
|
|
27135
|
-
* - `soundId` — wire sound id, present only on `kind:'sound'` entries.
|
|
27136
|
-
* - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
|
|
27137
|
-
* PTZ render ONLY enabled entries. Data-driven: the provider
|
|
27138
|
-
* flips it from config, never by editing code.
|
|
27139
|
-
*/
|
|
27140
|
-
var NavigationActionEntrySchema = object({
|
|
27141
|
-
id: string(),
|
|
27142
|
-
kind: NavigationEntryKindSchema,
|
|
27143
|
-
label: string(),
|
|
27144
|
-
icon: string(),
|
|
27145
|
-
/** Present only on `kind:'sound'` entries — the id to pass to `playSound`. */
|
|
27146
|
-
soundId: number().int().optional(),
|
|
27147
|
-
/** Per-device feature flag — render this entry only when true. */
|
|
27148
|
-
enabled: boolean()
|
|
27149
|
-
});
|
|
27150
|
-
/** Coordinates for `goToPoint` — a point on the robot's live map. */
|
|
27151
|
-
var NavigationPointSchema = object({
|
|
27152
|
-
x: number(),
|
|
27153
|
-
y: number()
|
|
27154
|
-
});
|
|
27155
|
-
/**
|
|
27156
|
-
* Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
|
|
27157
|
-
* The cap reports which are enabled so the UI / PTZ render only the controls
|
|
27158
|
-
* that are turned on for THIS device. Data-driven: the provider derives these
|
|
27159
|
-
* from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
|
|
27160
|
-
* live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
|
|
27161
|
-
* that are not dictionary entries.
|
|
27162
|
-
*
|
|
27163
|
-
* - `move` / `stop` — the momentary drive joystick.
|
|
27164
|
-
* - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
|
|
27165
|
-
* map-coordinate plumbing is wired.
|
|
27166
|
-
* - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
|
|
27167
|
-
* - `playSound` — the sound buttons (dictionary `kind:'sound'`).
|
|
27168
|
-
* - `light` — the on/off fill-light toggle (works anytime).
|
|
27169
|
-
* - `lightMode` — the auto/manual selector + manual level slider (a
|
|
27170
|
-
* camera-service control; needs an active stream).
|
|
27171
|
-
*/
|
|
27172
|
-
var NavigationFeaturesSchema = object({
|
|
27173
|
-
move: boolean(),
|
|
27174
|
-
stop: boolean(),
|
|
27175
|
-
goToPoint: boolean(),
|
|
27176
|
-
runAction: boolean(),
|
|
27177
|
-
playSound: boolean(),
|
|
27178
|
-
light: boolean(),
|
|
27179
|
-
lightMode: boolean()
|
|
27180
|
-
});
|
|
27181
|
-
/** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
|
|
27182
|
-
var NavigationLightModeSchema = _enum(["auto", "manual"]);
|
|
27183
|
-
/**
|
|
27184
|
-
* Live navigation state so the UI can reflect what the robot is doing:
|
|
27185
|
-
* - `mode` — coarse activity (idle / cleaning / following / …).
|
|
27186
|
-
* - `following` — person/pet follow is currently armed.
|
|
27187
|
-
* - `flash` — the on-camera fill light is on.
|
|
27188
|
-
* - `lightMode` — auto vs manual fill-light mode.
|
|
27189
|
-
* - `lightLevel` — manual fill-light level (40..100); meaningful when
|
|
27190
|
-
* `lightMode === 'manual'`.
|
|
27191
|
-
*/
|
|
27192
|
-
var NavigationStatusSchema = object({
|
|
27193
|
-
mode: _enum([
|
|
27194
|
-
"idle",
|
|
27195
|
-
"cleaning",
|
|
27196
|
-
"spot",
|
|
27197
|
-
"following",
|
|
27198
|
-
"goto",
|
|
27199
|
-
"returning",
|
|
27200
|
-
"paused",
|
|
27201
|
-
"unknown"
|
|
27202
|
-
]),
|
|
27203
|
-
following: boolean(),
|
|
27204
|
-
flash: boolean(),
|
|
27205
|
-
lightMode: NavigationLightModeSchema,
|
|
27206
|
-
lightLevel: number().min(40).max(100),
|
|
27207
|
-
/** Ms epoch when the slice was last updated. */
|
|
27208
|
-
lastChangedAt: number()
|
|
27209
|
-
});
|
|
27210
|
-
NavigationStatusSchema.extend({ lastFetchedAt: number() });
|
|
27211
|
-
DeviceType.Camera, method(NavigationMoveCommandSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), _void(), { kind: "mutation" }), method(NavigationPointSchema.extend({ deviceId: number() }), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), array(NavigationActionEntrySchema)), method(object({
|
|
27212
|
-
deviceId: number(),
|
|
27213
|
-
actionId: NavigationActionIdSchema
|
|
27214
|
-
}), _void(), { kind: "mutation" }), method(object({
|
|
27215
|
-
deviceId: number(),
|
|
27216
|
-
soundId: number().int()
|
|
27217
|
-
}), _void(), { kind: "mutation" }), method(object({
|
|
27218
|
-
deviceId: number(),
|
|
27219
|
-
on: boolean()
|
|
27220
|
-
}), _void(), { kind: "mutation" }), method(object({
|
|
27221
|
-
deviceId: number(),
|
|
27222
|
-
mode: NavigationLightModeSchema,
|
|
27223
|
-
level: number().min(40).max(100).optional()
|
|
27224
|
-
}), _void(), { kind: "mutation" }), method(object({
|
|
27225
|
-
deviceId: number(),
|
|
27226
|
-
level: number().min(40).max(100)
|
|
27227
|
-
}), _void(), { kind: "mutation" }), method(object({ deviceId: number() }), NavigationFeaturesSchema), object({
|
|
27228
|
-
deviceId: number(),
|
|
27229
|
-
status: NavigationStatusSchema
|
|
27230
|
-
});
|
|
27231
27358
|
DeviceType.Camera, DeviceType.Sensor, DeviceType.Switch, method(object({ deviceId: number().int().nonnegative() }), object({ success: literal(true) }), {
|
|
27232
27359
|
kind: "mutation",
|
|
27233
27360
|
auth: "admin"
|
|
@@ -34536,13 +34663,13 @@ Object.freeze({
|
|
|
34536
34663
|
addonId: null,
|
|
34537
34664
|
access: "view"
|
|
34538
34665
|
},
|
|
34539
|
-
"storage.
|
|
34666
|
+
"storage.list": {
|
|
34540
34667
|
capName: "storage",
|
|
34541
34668
|
capScope: "system",
|
|
34542
34669
|
addonId: null,
|
|
34543
34670
|
access: "view"
|
|
34544
34671
|
},
|
|
34545
|
-
"storage.
|
|
34672
|
+
"storage.listDrainProgress": {
|
|
34546
34673
|
capName: "storage",
|
|
34547
34674
|
capScope: "system",
|
|
34548
34675
|
addonId: null,
|
|
@@ -34692,6 +34819,12 @@ Object.freeze({
|
|
|
34692
34819
|
addonId: null,
|
|
34693
34820
|
access: "view"
|
|
34694
34821
|
},
|
|
34822
|
+
"storageOccupancy.getOccupancy": {
|
|
34823
|
+
capName: "storage-occupancy",
|
|
34824
|
+
capScope: "system",
|
|
34825
|
+
addonId: null,
|
|
34826
|
+
access: "view"
|
|
34827
|
+
},
|
|
34695
34828
|
"storageProvider.abortUpload": {
|
|
34696
34829
|
capName: "storage-provider",
|
|
34697
34830
|
capScope: "system",
|