NP-IPV-01UT/Rコマンドガイド

本書の概要

本書では、LAN通信によりNP-IPV-01UT/Rを制御する通信コマンドについて説明します。以下、NP-IPV-01UT/Rを「エンコーダー」または「デコーダー」と表記します。

通信コマンドにより以下の制御が可能です。

IPアドレスとチャンネルの設定(初期設定)
各種状態の取得・設定(MACアドレス、HDMI信号出力)
同一サブネット上にあるエンコーダー/デコーダーの一覧の取得
チャンネルの取得・変更
OSD（On Screen Display）表示の指示・消去
非接続時の画面表示を変更
エンコーダーにユーザー定義EDIDを登録
音声の選択
ビデオウォールの設定
USB over IP 関連
拡張制御機能
HTTPサーバーのアクセス権設定

通信の準備

本章では、LAN通信を準備する手順について説明します。
出荷時にすべてのエンコーダーには169.254.2.1、デコーダーには169.254.3.1がIPアドレスとして設定されています。これらの機器にアクセスするためには、制御用PCにも同一サブネットのIPアドレスを設定する必要があります。 169.254.0.0/16はリンクローカルアドレスなので、対象ネットワークにDHCPサーバーが存在しなければ、有効なIPアドレスが制御用PCに自動的に割り振られます。割り振られるのを待つ、または169.254.xxx.yyyの有効なアドレスを制御用PCに固定設定してください。

Windows PCのネットワークアダプターは、デフォルト設定ではDHCPでアドレスを取得できない場合に自動プライベートIPアドレス取得機能で代替アドレスを取得します。この代替アドレスとして169.254.xxx.yyyのアドレスが確定するまでには、 LANケーブルをつないでからおよそ1分程かかります。

各エンコーダー/デコーダーにユニークなIPアドレスを設定し終えるまでは、複数のエンコーダー/デコーダーを同時にLANスイッチにつながないでください。エンコーダーおよびデコーダーのIPアドレスを設定する方法は、「取扱説明書」を参照してください。

本書で説明する setup_device コマンドにて設定することも可能です。

コマンド発行方法

コマンドは、HTTPプロトコルのGETメソッドで発行します。
Webブラウザのアドレスボックスに下記を指定するとコマンドを発行できます。

http://対象機器IPアドレス/cgi-bin/api.cgi?cmd=コマンド+パラメーター

パラメーターが複数ある場合の区切り記号は、+ です。

Webブラウザのアドレスボックス以外では、

wget、curl 等のコンソールコマンド
JavaScriptのXMLHttpRequest()

でもコマンドを発行できます。
XMLHttpRequest Level 2/CORS に対応しています。

対象機器のWeb UIのSystem Tabにて、UtilitiesのConsole API Commandボックスからでもコマンドを発行できます。この場合は、コマンドとパラメーターの間は上記の+ではなく、スペースとしてください。

初期設定(IPアドレス等)

setup_device

機能
エンコーダー/デコーダーのIPアドレスとチャンネルの変更

パラメーター

チャンネル［IPアドレス］

チャンネルは、十進数値で指定してください。1から199までが有効値です。
第二引数のIPアドレスは省略可能です。省略した場合は、エンコーダーでは169.254.2.X、デコーダーでは169.254.3.Xが設定されます。ここで、Xは、第一引数のチャンネル番号と同じ数値となります。
第二引数に指定したIPアドレスが有効なプライベートアドレスではない場合は、強制的に第二引数が省略されたものとみなされます。
サブネットマスクは、IPアドレスの第一オクテットが10のときは255.0.0.0、 172及び169のときは255.255.0.0、192のときは255.255.255.0 になります。
上記に該当しないIPアドレスの設定を行う場合は、 Web UI または setup_device2 をご利用ください

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_device+2

http://169.254.2.1/cgi-bin/api.cgi?cmd=setup_device+4+172.16.2.4

setup_device2

機能
エンコーダー/デコーダーのIPアドレスとチャンネルの変更(制限無し)

パラメーター

チャンネル IPアドレス マスク　ゲートウェイアドレス

4個のパラメーターを全て指定する必要があります。省略はできません

返値
ありません

備考
setup_device と異なりパラメーターで指定した値のエラーチェックをおこないません。 IPアドレスとして正しくない値を指定すると、ネットワーク接続ができなくなる場合が有ります。

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=setup_device2+4+123.1.0.4+255.255.255.0+123.1.0.254

機器状態の取得・設定

get_version

機能
ファームウエアバージョンの取得

Web UI → System Tab → Version Information の最終行と同じ内容が取得できます

パラメーター
ありません

返値
ファームウエアバージョン

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_version

A7.1.0 Build 3104, P2018-02-23-0002

get_psn

機能
シリアル番号取得

Web UI → System Tab → Statistics → Product Serial Number と同じ内容です

パラメーター
ありません

返値
シリアル番号

備考
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_psn

R19E085

get_platform

機能
エンコーダー/デコーダーのいずれかを取得

パラメーター
ありません

返値
h または、c。h はエンコーダー、c はデコーダー

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_platform

c

get_monitor_info

機能
デコーダーに接続されているディスプレイの情報を取得します

パラメーター
ありません

返値
Web UI → System Tab → Statistics → Local Video Output と同じ内容です

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_monitor_info

attached=y

Checksum: ok
CEA Ext: y
CEA Ext Checksum: ok
HDMI 2.0: n
Input Signal: digital
Support Features:
    yuv: y
    hdr: n
Preferred Timing:
    1920x1080@60Hz,Prog (idx 13, sn 13)

EDID:
 00 ff ff ff | ff ff ff 00 | 34 a9 96 a2 | 01 01 01 01 | ........4.......
 00 18 01 03 | 80 80 48 78 | 0a da ff a3 | 58 4a a2 29 | ......Hx....XJ.)
 17 49 4b 21 | 08 00 31 40 | 45 40 61 40 | 81 80 01 01 | .IK!..1@E@a@....
 01 01 01 01 | 01 01 04 74 | 00 30 f2 70 | 5a 80 b0 58 | .......t.0.pZ..X
 8a 00 ba 88 | 21 00 00 1e | 02 3a 80 18 | 71 38 2d 40 | ....!....:..q8-@
 58 2c 45 00 | ba 88 21 00 | 00 1e 00 00 | 00 fc 00 50 | X,E...!........P
 61 6e 61 73 | 6f 6e 69 63 | 2d 54 56 0a | 00 00 00 fd | anasonic-TV.....
 00 17 3d 0f | 44 1e 00 0a | 20 20 20 20 | 20 20 01 79 | ..=.D...      .y
 02 03 39 f0 | 4d 10 05 20 | 22 04 03 02 | 07 06 5d 5f | ..9.M.. ".....]_
 62 64 23 09 | 07 01 77 03 | 0c 00 10 00 | b8 3c 2f 00 | bd#...w......

get_timing_info

機能
エンコーダー入力またはデコーダー出力のビデオ信号情報を取得します

パラメーター
ありません

返値
Web UI → System Tab → Statistics → Video Timing Information と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_timinginfo

Timing Table: Serial Number[0x000D] [1920]X[1080] [60]Hz
	Pixel Rate: 148351KHz, Htotal: 2200, Vtotal: 1125
	Hbp: 148, Vbp: 36, Hsw: 44, Vsw: 5
	Progressive, HPos, VPos
Color Depth: [36]
HDCP: [Off]
Capture Windows: [1920]X[1080] [60]Hz
Compress Windows: [1920]X[1080] [60]Hz
Active Windows: [1920]X[1080] [60]Hz
CRT Windows: [1920]X[1080]
Scan Mode: Progressive
Signal Type: HDMI 16:9

