Securex Nvr 插件开发文档

{
  "id": "tynvr_module_example",
  "name": "Example Plugin",
  "version": "1.0.0",
  "description": "Example Securex Nvr plugin",
  "enabled": true,
  "kind": "tynvr_core_module",
  "module_id": "example",
  "order": 50,
  "config_apply": "hot",
  "first_install_restart": true,
  "navigation_user_toggle": true,
  "navigation_default_visible": true,
  "actions": [
    {"id": "reload", "label": "Reload"}
  ],
  "navigation": {
    "key": "example",
    "mount": "settings.sidebar.plugins",
    "label": "Example Plugin",
    "url": "/api/example/?embed=1",
    "view": "iframe",
    "order": 50,
    "icon": "puzzle"
  }
}

from pathlib import Path
from typing import Any
from fastapi import APIRouter, Depends
from frigate.api.auth import require_role
from frigate.plugins.base import FrigatePlugin

class Plugin(FrigatePlugin):
    def __init__(self, frigate_config: Any, plugin_dir: Path, stop_event=None):
        super().__init__(frigate_config, plugin_dir, stop_event)
        self._router = APIRouter(tags=["example"])
        self._build_routes()

    @property
    def router(self):
        return self._router

    def _build_routes(self):
        @self._router.get(
            "/api/example/status",
            dependencies=[Depends(require_role(["admin"]))],
        )
        def status():
            return {"ok": True}

    def get_public_config(self):
        return {"enabled": True}

    def update_config(self, payload):
        return {"success": True}

    def run_action(self, action, payload):
        return {"success": action == "reload"}

    def stop(self):
        pass