統合 - 統合

APIの翻訳

APIの例とドキュメントはhttps://ispysoftware.github.io/Agent_API/に移動しました。

コマンド

Agent DVRのコマンドにアクセスするには、Agent UIの左上にあるサーバーアイコンをクリックし、Systemの下にある「Commands」を選択します。ショートカットキーは「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'

これらのコマンドは、/command.cgi?cmd=...の形式でAPI呼び出しに追加されます。したがって、APIで利用可能な任意のコマンドを使用できます。

上記の例のコマンドは、「external」とラベル付けされたすべてのデバイスをアクティブにし、「internal」とラベル付けされたすべてのデバイスを非アクティブにし、「external」とラベル付けされたデバイスで録画を開始し、すべての接続されているクライアントにブロードキャストメッセージを送信します。

例と利用可能なコマンドのリストについては、readmeコマンドボタンを参照してください。

コマンド内のパラメータを区切るために?の代わりに&を使用することを忘れないでください。

UIをリロードし、「C」を押すと、新しいコマンドがリストに表示されるはずです。クリックして実行します。

バージョン3.8.1.0以降では、コマンドで場所の名前を使用できます(例:switchon&location=home)。まずデバイスに場所を割り当ててください!

Amazon Alexa アマゾン アレクサ

バージョン2.9.5.0以降、Agent DVRではAmazon Alexaの統合が提供されています。この機能により、Alexa対応デバイスを通じて音声コマンドでAgent DVRを制御することができます。システムの武装・解除やAlexa Showデバイスでのライブ映像の表示が可能です。

設定するには、Agent DVRのサーバーメニューのIntegrationsで「Alexa」を選択します。これにより、アカウントのリンクのためにAmazonにリダイレクトされます。

リンクが完了したら、Alexaのディスカバリープロセスを実行します。セキュリティパネルとカメラコントロールの2つのデバイスが見つかるはずです。

これで、以下のような音声コマンドを使用できます:

  • "Alexa、ホームモードでAgentを武装"
  • "Alexa、Agentのカメラを表示"

認証が必要な操作には、Agentの設定でセキュリティコードを設定してください。デフォルトのコードは1234です。

Agent DVRと一致するAlexaプロファイル(ホーム/外出/夜間)を設定します。これらはサーバーのプロファイルで構成します。

複数のサーバーの場合は、設定でサーバー名を設定し、音声コマンドで使用します。

ホームアシスタント

Agent DVRはHome Assistantと完全に統合されており、Agent DVRをHome Assistantのセットアップに追加することができます。Agent DVRパネルをLovelace UIに埋め込むか、個々のカメラを選択することもできます。また、メインセキュリティパネルの制御も含まれています。詳細については、サーバーの「Integrations」の下にあるHome Assistantのリンクを参照してください。

IFTTT(If This Then That)

IFTTTはIoTデバイスとアクションやトリガーを設定することができます。最初に、IFTTTアカウントをiSpyConnect.comにリンクさせてください。リンクはサーバー - 統合の下でアクセスできます。

プッシュアラート

モバイルプッシュ通知の設定方法は、プッシュ通知の設定方法に詳細に記載されています。

テレグラム

Telegram Bot Example

TelegramチャットボットとAgent DVRを接続して、制御やライブアラート通知を行います。デバイスの設定でプッシュ通知を有効にして、ライブアラートを受け取るようにしてください。リモートWebインターフェースのサーバーアイコンの下にあるTelegramボタンを選択して開始します。

Pythonラッパー

基本的なUI機能のためのPythonラッパーはagent-py で利用できます。

URLパラメータ

エージェントを特定のビューで開くことができます。エージェント DVR の URL を呼び出すときは、次のようにします(大文字と小文字を区別します):

  • ?start=Live&viewIndex=3(ビュー 3 でライブビューを開始)
  • ?start=TimeMachine(タイムマシンビューを開始)
  • ?start=TimeLine(タイムラインビューを開始)
  • ?start=Photos(写真ビューを開始)
  • ?start=Recordings(録画ビューを開始)
  • ?start=Floorplans&planIndex=2(プラン 2 上のフロアプランビューを開始)
  • ?start=VR(仮想現実を開始)

特定の言語でエージェント DVR を開くこともできます(言語の選択をバイパスします)。2 文字の言語コードを渡してください:?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
ドキュメント
フィルターが適用されました