@apocaliss92/scrypted-reolink-native 0.1.11 → 0.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@apocaliss92/scrypted-reolink-native",
-   "version": "0.1.11",
+   "version": "0.1.13",
    "description": "Use any reolink camera with Scrypted, even older/unsupported models without HTTP protocol support",
    "author": "@apocaliss92",
    "license": "Apache",

package/src/camera-battery.ts

@@ -180,6 +180,26 @@ export class ReolinkNativeBatteryCamera extends CommonCameraMixin {
         }
     }
 
+    async checkRecordingAction(newBatteryLevel: number) {
+        const nvrDeviceId = this.plugin.nvrDeviceId;
+        if (nvrDeviceId && this.mixins.includes(nvrDeviceId)) {
+            const logger = this.getBaichuanLogger();
+
+            const settings = await this.thisDevice.getSettings();
+            const isRecording = !settings.find(setting => setting.key === 'recording:privacyMode')?.value;
+            const { lowThresholdBatteryRecording, highThresholdBatteryRecording } = this.storageSettings.values;
+
+            if (isRecording && newBatteryLevel < lowThresholdBatteryRecording) {
+                logger.log(`Recording is enabled, but battery level is below low threshold (${newBatteryLevel}% < ${lowThresholdBatteryRecording}%), disabling recording`);
+                await this.thisDevice.putSetting('recording:privacyMode', true);
+            } else if (!isRecording && newBatteryLevel > highThresholdBatteryRecording) {
+                logger.log(`Recording is disabled, but battery level is above high threshold (${newBatteryLevel}% > ${highThresholdBatteryRecording}%), enabling recording`);
+                await this.thisDevice.putSetting('recording:privacyMode', false);
+            }
+
+        }
+    }
+
     async updateBatteryInfo() {
         const api = await this.ensureClient();
         const channel = this.storageSettings.values.rtspChannel;
@@ -194,6 +214,8 @@ export class ReolinkNativeBatteryCamera extends CommonCameraMixin {
             this.batteryLevel = batteryInfo.batteryPercent;
             this.lastBatteryLevel = batteryInfo.batteryPercent;
 
+            let shouldCheckRecordingAction = true;
+
             // Log only if battery level changed
             if (oldLevel !== undefined && oldLevel !== batteryInfo.batteryPercent) {
                 if (batteryInfo.chargeStatus !== undefined) {
@@ -211,6 +233,12 @@ export class ReolinkNativeBatteryCamera extends CommonCameraMixin {
                 } else {
                     this.getBaichuanLogger().log(`Battery level set: ${batteryInfo.batteryPercent}%`);
                 }
+            } else {
+                shouldCheckRecordingAction = false;
+            }
+
+            if (shouldCheckRecordingAction) {
+                await this.checkRecordingAction(batteryInfo.batteryPercent);
             }
         }
     }

package/src/camera.ts

@@ -1,4 +1,4 @@
-import type { DebugOptions, ReolinkBaichuanApi } from "@apocaliss92/reolink-baichuan-js" with { "resolution-mode": "import" };
+import type { ReolinkBaichuanApi } from "@apocaliss92/reolink-baichuan-js" with { "resolution-mode": "import" };
 import sdk, { MediaObject, ObjectsDetected, RequestPictureOptions, ResponsePictureOptions, ScryptedInterface, Setting } from "@scrypted/sdk";
 import { UrlMediaStreamOptions } from "../../scrypted/plugins/rtsp/src/rtsp";
 import {
@@ -6,10 +6,6 @@ import {
 } from "./common";
 import { createBaichuanApi } from './connect';
 import ReolinkNativePlugin from "./main";
-import {
-    buildVideoStreamOptionsFromRtspRtmp,
-    fetchVideoStreamOptionsFromApi
-} from './stream-utils';
 
 export const moToB64 = async (mo: MediaObject) => {
     const bufferImage = await sdk.mediaManager.convertMediaObjectToBuffer(mo, 'image/jpeg');

package/src/common.ts

@@ -1,16 +1,16 @@
-import type { DeviceCapabilities, PtzCommand, PtzPreset, ReolinkBaichuanApi, ReolinkSimpleEvent } from "@apocaliss92/reolink-baichuan-js" with { "resolution-mode": "import" };
+import type { DeviceCapabilities, PtzCommand, PtzPreset, ReolinkBaichuanApi, ReolinkSimpleEvent, StreamSamplingSelection } from "@apocaliss92/reolink-baichuan-js" with { "resolution-mode": "import" };
 import sdk, { BinarySensor, Brightness, Camera, Device, DeviceProvider, Intercom, MediaObject, MediaStreamUrl, ObjectDetectionTypes, ObjectDetector, ObjectsDetected, OnOff, PanTiltZoom, PanTiltZoomCommand, RequestMediaStreamOptions, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, ScryptedMimeTypes, Setting, Settings, SettingValue, VideoCamera, VideoTextOverlay, VideoTextOverlays } from "@scrypted/sdk";
 import { StorageSettings } from "@scrypted/sdk/storage-settings";
 import type { UrlMediaStreamOptions } from "../../scrypted/plugins/rtsp/src/rtsp";
-import { BaseBaichuanClass, type BaichuanConnectionConfig, type BaichuanConnectionCallbacks } from "./baichuan-base";
-import { createBaichuanApi, normalizeUid, type BaichuanTransport } from "./connect";
+import { BaseBaichuanClass, type BaichuanConnectionCallbacks, type BaichuanConnectionConfig } from "./baichuan-base";
+import { normalizeUid, type BaichuanTransport } from "./connect";
 import { convertDebugLogsToApiOptions, DebugLogDisplayNames, DebugLogOption, getApiRelevantDebugLogs, getDebugLogChoices } from "./debug-options";
 import { ReolinkBaichuanIntercom } from "./intercom";
 import ReolinkNativePlugin from "./main";
 import { ReolinkNativeNvrDevice } from "./nvr";
 import { ReolinkPtzPresets } from "./presets";
 import {
-    buildVideoStreamOptionsFromRtspRtmp,
+    buildVideoStreamOptions,
     createRfc4571MediaObjectFromStreamManager,
     expectedVideoTypeFromUrlMediaStreamOptions,
     isNativeStreamId,
@@ -19,6 +19,7 @@ import {
     StreamManager
 } from "./stream-utils";
 import { getDeviceInterfaces, updateDeviceInfo } from "./utils";
+import path from 'path';
 
 export type CameraType = 'battery' | 'regular';
 
@@ -238,22 +239,6 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             type: 'boolean',
             hide: true,
         },
-        // snapshotCacheMinutes: {
-        //     title: "Snapshot Cache Minutes",
-        //     subgroup: 'Advanced',
-        //     description: "Return a cached snapshot if taken within the last N minutes.",
-        //     type: "number",
-        //     defaultValue: 60,
-        //     hide: true,
-        // },
-        batteryUpdateIntervalMinutes: {
-            title: "Battery Update Interval (minutes)",
-            subgroup: 'Advanced',
-            description: "How often to wake up the camera and update battery status and snapshot (default: 60 minutes).",
-            type: "number",
-            defaultValue: 60,
-            hide: true,
-        },
         // Regular camera specific
         dispatchEvents: {
             subgroup: 'Advanced',
@@ -330,7 +315,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
         },
         // PTZ Presets
         presets: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'Presets to enable',
             description: 'PTZ Presets in the format "id=name". Where id is the PTZ Preset identifier and name is a friendly name.',
             multiple: true,
@@ -358,11 +343,11 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             description: 'How long a PTZ command moves before sending stop. Higher = more movement per click.',
             type: 'number',
             defaultValue: 300,
-            group: 'PTZ',
+            subgroup: 'PTZ',
             hide: true,
         },
         ptzZoomStep: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'PTZ Zoom Step',
             description: 'How much to change zoom per zoom command (in zoom factor units, where 1.0 is normal).',
             type: 'number',
@@ -370,7 +355,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             hide: true,
         },
         ptzCreatePreset: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'Create Preset',
             description: 'Enter a name and press Save to create a new PTZ preset at the current position.',
             type: 'string',
@@ -407,7 +392,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             },
         },
         ptzSelectedPreset: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'Selected Preset',
             description: 'Select the preset to update or delete. Format: "id=name".',
             type: 'string',