get_mac_address

機能
Ethernet MAC アドレスの取得

パラメーター
ありません

返値
MAC アドレスの文字列

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_mac_address

00:19:FA:00:51:EF

get_hdcp

機能
HDCP対応中か否かを取得

パラメーター
ありません

返値
on または、 off
それぞれの意味は、set_hdcp を参照してください

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_hdcp

on

set_hdcp

機能
HDCP対応または非対応にします

パラメーター

{on | off}

HDCP 対応とします

off

HDCP 非対応とします。必要がないのにHDCPをかけるソース機器にHDCPをonさせたくない場合に有効です

返値
ありません

備考
エンコーダーのみが対象のコマンドです。
出荷時は、on です

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_hdcp+off

get_ud_buttons

機能
チャンネル上下ボタンが有効か否かを取得

パラメーター
ありません

返値
on または、off

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_ud_buttons

on

set_ud_buttons

機能
チャンネル上下ボタンを有効または無効にします

パラメーター

{on | off}

返値
ありません

備考
デコーダーのみが対象のコマンドです
無効時に上下ボタンを押すとLED表示は変化しますがチャンネルは変化しません

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_ud_buttons+off

get_casting_mode

機能
映像伝送モードの取得(マルチキャスト/ユニキャスト)

パラメーター
ありません

返値
multi または、uni

備考
Web UI → Network Tab → Casting Mode の設定と同じ内容です

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_casting_mode

on

set_casting_mode

機能
映像伝送モードの設定(マルチキャスト/ユニキャスト)

パラメーター
multi または、uni

返値
ありません

備考
Web UI → Network Tab → Casting Mode の設定と同じ内容です

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_casting_mode+multi

get_link_mode

機能
ネットワークのリンク速度を取得

パラメーター
ありません

返値
1G または、100M

備考
Web UI → System Tab → Statistics/Link Mode と同じ内容です
デコーダーでは内蔵ハブが有るため常に 1G となり、デコーダーとLANスイッチの間の速度を取得できません。エンコーダーでは、LANスイッチとの間の速度を示しています。

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_Link_mode

1G

get_bit_rate

機能
映像伝送データのビットレートの取得

パラメーター
ありません

返値
best、500M、400M、300M、または、200M

備考
エンコーダーのみが対象のコマンドです
Web UI → Function Tab → Maximum Bit Rate と同じ内容です

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_bit_rate

best

set_bit_rate

機能
映像伝送データのビットレートの設定

パラメーター
best、500M、400M、300M または、200M

返値
ありません

備考
エンコーダーのみが対象のコマンドです
Web UI → Function Tab → Maximum Bit Rate と同じ内容です
設定を反映するためには再起動が必要です

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_bit_rate+best

get_edid_copy

機能
EDID コピー機能の状態取得

パラメーター
ありません

返値
on または、 off

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Copy EDID from this Video Output と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_edid_copy

off

set_edid_copy

機能
EDID コピー機能の有効化・無効化

有効にすると、デコーダーとエンコーダーが接続するたびにデコーダーに接続されているディスプレイのEDIDをエンコーダーのEDIDにコピーします。マルチキャスト運用時には必ず無効としてください。

パラメーター
on または、 off

返値
ありません

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Copy EDID from this Video Output と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_edid_copy+off

get_scaler_mode

機能
映像出力のスケーリング設定の取得

パラメーター
ありません

返値
pass-through、pass-through_strict、auto、1080p60、1080p50、2160p60、2160p50、2160p30、2160p25 または、2160p24

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Scaler Output Mode と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_scaler_mode

pass-through

set_scaler_mode

機能
映像出力のスケーリング設定

パラメーター
pass-through、pass-through_strict、auto、1080p60、1080p50、2160p60、2160p50、2160p30、2160p25 または、2160p24

返値
ありません

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Scaler Output Mode と同じ内容です

設定を反映するためには再起動が必要です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_scaler_mode+pass-through

get_vlost_timeout

機能
エンコーダー入力が停止してから映像待画像に変更するまでの時間の取得

パラメーター
ありません

返値
3、5、10、20、30、60 または、 never
数値は秒。never の場合は映像待画像に遷移しない

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Timeout for Detecting Video Lost と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_vlost_timeout

10

set_vlost_timeout

機能
エンコーダー入力が停止してから映像待画像に変更するまでの時間の設定

パラメーター
3、5、10、20、30、60 または、 never
数値は秒。never の場合は映像待画像に遷移しない

返値
ありません

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Timeout for Detecting Video Lost と同じ内容です

設定を反映するためには再起動が必要です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_vlost_timeout+10

get_output_on_vlost

機能
エンコーダー入力停止時にHDMI出力を停止するかどうかの状態取得

パラメーター
ありません

返値
on または、off。on の場合は映像待画像が出力されます。
off の場合は HDMI 出力が停止します。

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Turn off screen of video lost と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_output_on_vlost

on

set_output_on_vlost

機能
エンコーダー入力停止時にHDMI出力を停止するかどうかの設定

パラメーター
on または、off。on を設定すると映像待画像が出力されます。 off を設定すると HDMI 出力が停止します。

返値
ありません

備考
デコーダーのみが対象のコマンドです
Web UI → Function Tab → Turn off screen of video lost と同じ内容です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_output_on_vlost+on

get_uoip

機能
USB over IP 設定状態の取得

パラメーター
ありません

返値
4項目の状態を1行の文字列で表示します。
set_uoip のパラメーターと同じ形式となります。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_uoip

off r on off

set_uoip

機能
USB over IP を設定
Web UI → Function Tab → USB over IP セクションと同じ項目が対象

パラメーター

{on|off} {a|l|r} {on|off} [on|off]

on | off

USB over IP (有効 | 無効)

a | l | r

Operation Mode (Auto select | active on Link | active per Request)

on | off

K/M over IP (有効 | 無効)

on | off

Mouse not responding well (有効 | 無効) ※エンコーダーだけの設定

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_uoip+off+r+on

get_soip

機能
Serial over IP 設定状態の取得

パラメーター
ありません

返値
3項目の状態を1行の文字列で表示します。
set_soip のパラメーターと同じ形式となります。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_soip

off 2g 115200-8n1

set_soip

機能
Serial over IP を設定
Web UI → Function Tab → Serial over IP セクションと同じ項目が対象

パラメーター

{on|off} {1|2|2g} B-DPS

on | off

Serial over IP (有効 | 無効)

1 | 2 | 2g

Operation Mode (Type 1 | Type 2 | Type 2 guest mode)

B-DPS

Baudrate-[Data bits][Parity][Stop bits]
115200-8n1 または 9600-8n1 を使ってください

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_soip+on+2g+115200-8n1

get_iroip

機能
IR over IP 設定状態の取得

パラメーター
ありません

返値
on または、off

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_iroip

on

set_iroip

機能
IR over IP を設定

パラメーター
on または、off

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_iroip+on

エンコーダー/デコーダーの列挙

node_list

機能
制御用PCと同一サブネット上にあるエンコーダーとデコーダーの一覧の取得

パラメーター

[-j]

無し

リスト形式(human-readable)での返値を要求

-j

JSON 形式の返値を要求

備考
コマンド発行から返値を得るまで数秒かかります

