@camstack/addon-provider-hikvision 1.2.119 → 1.2.121

package/dist/addon.js

@@ -5367,7 +5367,7 @@ var ZodIssueCode = {
 var ZodFirstPartyTypeKind;
 ZodFirstPartyTypeKind || (ZodFirstPartyTypeKind = {});
 //#endregion
-//#region ../types/dist/sleep-B1y0Fo1U.mjs
+//#region ../types/dist/sleep-Dk-BdnBf.mjs
 /**
 * The audio chunk plane's byte format, and the ONE expansion from a coded
 * window to float samples (D455).
@@ -31534,6 +31534,26 @@ var PtzHomePresetSchema = object({
 		"none"
 	])
 });
+/**
+* The camera's own idle-return behaviour: whether it goes home by itself, and
+* after how long.
+*
+* ONE shape, not two scalars, because on the camera they are ONE fact —
+* Reolink's guard point carries `benable` and `timeout` in the same element,
+* written by the same command. Reading them apart means two round-trips that
+* can disagree.
+*
+* `enabled` and `seconds` are INDEPENDENT: a camera can hold a 68 s delay with
+* the behaviour switched off, which is exactly what the vendor app leaves when
+* you turn the guard point off without clearing it. The first version of this
+* cap reported only the delay, so that state was invisible — a camera could be
+* configured to return after 68 seconds with no way to say whether it should
+* return at all.
+*/
+var PtzHomeReturnSchema = object({
+	enabled: boolean(),
+	seconds: number().int()
+});
 var ptzCapability = {
 	name: "ptz",
 	scope: "device",
@@ -31593,6 +31613,54 @@ var ptzCapability = {
 			auth: "admin"
 		}),
 		/**
+		* Make WHERE THE HEAD IS POINTING RIGHT NOW this camera's home.
+		*
+		* `setHomePreset` takes a preset id, and a preset id is the wrong shape for
+		* the most natural thing an operator does: aim the camera, then say "here".
+		* It is also the only shape a camera whose home is NOT a preset can accept
+		* -- Reolink's home is a guard point, a stored position with no id at all,
+		* and hiding the control for that case (as the UI briefly did) left the one
+		* vendor with a native home unable to set it.
+		*
+		* Each provider does it its own way:
+		*   reolink   `setGrd` with `needSetPos`, pinning the guard point here
+		*   hikvision / amcrest  save a preset, then pin it as home
+		*   onvif     REFUSES -- its home is the PTZ origin and cannot be moved
+		*
+		* A provider that cannot honour it throws rather than silently doing
+		* nothing: an operator who pressed "set home here" and saw no error would
+		* believe it took.
+		*/
+		captureHomeHere: method(object({ deviceId: number() }), _void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/**
+		* Whether the camera returns home on its own when left idle, and after how
+		* long. `null` when it has no such behaviour at all.
+		*
+		* Reolink's guard point carries one (`timeout`, freely settable in
+		* seconds). It is a real function of the camera that we did not expose at
+		* all, and it belongs next to the home it governs rather than in a vendor
+		* settings page nobody associates with Home.
+		*/
+		getHomeReturn: method(object({ deviceId: number() }), PtzHomeReturnSchema.nullable()),
+		/**
+		* Set both together. Refused by a camera with no idle-return behaviour.
+		*
+		* They travel together for the same reason they are read together: the
+		* underlying write carries both, so setting one alone means reading the
+		* other back first and racing whoever else is writing.
+		*/
+		setHomeReturn: method(object({
+			deviceId: number(),
+			enabled: boolean(),
+			seconds: number().int().min(0).max(3600)
+		}), _void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/**
 		* Pull the current PTZ position. Redundant with the auto-injected
 		* `getStatus` method (see `status` below); kept for callers that
 		* haven't migrated. Will be folded into `getStatus` in a future
@@ -41305,6 +41373,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"ptz.captureHomeHere": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "create"
+	},
 	"ptz.continuousMove": {
 		capName: "ptz",
 		capScope: "device",
@@ -41323,6 +41397,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"ptz.getHomeReturn": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "view"
+	},
 	"ptz.getOptions": {
 		capName: "ptz",
 		capScope: "device",
@@ -41377,6 +41457,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"ptz.setHomeReturn": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "create"
+	},
 	"ptz.stop": {
 		capName: "ptz",
 		capScope: "device",
@@ -44540,6 +44626,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.captureHomeHere": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.continuousMove": [{
 		name: "deviceId",
 		form: "single",
@@ -44555,6 +44646,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.getHomeReturn": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.getOptions": [{
 		name: "deviceId",
 		form: "single",
@@ -44600,6 +44696,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.setHomeReturn": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.stop": [{
 		name: "deviceId",
 		form: "single",
@@ -49975,6 +50076,43 @@ function assertPresetWritable(presetId, action) {
 	throw new Error(`Preset ${presetId} is a firmware function on this camera (${fn}) and cannot be ${action}` + (action === "overwritten" ? " — pick an unreserved id" : ""));
 }
 //#endregion
+//#region src/free-preset-slot.ts
+/**
+* The lowest preset id this camera will actually accept a write on.
+*
+* "Set home here" has to land somewhere, and on a camera whose home IS a preset
+* that means claiming a slot. Two things make the choice non-obvious:
+*
+*  - the reserved FUNCTION band shares the preset namespace (34 "Back to
+*    origin", 94 "Remote reboot", 95 "Call OSD menu" and friends), and writing
+*    one answers HTTP 500;
+*  - the operator's own presets must not be overwritten, ever. Losing
+*    "Credenza" to make room for a home is a worse trade than refusing.
+*
+* So: the first id that is neither taken nor reserved, within the camera's
+* advertised budget. `null` when there is no room, and the caller must then
+* REFUSE rather than pick a victim.
+*/
+function findFreePresetSlot(taken, maxPresets) {
+	const used = new Set(taken.map((p) => p.id));
+	const ceiling = maxPresets === void 0 ? 32 : Math.min(maxPresets, 300);
+	for (let id = 1; id <= ceiling; id += 1) {
+		const candidate = String(id);
+		if (used.has(candidate)) continue;
+		if (!isPresetWritable(candidate)) continue;
+		return candidate;
+	}
+	return null;
+}
+/**
+* The name written on a preset claimed by "set home here".
+*
+* Named rather than left a literal so the slot is recognisable in the camera's
+* own web UI — an operator who finds an unexplained preset has no way to know
+* it is ours.
+*/
+var HOME_PRESET_NAME = "CamStack Home";
+//#endregion
 //#region src/schema.ts
 /**
 * Single source of truth for the addon id used in event-source tags +
@@ -51750,6 +51888,27 @@ var HikvisionCamera = class HikvisionCamera extends BaseDevice {
 				};
 				return this.resolveHomePreset();
 			},
+			captureHomeHere: async ({ deviceId }) => {
+				if (deviceId !== this.id) return;
+				const [presets, caps] = await Promise.all([isapi.listPtzPresets(cameraNumber), isapi.getPtzCapabilities(cameraNumber)]);
+				const slot = findFreePresetSlot(presets.map((p) => ({
+					id: p.id,
+					writable: isPresetWritable(p.id)
+				})), caps?.maxPresetCount ?? void 0);
+				if (slot === null) throw new Error("No free preset slot on this camera to store a home position — free one first");
+				await isapi.savePtzPreset(cameraNumber, slot, HOME_PRESET_NAME);
+				await this.config.setAll({ homePresetId: slot });
+				this.ctx.logger.info("hikvision: home pinned to the current position", {
+					tags: { deviceId: this.id },
+					meta: { presetId: slot }
+				});
+			},
+			getHomeReturn: async () => {
+				return null;
+			},
+			setHomeReturn: async () => {
+				throw new Error("Hikvision: the idle-return timer is not wired on this driver");
+			},
 			setHomePreset: async ({ deviceId, presetId }) => {
 				if (deviceId !== this.id) return;
 				await this.config.setAll({ homePresetId: presetId ?? "" });

package/dist/addon.mjs

@@ -5368,7 +5368,7 @@ var ZodIssueCode = {
 var ZodFirstPartyTypeKind;
 ZodFirstPartyTypeKind || (ZodFirstPartyTypeKind = {});
 //#endregion
-//#region ../types/dist/sleep-B1y0Fo1U.mjs
+//#region ../types/dist/sleep-Dk-BdnBf.mjs
 /**
 * The audio chunk plane's byte format, and the ONE expansion from a coded
 * window to float samples (D455).
@@ -31535,6 +31535,26 @@ var PtzHomePresetSchema = object({
 		"none"
 	])
 });
+/**
+* The camera's own idle-return behaviour: whether it goes home by itself, and
+* after how long.
+*
+* ONE shape, not two scalars, because on the camera they are ONE fact —
+* Reolink's guard point carries `benable` and `timeout` in the same element,
+* written by the same command. Reading them apart means two round-trips that
+* can disagree.
+*
+* `enabled` and `seconds` are INDEPENDENT: a camera can hold a 68 s delay with
+* the behaviour switched off, which is exactly what the vendor app leaves when
+* you turn the guard point off without clearing it. The first version of this
+* cap reported only the delay, so that state was invisible — a camera could be
+* configured to return after 68 seconds with no way to say whether it should
+* return at all.
+*/
+var PtzHomeReturnSchema = object({
+	enabled: boolean(),
+	seconds: number().int()
+});
 var ptzCapability = {
 	name: "ptz",
 	scope: "device",
@@ -31594,6 +31614,54 @@ var ptzCapability = {
 			auth: "admin"
 		}),
 		/**
+		* Make WHERE THE HEAD IS POINTING RIGHT NOW this camera's home.
+		*
+		* `setHomePreset` takes a preset id, and a preset id is the wrong shape for
+		* the most natural thing an operator does: aim the camera, then say "here".
+		* It is also the only shape a camera whose home is NOT a preset can accept
+		* -- Reolink's home is a guard point, a stored position with no id at all,
+		* and hiding the control for that case (as the UI briefly did) left the one
+		* vendor with a native home unable to set it.
+		*
+		* Each provider does it its own way:
+		*   reolink   `setGrd` with `needSetPos`, pinning the guard point here
+		*   hikvision / amcrest  save a preset, then pin it as home
+		*   onvif     REFUSES -- its home is the PTZ origin and cannot be moved
+		*
+		* A provider that cannot honour it throws rather than silently doing
+		* nothing: an operator who pressed "set home here" and saw no error would
+		* believe it took.
+		*/
+		captureHomeHere: method(object({ deviceId: number() }), _void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/**
+		* Whether the camera returns home on its own when left idle, and after how
+		* long. `null` when it has no such behaviour at all.
+		*
+		* Reolink's guard point carries one (`timeout`, freely settable in
+		* seconds). It is a real function of the camera that we did not expose at
+		* all, and it belongs next to the home it governs rather than in a vendor
+		* settings page nobody associates with Home.
+		*/
+		getHomeReturn: method(object({ deviceId: number() }), PtzHomeReturnSchema.nullable()),
+		/**
+		* Set both together. Refused by a camera with no idle-return behaviour.
+		*
+		* They travel together for the same reason they are read together: the
+		* underlying write carries both, so setting one alone means reading the
+		* other back first and racing whoever else is writing.
+		*/
+		setHomeReturn: method(object({
+			deviceId: number(),
+			enabled: boolean(),
+			seconds: number().int().min(0).max(3600)
+		}), _void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/**
 		* Pull the current PTZ position. Redundant with the auto-injected
 		* `getStatus` method (see `status` below); kept for callers that
 		* haven't migrated. Will be folded into `getStatus` in a future
@@ -41306,6 +41374,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"ptz.captureHomeHere": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "create"
+	},
 	"ptz.continuousMove": {
 		capName: "ptz",
 		capScope: "device",
@@ -41324,6 +41398,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"ptz.getHomeReturn": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "view"
+	},
 	"ptz.getOptions": {
 		capName: "ptz",
 		capScope: "device",
@@ -41378,6 +41458,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"ptz.setHomeReturn": {
+		capName: "ptz",
+		capScope: "device",
+		addonId: null,
+		access: "create"
+	},
 	"ptz.stop": {
 		capName: "ptz",
 		capScope: "device",
@@ -44541,6 +44627,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.captureHomeHere": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.continuousMove": [{
 		name: "deviceId",
 		form: "single",
@@ -44556,6 +44647,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.getHomeReturn": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.getOptions": [{
 		name: "deviceId",
 		form: "single",
@@ -44601,6 +44697,11 @@ Object.freeze({
 		form: "single",
 		optional: false
 	}],
+	"ptz.setHomeReturn": [{
+		name: "deviceId",
+		form: "single",
+		optional: false
+	}],
 	"ptz.stop": [{
 		name: "deviceId",
 		form: "single",
@@ -49976,6 +50077,43 @@ function assertPresetWritable(presetId, action) {
 	throw new Error(`Preset ${presetId} is a firmware function on this camera (${fn}) and cannot be ${action}` + (action === "overwritten" ? " — pick an unreserved id" : ""));
 }
 //#endregion
+//#region src/free-preset-slot.ts
+/**
+* The lowest preset id this camera will actually accept a write on.
+*
+* "Set home here" has to land somewhere, and on a camera whose home IS a preset
+* that means claiming a slot. Two things make the choice non-obvious:
+*
+*  - the reserved FUNCTION band shares the preset namespace (34 "Back to
+*    origin", 94 "Remote reboot", 95 "Call OSD menu" and friends), and writing
+*    one answers HTTP 500;
+*  - the operator's own presets must not be overwritten, ever. Losing
+*    "Credenza" to make room for a home is a worse trade than refusing.
+*
+* So: the first id that is neither taken nor reserved, within the camera's
+* advertised budget. `null` when there is no room, and the caller must then
+* REFUSE rather than pick a victim.
+*/
+function findFreePresetSlot(taken, maxPresets) {
+	const used = new Set(taken.map((p) => p.id));
+	const ceiling = maxPresets === void 0 ? 32 : Math.min(maxPresets, 300);
+	for (let id = 1; id <= ceiling; id += 1) {
+		const candidate = String(id);
+		if (used.has(candidate)) continue;
+		if (!isPresetWritable(candidate)) continue;
+		return candidate;
+	}
+	return null;
+}
+/**
+* The name written on a preset claimed by "set home here".
+*
+* Named rather than left a literal so the slot is recognisable in the camera's
+* own web UI — an operator who finds an unexplained preset has no way to know
+* it is ours.
+*/
+var HOME_PRESET_NAME = "CamStack Home";
+//#endregion
 //#region src/schema.ts
 /**
 * Single source of truth for the addon id used in event-source tags +
@@ -51751,6 +51889,27 @@ var HikvisionCamera = class HikvisionCamera extends BaseDevice {
 				};
 				return this.resolveHomePreset();
 			},
+			captureHomeHere: async ({ deviceId }) => {
+				if (deviceId !== this.id) return;
+				const [presets, caps] = await Promise.all([isapi.listPtzPresets(cameraNumber), isapi.getPtzCapabilities(cameraNumber)]);
+				const slot = findFreePresetSlot(presets.map((p) => ({
+					id: p.id,
+					writable: isPresetWritable(p.id)
+				})), caps?.maxPresetCount ?? void 0);
+				if (slot === null) throw new Error("No free preset slot on this camera to store a home position — free one first");
+				await isapi.savePtzPreset(cameraNumber, slot, HOME_PRESET_NAME);
+				await this.config.setAll({ homePresetId: slot });
+				this.ctx.logger.info("hikvision: home pinned to the current position", {
+					tags: { deviceId: this.id },
+					meta: { presetId: slot }
+				});
+			},
+			getHomeReturn: async () => {
+				return null;
+			},
+			setHomeReturn: async () => {
+				throw new Error("Hikvision: the idle-return timer is not wired on this driver");
+			},
 			setHomePreset: async ({ deviceId, presetId }) => {
 				if (deviceId !== this.id) return;
 				await this.config.setAll({ homePresetId: presetId ?? "" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/addon-provider-hikvision",
-  "version": "1.2.119",
+  "version": "1.2.121",
   "description": "Hikvision camera device provider addon for CamStack — ISAPI over HTTP(S) with digest auth (snapshot, alarm stream, RTSP discovery)",
   "keywords": [
     "camstack",