Page 1 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

Glamo Inc.

第 1.1版

IRM-01Lコマンド仕様書
Copyright (C) 2013 Glamo Inc. All Rights Reserved.

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

Page 2 of 19
Issue 1
2013/08/14

1.

改版履歴 ................................................................................................................................................ 3

2.

概要 ....................................................................................................................................................... 4
2.1.
2.2.

3.

IRM-01Lへの接続方法 ........................................................................................................................... 5
3.1.
3.2.

4.

IRM-01Lに設定されたIPアドレス情報の取得・設定について ...................................................... 4
IRM-01Lの外出先からのコントロールについて ............................................................................ 4

ポート番号 ..................................................................................................................................... 5
KEEPALIVEについて ........................................................................................................................ 5

コマンド送信仕様.................................................................................................................................. 6
4.1. 概要 ................................................................................................................................................ 64.1.1.
コマンドバッファクリア文字列 ............................................................................................. 6
4.1.2.
コマンド部 .............................................................................................................................. 6
4.1.3.
パラメーター指定記号 ............................................................................................................ 6
4.1.4.
パラメーター部 ....................................................................................................................... 6
4.1.5.
コマンド実行文字列 ............................................................................................................... 6
4.1.6.
コマンドタイムアウト ............................................................................................................ 7
4.2. コマンド一覧.................................................................................................................................. 8
4.2.1.
[au]：接続確認用 .................................................................................................................... 9
4.2.2.
[is]：赤外線発光 .................................................................................................................... 10
4.2.3.
[ic]：リモコン学習開始 ......................................................................................................... 11
4.2.4.
[cc]：リモコン学習中止 ........................................................................................................ 12
4.2.5.
[tm]：タイマーセット ........................................................................................................... 13
4.2.6.
[tl]：タイマー一覧取得 .......................................................................................................... 14
4.2.7.
[td]：タイマー解除 ................................................................................................................ 15
4.2.8.
[ts]：現在時刻設定 ................................................................................................................ 16
4.2.9.
[tg]：現在時刻取得 ................................................................................................................ 17
4.2.10. [vr]：ファームバージョン番号の取得 ................................................................................... 18

5.

エラーコード一覧................................................................................................................................ 19

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 3 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

改版履歴

1.
発行

理由

1.0

初版

1.1

・各コマンドの「実行例」の間違いを修正
・icコマンドのレスポンスの間違いを修正

・

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

作成者

日付

Glamo Inc.

2011/08/07

Glamo Inc.

2013/08/14

Page 4 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

2.

概要

本ドキュメントはIRM-01Lを自宅内LANから制御するコマンド仕様を記載したものです。
IRM-01Lに設定されたローカルIPアドレスに対してTCP/IPで本ドキュメントに定義されたコマンドを送信することでIRM-01Lをコントロールすることが可能となります。

法人様にのみ公開
iRemocon-Server（Glamo Inc内）
外出先からの接続端末(スマートフォン、PC、携帯、その他機器等)

自宅内LANネットワーク

ローカルIPに対しての接続端末(スマートフォン、PC、携帯、その他機器等)
iRemocon※インターフェースの関係をわかりやすくするために図内にルーター機器を表示しておりません。

本ドキュメントでの公開範囲

2.1.

IRM-01Lに設定されたIPアドレス情報の取得・設定について

IRM-01Lに設定されたIPアドレスの取得やIPアドレスの設定については、弊社からリリースされている公式「iRemocon」アプリの設定メニューをご利用ください。
現在、IRM-01Lに対して直接、情報の取得・設定を行う仕様の個人のお客様への公開は行っておりません。
法人様への公開については個別対応とさせて頂いておりますので製品ページよりお問い合わせください。

2.2.

IRM-01Lの外出先からのコントロールについて

IRM-01Lを外出先からコントロールする仕様については、法人様への公開に限定させて頂いております。
ご利用を希望される法人のお客様は製品ページよりお問い合わせください。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

3.

Page 5 of 19
Issue 1
2013/08/14

IRM-01Lへの接続方法

IRM-01Lへの接続は以下のポート番号に対してTCP/IPのSocket通信で行います。
※接続先IPアドレスについては「2.1 IRM-01Lに設定されたIPアドレス情報の取得・設定について」をご覧ください。

