目次  MOBOTIXオンラインヘルプ

HTTP API

HTTP API(Application Programming Interface) はカメラとのソフトウェア・インターフェースで中央の管理システムへのカメラの組み込みを容易にするものです。インターフェースは2つのCGIスクリプトで構成されており、パラメータと値をともなうHTTPコマンドです。その記述内容によって、 Setup のサブメニュー設定内容の変更や、カメラ動作の実行が可能です。

セットアップメニューの設定変更

HTTPコマンド http://192.168.11.104/control/controlを使用して、 設定メニューの設定変更が可能です。

vPTZ 機能の利用

Qカメラモデルの統合で、これより HTTP APIでも vPTZ機能 (バーチャル・パン/チルト/ズーム) を提供します。機能に関しては、特定のヘルプページに記述があり、以下のリンクを使用して開くことができます:

  • click.cgi:インターフェースは vPTZ機能に制限されたアクセスを提供します。

  • rotorcgi:インターフェースは vPTZ機能にフルアクセスを提供します。

  • control?list&section=vptzcontrolcontrol では、 vptzcontrol セクションの記述通り、いくつかの vPTZ機能へのアクセスを提供しますsection.

カメラ機能の実行

HTTPコマンド http://192.168.11.104/control/rcontrolを使用してカメラの機能を実行する事ができます。

注意

コンフィグレーションの セーブおよびリストア に関する動作は admin アクセスレベルのユーザによってのみ実行可能です。この場合、 rcontrol スクリプトの呼び出しに、別のHTTPコマンドが必要になります。それは:

http://192.168.11.104/admin/rcontrol

コマンド規定

命令とコマンド

Control コマンドで list 命令を使用する場合、 ?を使ってコマンドから命令を区別する必要があります:

http://192.168.11.104/control/control?list

命令とコマンド、およびパラメータ/値ペア

パラメータを付けて命令を実行するには、命令とパラメータを区別するためにアンパーサンド記号 &で区切ってください。パラメータの値は = マークで区別されます。

http://192.168.11.104/control/control?list&section=actions

命令とコマンド、および複数のパラメータ/値ペア

複数のパラメータを使用する場合は、各パラメータをアンパーサンド記号 &で区切ります:

http://192.168.11.104/control/rcontrol?action=ledson&time=5

ひとつのパラメータに複数の値

いくつかのパラメータについては両方のレンズを指定するために2個の値を入力してください。これらのパラメータは 2つ のデフォルト値 (例: 0 0)を持って表示されます。httpコマンドでは、これらの値は + マークを使用して区別する必要があります:

http://192.168.11.104/control/control?set&section=general&sharpen=0+0

コマンドの新しい文字

コマンドに 1つ以上の改行文字を使用する場合 (例:複数のビデオモーションウィンドウを定義する場合など)、改行文字は CGI 置換文字列 %0Aを使用して置き換える必要があります。

http://192.168.11.104/control/control?set&section=general&coverimage_area=0,540,380,200,200,2%0A1,320,100,100,150,2

コマンドの特殊文字

CGI フォーマットの文字列を表示するには (改行文字、空欄、ウムラウト...など)、 URL-符号化された 文字を入力します。このためには、表示する 16進数値文字による % マークを入力します。以下のテーブルでは、頻度の高い共通文字がリストされています。

文字

URL-符号化

文字

URL-符号化

文字

URL-符号化

(改行)

%0A

(空欄)

%20 または +

%

25

&

26

+

%2B

=

%3D

?

%3F

©

%A9

®

%AE

ß

%DF

ä

%e4

Ä

%c4

ö

%F6

Ö

%D6

ü

%FC

Ü

%DC

Ç

%c7

à

%e0

á

%e1

â

%E2

æ

%E6

ç

%E7

è

%E8

é

%E9

ê

%EA

ë

%EB

î

%ee

ï

%EF

ô

%F4

ù

%F9

ú

%FA

ù

%FB

û

%fc

詳細は ja.wikipedia.org/wiki/パーセントエンコーディングを参照してください。

カラー値のテーブル

特定のパラメータにカラー値を指定することができます。これらの値は、特定色である赤、緑、青 (TGB) 値の 16進値に対応しています。それぞれの 2文字は、 00 は最低値 (色なし)を FF は最高値 (フルカラー)を意味します。色は相加的にミックスされており、 0x000000 は黒色、 0XFFFFFF は白色になります。

カラー名

16進記号

カラー名

16進記号

0x000000

マロン

0x800000

濃い緑

0x008000

オリーブ

0x808000

マリン

0x000080

パープル

0x800080

ティール

0x008080

濃いグレー

0x808080

明るいグレー

0xC0C0C0

赤色

0xFF0000

