Table of Contents   MOBOTIX Online Help

HTTP API

HTTP API(Application Programming Interface)は中央管理システムへのカメラ統合するソフトウェアインターフェースです。インターフェースは2つのCGIスクリプトで構成され、HTTPコマンドを使用してパラメータと値で呼び出すことができます。その記述内容によって、Setupのサブメニュー設定内容の変更や、カメラの機能を利用できます。

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

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

カメラ機能の実行

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

重要: 保存とリストアの一部機能は、admin(管理者)アクセスレベルのユーザによってのみ設定可能です。この場合、rcontrolスクリプトの呼び出しに、次のHTTPコマンドが必要になります。
http://128.243.66.90/admin/rcontrol

コマンド規定

命令が1つあるコマンド

controlコマンドにlist命令を付ける場合、?を使用して命令とコマンドを区切る必要があります。
   http://128.243.66.90/control/control?list

命令とパラメータ/値の組み合わせが1つずつあるコマンド

パラメータで命令を実行するには、命令とパラメータはアンパサンド記号&で区切ります。パラメータ値は=記号で区切ります。
   http://128.243.66.90/control/control?list&section=actions

命令1つとパラメータ/値の組み合わせが複数あるコマンド

複数のパラメータを使用する場合は、各パラメータをアンパーサンド゙記号&で区切ります。
    http://128.243.66.90/control/rcontrol?action=ledson&time=5

複数の値があるパラメータ

パラメータの中には、両方のレンズ゙を指定するために2個の値を入力する場合があります。このようなパラメータは工場出荷時設定値が2つあるパラメータとして表示されます(0 0など)。HTTPコマンドでは、2つの値を+記号を使用して区切ります。
   http://128.243.66.90/control/control?set&section=general&sharpen=0+0

コマンド中の改行文字

コマンド中に改行文字を使用する場合(ビデオモーションウィンドウを複数設定する場合など)は、改行文字を次のCGI文字列を使用して置換する必要があります。%0A   http://128.243.66.90/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

カラー値のテーブル

パラメータにカラー値を指定できます。カラー値は特定の色を構成するレッド、グリーン、ブルー(RGB)の16進値に対応しています。2つの文字がそれぞれカラーを表し、00は最低値(カラーなし)、FFは最高値(フルカラー)を表しています。カラーは追加すると混合されて、0x000000はブラック、0XFFFFFFはホワイトになります。

例:

0xFF0000 レッド
0x00FF00 グリーン
0x0000FF ブルー

カラー名 16進記号 カラー カラー名 16進記号 カラー
ブラック 0x000000   マロン 0x800000  
ダークグリーン 0x008000   オリーブ 0x808000  
マリン 0x000080   パープル 0x800080  
ティール 0x008080   ダークグレー 0x808080  
ライトグレー 0xC0C0C0   レッド 0xFF0000  
グリーン 0x00FF00   イエロー 0xFFFF00  
ブルー 0x0000FF   マゼンタ 0xFF00FF  
シアン 0x00FFFF   ホワイト 0xFFFFFF  

controlコマンド

最初に、どの命令を実行すべきかカメラに指示する必要があります。

controlコマンドの命令

命令 説明
set イメージ設定の書き込み。イメージ設定の変更に使用します。
http://128.243.66.90/control/control?set
read イメージ設定の読み出し。イメージ設定内容の問い合わせに使用します。
http://128.243.66.90/control/control?read
list

ist命令は、システム設定ファイルの中で変更可能なセクションの一覧を返します。
特定セクションのパラメータを修正するには、記述の最後部にsection=<sectionname>を追加します。

例:
http://128.243.66.90/control/control?listsection=actions actionsセクションのすべてのオプションがリストされます。

このコマンドは現在値の読み込み、および他のアプリケーションでユーザインターフェースのオプションとテキストを取得するために使用します。

factory factory インストラクションはセクションのパラメータを工場出荷時の設定値にリセットします。使用時は追加パレメータとしてセクション名、section=<sectionname>が必要です。
http://128.243.66.90/control/control?factory&section=<sectionname>
restore restore命令はセクションのパラメータをフラッシュメモリに保存しておいた設定値に戻します。使用時は追加パラメータとしてセクション名、section=<sectionname>が必要です。
http://128.243.66.90/control/control?restore&section=<sectionname>



rcontrolコマンド

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

注意:

rcontrolコマンドのすべてのオプションを表示するには、ブラウザのアドレスバーにlist命令を入力します。
http://128.243.66.90/control/rcontrol?list.

rcontrolパラメータ

アクション 説明 必須パラメータ オプションパラメータ
sigouthigh デジタル出力を閉じます。オプションパラメータtimeは設定時間経過後にデジタル出力を再び開きます。 なし
time
時間(単位sec)
sigoutlow デジタル出力を開きます。オプションパラメータtimeは設定時間経過後にデジタル出力を再び閉じます。 なし
time
時間(単位sec)
sound ボイン音を鳴らします。オプションパラメータsoundfileを使うと音を設定できます他のソフトウェアで作成したオーディオファイルやボイスメッセージ管理で録音したオーディオファイルも使用できます。 なし
soundfile
オーディオファイル名
ledson LEDを全部点灯します。オプションパラメータtimeは設定時間経過後にLED表示を工場出荷時設定状態にリセットします。 なし
time
時間(単位sec)
ledsoff LEDを全部消灯します。オプションパラメータtimeは設定時間経過後にLED表示を工場出荷時設定状態にリセットします。 なし
time
時間(単位sec)
ledsdefault LED表示を工場出荷時設定状態にリセットします。オプションパラメータtimeは設定時間経過後にLED表示を前回の設定状態にリセットします。 なし time
ledsstring 個々のLEDの表示を変更できます。パラメータledsのみを使用します。このパラメータは6文字構成で各文字はLED表示内容を指定します。文字は時計回りに配置され、最初の文字は12時の位置に相当します。
例:http://128.243.66.90/
control/rcontrol?
action=ledsstring
&leds=01BD11