3.1.

ポート番号以下のポート番号に対して接続を行ってください。

接続先ポート番号：51013

3.2.

KeepAliveについて

IRM-01Lでは、300秒の間、無通信状態が継続するとIRM-01L側から接続を切断します。
接続を継続したい場合には「4.2.1 [au]：接続確認用」などのコマンドを利用してKeepAliveを行ってください。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

Page 6 of 19
Issue 1
2013/08/14

コマンド送信仕様

4.

4.1.

概要

IRM-01Lの基本的なコマンドは以下のフォーマットで構成されています。
全てASCIIコードでIRM-01Lに送信してください。
※コマンドの入力に５秒以上、間を空けるとタイムアウトしますのでご注意ください。

*XX;yyyy\r\n*：コマンドバッファクリア文字列

XX：コマンド部;：パラメーター指定記号yyyy：パラメーター部\r\n：コマンド実行文字列

4.1.1. コマンドバッファクリア文字列「*」を入力することにより、入力中のコマンドをIRM-01Lのバッファから削除し、キャンセルします。
ただし、先頭２文字のコマンド部分を入力後はキャンセルできません。
※コマンドの入力を行う場合は常に先頭に付加することを推奨します。

4.1.2. コマンド部
２文字で構成される実際のコマンドです。

4.1.3. パラメーター指定記号
コマンドにパラメーターを指定する必要がある場合は、「;」を各パラメーターの先頭に付加して指定します。
コマンドによっては複数のパラメーターを指定する必要があります。

4.1.4. パラメーター部
コマンドに渡すパラメーターを指定します。

4.1.5. コマンド実行文字列

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

Page 7 of 19
Issue 1
2013/08/14

IRM-01Lへのコマンド送信は改行コード「\r\n(0x0A 0x0D)」を実行文字列として行います。
コマンド文字列に続けて、\r\nを送信することにより、コマンドの実行を行います。

4.1.6. コマンドタイムアウト
IRM-01Lへコマンドの送信を開始し、５秒以内に区切り文字が確認できなかった場合はタイムアウトとなり、エラーを返却します。
※コマンドの入力に５秒以上、間を空けないでください。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 8 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.

コマンド一覧

コマンドau

備考
接続確認用

is

赤外線発信ic

リモコン学習開始cc

リモコン学習中止

tm

タイマーセット

tltdtstgvr

タイマー一覧取得
タイマー解除現在時刻設定現在時刻取得ファームバージョン番号の取得

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

引数;1～1500※一部 1～800 までの機種があります。
;1～1500※一部 1～800 までの機種があります。
;1～1500;現在時刻+60～4102444800;0～31536000;1～500;1293775200～4102444800-

IRM-01Lコマンド仕様書

4.2.1. [au]：接続確認用
4.2.1.1.

機能

コマンドを受信すると無条件に[ok\r\n]が返却されます。
コネクションが正常に確立されているかの確認用や、KeepAliveに活用できます。

4.2.1.2.

パラメーター指定なし。
実行形式：*au\r\n4.2.1.3.

コマンド応答無条件で以下の応答が返却されます。
[ok\r\n]Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 9 of 19
Issue 1
2013/08/14

Page 10 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.2. [is]：赤外線発光
4.2.2.1.

機能パラメーターで指定したリモコンコード番号に記録されたリモコンコードを赤外線LEDから発信します。

4.2.2.2.

パラメーター

番号①値
1～1500内容
リモコンコードが記録された番号※一部1～800までの機種があります。
実行形式：is;①\r\n
実行例

4.2.2.3.

：*is;1\r\n

コマンド応答

以下の応答が返却されます。
成功の場合：[is;ok\r\n]
失敗の場合： [is;err;xxx\r\n]※xxxはエラーコード

4.2.2.4. 注意事項
必ずコマンドの応答を待って、次のコマンドを送信してください。
また、赤外線送信を連続で長時間行わないでください。
故障の原因となります。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 11 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.3. [ic]：リモコン学習開始
4.2.3.1. 機能
パラメーターで指定したリモコンコード番号にリモコンコードを学習させます。
このコマンド発行後は本体のLearnランプが点灯し、リモコンコード学習モードに移行します。
リモコンコード学習モードでは、リモコン信号受信および[cc]コマンド以外のコマンドは受け付けません。