実行例

  http://169.254.3.1/cgi-bin/api.cgi?cmd=node_list

  IP Hostname Status
  >>>>>
  169.254.3.1 ast3-client0019FA0051F6 s_srv_on
  169.254.2.1 ast3-gateway0001 s_attaching
  <<<<<

  http://169.254.3.1/cgi-bin/api.cgi?cmd=node_list+-j

  {
  "ast3-client0019FA0051F6":
  {
   "ip":"169.254.3.1",
   "host_name":"ast3-client0019FA0051F6",
   "status":"s_srv_on",
   "is_host":"n"
  },,
  "ast3-gateway0001":
  {
   "ip":"169.254.2.1",
   "host_name":"ast3-gateway0001",
   "status":"s_attaching",
   "is_host":"y"
  },,
  },

チャンネル変更・HDMI出力停止

get_channel

機能
デコーダーが選択しているチャンネルの取得、またはエンコーダーに設定されているチャンネルの取得

パラメーター

エンコーダー

ありません

デコーダー

[v] [a] [u] [s] [r]

デコーダーの接続先のチャンネルは、信号種ごとに別々に選択可能です
パラメーターを省略した場合は、v のみを指定した場合と同じ結果となります
パラメーターの数は自由です。

v: 映像
a: 音声
u: USB・キーボードマウスエミュレーション
s: シリアル・RS-232C
r: IR 信号

返値
チャンネル番号が返ります
複数のパラメーターを指定すると、同じ数のチャンネル番号の組み合わせが返ります

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_channel

1

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_channel+a

3

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_channel+v+a+u+s+r

1 3 1 1 1

set_channel

機能
エンコーダー/デコーダーが選択するチャンネルの変更

パラメーター

エンコーダー

チャンネル番号

デコーダー

チャンネル番号 [v][a][u][s][r]

チャンネル番号は10進数で指定

デコーダーの接続先のチャンネルは、信号種ごとに別々に選択可能です
第2パラメーターを省略した場合は全て信号を指定したとみなします。
第2パラメーターの信号種を表す文字はスペースで区切らずに繋げる必要があります。

v: 映像
a: 音声
u: USB・キーボードマウスエミュレーション
s: シリアル・RS-232C
r: IR 信号

返値
ありません

備考
運用時にエンコーダーのチャンネル変更は行わないでください。
導入時にエンコーダーのチャンネルを変更する場合は、 IPアドレスとチャンネルを同時に設定可能なsetup_deviceコマンドの利用をおすすめします

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_channel+2

音声だけ別のチャンネルに変更

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_channel+2+vusr
http://169.254.3.1/cgi-bin/api.cgi?cmd=set_channel+3+a

映像と音声だけを延長。他の信号は無効とする

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_channel+2+av
http://169.254.3.1/cgi-bin/api.cgi?cmd=set_channel+0+usr

get_valid_chs

機能
デコーダーが選択可能なチャンネル番号のリストを取得

パラメーター
ありません

返値
選択可能なチャンネル番号をスペースで区切った文字列が返ります。
全てのチャンネルを選択可能な場合は、0 が返ります

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_valid_chs

0

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_valid_chs

1 2 3 4

set_valid_chs

機能
エンコーダー/デコーダーが選択可能なチャンネルの設定。
チャンネルの選択を限定したい場合に利用できます。

パラメーター

ch1 ch2 ch3 ...

選択可能なチャンネル番号をスペースで区切った文字列で指定。
パラメーターを省略すると全てのチャンネルが選択可能となる

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_valid_chs

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_valid_chs+1+2+3+4

get_hdmiout

機能
デコーダーのHDMI出力状態を取得します

パラメーター
ありません

返値
on または、off

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_hdmiout

on

set_hdmiout

機能
デコーダーのHDMI出力を停止します

パラメーター

{on | off}

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_hdmiout+off

get_isch

機能
同一チャンネルへ変更した場合の動作の取得

パラメーター
ありません

返値
on の場合は、同一チャンネルへの set_channel では何もしません。
off の場合は、再接続処理を実施します。映像が一旦途切れます。
出荷時設定は off です。

備考
isch は ignore same channel の略です。
デコーダーのみが対象のコマンドです。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_isch
off

set_isch

機能
同一チャンネルへ変更した場合の動作の設定

パラメーター

{on | off}

on の場合は、同一チャンネルへの set_channel では何もしなくなります。
off の場合は、再接続処理を実施するようになります。

返値
ありません

備考
isch は ignore same channel の略です。
デコーダーのみが対象のコマンドです。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_isch+on

reconnect

機能
同一チャンネルへの set_channel が無視される状態で再接続

パラメーター
ありません

返値
ありません

備考
デコーダーのみが対象のコマンドです。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=reconnect

ud_ch

機能
チャンネル番号を上下(Up/Down)

パラメーター

{u|d} [min max]

min max を省略した場合はそれぞれ1 199を指定したとみなします。
チャンネル変更時に次のチャンネル番号を OSD 表示します。
maxで指定したチャンネル選択時にuを指定するとminで指定したチャンネルとなります。
minで指定したチャンネル選択時にdを指定するとmaxで指定したチャンネルとなります。

返値
ありません

備考
デコーダーのみが対象のコマンドです。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=ud_ch+u+1+5

On Screen Display

set_osd

機能
デコーダーへ指定した文字列でのOSD（On Screen Display）表示、消去

パラメーター

表示する文字列

利用可能な文字は、数字とアルファベットとハイフンとピリオド。上限は10文字程度です。
パラメーターを省略するとOSD表示を消去することができます

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd+Hello+world

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd

set_osd2

機能
デコーダーへ指定した文字列でのOSD(On Screen Display) 表示。指定した秒数のあとに消去

パラメーター

表示する秒数 表示する文字列

利用可能な文字は、数字とアルファベットとハイフンとピリオド。上限は10文字程度です。

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd2+3+Hello+world

set_osd_pos

機能
文字列のOSD(On Screen Display) の表示位置を指定

パラメーター

0: Default
1: Top-Left
2: Top
3: Top-Right
4: Left
5: Center
6: Right
7: Bottom-Left
8: Bottom
9: Bottom-Right

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd_pos+9

get_osd_res

機能
OSD解像度(非接続時画面の解像度)の取得

パラメーター
ありません

返値
640x480@60 または、1920x1080@60

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_osd_res

640x480@60

set_osd_res

機能
OSD解像度(非接続時画面の解像度)の指定
set_osd_pic で静止画を表示するときの背景は、ここで指定したサイズとなります。

パラメーター

{ 640x480@60 | 1920x1080@60 }

返値
ありません

備考
デコーダーのみが対象のコマンドです
出荷時設定は、640x480@60 です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd_res+1920x1080@60

set_osd_pic

機能
静止画をOSDとして表示。
IRリモコンで制御を行う場合に、番号と機能の説明の表示に活用可能です

パラメーター

ファイル名 [透明度] [t]

ファイル名

/usr に置いたjpg または png の静止画のファイル名
/usr にファイルを置く方法は、/usr の活用を参照してください

透明度

0 - 31。31 の場合はアルファブレンディング無し

トグル動作指定。ひとつのプリセットコマンドで、静止画を出す・消す場合に便利

静止画ファイル名を含めて引数なしで実行すると静止画OSDを消去します。

静止画の左上の1ピクセルと同じ色は表示されず背景の動画が表示されます。
それ以外の色は、透明度で指定した透け方で背景の動画とアルファブレンディングされます

返値
ありません

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd_pic+usage.jpg+25

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_osd_pic

非接続時の表示

get_logo

機能
デコーダーが接続を失った時に出力するロゴ・メッセージの状態を取得

パラメーター
ありません

返値
on、off、all_off のいずれか。
それぞれの意味は set_logo を参照してください

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_logo

off

set_logo

機能
エンコーダーを未接続時にデコーダーが出力するロゴ・メッセージの消去・表示

パラメーター

{ on | off | all_off }

弊社ブランドロゴとIP address等の機器情報が表示されます。
表示するロゴの変更は、/usr の活用を参照してください