leds

0=LED消灯
1=LED点灯
B=LED点滅
D=LEDの工場出荷時設定
time
時間(単位sec)
irledson LEDを全部点灯します。オプションパラメータtimeは設定時間経過後にすべてのLEDを再び消灯します。 なし
time
時間(単位sec)
irledsoff LEDを全部消灯します。 なし なし
irledsstring

左右のLEDの表示を変更できます。パラメータledsのみを使用します。このパラメータは2文字構成で各文字は各LEDのバーの内容を指定します。文字列の最初の文字は右側のLEDバーの状態を制御し、2番目の文字は左側のLEDバーの状態を制御します。

例:
http://128.243.66.90/
control/rcontrol?
action=ledsstring
    &leds=01

leds

0=LED消灯
1=LED点灯
time
時間(単位sec)
defreeze Stop Action(SP)イベントの発生後にカメラを解除して、画像の記録を再開します。 なし なし
putrs232 テキストをシリアルインターフェース経由で送出します。rs232outtextにパラメータを設定しない場合は"hello world"を送ります。 なし
rs232outtext
文字列
getrs232 シリアルインターフェースからのテキストを読みます。他のパラメータを使用しない場合は、最後の2048バイトをバッファから読み出します。 なし
nrofbytes
0 .. 102400 bytes
rs232delafterread
読み出し後、バッファを削除します。
getrs232hex getrs232と似ていますが、文字はHEXコードで返されます。 なし getrs232と同じです。
userclick User Clickを実行します。 なし なし
pancenter ズームの対象となる画像の位置を表示される画像の中心に合わせます。 なし なし
gettemp カメラ内部温度を返します。
注意:
このコマンドはWebモデルとBasicモデルでは使用できません。
なし なし
rs232sigin シリアルインターフェースの9ピンの状態を返します。 なし なし
setrs232sig シリアルインターフェースのピンを設定します。シリアルインターフェースはセットアップ(シリアルインターフェースとモデム)ダイアログで正しく設定されていることを確認してください。
24V 0, 1
RTS 0, 1
TXD 0, 1
DTR 0, 1
なし
ftplastevent 最後に保存したアラーム画像をFTPで転送します。追加情報としてFTPプロファイル名が必要です。プロファイルはFTPプロファイルダイアログで設定しておく必要があります。
profile
プロファイル名
なし
ftpcurrent 現在の画像をFTPで転送します。追加情報としてFTPプロファイル名が必要です。プロファイルはFTPプロファイルダイアログで設定しておく必要があります。
profile
プロファイル名
なし
emaillastevent 最後に保存したアラーム画像をEメールで転送します。追加情報としてEメールのプロファイル名が必要です。プロファイルはEメールプロファイルダイアログで設定しておく必要があります。
profile
プロファイル名
なし
emailcurrent 現在の画像をEメールで転送します。追加情報としてEメールのプロファイル名が必要です。プロファイルはEメールプロファイルダイアログで設定しておく必要があります。
profile
プロファイル名
なし
notifylastevent 最新のイベント画像の状態を示すネットワークメッセージを送信します。
profile
プロファイル名
なし
notifycurrent 現在の画像の状態を示すネットワークメッセージを送信します。
profile
プロファイル名
なし
sendmessage 指定アドレスにIP通知を送信します。
注意:
このコマンドはWebモデルとBasicモデルでは使用できません。
message 文字列
addr IPアドレス:ポート番号
なし
actionactivityon 全てのアクションを有効にします。 なし なし
actionactivityoff 全てのアクションを無効にします。 なし なし
actionactivitytime イベント共通設定ダイアログで設定した期間中、すべてのアクションを有効に使用します。 なし なし
eventack アラームを確認します。 なし なし
isdnphone 電話でカメラのボイスメッセージを起動します。追加情報としてOutgoing Calls Settings名が必要です。
profile
プロファイル名
なし
speakip 現在のIPアドレスをスピーカで再生します。

注意:
このコマンドはWebモデルとBasicモデルでは使用できません。

なし なし

システム設定の保存とリストア

システム設定の保存とリストアはadmin(管理者)アクセスレベルのユーザによってのみ実行可能です。

例: http://128.243.66.90/admin/rcontrol?action=storeconfig
注意: これらのコマンドはWebモデルとBasicモデルでは使用できません。

admin(管理者)レベルのユーザの機能

機能 説明 必須パラメータ オプションパラメータ
storeconfig 現在のシステム設定をカメラ内部に永久保存します。 なし なし
restoreconfig 最後に保存したシステム設定をカメラの永久保存領域から取り出します。 なし なし
resetconfig カメラの工場出荷時設定値を読み出します。 なし なし
再起動 カメラを再起動します。 なし なし

cn, de, en, es, fr, it, jp, ru

© 2001-2017 MOBOTIX AG, Germany · http://www.mobotix.com/