集成 - 集成

API (应用程序接口)

API示例和文档已经迁移到https://ispysoftware.github.io/Agent_API/

命令

要访问Agent DVR中的命令,请点击Agent UI左上角的服务器图标,然后在系统下选择"命令"。快捷方式是按下"C"键。


Agent DVR包含多个预设命令,可以同时控制多个设备。这些命令利用API执行各种任务。您可以灵活地添加自定义命令,用于调用API或在计算机上运行软件。

调用脚本文件

要执行通用脚本文件,只需将.bat文件(或Linux/OSX上的.sh文件)添加到命令目录中。脚本的文件名(不包括扩展名)将显示在命令列表中,可以点击运行。注意:可能需要重新加载UI才能显示。

调用API

在Agent安装目录的Commands文件夹中创建一个新的.bat文件。第一行应为:
REM ispy-internal
此行表示该文件应由Agent内部处理,而不是作为独立应用程序执行。

后续行将被解释为Agent的API命令。例如:

REM ispy-internal
switchon&group=external
switchoff&group=internal
record&group=external
broadcast 'external cameras are on and recording'

这些命令将附加到API调用的格式/command.cgi?cmd=...中。因此,您可以使用API中提供的任何命令。

上述示例命令将激活所有标记为"external"的设备,停用所有"internal"设备,开始在"external"设备上录制,并向所有连接的客户端发送广播消息。

请参考readme命令按钮中的示例以及API文档中提供的命令列表。

请记住,在命令中使用&而不是?来分隔参数。

重新加载UI并按下"C"键后,您的新命令应该在列表中可见。点击它来执行。

从版本3.8.1.0+开始,您可以在命令中使用位置名称(例如,switchon&location=home)。只需首先为您的设备分配一个位置!

Amazon Alexa

从版本2.9.5.0开始,Agent DVR 提供了亚马逊 Alexa 集成功能。该功能允许您通过 Alexa 启用设备使用语音命令来控制 Agent DVR。您可以通过 Alexa Show 设备来布防或撤防系统,或者显示实时视频。

要设置,请在 Agent DVR 的服务器菜单下选择“集成”中的“Alexa”。这将重定向您到亚马逊以链接您的账户。

链接完成后,运行 Alexa 的发现过程。它应该会找到两个设备:安全面板和摄像头控制。

现在您可以使用以下语音命令:

  • "Alexa,布防家庭模式的 Agent"
  • "Alexa,显示 Agent 摄像头"

在 Agent 设置中设置您的安全码以进行需要身份验证的操作。默认码为 1234。

亚马逊 Alexa 的配置文件(家庭/外出/夜间)与 Agent DVR 中的配置文件相匹配。请在服务器 - 配置文件中进行配置。

对于多个服务器,请在设置中设置服务器名称,并在语音命令中使用它。

家庭助手

Agent DVR与Home Assistant完全集成,允许您将Agent DVR添加到Home Assistant设置中。将Agent DVR面板嵌入到lovelace UI中,或选择单个摄像头。它还包括主安全面板的控制。有关更多信息,请参阅服务器 - 集成下的Home Assistant链接。

IFTTT(如果这样,那么那样)

IFTTT允许您使用物联网设备设置动作和触发器。首先,将您的IFTTT账户与iSpyConnect.com链接,可在服务器-集成下访问。

推送警报

设置移动推送警报的详细步骤请参考设置推送警报

Telegram 电报

Telegram Bot Example

将Agent DVR与Telegram聊天机器人连接,以进行控制和实时警报通知。在设备设置中启用推送通知以获取实时警报。首先,在远程Web界面下的服务器图标下选择Telegram按钮。

Python包装器

这里有一个用于基本UI功能的Python封装器:agent-py

URL参数

您可以通过调用Agent DVR的URL以打开特定视图(区分大小写):

  • ?start=Live&viewIndex=3(在第3个视图上进行实时查看)
  • ?start=TimeMachine(时光机视图)
  • ?start=TimeLine(时间轴视图)
  • ?start=Photos(照片视图)
  • ?start=Recordings(录像视图)
  • ?start=Floorplans&planIndex=2(在第2个平面图上进行楼层图视图)
  • ?start=VR(虚拟现实)

您可以通过传入两个字母的语言代码来打开Agent DVR(绕过语言选择)。例如:?lang=fr

您可以通过使用过滤器参数传入保存的过滤器名称来应用过滤器。例如:?start=Recordings&filter=intruder。您还可以通过JavaScript刻度传入过滤器的起始时间和结束时间。例如:?start=timeline&from=1657841514949&to=1657852514949。

设置默认主题选项(主题选项可在账户菜单中的主题设置中找到):

  • ?theme=darkly&variant=dark&large=false
  • ?theme=sketchy&variant=primary&large=true

在加载时自动播放音频(可能还需要更改浏览器设置):

  • ?playaudio=true

以最小化模式启动(隐藏顶部和底部UI栏):

  • ?mini=true

传入本地用户名和密码以进行自动登录(注意 - 这将向网络公开您的凭据):

  • ?un=username&pwd=password
文档
已应用过滤器