緑色

0x00FF00

黄色

0xFFFF00

青色

0x0000FF

マゼンタ

0xFF00FF

シアン

0x00FFFF

0xFFFFFF

control コマンド

はじめに、どの命令を実行すべきかカメラに指示が必要です。

control コマンドのインストラクション

インストラクション

説明

set

アクセス設定の書き込み。この命令は設定の変更に使用します。

http://192.168.11.104/control/control?set&<parameter>=<value>[&<parameter>=<value>]

read

アクセス設定の読みだし。この命令は設定内容の問い合わせに使用します。

http://192.168.11.104/control/control?read&<parameter>[&<parameter>]

list

list インストラクションは、コンフィグレーションファイルの中で変更のあったセクションをリストアップします。

特定セクションのパラメータを修正するには、記述の最後部に section=sectionname を追加します。

例:

http://192.168.11.104/control/control?list&section=actions には アクション 項目の全オプションがリストされています。

このコマンドは、現在の値の読み込みを許可、利用可能なオプションの取得および他のアプリケーションでユーザインターフェースのテキスト取得方法を提供します。

factory

factory インストラクションはセクションのパラメータを工場出荷時の設定値にリセットします。使用時は追加パラメータとしてセクション名、 section=sectionname が必要です。

http://192.168.11.104/control/control?factory&section=<section name>

リストア

リストア でセクションのパラメータをフラッシュメモリに保存しておいた設定値に戻します。使用時は追加パラメータとしてセクション名、 section=<sectionname> が必要です。

http://192.168.11.104/control/control?restore&section=<section name>
プロファイルのパラメータにアクセス

プロファイルは、ひとつの値に複数設定を保存します:

<profile designator>=<name>[:<parameter>=<value>].

同一の <profile designators> で複数のプロファイルは共存できます。プロファイルは read および set コマンドを使用して適せつな編集ができないため、以下のコマンドを利用してください:

インストラクション

説明

read_profile

プロファイルの読み込み。

http://192.168.11.104/control/control?read_profile=<profile designator>:<name>

delete_profile

プロファイルの削除

http://192.168.11.104/control/control?delete_profile=<profile designator>:<name>

set_profile

プロファイルの書き込み。

http://192.168.11.104/control/control?set_profile=<profile designator>:<name>&<parameter>=<value>[&<parameter>=<value>]

add_profile

プロファイルの追加。

http://192.168.11.104/control/control?add_profile=<profile designator>:<name>&<parameter>=<value>[&<parameter>=<value>]

また、いくつかのプロファイルにはさらに多くのパラメータがあり、前にアンダースコア文字があることにより確認されます。

パラメータ

説明

_profilename

このプロファイルには本当の名前があります。 <Name> 値の代わりに、カメラのユーザインターフェースは本当の名前の値を表示します。このカメラには UTF-8 文字が含まれ (構文維持のためいくつかは URL-符号化の必要あり)、固有である必要はありません。

_profilestate

現時点では、プロファイル値の状態は空欄 (_profilestate=) または i (_profilestate=i)文字が使えます。空白値はプロファイルを有効にしますが、 i 文字で無効になります (例として、イベントプロファイルを参照)。

control コマンドのセクションリスト

セクションでは、 control コマンドを使用してリモート制御可能なすべてのダイアログに応答する以下のテーブルが表示されます。以下にリストされたリンクをクリックして、応答するセクションに移動します。

注記

グループアクセスコントロールリストAPI 権限 への公共アクセスができる場合、もしくは ユーザ名 に権限がある場合場合にのみ、フレーム内容は表示されます。

Click.cgi インターフェース

インターフェースは vPTZ機能に制限されたアクセスを提供します。このインターフェースが提供するコマンドリストの取得には、 list コマンドを使用してください:

http://192.168.11.104/control/click.cgi?list

help コマンドは、詳細情報や各コマンドの使用例を戻します。

http://192.168.11.104/control/click.cgi?help

query コマンドは、現在の vPTZ設定に関する情報を戻します。

http://192.168.11.104/control/click.cgi?query

rotorcgi インターフェース

このインターフェースは、vPTZ機能へのフルアクセスを提供します。 help コマンドは、各コマンドの使用に関する詳細情報を戻します。

http://192.168.11.104/control/rotorcgi?help

control コマンド

スクリプトの最初の値は実行されるアクションの名前です。アクションに応じて追加パラメータを準備してください必要なパラメータとオプションとしてのパラメータがあります。

注意

注記

rcontrol コマンドの全オプションを確認するためには、ブラウザのアドレスバーに list 命令を入力してください。

http://192.168.11.104/control/rcontrol?list


© 2001-2024 MOBOTIX, · http://www.mobotix.com/