通常状態

icコマンドリモコンコード
学習モード

結果通知

リモコン信号受信or[cc]コマンドによるキャンセル

4.2.3.2. パラメーター
番号①

値
1～1500内容
リモコンコードを学習させる番号※一部1～800までの機種があります。
実行形式：ic;①\r\n
実行例：*ic;1\r\n4.2.3.3. コマンド応答※icコマンド実行時には何もレスポンスがありません。
リモコンコード学習モードへ切り替えた後に、本体にリモコン信号を送信すると、続けて以下の応答が返却されます。

リモコンコード学習成功の場合：[ic;ok\r\n]リモコンコード学習失敗の場合：[ic;err;xxx\r\n]※xxxはエラーコード

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

Page 12 of 19Issue 1
2013/08/14

4.2.4. [cc]：リモコン学習中止
4.2.4.1. 機能[ic]コマンドによって遷移したリモコンコード学習モードを解除します。
リモコンコード学習モードを解除することにより、本体を通常のコマンド待受け状態に戻します。
※このコマンドはリモコンコード学習モード時にのみ有効です。

4.2.4.2. パラメーター
指定なし。
実行形式：*cc\r\n4.2.4.3. コマンド応答
以下の応答が返却されます。
成功の場合：[cc;ok\r\n]
失敗の場合： [cc;err;xxx\r\n]※xxxはエラーコード※ キャンセルに成功した場合、続けて[ic]コマンドのキャンセルによる返答が返却されます。
※ その結果、実際の応答は [cc;ok\r\nic;err;002\r\n]となります。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 13 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.5. [tm]：タイマーセット
4.2.5.1. 機能
IRM-01Lにタイマーを設定します。

4.2.5.2. パラメーター
番号値

内容

①

1～1500

発信するリモコンコードが記録された番号②

現在時刻+60～4102444800

発信実行時刻※未来の1970/01/01 09:00:00 (UTC+0900) からの秒数を指定します。
例）2020/1/1 00:00:00は「1577804400」となります。

③

0②発信実行時刻を起点とした繰り返し秒数を指定します。

または

「0」

60～31536000※必ず60以上を設定してください。の場合は繰り返しを行いません。

間隔が短い場合、暴走やフリーズ、製品寿命の短縮につながる場合がございます。

実行形式：tm;①;②;③\r\n
実行例：*tm;1;1577804400;360\r\n4.2.5.3. コマンド応答
以下の応答が返却されます。
成功の場合：[tm;ok\r\n]
失敗の場合： [tm;err;xxx\r\n]※xxxはエラーコード

4.2.5.4. 注意事項
タイマーの設定時刻、繰り返し時刻はかならず６０秒以上の間隔を空けてください。
タイマーが複数重なり、連続で長時間の送信が発生しないように注意してください。
故障の原因となります。

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 14 of 19Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.6. [tl]：タイマー一覧取得
機能4.2.6.1.

[tm]コマンドで設定したタイマーの一覧を取得します。

パラメーター

4.2.6.2.
指定なし。

実行形式：*tl \r\n4.2.6.3.

コマンド応答

以下の応答が返却されます。
成功の場合：[tl;ok;①;②;③;④;⑤;②;③;④;⑤;②;③;④;⑤・・・・\r\n]
番号
①値
1～500

内容
総データ件数（②～⑤を１データとした件数）※この件数分、②～⑤のセットが連続で続く

②

1～500

タイマー番号③

1～1500[tm]コマンドで設定したリモコンコード番号④

現在時刻+1～4102444800[tm]コマンドで設定した発信実行時刻⑤

0~31536000[tm]コマンドで設定した繰り返し秒数※ 返却例：（タイマーが３件登録されている場合）[tl;ok;3;1;100;1577804400;0;2;200;1577805500;360;3;300;1577806600;3600\r\n]

失敗の場合： [tl;err;xxx\r\n]※ xxxはエラーコード

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 15 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.7. [td]：タイマー解除
4.2.7.1.