off

機器情報のみが表示されます

all_off

一切表示がありません。黒画面の信号が出力されるためディスプレイがスタンバイに入ることはありません

返値
ありません

備考
出荷時設定は、off です
デコーダーのみが対象のコマンドです

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_logo+off

get_nclogo

機能
デコーダーが接続を失った時に表示する画像ファイル名の取得

パラメーター
ありません

返値
ファイル名

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_nclogo

default.jpg

set_nclogo

機能
デコーダーが接続を失った時に表示する画像ファイル名の指定。
nclogo.jpg以外の JPEGファイルを複数登録し、
状況によって表示する画像ファイルを変更することができます

パラメーター
.jpg 拡張子を除いたファイル名。
指定する JPEGファイルは /usr に存在する必要がある。
JPEGファイルの登録方法に関しては、/usr の活用を参照してください

返値
JPEGファイル名

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_nclogo+new

new.jpg

EDID

get_edid

機能
エンコーダーのEDIDを取得

パラメーター

[ 1 | 2 ]

無し

Web UI → System Tab → Statistics と同じ表示

/usr/bin/od -tx1 -An -v と同じ表示。 1行あたり16バイトを 0-f 2桁をスペースで区切ったもの

512 文字の16進数値

返値
実行例を参照してください

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_edid

 00 ff ff ff | ff ff ff 00 | 3a 01 02 10 | 01 00 00 00 | ........:.......
 30 1a 01 03 | 80 50 2d 78 | 2a 5f b1 a2 | 57 4f a2 28 | 0....P-x*_..WO.(
 0f 50 54 21 | 00 00 81 c0 | 01 00 01 00 | 01 00 01 00 | .PT!............
 01 00 01 00 | 01 00 02 3a | 80 18 71 38 | 2d 40 58 2c | .......:..q8-@X,
 45 00 fe 1f | 11 00 00 1e | 00 00 00 10 | 00 00 00 00 | E...............
 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | 00 fd 00 38 | ...............8
 4c 26 53 11 | 00 0a 20 20 | 20 20 20 20 | 00 00 00 fc | L&S...      ....
 00 4e 50 2d | 48 44 32 49 | 50 20 48 44 | 20 20 01 9e | .NP-HD2IP HD  ..
 02 03 20 c1 | 48 90 1f 20 | 04 13 03 12 | 3c 23 09 1f | .. .H.. ....<#..
 07 83 01 00 | 00 6a 03 0c | 00 10 00 80 | 1e 00 10 00 | .....j..........
 01 1d 00 72 | 51 d0 1e 20 | 6e 28 55 00 | 60 59 21 00 | ...rQ.. n(U.`Y!.
 00 1e 00 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | ................
 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | ................
 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | ................
 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | ................
 00 00 00 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 bc | ................

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_edid+1

00 ff ff ff ff ff ff 00 3a 01 02 10 01 00 00 00
30 1a 01 03 80 50 2d 78 2a 5f b1 a2 57 4f a2 28
0f 50 54 21 00 00 81 c0 01 00 01 00 01 00 01 00
01 00 01 00 01 00 02 3a 80 18 71 38 2d 40 58 2c
45 00 fe 1f 11 00 00 1e 00 00 00 10 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 fd 00 38
4c 26 53 11 00 0a 20 20 20 20 20 20 00 00 00 fc
00 4e 50 2d 48 44 32 49 50 20 48 44 20 20 01 9e
02 03 20 c1 48 90 1f 20 04 13 03 12 3c 23 09 1f
07 83 01 00 00 6a 03 0c 00 10 00 80 1e 00 10 00
01 1d 00 72 51 d0 1e 20 6e 28 55 00 60 59 21 00
00 1e 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 bc

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_edid+2

00ffffffffffff003a01021001000000301a010380502d782a5fb1a2574fa2280f505421000081c00100010001000100010001000100023a801871382d40582c4500fe1f1100001e000000100000000000000000000000000000000000fd00384c265311000a202020202020000000fc004e502d48443249502048442020019e020320c148901f20041303123c23091f07830100006a030c001000801e001000011d007251d01e206e28550060592100001e0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000bc

set_edid

機能
エンコーダーのEDIDをプリセットから選択

パラメーター

1: HDMI 4K 60Hz 7.1ch
2: HDMI 4K 60Hz 2ch
3: HDMI 4K 30Hz 7.1ch
4: HDMI 4K 30Hz 2ch
5: HDMI 1080p 2ch
6: HDMI 720p 2ch
7: DVI 1920x1200
8: DVI 1920x1080
usr: User defined EDID

返値
ありません

備考
Web UI → System Tab → Utilities のドロップダウンメニューでの選択と同じ効果です。
コマンド発行後に即時反映されソース機器に対してHPD信号を送信します。

エンコーダーのみが対象のコマンドです
設定を反映するためには再起動が必要です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_edid+hdmihd

get_uedid

機能
エンコーダーに登録済みのユーザー定義EDIDを取得。または、デコーダーに接続中されたディスプレイのEDIDを取得

パラメーター
ありません

返値
512文字の16進数値

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_uedid

00ffffffffffff003a01021001000000301a010380502d782a5fb1a2574fa2280f505421000081c00100010001000100010001000100023a801871382d40582c4500fe1f1100001e000000100000000000000000000000000000000000fd00384c265311000a202020202020000000fc004e502d48443249502048442020019e020320c148901f20041303123c23091f07830100006a030c001000801e001000011d007251d01e206e28550060592100001e0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000bc

put_uedid

機能
ユーザー定義EDIDの登録

この登録だけでは、エンコーダーのEDIDは変更されません。登録した後にrestore_uedidコマンドを発行する必要があります

パラメーター

512文字の16進数値

返値
ありません

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=put_uedid+00ffffffffffff003a01021001000000301a010380502d782a5fb1a2574fa2280f505421000081c00100010001000100010001000100023a801871382d40582c4500fe1f1100001e000000100000000000000000000000000000000000fd00384c265311000a202020202020000000fc004e502d48443249502048442020019e020320c148901f20041303123c23091f07830100006a030c001000801e001000011d007251d01e206e28550060592100001e0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000bc

restore_uedid

機能
登録済みユーザー定義EDIDの適用

対象機器のWeb UIのSystem Tab Utilitiesにて User Defined EDIDを選んでApplyボタンを押せば、同じ結果となります。
set_edit user としても同じ結果となります

パラメーター
ありません

返値
ありません

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=restore_uedid

音声の選択

get_audio

機能
エンコーダーが送信するオーディオの選択状態の取得、デコーダーのオーディオ出力状態の取得、

パラメーター
ありません

返値
エンコーダー：auto、hdmi、または、analog。出荷時設定は auto です。
デコーダー：both、hdmi、または、analog。出荷時設定は both です。

詳細は、set_audio を参照してください。

実行例

http://169.254.2.1/cgi-bin/api.cgi?cmd=get_audio

auto

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_audio

both

set_audio

機能
エンコーダーが転送するオーディオの選択エンコーダーのオーディオの出力先の選択

パラメーター

エンコーダー：

{ auto | hdmi | analog }

auto

analog 端子にケーブルが接続されると analog入力が転送されます。ケーブルが接続されていなければ、HDMIのオーディオが転送されます

hdmi

analog 端子の状態によらず常に HDMIのオーディオが転送されます

analog

analog 端子の状態によらず常に analog入力が転送されます

デコーダー：

{ both | hdmi | analog }

both

HDMI/analog の双方に音声出力します

hdmi

HDMI 端子だけに音声出力します

analog

analog 端子だけに音声出力します

返値
ありません

備考
設定を反映するためには再起動が必要です

実行例

エンコーダーでアナログ音声をエンベッド

http://169.254.2.1/cgi-bin/api.cgi?cmd=set_audio+analog

ビデオウォール

get_vw

機能
ビデオウォールの設定状態の取得

パラメーター
ありません

返値
2,x1,y1,x2,y2,stretch-type,rotation,end
または、
1,max_row,max_col,row,col,stretch-type,rotation,end

setup_vw2 で設定した後では、先頭が2で始まる返値となります。この場合は、stretch-type の値に意味はありません。
setup_vw で設定した後と Web UI で設定した後では、先頭が1で始まる返値となります。
いずれの場合も最後は必ず ,end となります。

切り出す矩形の左上のx座標

切り出す矩形の左上のy座標

切り出す矩形の右下のx座標

切り出す矩形の右下のy座標

max_row

ウォールの行数 - 1

max_col

ウォールの列数 - 1

row

行の位置(0始まり)

col

列の位置(0始まり)

stretch-type

1: Stretch Out、2: Fit In (返値の先頭が1の場合のみ有効)

rotation

0: 回転無し、3: 180度回転、6: 90度回転

備考
デコーダーのみが対象のコマンドです

実行例

setup_vw2 でウォール解除した直後の場合

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_vw

2,0,0,10000,10000,n,0,end

setup_vw2

機能
ビデオウォールの詳細設定

パラメーター

x1 y1 x2 y2 [rotation]

4個の座標値は必須です。5番目の回転指示は省略可能です

切り出す矩形の左上のx座標

切り出す矩形の左上のy座標

切り出す矩形の右下のx座標

切り出す矩形の右下のy座標

rotation

0: 回転無し、3: 180度回転、6: 90度回転 (省略可能です)

入力映像の画角を左上(0,0)、右下(10000,10000)で表す仮想座標とします。その中から任意の矩形を切り出して出力画角いっぱいに拡大します(スケーリングします)

返値
ありません

備考
デコーダーのみが対象のコマンドです。

実行例

下記では、169.254.3.1/2/3/4 のデコーダーがそれぞれ、左上・右上・左下・右下のディスプレイに接続されている場合です。

2x2 ベゼル無し

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw2+0+0+5000+5000
http://169.254.3.2/cgi-bin/api.cgi?cmd=setup_vw2+5000+0+10000+5000
http://169.254.3.3/cgi-bin/api.cgi?cmd=setup_vw2+0+5000+5000+10000
http://169.254.3.4/cgi-bin/api.cgi?cmd=setup_vw2+5000+5000+10000+10000

2x2 ベゼル無し、胴切れ対策のために2列目を上下反転。
この場合には、2列目のディスプレイは天地逆に設置する必要有り

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw2+0+0+5000+5000
http://169.254.3.2/cgi-bin/api.cgi?cmd=setup_vw2+5000+0+10000+5000
http://169.254.3.3/cgi-bin/api.cgi?cmd=setup_vw2+0+5000+5000+10000+3
http://169.254.3.4/cgi-bin/api.cgi?cmd=setup_vw2+5000+5000+10000+10000+3

2x2 ベゼル幅をディスプレイ表示域高さの1/9と仮定。
左上のx2 = 10000 * 16 / (16 + 1 + 16) = 4848
左上のy2 = 10000 * 9 / (9 + 1 + 9) = 4737
10000 - 4848 = 5152
10000 - 4737 = 5263

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw2+0+0+4848+4737
http://169.254.3.2/cgi-bin/api.cgi?cmd=setup_vw2+5152+0+10000+4737
http://169.254.3.3/cgi-bin/api.cgi?cmd=setup_vw2+0+5263+4848+10000
http://169.254.3.4/cgi-bin/api.cgi?cmd=setup_vw2+5152+5263+10000+10000

2x2 プロジェクターでエッジブレンディング。
境界が重なり合うように切り取る。重なりの輝度調整はプロジェクター側でおこなう必要が有ります

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw2+0+0+5100+5100
http://169.254.3.2/cgi-bin/api.cgi?cmd=setup_vw2+4900+0+10000+5100
http://169.254.3.3/cgi-bin/api.cgi?cmd=setup_vw2+0+4900+5100+10000
http://169.254.3.4/cgi-bin/api.cgi?cmd=setup_vw2+4900+4900+10000+10000

ウォール解除

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw2+0+0+10000+10000
http://169.254.3.2/cgi-bin/api.cgi?cmd=setup_vw2+0+0+10000+10000
http://169.254.3.3/cgi-bin/api.cgi?cmd=setup_vw2+0+0+10000+10000
http://169.254.3.4/cgi-bin/api.cgi?cmd=setup_vw2+0+0+10000+10000

setup_vw

機能
ビデオウォールの設定+ Web UI の Video Wall Tab と同様の設定をおこないます。
細かい設定を追い込む必要がある場合は、setup_vw2 を利用してください

パラメーター

[-m VW_OW_VH_OH] [-w WH_WW] [-p R_C] [-r 0|3|6] [-s i|o]

-m ディスプレイ情報の指定
VW：表示領域の幅、VH：表示領域の高さ、OW：外枠の幅、OH：外枠の高さ。１mmあたり10 の数値で指定。
例えば、表示領域が80cm x 45cm、外枠が83cm x 48cm とすると、 8000_8300_4500_4800を指定する

-w ウォール縦横の要素数-1
例えば、縦3個、横6個のウォールでは、2_5を指定する

-p ウォール位置。左上から縦横それぞれ0始まりの数値。
例えば、縦3個、横6個のウォールでは、右下に2_5を指定する。左上ならば、0_0を指定する

-r 画像の回転。
0：回転なし、3：180度、6：270度

-s ストレッチモード
縦横の数が異なるウォール構成時に、

映像の縦または横を縮小してウォールにはめ込む（Fit In）
映像のアスペクト比を維持するためにウォールからはみ出させる（Stretch Out）

のどちらかを選ぶ。
i：Fit In 、o：Stretch Out

縦横の数が同じ場合はストレッチモードの指定は無視され、常にFit Inを選んだ状態になります

備考
デコーダーのみが対象のコマンドです。
返値はありません

実行例

すべてのパラメーターを一気に設定

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw+-m+8000_8300_4500_4800+-w+2_2+-p+0_0+-r+0+-s+i

位置だけ変更

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw+-p+1_1

ウォール解除

http://169.254.3.1/cgi-bin/api.cgi?cmd=setup_vw+-w+0_0+-p+0_0

USB over IP

request_usb

機能
対象デコーダーのUSBハブをエンコーダーに接続します

USBの転送方法で USB over IP を選択した場合は、エンコーダーと接続されるUSBハブを持つデコーダーは1器に限定されます。 USBハブが非接続なデコーダーに対してこのコマンドを発行すると、既に接続されているデコーダーのUSBハブがエンコーダーから切り離され、代わりに対象デコーダーのUSBハブがエンコーダーに接続されます

パラメーター
ありません

返値
ありません

備考
デコーダーのみが対象のコマンドです。
コマンドを発行すると、「requesting usb」というOSDが表示されます。
ただし、既に接続中の場合は何も起こりません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=request_usb

get_usb_status

機能
USB over IP の接続状態を取得します

パラメーター
ありません

返値

s_srv_on

接続中

s_srv_search

切断中

備考
デコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_usb_status

s_srv_on

get_usb_device_list

機能
USBハブに接続されているUSBデバイスの情報を取得します

パラメーター
ありません

返値
接続中のUSBデバイスのID

備考
デコーダーのみが対象のコマンドです。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_usb_device_list

0461:4e22

映像取得

エンコーダーへの HDMI入力映像、デコーダーからの HDMI出力映像からある時点での静止画を取得することができます。ただし、映像が HDCP によって保護がされていない時に限ります。

capture

機能
HDMI 入力中・出力中の映像のサムネイルを保存します。
パラメーターにて画像の縦ドット数を指定すると /images/capture.jpg に保存します。
HDCP がかかっている場合は HDCP という文字の静止画となります。

パラメーター

{120 | 240 | 480 | 960}

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=capture
http://169.254.3.1/images/capture.jpg

拡張制御機能

http2idk

機能
ネットワーク内のIDK機器へコマンドを中継します

HTTP GET CORS でのIDK機器を制御可能となります。 IDK機器をWebアプリ(JavaScript)で制御できるようになります

パラメーター

IPアドレス ウェイト コマンド文字列

返値
送信したコマンドに対する応答が返ります

備考
ポートは1100固定です。変更できません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=http2idk+169.254.10.1+500+@GSW

@GSW,2,2,2,2,2,2,2,2,0,0,0,0,0,0,0,0

http2lxc

機能
ネットワーク内のAurora LXC-1へコマンドを中継します

HTTP GET CORS で LXC-1 を制御可能となります。
LXC-1はHTTP POSTでのコマンドを受け付けますが、 cross origin に対応していません。制御するためのWebページをLXC-1内に配置しないと動作しない制限があります

パラメーター

IPアドレス ウェイト telnet版コマンド文字列

返値
送信したコマンドに対する応答が返ります

備考
ポートは6970固定です。変更できません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=http2lxc+169.254.10.1+200+set+relay+1+ON

Status:Success,Response:ON

http2serial

機能
コマンド発行対象のRS-232C端子からシリアルデータを送信します

パラメーター

ウェイト オプション　文字列...

ウェイト

指定したミリ秒を上限に返答を待ちます

オプション

CR, CRLF, LF のいずれかで終端の改行コードを指定できます
B でバイナリーモードを指定できます。文字列が16進数である必要があります。

文字列

RS-232C端子に出力する文字列。スペースで区切られた複数語も可

返値
送信したシリアルデータに対する応答が返ります

備考
対象機器のWeb UI の Function Tab で、Serial over IP の Operation Mode を Type2 Guest mode にする必要があります

実行例

下記の2種は全く同じデータを送信しています。2つ目はバイナリーモードの例です。
バイナリーモードでは文字列として表示できないコードも送信可能です。

http://169.254.3.1/cgi-bin/api.cgi?cmd=http2serial+500+CRLF+@GSW

@GSW,2,2,2,2,2,2,2,2,0,0,0,0,0,0,0,0

http://169.254.3.1/cgi-bin/api.cgi?cmd=http2serial+500+B+404753570d0a

@GSW,2,2,2,2,2,2,2,2,0,0,0,0,0,0,0,0

reboot

機能
対象機器を再起動します

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=reboot

sleep

機能
パラメーターで指定した秒数を待ちます

パラメーター

秒数

返値
ありません

備考
プリセット内で複数のコマンドを実行する途中で、コマンド発行に間隔を設ける場合を想定しています

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=sleep+10

factory_default

機能
工場出荷状態に戻します

パラメーター

 [full]

返値
ありません

備考

パラメーターを省略した場合は、IPアドレスの設定だけは保持されます。
パラメーターにfullを指定した場合は、IPアドレスも初期化されます。
設定を反映するためには再起動が必要です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=factory_default

プリセットコマンド

プリセットは1台のエンコーダー、またはデコーダーごとに18種類を登録できます。
それぞれのプリセットには、複数のコマンドを登録できます。
書式は、

対象IPアドレス コマンド 引数...

となります。
プリセットを登録するエンコーダー/デコーダーだけでなく、ネットワーク内の他のエンコーダー/デコーダーに対してのコマンドを登録できます。
コマンド行の最後に & を記述するとコマンド実行の完了を待たずに次のコマンド実行を開始できます。

以下にプリセット定義ファイルの例を示します。 4台のデコーダーに対して、

4台全てのチャンネルを1にする
4台全てのチャンネルを2にする
2x2 ウォールを構成する
2x2 ウォールを解除する

ためのコマンドを登録しています。

pcmd01
127.0.0.1 set_osd2 2 CH1
169.254.3.1 set_channel 1 &
169.254.3.2 set_channel 1 &
169.254.3.3 set_channel 1 &
169.254.3.4 set_channel 1

pcmd02
127.0.0.1 set_osd2 2 CH2
169.254.3.1 set_channel 2 &
169.254.3.2 set_channel 2 &
169.254.3.3 set_channel 2 &
169.254.3.4 set_channel 2

pcmd03
127.0.0.1 set_osd2 2 Wall On
169.254.3.1 setup_vw2 0 0 5000 5000 0 &
169.254.3.2 setup_vw2 5000 0 5000 10000 0 &
169.254.3.3 setup_vw2 0 5000 5000 10000 0 &
169.254.3.4 setup_vw2 5000 5000 10000 10000 0

pcmd04
127.0.0.1 set_osd2 2 Wall Off
169.254.3.1 setup_vw2 0 0 10000 10000 0 &
169.254.3.2 setup_vw2 0 0 10000 10000 0 &
169.254.3.3 setup_vw2 0 0 10000 10000 0 &
169.254.3.4 setup_vw2 0 0 10000 10000 0

pcmd05
127.0.0.1 set_osd2 2 pcmd05

以下略

http://機器のIPアドレス/pcmd/up.html にアクセスするとプリセットコマンドを定義したテキストファイルを登録できます。
アップロード開始してから登録完了までに数分かかります。登録完了後に手動で再起動する必要があります。

http://機器のIPアドレス/pcmd にアクセスすると、プリセットコマンドを実行する Web アプリが表示されます。

pcmd

機能
プリセットの実行

パラメーター

プリセット番号

プリセット番号は、1から18 までが有効です。

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=pcmd+1

get_pcmd

機能
登録されたプリセット内容の取得

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_pcmd

pcmd01
127.0.0.1 set_osd2 2 pcmd01

pcmd02
127.0.0.1 set_osd2 2 pcmd02

pcmd03
127.0.0.1 set_osd2 2 pcmd03

pcmd04
127.0.0.1 set_osd2 2 pcmd04

以下略

rm_pcmd

機能
登録されたプリセットの削除。
全てのプリセットは、プリセット番号を含むOSDを表示するコマンドのみとなります。

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=rm_pcmd

get_pcmd_on_input

機能
エンコーダーへの入力開始時に実行するプリセット番号の取得

パラメーター
ありません

返値
off またはプリセット番号

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_pcmd_on_input

1

set_pcmd_on_input

機能
エンコーダーへの入力開始時に実行するプリセット番号の指定。
入力開始をトリガーに、特定のデコーダー(複数可)にそのエンコーダーを選択させるといった使い方を想定しています。
対象デコーダーへ該当するエンコーダーを選択する set_channelコマンドをプリセットに登録して、その番号をこのコマンドの引数とする必要があります

パラメーター
off または、1から18までの数値

返値
ありません

備考
エンコーダーのみが対象のコマンドです

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_pcmd_on_input+1

リモコンによる制御

get_irctrl

機能
IR制御機能の状態取得

パラメーター
ありません

返値
on または off
それぞれの意味は、set_irctrl を参照してください。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_irctrl

off

set_irctrl

機能
IR制御の有効・無効を設定します。

出荷時は無効です。
IR受信ケーブルを接続し、このコマンドで有効にした後に再起動する必要があります。
set_ir_code で指定するメーカーのテレビリモコンのチャンネルボタン・音量上下ボタン・チャンネル上下ボタン、ミュートボタン、画面ボタン、でプリセットコマンドの1から18 を実行できます。

弊社で動作確認済みのリモコンは以下となります。
エルパテレビリモコンIRC-202T
ダイセン 4キーリモコン
 ダイセン 18キーリモコン

パラメーター

{ on | off }

IR制御を有効にします

off

IR制御を無効にします

返値
ありません

備考
設定を反映するためには再起動が必要です

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_irctrl+on

get_ir_code

機能
受け付けるIRリモコンコードのメーカー名を取得します

パラメーター
ありません

返値
設定されているIRコードのメーカー名
それぞれの意味は、set_ir_code を参照してください。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_ir_code

1411:toshiba

set_ir_code

機能
受け付けるIRリモコンコードのメーカー名を設定します

パラメーター

code

code	メーカー
1411	東芝
1511	日立
1211	三洋
2311	パイオニア
2711	フナイ
8211	エプソン
0001	ダイセン
0000	リモコンコード学習

返値
メーカー名の文字列

備考
ダイセン社以外では、各社のテレビリモコンの信号に対応しています。
1 から 12 のチャンネルボタン以外では下記の表の数字として扱います。

ボタン	数字
Vol up	13
Vol down	14
CH up	15
CH down	16
ミュート	17
画面	18

弊社で動作確認済みのリモコンは以下となります。
エルパテレビリモコンIRC-202T
ダイセン 4キーリモコン
 ダイセン 18キーリモコン

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_ir_code+1411

toshiba

シリアル及び raw TCP による制御

get_serialctrl

機能
シリアル制御機能の状態取得

パラメーター
ありません

返値
on、on_all、on_auto または、 off
それぞれの意味は、set_serialctrl を参照してください

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_serialctrl

off

set_serialctrl

機能
シリアル制御機能の有効・無効設定

パラメーター

{ on | on_all | on_auto | off }

シリアル制御を有効にします。すべてのコマンドをバックグラウンド実行します。返値は破棄されます

on_all

シリアル制御を有効にします。すべてのコマンドをブロッキング実行します

on_auto

シリアル制御を有効にします。返値があるコマンドに対してのみブロッキング実行します

off

シリアル制御を無効にします

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_serialctrl+on_auto

備考
設定を反映するためには再起動が必要です
対象機器のWeb UI の Function Tab で、Serial over IP の Operation Mode を Type2 Guest mode にする必要が有ります

シリアルでコマンドを送る場合は、@ (アットマーク)を先頭とした文字列を使ってください。コマンドと引数の区切りはスペースです。最後に改行コードが必要です。
チャンネル変更コマンドの例は以下となります。

@set_channel 4[CR][LF]

シリアルケーブルを繋いでいるエンコーダー/デコーダーを通じて、ネットワーク越しの他エンコーダー/デコーダーに対してもコマンドを発行することができます。その場合は @ (アットマーク) とコマンドの間に対象のIPアドレスを記述します。 IPアドレスとコマンドの間にスペースが必要です。
チャンネル変更コマンドの例は以下となります。

@169.254.3.2 set_channel 4[CR][LF]

get_tcpctrl

機能
シリアル制御機能の状態取得

パラメーター
ありません

返値
on、on_all、on_auto または、 off
それぞれの意味は、set_tcpctrl を参照してください

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_tcpctrl

off

set_tcpctrl

機能
raw TCP制御機能の有効・無効設定

パラメーター

{ on | on_all | on_auto | off }

raw TCP制御を有効にします。すべてのコマンドをバックグラウンド実行します。返値は破棄されます

on_all

raw TCP制御を有効にします。すべてのコマンドをブロッキング実行します

on_auto

raw TCP制御を有効にします。返値があるコマンドに対してのみブロッキング実行します

off

raw TCP制御を無効にします

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_tcpctrl+on_auto

備考
設定を反映するためには再起動が必要です
TCPの接続先ポートは 5555固定です

raw TCPでコマンドを送る場合は、@ (アットマーク)を先頭とした文字列を使ってください。コマンドと引数の区切りはスペースです。最後に改行コードが必要です。
チャンネル変更コマンドの例は以下となります。

@set_channel 4[CR][LF]

対象エンコーダー/デコーダーを通じて、ネットワーク越しの他エンコーダー/デコーダーに対してもコマンドを発行することができます。その場合は @ (アットマーク) とコマンドの間に対象のIPアドレスを記述します。 IPアドレスとコマンドの間にスペースが必要です。
チャンネル変更コマンドの例は以下となります。

@169.254.3.2 set_channel 4[CR][LF]

KVM 運用時のデコーダーGUI

get_kvm_gui

機能
デコーダーに接続したUSBキーボードのショートカットキーで制御GUIを表示する機能の状態取得

パラメーター
ありません

返値
on、on_by_btn または、off

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_kvm_gui

on

set_kvm_gui

機能
デコーダーに接続したUSBキーボードのショートカットキーで制御GUIを表示する機能の有効化・無効化
映像伝送中に PrtScn キーを短時間に 3回押すと制御GUI画面を表示します。
キーボード・マウスで GUI を操作できます。

パラメーター

ショートカットキーで GUI 表示

off

GUI 表示機能の無効化

ショートカットキーは KM over IP での接続中に利用してください。 USB over IP で接続中の場合はショートカットキーが効きません。
タッチパネルやジョイスティック等のキーボード・マウス以外の HID を延長する場合は、USB over IPが必須となります。

返値
ありません

備考
GUI表示中の画面解像度は、set_osd_resコマンドで変更できます。

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_kvm_gui+on

show_gui

機能
KVM_GUI有効時かつ映像伝送中にGUIを表示します

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=show_gui

IRリモコンコード学習・送信

リモコンコードを学習したり送信するためには、 set_irctrl onとset_ir_code 0000 の2つのコマンドを実行して再起動を済ませておく必要があります。

get_pronto

機能
IR信号を受信して PRONTO フォーマットデータを取得します。
コマンドを実行した後に IR受光部に対して IR信号を送ってください。

パラメーター
ありません

返値
PRONT フォーマットデータ(改行なし文字列)

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_pronto

0000 0067 0016 0000 0010 020c 000e 004d 000a 004f 000b 0024 0006 002b 002a 0005 0029 0006 0082 0008 0052 0009 0024 0006 002d 0059 0005 0082 0009 0029 0004 0026 0004 0199 0005 0055 0006 0052 0006 00ae 0006 0058 0057 0005 0054 0004 073f

send_pronto

機能
PRONTO フォーマットデータを元に IR発光します。

パラメーター
PRONTO フォーマットデータ

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=send_pront+0000+0067+0016+0000+0010+020c+000e+004d+000a+004f+000b+0024+0006+002b+002a+0005+0029+0006+0082+0008+0052+0009+0024+0006+002d+0059+0005+0082+0009+0029+0004+0026+0004+0199+0005+0055+0006+0052+0006+00ae+0006+0058+0057+0005+0054+0004+073f

stop_pronto

機能
get_pronto 実行を中断します。

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=stop_pronto

HTTPサーバーのアクセス権設定

get_httpd.conf

機能
HTTPサーバーのアクセス権設定を取得します

パラメーター
ありません

返値
詳細は set_httpd.conf を参照してください

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=get_httpd.conf

/:abc:def
A:169.254.0.0/30
A:127.0.0.1
D:*

set_httpd.conf

機能
HTTPサーバーのアクセス権を設定します

パラメーター
下記で詳細説明するHTTPサーバー設定ファイルの内容を URL encodeを用いて一行の文字列で記述します

 httpd.conf has the following format:

 A:172.20.         # Allow address from 172.20.0.0/16
 A:10.0.0.0/25     # Allow any address from 10.0.0.0-10.0.0.127
 A:10.0.0.0/255.255.255.128  # Allow any address that previous set
 A:127.0.0.1       # Allow local loopback connections
 D:*               # Deny from other IP connections

 /:foo:bar         # Require user foo, pwd bar on urls starting with /
 /adm:admin:setup  # Require user admin, pwd setup on urls starting with /adm/

 A/D may be as a/d or allow/deny - only first char matters.
 Deny/Allow IP logic:
  - Default is to allow all (Allow all (A:*) is a no-op).
  - Deny rules take precedence over allow rules.
  - "Deny all" rule (D:*) is applied last.

 Example:
   1. Allow only specified addresses
     A:172.20          # Allow any address that begins with 172.20.
     A:10.10.          # Allow any address that begins with 10.10.
     A:127.0.0.1       # Allow local loopback connections
     D:*               # Deny from other IP connections

   2. Only deny specified addresses
     D:1.2.3.        # deny from 1.2.3.0 - 1.2.3.255
     D:2.3.4.        # deny from 2.3.4.0 - 2.3.4.255
     A:*             # (optional line added for clarity)

以下はパラメーターとして記述時に必要なURL encode の例です

改行

%0a

* (アスタリスク)

%2a

返値
ありません

備考
/cgi-bin/ に対してアクセス権を設定すると、内部で HTTP GET によるコマンド実行しているプリセットコマンド、リモコンによる制御、シリアル/raw TCPによる制御は動作しなくなります。

設定を反映するためには再起動が必要です

実行例

ユーザー名 abc、パスワード def に設定。
ローカルアドレスおよび 169.254.0.1 - 169.254.3.254 以外からのアクセスを拒否

http://169.254.3.1/cgi-bin/api.cgi?cmd=set_httpd.conf+/:abc:def%0aA:169.254.0.0/30%0aA:127.0.0.1%0aD:%2a%0a

/usr の活用

静的なWebページのファイルをアップロードして配信することができます。
制御用の Web アプリを配置するのに最適です。

http://機器のIPアドレス/usr/up.html にアクセスすると静的webファイルの tarball をアップロードできます。

tarball に含めることが可能なのは、 .html , .css , .js , .png , .jpg のみです。
tarball の上限サイズは、1.3M バイトです

nclogo.jpg を /usr に配置すると非接続時の背景画像として使われます。
get_logo コマンドの結果が on である状態で有効となります。

/usr に配置した画像ファイル(jpg または png) を set_osd_pic コマンドで OSD表示することができます。

save_wwwusr

機能
/usr フォルダーにアップロードした静的WebファイルをFlash ROMに保存します

http://機器のIPアドレス/usr/up.html にアクセスすると静的webファイルの tarball をアップロードできます。アップロードしただけでは、対象機器を再起動すると内容は失われます。
アップロードした後にこのコマンドを発行すると内容を保持することができます。

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=save_wwwusr

rm_wwwusr

機能
Flash ROMに保存した/usr 以下のファイルを削除します

パラメーター
ありません

返値
ありません

実行例

http://169.254.3.1/cgi-bin/api.cgi?cmd=rm_wwwusr

コマンド活用例

シェルスクリプトでの実施例

デコーダー1（169.254.3.1）に接続されているディスプレイのEDIDをエンコーダー1（169.254.2.1）からエンコーダー4（169.254.2.4）の4台にコピーする例です。制御用のPCは、エンコーダー/デコーダーと同一ネットワークに接続されていることを前提とします。
wget コマンドで HTTP GET リクエストを送信することによりコマンドを発行しています。

macOS(OS X) や Linux であればコマンドラインコンソールでそのまま実行可能です。
Windows の場合は、下記をcp_edid.shとして保存し、cmd.exeコンソールで、

> busybox.exe sh cp_edid.sh

とすれば実行できます。
Windows用のbusyboxは、 https://frippery.org/busybox/ から入手可能です。

Windows 10から利用可能な WSL (Windows Subsystem for Linux) でもご利用いただけます。

1. cp_edid.sh

#!/bin/sh
rxip="169.254.3.1"
txs="1 2 3 4"
copy_to_TX() {
  echo ""
  echo "copy EDID to TX$1"

  wget -q -O- 169.254.2.$1/cgi-bin/api.cgi?cmd=put_uedid+$2
  if [ $? -ne 0 ]; then
    echo EDID copy NG.
    return 1
  fi
  wget -q -O- 169.254.2.$1/cgi-bin/api.cgi?cmd=restore_uedid
  if [ $? -eq 0 ]; then
    echo EDID copy done.
  else
    echo EDID copy NG
  fi
  return 0
}

edid_str=$(wget -q -O- $rxip/cgi-bin/api.cgi?cmd=get_uedid|sed -e 's/current_edid_str=//')
if [ ${#edid_str} -ne 512 ]; then
  echo ""
  echo Invalid EDID, may be display was not connected.
  exit 1
fi

for i in $txs
do
  copy_to_TX $i $edid_str
done

Webページ(JavaScript)での実施例

デコーダー（169.254.3.1）のチャンネルを変更するWebページです。

制御用のPCがデコーダーと同一ネットワークに接続されていること
CH1 および CH2 に設定されたエンコーダーが存在すること

を前提とします。

下記をchsel.htmlという名前でファイルに保存し、Webブラウザで開いてください。 CORSに対応しているのでクロスオリジンアクセスでの制御が可能となっています。

2. chsel.html

<html>
<head>
<meta http-equiv="content-type" content="text/html"><meta charset="utf-8">
<title>NP-HD2IP Channel Selection</title>
<script>
const cmd_prefix = "http://169.254.3.1/cgi-bin/api.cgi?cmd=";

function sendCommand(cmd, callback) {
  let url = cmd_prefix + cmd;
  let xhr = new XMLHttpRequest();
  console.log("sendCommand, url: " + url);
  xhr.open("GET", url, true);
  xhr.timeout = 5000;
  xhr.onload = function(e) {
    if (this.status === 200)
      console.log("sendCommand, res: " + this.responseText);
      callback(this.responseText);
  };
  xhr.onerror = function(e) {
    callback("xhr.error");
  };
  xhr.ontimeout = function(e) {
    xhr.abort();
    alert("Connection Timeout\n" + url);
    callback("xhr.timeout");
  };

  xhr.send();
}

function selectRadio() {
  if (document.fm1.radio_ch[0].checked)
    sendCommand("set_channel+1", function(){});
  else
    sendCommand("set_channel+2", function(){});
}

window.onload = function getChannel() {
  sendCommand("get_channel", function(result) {
    for (i = 0; i < 2; i++)
      document.fm1.radio_ch[i].checked = (i+1 == Number(result));
  });
}
</script>
<style> body {font-size: 24px; line-height:36px;} </style>
</head>
<body bgcolor="white">
<H3><br> NP-HD2IP Channel Selection</H3>
<form name="fm1">
  <input type="radio" name="radio_ch" value="TX1" onclick="selectRadio()"> CH1
  <input type="radio" name="radio_ch" value="TX2" onclick="selectRadio()"> CH2
</form>
</body>
</html>

その他のコマンド活用例

Webブラウザ上で動作するSPA(Single Page Application)のサンプルソースコードをご用意しています。
弊社の製品Webページをご確認ください。

発行元

株式会社アルバニクス
〒242-0021 神奈川県大和市中央7-9-1
TEL: (046) 259-6920
FAX: (046) 259-6930
E-mail: info@arvanics.com
URL: https://www.arvanics.com/