@camstack/types 1.2.153 → 1.2.154

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/addon.js CHANGED
@@ -1,6 +1,6 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
2
  const require_event_category = require("./event-category-b8kBSOTT.js");
3
- const require_sleep = require("./sleep-TVipGseU.js");
3
+ const require_sleep = require("./sleep-Dp0uukHR.js");
4
4
  const require_err_msg = require("./err-msg-COpsHMw2.js");
5
5
  //#region src/generated/cap-input-defaults.ts
6
6
  /**
package/dist/addon.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  import { t as EventCategory } from "./event-category-zAv7pMUz.mjs";
2
- import { D as adminUiCapability, E as DeviceType, G as scopeKey, H as ReadinessTimeoutError, M as expandCapMethods, R as nodePin, S as DEVICE_CHILDREN_BATCH_MAX, V as ReadinessRegistry, _t as DATAPLANE_SECRET_HEADER, a as asJsonObject, b as deviceOpsCapability, bt as BaseAddon, d as BOOT_RECOVERY_BACKOFF_MS, f as DEVICE_SCOPED_CAPS, h as createEventBusSliceSource, m as createDeviceProxy, p as isDeviceScopedCap, s as asString, t as sleep, u as parseJsonUnknown, wt as emitReadiness, x as viewerUiCapability, xt as normalizeAddonInitResult, yt as DisposerChain, z as readNodePin } from "./sleep-BRy4r7RG.mjs";
2
+ import { D as adminUiCapability, E as DeviceType, G as scopeKey, H as ReadinessTimeoutError, M as expandCapMethods, R as nodePin, S as DEVICE_CHILDREN_BATCH_MAX, V as ReadinessRegistry, _t as DATAPLANE_SECRET_HEADER, a as asJsonObject, b as deviceOpsCapability, bt as BaseAddon, d as BOOT_RECOVERY_BACKOFF_MS, f as DEVICE_SCOPED_CAPS, h as createEventBusSliceSource, m as createDeviceProxy, p as isDeviceScopedCap, s as asString, t as sleep, u as parseJsonUnknown, wt as emitReadiness, x as viewerUiCapability, xt as normalizeAddonInitResult, yt as DisposerChain, z as readNodePin } from "./sleep-CgijQHtG.mjs";
3
3
  import { t as errMsg } from "./err-msg-IQTHeDzc.mjs";
4
4
  //#region src/generated/cap-input-defaults.ts
5
5
  /**
@@ -185,6 +185,7 @@ export { type IPressureSensorProvider, type PressureSensorStatus, PressureSensor
185
185
  export { type IPrivacyMaskProvider, type PrivacyMaskOptions, PrivacyMaskOptionsSchema, type PrivacyMaskPatch, PrivacyMaskPatchSchema, type PrivacyMaskRegion, PrivacyMaskRegionSchema, type PrivacyMaskShape, PrivacyMaskShapeSchema, type PrivacyMaskStatus, PrivacyMaskStatusSchema, privacyMaskCapability, summarisePrivacyAudio, } from './privacy-mask.cap.js';
186
186
  export { type IPtzProvider, PtzMoveCommandSchema, type PtzOptions, PtzOptionsSchema, PtzPositionSchema, PtzPresetSchema, type PtzStatus, PtzStatusSchema, ptzCapability, } from './ptz.cap.js';
187
187
  export { type IPtzAutotrackProvider, type PtzAutotrackRuntimeState, PtzAutotrackRuntimeStateSchema, type PtzAutotrackSettings, PtzAutotrackSettingsSchema, type PtzAutotrackStatus, PtzAutotrackStatusSchema, type PtzAutotrackTargetOption, PtzAutotrackTargetOptionSchema, ptzAutotrackCapability, } from './ptz-autotrack.cap.js';
188
+ export { type INavigationProvider, NAVIGATION_ACTION_CATALOG, NAVIGATION_LIGHT_LEVEL_MAX, NAVIGATION_LIGHT_LEVEL_MIN, type NavigationActionEntry, NavigationActionEntrySchema, type NavigationActionId, NavigationActionIdSchema, navigationCapability, type NavigationEntryKind, NavigationEntryKindSchema, type NavigationFeatures, NavigationFeaturesSchema, type NavigationLightMode, NavigationLightModeSchema, type NavigationMode, NavigationModeSchema, type NavigationMoveCommand, NavigationMoveCommandSchema, type NavigationPoint, NavigationPointSchema, type NavigationRuntimeState, NavigationRuntimeStateSchema, type NavigationStatus, NavigationStatusSchema, } from './navigation.cap.js';
188
189
  export { type IRebootProvider, rebootCapability } from './reboot.cap.js';
189
190
  export { type IRecordingProvider, type LocateSegmentResult, LocateSegmentResultSchema, RECORDING_TIMELINE_BATCH_MAX, type ReadGopBytesResult, ReadGopBytesResultSchema, type ReadSegmentBytesResult, ReadSegmentBytesResultSchema, type ReadWindowBytesResult, ReadWindowBytesResultSchema, type RecordingAvailability, type RecordingAvailabilityForDevice, RecordingAvailabilityForDeviceSchema, RecordingAvailabilitySchema, type RecordingDays, type RecordingDaysForDevice, RecordingDaysForDeviceSchema, RecordingDaysSchema, type RecordingDeviceUsage, RecordingDeviceUsageSchema, type RecordingLocationUsage, RecordingLocationUsageSchema, type RecordingManifest, RecordingManifestSchema, RecordingRangeSchema, type RecordingRebalanceInput, RecordingRebalanceInputSchema, type RecordingRebalanceMove, RecordingRebalanceMoveSchema, type RecordingRebalancePlan, RecordingRebalancePlanSchema, type RecordingRebalanceSkip, type RecordingRebalanceSkipReason, RecordingRebalanceSkipReasonSchema, RecordingRebalanceSkipSchema, type RecordingStatus, RecordingStatusSchema, type RecordingStorageUsage, RecordingStorageUsageSchema, recordingCapability, } from './recording.cap.js';
190
191
  export { EXPORT_DENSE_MAX_RANGES, type ExportBytes, ExportBytesSchema, type ExportDense, type ExportDenseRange, ExportDenseRangeSchema, ExportDenseSchema, type ExportDownload, ExportDownloadSchema, type ExportOptions, ExportOptionsSchema, type ExportRecord, ExportRecordSchema, ExportSpeedSchema, type ExportState, ExportStateSchema, ExportTimelapseSchema, type IRecordingExportProvider, RECORDING_EXPORT_MAX_READ_BYTES, recordingExportCapability, } from './recording-export.cap.js';
@@ -301,6 +302,7 @@ import type { motionTriggerCapability } from './motion-trigger.cap.js';
301
302
  import type { motionZonesCapability } from './motion-zones.cap.js';
302
303
  import type { mqttBrokerCapability } from './mqtt-broker.cap.js';
303
304
  import type { nativeObjectDetectionCapability } from './native-object-detection.cap.js';
305
+ import type { navigationCapability } from './navigation.cap.js';
304
306
  import type { networkAccessCapability } from './network-access.cap.js';
305
307
  import type { networkQualityCapability } from './network-quality.cap.js';
306
308
  import type { nodesCapability } from './nodes.cap.js';
@@ -364,6 +366,6 @@ import type { webrtcSessionCapability } from './webrtc-session.cap.js';
364
366
  import type { zoneAnalyticsCapability } from './zone-analytics.cap.js';
365
367
  import type { zoneRulesCapability } from './zone-rules.cap.js';
366
368
  import type { zonesCapability } from './zones.cap.js';
367
- type AnyCapability = typeof addonSettingsCapability | typeof alertsCapability | typeof storageCapability | typeof storageMigrationCapability | typeof storageProviderCapability | typeof storageEvictableCapability | typeof filesystemBrowseCapability | typeof backupCapability | typeof terminalSessionCapability | typeof settingsStoreCapability | typeof dataStoreProviderCapability | typeof logChannelsCapability | typeof logDestinationCapability | typeof loadContributionCapability | typeof failureContributionCapability | typeof adminUiCapability | typeof viewerUiCapability | typeof ssoBridgeCapability | typeof userPasskeysCapability | typeof smtpProviderCapability | typeof mqttBrokerCapability | typeof brokerCapability | typeof deviceAdoptionCapability | typeof deviceExportCapability | typeof addonPagesCapability | typeof addonPagesSourceCapability | typeof addonWidgetsCapability | typeof addonWidgetsSourceCapability | typeof customModelRegistryCapability | typeof modelDistributorCapability | typeof modelConvertCapability | typeof addonRoutesCapability | typeof streamBrokerCapability | typeof decoderCapability | typeof webrtcSessionCapability | typeof cameraStreamsCapability | typeof motionDetectionCapability | typeof pipelineExecutorCapability | typeof detectionPipelineCapability | typeof cameraPipelineConfigCapability | typeof pipelineRunnerCapability | typeof pipelineOrchestratorCapability | typeof audioAnalyzerCapability | typeof audioAnalysisCapability | typeof audioCodecCapability | typeof embeddingEncoderCapability | typeof vectorStoreCapability | typeof deviceProviderCapability | typeof deviceManagerCapability | typeof deviceStateCapability | typeof authProviderCapability | typeof loginMethodCapability | typeof networkAccessCapability | typeof turnProviderCapability | typeof snapshotCapability | typeof llmCapability | typeof llmRuntimeCapability | typeof notificationOutputCapability | typeof coreBlocksCapability | typeof notificationRulesCapability | typeof pipelineAnalyticsCapability | typeof metricsProviderCapability | typeof ptzCapability | typeof ptzAutotrackCapability | typeof consumablesCapability | typeof connectionTestCapability | typeof rebootCapability | typeof deviceDiscoveryCapability | typeof brightnessCapability | typeof colorCapability | typeof climateControlCapability | typeof coverCapability | typeof valveCapability | typeof humidifierCapability | typeof waterHeaterCapability | typeof weatherCapability | typeof imageCapability | typeof lockControlCapability | typeof vacuumControlCapability | typeof petFeederCapability | typeof lawnMowerControlCapability | typeof fanControlCapability | typeof controlCapability | typeof notifierCapability | typeof mediaPlayerCapability | typeof alarmPanelCapability | typeof presenceCapability | typeof scriptRunnerCapability | typeof automationControlCapability | typeof motionTriggerCapability | typeof eventsCapability | typeof zonesCapability | typeof zoneRulesCapability | typeof zoneAnalyticsCapability | typeof audioMetricsCapability | typeof motionCapability | typeof contactCapability | typeof floodCapability | typeof smokeCapability | typeof carbonMonoxideCapability | typeof gasCapability | typeof tamperCapability | typeof vibrationCapability | typeof connectivityCapability | typeof binaryCapability | typeof temperatureSensorCapability | typeof humiditySensorCapability | typeof ambientLightSensorCapability | typeof pressureSensorCapability | typeof powerMeterCapability | typeof airQualitySensorCapability | typeof numericSensorCapability | typeof enumSensorCapability | typeof recordingCapability | typeof recordingExportCapability | typeof deviceOpsCapability | typeof platformProbeCapability | typeof localNetworkCapability | typeof meshNetworkCapability | typeof userManagementCapability | typeof systemCapability | typeof networkQualityCapability | typeof toastCapability | typeof nodesCapability | typeof serverManagementCapability | typeof integrationsCapability | typeof addonsCapability | typeof oauthIntegrationCapability | typeof streamParamsCapability | typeof streamCatalogCapability | typeof motionZonesCapability | typeof sceneMonitorCapability | typeof privacyMaskCapability | typeof dayNightCapability | typeof imageSettingsCapability | typeof osdCapability | typeof osdManagerCapability | typeof accessoriesCapability | typeof batteryCapability | typeof networkLinkCapability | typeof buttonCapability | typeof cameraCredentialsCapability | typeof deviceStatusCapability | typeof doorbellCapability | typeof eventEmitterCapability | typeof faceGalleryCapability | typeof featureProbeCapability | typeof intercomCapability | typeof nativeObjectDetectionCapability | typeof plateGalleryCapability | typeof switchCapability | typeof updateCapability | typeof videoclipsCapability;
369
+ type AnyCapability = typeof addonSettingsCapability | typeof alertsCapability | typeof storageCapability | typeof storageMigrationCapability | typeof storageProviderCapability | typeof storageEvictableCapability | typeof filesystemBrowseCapability | typeof backupCapability | typeof terminalSessionCapability | typeof settingsStoreCapability | typeof dataStoreProviderCapability | typeof logChannelsCapability | typeof logDestinationCapability | typeof loadContributionCapability | typeof failureContributionCapability | typeof adminUiCapability | typeof viewerUiCapability | typeof ssoBridgeCapability | typeof userPasskeysCapability | typeof smtpProviderCapability | typeof mqttBrokerCapability | typeof brokerCapability | typeof deviceAdoptionCapability | typeof deviceExportCapability | typeof addonPagesCapability | typeof addonPagesSourceCapability | typeof addonWidgetsCapability | typeof addonWidgetsSourceCapability | typeof customModelRegistryCapability | typeof modelDistributorCapability | typeof modelConvertCapability | typeof addonRoutesCapability | typeof streamBrokerCapability | typeof decoderCapability | typeof webrtcSessionCapability | typeof cameraStreamsCapability | typeof motionDetectionCapability | typeof pipelineExecutorCapability | typeof detectionPipelineCapability | typeof cameraPipelineConfigCapability | typeof pipelineRunnerCapability | typeof pipelineOrchestratorCapability | typeof audioAnalyzerCapability | typeof audioAnalysisCapability | typeof audioCodecCapability | typeof embeddingEncoderCapability | typeof vectorStoreCapability | typeof deviceProviderCapability | typeof deviceManagerCapability | typeof deviceStateCapability | typeof authProviderCapability | typeof loginMethodCapability | typeof networkAccessCapability | typeof turnProviderCapability | typeof snapshotCapability | typeof llmCapability | typeof llmRuntimeCapability | typeof notificationOutputCapability | typeof coreBlocksCapability | typeof notificationRulesCapability | typeof pipelineAnalyticsCapability | typeof metricsProviderCapability | typeof ptzCapability | typeof ptzAutotrackCapability | typeof navigationCapability | typeof consumablesCapability | typeof connectionTestCapability | typeof rebootCapability | typeof deviceDiscoveryCapability | typeof brightnessCapability | typeof colorCapability | typeof climateControlCapability | typeof coverCapability | typeof valveCapability | typeof humidifierCapability | typeof waterHeaterCapability | typeof weatherCapability | typeof imageCapability | typeof lockControlCapability | typeof vacuumControlCapability | typeof petFeederCapability | typeof lawnMowerControlCapability | typeof fanControlCapability | typeof controlCapability | typeof notifierCapability | typeof mediaPlayerCapability | typeof alarmPanelCapability | typeof presenceCapability | typeof scriptRunnerCapability | typeof automationControlCapability | typeof motionTriggerCapability | typeof eventsCapability | typeof zonesCapability | typeof zoneRulesCapability | typeof zoneAnalyticsCapability | typeof audioMetricsCapability | typeof motionCapability | typeof contactCapability | typeof floodCapability | typeof smokeCapability | typeof carbonMonoxideCapability | typeof gasCapability | typeof tamperCapability | typeof vibrationCapability | typeof connectivityCapability | typeof binaryCapability | typeof temperatureSensorCapability | typeof humiditySensorCapability | typeof ambientLightSensorCapability | typeof pressureSensorCapability | typeof powerMeterCapability | typeof airQualitySensorCapability | typeof numericSensorCapability | typeof enumSensorCapability | typeof recordingCapability | typeof recordingExportCapability | typeof deviceOpsCapability | typeof platformProbeCapability | typeof localNetworkCapability | typeof meshNetworkCapability | typeof userManagementCapability | typeof systemCapability | typeof networkQualityCapability | typeof toastCapability | typeof nodesCapability | typeof serverManagementCapability | typeof integrationsCapability | typeof addonsCapability | typeof oauthIntegrationCapability | typeof streamParamsCapability | typeof streamCatalogCapability | typeof motionZonesCapability | typeof sceneMonitorCapability | typeof privacyMaskCapability | typeof dayNightCapability | typeof imageSettingsCapability | typeof osdCapability | typeof osdManagerCapability | typeof accessoriesCapability | typeof batteryCapability | typeof networkLinkCapability | typeof buttonCapability | typeof cameraCredentialsCapability | typeof deviceStatusCapability | typeof doorbellCapability | typeof eventEmitterCapability | typeof faceGalleryCapability | typeof featureProbeCapability | typeof intercomCapability | typeof nativeObjectDetectionCapability | typeof plateGalleryCapability | typeof switchCapability | typeof updateCapability | typeof videoclipsCapability;
368
370
  export type CapabilityName = AnyCapability['name'];
369
371
  export type ITypedReadinessRegistry = IReadinessRegistry<CapabilityName>;
@@ -0,0 +1,463 @@
1
+ import { z } from 'zod';
2
+ import { type InferProvider } from './capability-definition.js';
3
+ import { DeviceType } from '../device/device-type.js';
4
+ /**
5
+ * `navigation` — a device-scoped capability that natively expresses the FULL
6
+ * navigation / action surface of a robot that DRIVES ITSELF and carries an
7
+ * on-board camera (the Dreame robot-vacuum camera is the first provider).
8
+ *
9
+ * Why a NEW cap rather than overloading `ptz`:
10
+ * - `ptz` moves a *gimbal* on a fixed camera (pan/tilt/zoom of the lens). A
11
+ * robot vacuum has no gimbal — the whole chassis drives, turns and spins.
12
+ * The two are different physical models: PTZ is absolute-position + presets,
13
+ * navigation is momentary drive nudges + discrete robot ACTIONS
14
+ * (dock / spot-clean / follow-pet / go-to-point / …).
15
+ * - This cap is the SOURCE OF TRUTH. Two consumers adapt from it rather than
16
+ * the reverse:
17
+ * 1. a native CamStack navigation panel (data-driven from `listActions`
18
+ * / `getOptions`), and
19
+ * 2. the PTZ surface — a thin adapter mimics `ptz` from `navigation` so a
20
+ * robot camera shows up in the existing PTZ control path without every
21
+ * PTZ provider learning about robots. The mapping lives in the adapter,
22
+ * not here (see the addon design note):
23
+ * ptz.continuousMove({pan,tilt}) → navigation.move({pan,tilt})
24
+ * ptz.stop() → navigation.stop()
25
+ * ptz.goHome() → navigation.runAction('goHome')
26
+ * ptz.getPresets() → navigation.listActions() (id→preset)
27
+ * ptz.goToPreset(id) → navigation.runAction(id)
28
+ *
29
+ * ## Continuous drive
30
+ *
31
+ * `move` is MOMENTARY. Fluid navigation comes from the UI (or the PTZ adapter)
32
+ * sending `move({pan,tilt})` REPEATEDLY at ~1 Hz while a direction is held, and
33
+ * one `stop()` on release — exactly like the robot app's remote-drive joystick.
34
+ * The provider forwards EACH `move` to one drive write; it must NOT debounce or
35
+ * coalesce them. The UI owns the cadence.
36
+ *
37
+ * ## The action dictionary
38
+ *
39
+ * The discrete controls (dock / locate / spot-clean / follow / flash / sounds)
40
+ * are a DATA-DRIVEN dictionary the cap exposes via `listActions()`. Each entry
41
+ * carries `{ id, kind, label, icon }` (plus `soundId` for sound entries) so the
42
+ * native panel AND the PTZ mimic render buttons WITHOUT hardcoding a
43
+ * vendor-specific list. `kind: 'action'` entries are triggered with
44
+ * `runAction({ actionId })`; `kind: 'sound'` entries with `playSound({ soundId })`
45
+ * (the entry carries the `soundId` to pass). The general primitives — `move`,
46
+ * `stop`, `goToPoint` — stay as first-class methods, not dictionary entries.
47
+ *
48
+ * NOTE (provider wiring): the first provider (Dreame) drives this with the RAW
49
+ * `callAction(siid,aiid,in)` / `setProperty({siid,piid,value})` MIoT primitives
50
+ * that the currently-published `@apocaliss92/nodedreame` already exposes on
51
+ * every device handle. A future nodedreame publish adds a typed
52
+ * `DreameCameraController` (drive / playPetSound / spotClean / findPet / …); the
53
+ * provider can then swap the raw calls for the typed methods with no change to
54
+ * THIS contract.
55
+ */
56
+ /**
57
+ * A momentary drive nudge. The robot MOVES (no gimbal) for as long as the caller
58
+ * keeps sending nudges (~1 Hz); an explicit `stop` (or letting the nudges lapse)
59
+ * halts it.
60
+ *
61
+ * - `pan` — turn: negative = left, positive = right, 0 = straight.
62
+ * - `tilt` — throttle: positive = forward, negative = spin / turn-around.
63
+ * - `speed` — optional intensity hint [0, 1]; the provider may scale the drive
64
+ * vector by it (drivers without proportional drive ignore it).
65
+ *
66
+ * `pan` / `tilt` are normalized [-1, 1]. Both optional so a caller can nudge one
67
+ * axis alone; an all-undefined nudge is a no-op.
68
+ */
69
+ export declare const NavigationMoveCommandSchema: z.ZodObject<{
70
+ pan: z.ZodOptional<z.ZodNumber>;
71
+ tilt: z.ZodOptional<z.ZodNumber>;
72
+ speed: z.ZodOptional<z.ZodNumber>;
73
+ }, z.core.$strip>;
74
+ export type NavigationMoveCommand = z.infer<typeof NavigationMoveCommandSchema>;
75
+ /**
76
+ * The enumerated discrete actions a navigation-capable robot can perform via
77
+ * `runAction`. This is the CLOSED vocabulary; a given device advertises the
78
+ * subset it supports through `listActions`. Sounds are NOT here — they go through
79
+ * `playSound` (see the `sound` dictionary entries).
80
+ */
81
+ export declare const NavigationActionIdSchema: z.ZodEnum<{
82
+ stop: "stop";
83
+ goHome: "goHome";
84
+ locate: "locate";
85
+ spotClean: "spotClean";
86
+ findPet: "findPet";
87
+ personFollow: "personFollow";
88
+ startClean: "startClean";
89
+ pauseClean: "pauseClean";
90
+ dockWash: "dockWash";
91
+ autoEmpty: "autoEmpty";
92
+ flashOn: "flashOn";
93
+ flashOff: "flashOff";
94
+ }>;
95
+ export type NavigationActionId = z.infer<typeof NavigationActionIdSchema>;
96
+ /** Whether a dictionary entry is a `runAction` action or a `playSound` sound. */
97
+ export declare const NavigationEntryKindSchema: z.ZodEnum<{
98
+ action: "action";
99
+ sound: "sound";
100
+ }>;
101
+ export type NavigationEntryKind = z.infer<typeof NavigationEntryKindSchema>;
102
+ /**
103
+ * One entry in the navigation action dictionary — the DATA-DRIVEN unit both the
104
+ * native panel and the PTZ mimic render as a button.
105
+ *
106
+ * - `id` — stable id. For `kind:'action'` it is a {@link NavigationActionId}
107
+ * (pass to `runAction`); for `kind:'sound'` it is a namespaced id
108
+ * (`sound:meow`) whose `soundId` is passed to `playSound`.
109
+ * - `icon` — icon HINT (lucide-style name; the UI maps it to its own set).
110
+ * - `label` — operator-facing English label.
111
+ * - `soundId` — wire sound id, present only on `kind:'sound'` entries.
112
+ * - `enabled` — per-device FEATURE FLAG. `listActions` reports it so the UI /
113
+ * PTZ render ONLY enabled entries. Data-driven: the provider
114
+ * flips it from config, never by editing code.
115
+ */
116
+ export declare const NavigationActionEntrySchema: z.ZodObject<{
117
+ id: z.ZodString;
118
+ kind: z.ZodEnum<{
119
+ action: "action";
120
+ sound: "sound";
121
+ }>;
122
+ label: z.ZodString;
123
+ icon: z.ZodString;
124
+ soundId: z.ZodOptional<z.ZodNumber>;
125
+ enabled: z.ZodBoolean;
126
+ }, z.core.$strip>;
127
+ export type NavigationActionEntry = z.infer<typeof NavigationActionEntrySchema>;
128
+ /**
129
+ * Canonical dictionary of every navigation control (discrete actions + sounds)
130
+ * with its default label + icon hint. A provider filters this to the subset a
131
+ * device supports (and may override a label). Exported so the provider AND the
132
+ * UI share ONE list instead of re-deriving labels / ids independently.
133
+ *
134
+ * Icons are lucide-style hints; the viewer maps them to its own icon set. Every
135
+ * catalog default is `enabled: true`; a provider overrides per-device from
136
+ * config (data-driven — enabling / disabling one later is a config change, not a
137
+ * code change).
138
+ */
139
+ export declare const NAVIGATION_ACTION_CATALOG: readonly NavigationActionEntry[];
140
+ /** Coordinates for `goToPoint` — a point on the robot's live map. */
141
+ export declare const NavigationPointSchema: z.ZodObject<{
142
+ x: z.ZodNumber;
143
+ y: z.ZodNumber;
144
+ }, z.core.$strip>;
145
+ export type NavigationPoint = z.infer<typeof NavigationPointSchema>;
146
+ /**
147
+ * Per-device FEATURE-FLAG report for the general (non-dictionary) primitives.
148
+ * The cap reports which are enabled so the UI / PTZ render only the controls
149
+ * that are turned on for THIS device. Data-driven: the provider derives these
150
+ * from config + probe, never hardcoded in the UI. The per-DICTIONARY-entry flags
151
+ * live on {@link NavigationActionEntrySchema.enabled}; these gate the primitives
152
+ * that are not dictionary entries.
153
+ *
154
+ * - `move` / `stop` — the momentary drive joystick.
155
+ * - `goToPoint` — send-to-map-coordinate. Ships OFF on Dreame until the
156
+ * map-coordinate plumbing is wired.
157
+ * - `runAction` — the discrete action buttons (dictionary `kind:'action'`).
158
+ * - `playSound` — the sound buttons (dictionary `kind:'sound'`).
159
+ * - `light` — the on/off fill-light toggle (works anytime).
160
+ * - `lightMode` — the auto/manual selector + manual level slider (a
161
+ * camera-service control; needs an active stream).
162
+ */
163
+ export declare const NavigationFeaturesSchema: z.ZodObject<{
164
+ move: z.ZodBoolean;
165
+ stop: z.ZodBoolean;
166
+ goToPoint: z.ZodBoolean;
167
+ runAction: z.ZodBoolean;
168
+ playSound: z.ZodBoolean;
169
+ light: z.ZodBoolean;
170
+ lightMode: z.ZodBoolean;
171
+ }, z.core.$strip>;
172
+ export type NavigationFeatures = z.infer<typeof NavigationFeaturesSchema>;
173
+ /** Light mode: `auto` lets the camera choose brightness; `manual` uses `level`. */
174
+ export declare const NavigationLightModeSchema: z.ZodEnum<{
175
+ auto: "auto";
176
+ manual: "manual";
177
+ }>;
178
+ export type NavigationLightMode = z.infer<typeof NavigationLightModeSchema>;
179
+ /** Manual fill-light level bounds (the camera-service accepts 40..100). */
180
+ export declare const NAVIGATION_LIGHT_LEVEL_MIN = 40;
181
+ export declare const NAVIGATION_LIGHT_LEVEL_MAX = 100;
182
+ /** Coarse work mode the robot reports — drives the UI's active-state chips. */
183
+ export declare const NavigationModeSchema: z.ZodEnum<{
184
+ unknown: "unknown";
185
+ idle: "idle";
186
+ paused: "paused";
187
+ cleaning: "cleaning";
188
+ spot: "spot";
189
+ following: "following";
190
+ goto: "goto";
191
+ returning: "returning";
192
+ }>;
193
+ export type NavigationMode = z.infer<typeof NavigationModeSchema>;
194
+ /**
195
+ * Live navigation state so the UI can reflect what the robot is doing:
196
+ * - `mode` — coarse activity (idle / cleaning / following / …).
197
+ * - `following` — person/pet follow is currently armed.
198
+ * - `flash` — the on-camera fill light is on.
199
+ * - `lightMode` — auto vs manual fill-light mode.
200
+ * - `lightLevel` — manual fill-light level (40..100); meaningful when
201
+ * `lightMode === 'manual'`.
202
+ */
203
+ export declare const NavigationStatusSchema: z.ZodObject<{
204
+ mode: z.ZodEnum<{
205
+ unknown: "unknown";
206
+ idle: "idle";
207
+ paused: "paused";
208
+ cleaning: "cleaning";
209
+ spot: "spot";
210
+ following: "following";
211
+ goto: "goto";
212
+ returning: "returning";
213
+ }>;
214
+ following: z.ZodBoolean;
215
+ flash: z.ZodBoolean;
216
+ lightMode: z.ZodEnum<{
217
+ auto: "auto";
218
+ manual: "manual";
219
+ }>;
220
+ lightLevel: z.ZodNumber;
221
+ lastChangedAt: z.ZodNumber;
222
+ }, z.core.$strip>;
223
+ export type NavigationStatus = z.infer<typeof NavigationStatusSchema>;
224
+ /**
225
+ * Runtime-state slice owned by this cap (kernel-managed: validated, mirrored,
226
+ * observable). Adds `lastFetchedAt` on top of the status shape per the
227
+ * convention.
228
+ */
229
+ export declare const NavigationRuntimeStateSchema: z.ZodObject<{
230
+ mode: z.ZodEnum<{
231
+ unknown: "unknown";
232
+ idle: "idle";
233
+ paused: "paused";
234
+ cleaning: "cleaning";
235
+ spot: "spot";
236
+ following: "following";
237
+ goto: "goto";
238
+ returning: "returning";
239
+ }>;
240
+ following: z.ZodBoolean;
241
+ flash: z.ZodBoolean;
242
+ lightMode: z.ZodEnum<{
243
+ auto: "auto";
244
+ manual: "manual";
245
+ }>;
246
+ lightLevel: z.ZodNumber;
247
+ lastChangedAt: z.ZodNumber;
248
+ lastFetchedAt: z.ZodNumber;
249
+ }, z.core.$strip>;
250
+ export type NavigationRuntimeState = z.infer<typeof NavigationRuntimeStateSchema>;
251
+ export declare const navigationCapability: {
252
+ readonly name: "navigation";
253
+ readonly scope: "device";
254
+ readonly deviceNative: true;
255
+ readonly mode: "singleton";
256
+ readonly deviceTypes: readonly [DeviceType.Camera];
257
+ readonly deviceConfig: {
258
+ readonly ui: {
259
+ readonly kind: "widget";
260
+ readonly widgetId: "host/navigation-panel";
261
+ readonly tab: "navigation";
262
+ readonly topTab: true;
263
+ readonly label: "Navigation";
264
+ readonly order: 0;
265
+ };
266
+ };
267
+ readonly methods: {
268
+ /**
269
+ * Momentary drive nudge (the robot moves). `protected` — mirrors
270
+ * `ptz.continuousMove` so the Viewer navigation panel (and the PTZ-mimic
271
+ * path) works for any authenticated user, not admin-only. The UI sends
272
+ * these at ~1 Hz while a control is held; the provider forwards each one to
273
+ * a single drive write WITHOUT debouncing.
274
+ */
275
+ readonly move: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
276
+ pan: z.ZodOptional<z.ZodNumber>;
277
+ tilt: z.ZodOptional<z.ZodNumber>;
278
+ speed: z.ZodOptional<z.ZodNumber>;
279
+ deviceId: z.ZodNumber;
280
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
281
+ /** Halt all motion immediately (zero drive vector). */
282
+ readonly stop: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
283
+ deviceId: z.ZodNumber;
284
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
285
+ /** Send the robot to a point on its live map. */
286
+ readonly goToPoint: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
287
+ x: z.ZodNumber;
288
+ y: z.ZodNumber;
289
+ deviceId: z.ZodNumber;
290
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
291
+ /**
292
+ * Enumerate the discrete controls THIS device supports (data-driven UI +
293
+ * PTZ mimic). Camera-probed subset of {@link NAVIGATION_ACTION_CATALOG}.
294
+ */
295
+ readonly listActions: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
296
+ deviceId: z.ZodNumber;
297
+ }, z.core.$strip>, z.ZodArray<z.ZodObject<{
298
+ id: z.ZodString;
299
+ kind: z.ZodEnum<{
300
+ action: "action";
301
+ sound: "sound";
302
+ }>;
303
+ label: z.ZodString;
304
+ icon: z.ZodString;
305
+ soundId: z.ZodOptional<z.ZodNumber>;
306
+ enabled: z.ZodBoolean;
307
+ }, z.core.$strip>>, import("./capability-definition.js").CapabilityMethodKind>;
308
+ /**
309
+ * Run one discrete action (a `kind:'action'` dictionary entry). Invalid /
310
+ * unsupported action ids are rejected by the provider.
311
+ */
312
+ readonly runAction: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
313
+ deviceId: z.ZodNumber;
314
+ actionId: z.ZodEnum<{
315
+ stop: "stop";
316
+ goHome: "goHome";
317
+ locate: "locate";
318
+ spotClean: "spotClean";
319
+ findPet: "findPet";
320
+ personFollow: "personFollow";
321
+ startClean: "startClean";
322
+ pauseClean: "pauseClean";
323
+ dockWash: "dockWash";
324
+ autoEmpty: "autoEmpty";
325
+ flashOn: "flashOn";
326
+ flashOff: "flashOff";
327
+ }>;
328
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
329
+ /** Play a sound by its wire id (the `soundId` of a `kind:'sound'` entry). */
330
+ readonly playSound: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
331
+ deviceId: z.ZodNumber;
332
+ soundId: z.ZodNumber;
333
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
334
+ /**
335
+ * Turn the on-camera fill light on / off (the `OpenFullLight` control —
336
+ * works anytime, no active stream required).
337
+ */
338
+ readonly setLightOn: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
339
+ deviceId: z.ZodNumber;
340
+ on: z.ZodBoolean;
341
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
342
+ /**
343
+ * Set the fill-light mode (auto vs manual). `manual` optionally carries the
344
+ * initial `level`. The auto/manual + level control is a CAMERA-service
345
+ * action that generally needs an active camera stream/monitor session — the
346
+ * UI shows the manual level slider ONLY when `mode === 'manual'`.
347
+ */
348
+ readonly setLightMode: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
349
+ deviceId: z.ZodNumber;
350
+ mode: z.ZodEnum<{
351
+ auto: "auto";
352
+ manual: "manual";
353
+ }>;
354
+ level: z.ZodOptional<z.ZodNumber>;
355
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
356
+ /** Set the MANUAL fill-light level (40..100). Implies `manual` mode. */
357
+ readonly setLightLevel: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
358
+ deviceId: z.ZodNumber;
359
+ level: z.ZodNumber;
360
+ }, z.core.$strip>, z.ZodVoid, "mutation">;
361
+ /**
362
+ * Per-device FEATURE-FLAG report for the general primitives — drives which
363
+ * controls the UI shows (the per-entry flags for the dictionary come back on
364
+ * `listActions`).
365
+ */
366
+ readonly getFeatures: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
367
+ deviceId: z.ZodNumber;
368
+ }, z.core.$strip>, z.ZodObject<{
369
+ move: z.ZodBoolean;
370
+ stop: z.ZodBoolean;
371
+ goToPoint: z.ZodBoolean;
372
+ runAction: z.ZodBoolean;
373
+ playSound: z.ZodBoolean;
374
+ light: z.ZodBoolean;
375
+ lightMode: z.ZodBoolean;
376
+ }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
377
+ };
378
+ readonly events: {
379
+ readonly onStatusChanged: {
380
+ readonly data: z.ZodObject<{
381
+ deviceId: z.ZodNumber;
382
+ status: z.ZodObject<{
383
+ mode: z.ZodEnum<{
384
+ unknown: "unknown";
385
+ idle: "idle";
386
+ paused: "paused";
387
+ cleaning: "cleaning";
388
+ spot: "spot";
389
+ following: "following";
390
+ goto: "goto";
391
+ returning: "returning";
392
+ }>;
393
+ following: z.ZodBoolean;
394
+ flash: z.ZodBoolean;
395
+ lightMode: z.ZodEnum<{
396
+ auto: "auto";
397
+ manual: "manual";
398
+ }>;
399
+ lightLevel: z.ZodNumber;
400
+ lastChangedAt: z.ZodNumber;
401
+ }, z.core.$strip>;
402
+ }, z.core.$strip>;
403
+ };
404
+ };
405
+ readonly status: {
406
+ readonly schema: z.ZodObject<{
407
+ mode: z.ZodEnum<{
408
+ unknown: "unknown";
409
+ idle: "idle";
410
+ paused: "paused";
411
+ cleaning: "cleaning";
412
+ spot: "spot";
413
+ following: "following";
414
+ goto: "goto";
415
+ returning: "returning";
416
+ }>;
417
+ following: z.ZodBoolean;
418
+ flash: z.ZodBoolean;
419
+ lightMode: z.ZodEnum<{
420
+ auto: "auto";
421
+ manual: "manual";
422
+ }>;
423
+ lightLevel: z.ZodNumber;
424
+ lastChangedAt: z.ZodNumber;
425
+ }, z.core.$strip>;
426
+ readonly kind: "push";
427
+ };
428
+ /**
429
+ * Runtime-state slice mirrored by the kernel. The navigation panel watches it
430
+ * for live mode / follow / flash changes.
431
+ */
432
+ readonly runtimeState: z.ZodObject<{
433
+ mode: z.ZodEnum<{
434
+ unknown: "unknown";
435
+ idle: "idle";
436
+ paused: "paused";
437
+ cleaning: "cleaning";
438
+ spot: "spot";
439
+ following: "following";
440
+ goto: "goto";
441
+ returning: "returning";
442
+ }>;
443
+ following: z.ZodBoolean;
444
+ flash: z.ZodBoolean;
445
+ lightMode: z.ZodEnum<{
446
+ auto: "auto";
447
+ manual: "manual";
448
+ }>;
449
+ lightLevel: z.ZodNumber;
450
+ lastChangedAt: z.ZodNumber;
451
+ lastFetchedAt: z.ZodNumber;
452
+ }, z.core.$strip>;
453
+ /**
454
+ * Runtime-state durability: **session** — like `vacuum-control`, a restored
455
+ * `mode: cleaning` / `following: true` is a robot that is not actually doing
456
+ * that. The live handle re-publishes on connect.
457
+ *
458
+ * See `RuntimeStateDurability`. Enforced by
459
+ * `scripts/check-runtime-state-durability.ts`.
460
+ */
461
+ readonly durability: "session";
462
+ };
463
+ export type INavigationProvider = InferProvider<typeof navigationCapability>;
@@ -71,6 +71,7 @@ import type { motionZonesCapability } from '../capabilities/motion-zones.cap.js'
71
71
  import type { motionCapability } from '../capabilities/motion.cap.js';