機能[tm]コマンドで設定したタイマーを解除します。

4.2.7.2.

パラメーター

番号①値
1～1500

実行形式：td;①\r\n
実行例

4.2.7.3.

：*td;1\r\n

コマンド応答

以下の応答が返却されます。
成功の場合：[td;ok\r\n]
失敗の場合： [td;err;xxx\r\n]※xxxはエラーコード

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

内容[tl]コマンドで取得したタイマー番号

Page 16 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.8. [ts]：現在時刻設定
4.2.8.1.

機能IRM-01Lの時計をパラメーターで指定した時刻で補正します。

4.2.8.2.

パラメーター

番号①値1293775200～4102444800内容現在時刻※1970/01/01 09:00:00 (UTC+0900) からの秒数を指定します。
例）2020/1/1 00:00:00は「1577804400」となります。

実行形式：ts;①\r\n
実行例：*ts;1577804400\r\n4.2.8.3.

コマンド応答

以下の応答が返却されます。
成功の場合：[ts;ok\r\n]
失敗の場合： [ts;err;xxx\r\n]※xxxはエラーコード

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 17 of 19Issue 1
2013/08/14

IRM-01Lコマンド仕様書

4.2.9. [tg]：現在時刻取得
4.2.9.1.

機能IRM-01Lの時計に設定された現在時刻を取得します。

4.2.9.2.

パラメーター指定なし。
実行形式：*tg\r\n4.2.9.3.

コマンド応答

以下の応答が返却されます。
成功の場合：[tg;ok;①\r\n]
番号①値
1293775200～4102444800

内容
現在時刻※1970/01/01 09:00:00 (UTC+0900) からの秒数を指定します。
例）2020/1/1 00:00:00は「1577804400」となります。

※ 返却例：（タイマーが３件登録されている場合）[tg;ok;1577804400\r\n]

失敗の場合： [tg;err;xxx\r\n]※xxxはエラーコード

Copyright (C) 2011 Glamo Inc. All Rights Reserved.

IRM-01Lコマンド仕様書

4.2.10.

[vr]：ファームバージョン番号の取得

4.2.10.1. 機能
IRM-01Lのバージョン番号が返却されます。

4.2.10.2. パラメーター
指定なし。
実行形式：*vr\r\n4.2.10.3. コマンド応答
ファームウェアのバージョン番号が返却されます。
[1.0.0\r\n]Copyright (C) 2011 Glamo Inc. All Rights Reserved.

Page 18 of 19
Issue 1
2013/08/14

Page 19 of 19
Issue 1
2013/08/14

IRM-01Lコマンド仕様書

5.
コマンド
au

is

ic

cc

tm

tl

td

tstg
vr

エラーコード一覧
エラーコード

エラー内容

備考

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001

リモコン番号範囲外

1～1500 の範囲外

002

リモコンデータ未登録エラー

リモコンデータが記録されていない番号が指定された

003

送信エラー

不正なデータを送信しようとした

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001

リモコン番号範囲外

1～1500 の範囲外

002

キャンセル

cc コマンドによってキャンセルされた

003

受信エラー

不正なリモコンデータを受信した

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001実行エラー

リモコンコード学習モード以外の状態に対して実行した

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001

リモコン番号範囲外

1～1500 の範囲外

002

実行時間範囲外エラー

現在時刻+1～4102444800 の範囲外

003

繰り返し時間範囲外エラー

0～31536000 以外の範囲が指定された

004

２重登録エラー（同一時間あり）

同一の時間に既にタイマー登録されている

005

登録数オーバーエラー

登録数オーバー（最大 500 件）

006

リモコンデータエラー

リモコンデータが登録されていない番号が指定された

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた001

タイマー登録なし

タイマーが１件も登録されていない

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001

タイマー番号範囲外エラー

1～500 の範囲外

002

タイマー登録なし

指定したタイマー番号のタイマーが存在しない

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

001

設定時間範囲外

1293775200～4102444800 の範囲外

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

010

フォーマットエラー

コマンドの書式が不正

020

タイムアウトエラー

コマンド入力が５秒以上途切れた

Copyright (C) 2011 Glamo Inc. All Rights Reserved.