@@ -416,7 +401,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             hide: true,
         },
         ptzUpdateSelectedPreset: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'Update Selected Preset Position',
             description: 'Overwrite the selected preset with the current PTZ position.',
             type: 'button',
@@ -439,7 +424,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
             },
         },
         ptzDeleteSelectedPreset: {
-            group: 'PTZ',
+            subgroup: 'PTZ',
             title: 'Delete Selected Preset',
             description: 'Delete the selected preset (firmware dependent).',
             type: 'button',
@@ -463,6 +448,47 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
                 logger.log(`PTZ presets: delete ok (presetId=${presetId})`);
             },
         },
+        batteryUpdateIntervalMinutes: {
+            title: "Battery Update Interval (minutes)",
+            subgroup: 'Advanced',
+            description: "How often to wake up the camera and update battery status and snapshot (default: 60 minutes).",
+            type: "number",
+            defaultValue: 60,
+            hide: true,
+        },
+        lowThresholdBatteryRecording: {
+            title: "Low Threshold Battery Recording (%)",
+            subgroup: 'Recording',
+            description: "Battery level threshold below which recording is disabled (default: 15%).",
+            type: "number",
+            defaultValue: 15,
+            hide: true,
+        },
+        highThresholdBatteryRecording: {
+            title: "High Threshold Battery Recording (%)",
+            subgroup: 'Recording',
+            description: "Battery level threshold above which recording is enabled (default: 35%).",
+            type: "number",
+            defaultValue: 35,
+            hide: true,
+        },
+        diagnosticsOutputPath: {
+            title: "Diagnostics Output Path",
+            subgroup: 'Diagnostics',
+            description: "Directory where diagnostics files will be saved (default: plugin volume).",
+            type: "string",
+            defaultValue: path.join(process.env.SCRYPTED_PLUGIN_VOLUME, 'diagnostics', this.name),
+        },
+        diagnosticsRun: {
+            subgroup: 'Diagnostics',
+            title: 'Run Diagnostics',
+            description: 'Run all diagnostics and save results to the output path.',
+            type: 'button',
+            immediate: true,
+            onPut: async () => {
+                await this.runDiagnostics();
+            },
+        },
     });
 
     ptzPresets = new ReolinkPtzPresets(this);