72
72
  import type { mqttBrokerCapability } from '../capabilities/mqtt-broker.cap.js';
73
73
  import type { nativeObjectDetectionCapability } from '../capabilities/native-object-detection.cap.js';
74
+ import type { navigationCapability } from '../capabilities/navigation.cap.js';
74
75
  import type { networkAccessCapability } from '../capabilities/network-access.cap.js';
75
76
  import type { networkQualityCapability } from '../capabilities/network-quality.cap.js';
76
77
  import type { nodesCapability } from '../capabilities/nodes.cap.js';
@@ -4318,6 +4319,90 @@ export type AppRouter = TrpcCoreRouter<{
4318
4319
  meta: object;
4319
4320
  }>;
4320
4321
  }>>;
4322
+ navigation: TRPCBuiltRouter<{
4323
+ ctx: TrpcContext;
4324
+ meta: object;
4325
+ errorShape: AugmentedErrorShape;
4326
+ transformer: true;
4327
+ }, TRPCDecorateCreateRouterOptions<{
4328
+ getStatus: TRPCQueryProcedure<{
4329
+ input: {
4330
+ [x: string]: unknown;
4331
+ } & z.input<typeof DEVICE_STATUS_METHOD.getStatus.input>;
4332
+ output: z.infer<typeof DEVICE_STATUS_METHOD.getStatus.output>;
4333
+ meta: object;
4334
+ }>;
4335
+ move: TRPCMutationProcedure<{
4336
+ input: {
4337
+ [x: string]: unknown;
4338
+ } & z.input<typeof navigationCapability.methods.move.input>;
4339
+ output: z.infer<typeof navigationCapability.methods.move.output>;
4340
+ meta: object;
4341
+ }>;
4342
+ stop: TRPCMutationProcedure<{
4343
+ input: {
4344
+ [x: string]: unknown;
4345
+ } & z.input<typeof navigationCapability.methods.stop.input>;
4346
+ output: z.infer<typeof navigationCapability.methods.stop.output>;
4347
+ meta: object;
4348
+ }>;
4349
+ goToPoint: TRPCMutationProcedure<{
4350
+ input: {
4351
+ [x: string]: unknown;
4352
+ } & z.input<typeof navigationCapability.methods.goToPoint.input>;
4353
+ output: z.infer<typeof navigationCapability.methods.goToPoint.output>;
4354
+ meta: object;
4355
+ }>;
4356
+ listActions: TRPCQueryProcedure<{
4357
+ input: {
4358
+ [x: string]: unknown;
4359
+ } & z.input<typeof navigationCapability.methods.listActions.input>;
4360
+ output: z.infer<typeof navigationCapability.methods.listActions.output>;
4361
+ meta: object;
4362
+ }>;
4363
+ runAction: TRPCMutationProcedure<{
4364
+ input: {
4365
+ [x: string]: unknown;
4366
+ } & z.input<typeof navigationCapability.methods.runAction.input>;
4367
+ output: z.infer<typeof navigationCapability.methods.runAction.output>;
4368
+ meta: object;
4369
+ }>;
4370
+ playSound: TRPCMutationProcedure<{
4371
+ input: {
4372
+ [x: string]: unknown;
4373
+ } & z.input<typeof navigationCapability.methods.playSound.input>;
4374
+ output: z.infer<typeof navigationCapability.methods.playSound.output>;
4375
+ meta: object;
4376
+ }>;
4377
+ setLightOn: TRPCMutationProcedure<{
4378
+ input: {
4379
+ [x: string]: unknown;
4380
+ } & z.input<typeof navigationCapability.methods.setLightOn.input>;
4381
+ output: z.infer<typeof navigationCapability.methods.setLightOn.output>;
4382
+ meta: object;
4383
+ }>;
4384
+ setLightMode: TRPCMutationProcedure<{
4385
+ input: {
4386
+ [x: string]: unknown;
4387
+ } & z.input<typeof navigationCapability.methods.setLightMode.input>;
4388
+ output: z.infer<typeof navigationCapability.methods.setLightMode.output>;
4389
+ meta: object;
4390
+ }>;
4391
+ setLightLevel: TRPCMutationProcedure<{
4392
+ input: {
4393
+ [x: string]: unknown;
4394
+ } & z.input<typeof navigationCapability.methods.setLightLevel.input>;
4395
+ output: z.infer<typeof navigationCapability.methods.setLightLevel.output>;
4396
+ meta: object;
4397
+ }>;
4398
+ getFeatures: TRPCQueryProcedure<{
4399
+ input: {
4400
+ [x: string]: unknown;
4401
+ } & z.input<typeof navigationCapability.methods.getFeatures.input>;
4402
+ output: z.infer<typeof navigationCapability.methods.getFeatures.output>;
4403
+ meta: object;
4404
+ }>;
4405
+ }>>;
4321
4406
  networkAccess: TRPCBuiltRouter<{
4322
4407
  ctx: TrpcContext;
4323
4408
  meta: object;
@@ -42,6 +42,7 @@ import type { MotionTriggerStatusSchema } from '../capabilities/motion-trigger.c
42
42
  import type { motionZonesCapability } from '../capabilities/motion-zones.cap.js';
43
43
  import type { MqttBrokerStatusSchema } from '../capabilities/mqtt-broker.cap.js';
44
44
  import type { NativeObjectDetectionStatusSchema } from '../capabilities/native-object-detection.cap.js';
45
+ import type { NavigationStatusSchema } from '../capabilities/navigation.cap.js';
45
46
  import type { NetworkLinkStatusSchema } from '../capabilities/network-link.cap.js';
46
47
  import type { NotifierStatusSchema } from '../capabilities/notifier.cap.js';
47
48
  import type { NumericSensorStatusSchema } from '../capabilities/numeric-sensor.cap.js';
@@ -117,6 +118,7 @@ export type CapStatusTypeMap = {
117
118
  readonly 'motion-zones': z.infer<(typeof motionZonesCapability)['status']['schema']>;
118
119
  readonly 'mqtt-broker': z.infer<typeof MqttBrokerStatusSchema>;
119
120
  readonly 'native-object-detection': z.infer<typeof NativeObjectDetectionStatusSchema>;
121
+ readonly 'navigation': z.infer<typeof NavigationStatusSchema>;
120
122
  readonly 'network-link': z.infer<typeof NetworkLinkStatusSchema>;
121
123
  readonly 'notifier': z.infer<typeof NotifierStatusSchema>;
122
124
  readonly 'numeric-sensor': z.infer<typeof NumericSensorStatusSchema>;
@@ -151,4 +153,4 @@ export type CapNameWithStatus = keyof CapStatusTypeMap;
151
153
  * aggregator to enumerate caps whose `status` should be polled +
152
154
  * streamed via `subscribeDeviceStatusAggregate`.
153
155
  */
154
- export declare const CAP_NAMES_WITH_STATUS: readonly ["accessories", "air-quality-sensor", "alarm-panel", "ambient-light-sensor", "automation-control", "battery", "binary", "brightness", "broker", "camera-credentials", "carbon-monoxide", "climate-control", "color", "connectivity", "consumables", "contact", "control", "cover", "day-night", "device-adoption", "device-discovery", "device-export", "device-status", "doorbell", "enum-sensor", "event-emitter", "fan-control", "feature-probe", "flood", "gas", "humidifier", "humidity-sensor", "image", "image-settings", "intercom", "lawn-mower-control", "lock-control", "media-player", "motion", "motion-trigger", "motion-zones", "mqtt-broker", "native-object-detection", "network-link", "notifier", "numeric-sensor", "osd", "pet-feeder", "power-meter", "presence", "pressure-sensor", "privacy-mask", "ptz", "ptz-autotrack", "recording", "scene-monitor", "script-runner", "smoke", "snapshot", "stream-params", "switch", "tamper", "temperature-sensor", "update", "vacuum-control", "valve", "vibration", "water-heater", "weather"];
156
+ export declare const CAP_NAMES_WITH_STATUS: readonly ["accessories", "air-quality-sensor", "alarm-panel", "ambient-light-sensor", "automation-control", "battery", "binary", "brightness", "broker", "camera-credentials", "carbon-monoxide", "climate-control", "color", "connectivity", "consumables", "contact", "control", "cover", "day-night", "device-adoption", "device-discovery", "device-export", "device-status", "doorbell", "enum-sensor", "event-emitter", "fan-control", "feature-probe", "flood", "gas", "humidifier", "humidity-sensor", "image", "image-settings", "intercom", "lawn-mower-control", "lock-control", "media-player", "motion", "motion-trigger", "motion-zones", "mqtt-broker", "native-object-detection", "navigation", "network-link", "notifier", "numeric-sensor", "osd", "pet-feeder", "power-meter", "presence", "pressure-sensor", "privacy-mask", "ptz", "ptz-autotrack", "recording", "scene-monitor", "script-runner", "smoke", "snapshot", "stream-params", "switch", "tamper", "temperature-sensor", "update", "vacuum-control", "valve", "vibration", "water-heater", "weather"];