@@ -497,15 +523,16 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
     initComplete?: boolean;
     resetBaichuanClient?(reason?: any): Promise<void>;
 
-    protected nvrDevice?: any; // Optional reference to NVR device
+    protected nvrDevice?: ReolinkNativeNvrDevice;
+    thisDevice: Settings
 
     constructor(nativeId: string, public plugin: ReolinkNativePlugin, public options: CommonCameraMixinOptions) {
         super(nativeId);
-        // Set protocol based on camera type
         this.protocol = !options.nvrDevice && options.type === 'battery' ? 'udp' : 'tcp';
 
         // Store NVR device reference if provided
         this.nvrDevice = options.nvrDevice;
+        this.thisDevice = sdk.systemManager.getDeviceById<Settings>(this.id);
 
         setTimeout(async () => {
             await this.parentInit();
@@ -554,6 +581,42 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
         return this.name || 'Camera';
     }
 
+    private async runDiagnostics(): Promise<void> {
+        const logger = this.getBaichuanLogger();
+        const outputPath = this.storageSettings.values.diagnosticsOutputPath || process.env.SCRYPTED_PLUGIN_VOLUME || "";
+
+        if (!outputPath) {
+            throw new Error('Diagnostics output path is required');
+        }
+
+        const channel = this.storageSettings.values.rtspChannel || 0;
+        const durationSeconds = 15;
+        const selection: StreamSamplingSelection = {
+            kinds: ['native'],
+            profiles: ['main', 'ext', 'sub'],
+        };
+
+        logger.log(`Starting diagnostics with parameters: outDir=${outputPath}, channel=${channel}, durationSeconds=${durationSeconds}, selection=${JSON.stringify(selection)}`);
+
+        try {
+            const api = await this.ensureClient();
+
+            const result = await api.runAllDiagnosticsConsecutively({
+                outDir: outputPath,
+                channel,
+                durationSeconds,
+                selection,
+            });
+
+            logger.log(`Diagnostics completed successfully. Output directory: ${result.runDir}`);
+            logger.log(`Diagnostics file: ${result.diagnosticsPath}`);
+            logger.log(`Streams directory: ${result.streamsDir}`);
+        } catch (e) {
+            logger.error('Failed to run diagnostics', e);
+            throw e;
+        }
+    }
+
     protected async onBeforeCleanup(): Promise<void> {
         // Unsubscribe from events if needed
         if (this.onSimpleEvent && this.baichuanApi) {
@@ -1261,7 +1324,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
 
         const client = await this.ensureClient();
 
-        const { ipAddress, rtspChannel, isFromNvr } = this.storageSettings.values;
+        const { ipAddress, rtspChannel } = this.storageSettings.values;
 
         try {
             await this.ensureNetPortCache();
@@ -1272,7 +1335,7 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
         }
 
         try {
-            streams = await buildVideoStreamOptionsFromRtspRtmp(
+            streams = await buildVideoStreamOptions(
                 {
                     client,
                     ipAddress,
@@ -1501,6 +1564,8 @@ export abstract class CommonCameraMixin extends BaseBaichuanClass implements Vid
         // this.storageSettings.settings.snapshotCacheMinutes.hide = !isBattery;
         this.storageSettings.settings.uid.hide = !isBattery;
         this.storageSettings.settings.batteryUpdateIntervalMinutes.hide = !isBattery;
+        this.storageSettings.settings.lowThresholdBatteryRecording.hide = !isBattery;
+        this.storageSettings.settings.highThresholdBatteryRecording.hide = !isBattery;
 
         if (isBattery && !this.storageSettings.values.mixinsSetup) {
             try {

package/src/main.ts

@@ -7,6 +7,14 @@ import { getDeviceInterfaces } from "./utils";
 
 class ReolinkNativePlugin extends ScryptedDeviceBase implements DeviceProvider, DeviceCreator {
     devices = new Map<string, ReolinkNativeCamera | ReolinkNativeBatteryCamera | ReolinkNativeNvrDevice>();
+    nvrDeviceId: string;
+
+    constructor(nativeId: string) {
+        super(nativeId);
+
+        const nvrDevice = sdk.systemManager.getDeviceByName('Scrypted NVR');
+        this.nvrDeviceId = nvrDevice?.id;
+    }
 
     getScryptedDeviceCreator(): string {
         return 'Reolink Native camera';

package/src/stream-utils.ts

@@ -1,7 +1,7 @@
 import type {
     ReolinkBaichuanApi,
-    StreamProfile,
     ScryptedRfc4571TcpServer,
+    StreamProfile,
     VideoType,
 } from "@apocaliss92/reolink-baichuan-js" with { "resolution-mode": "import" };
 
@@ -97,7 +97,7 @@ export async function fetchVideoStreamOptionsFromApi(
     return streams;
 }
 
-export async function buildVideoStreamOptionsFromRtspRtmp(
+export async function buildVideoStreamOptions(
     props: {
         client: ReolinkBaichuanApi,
         ipAddress: string,