Command Manual
W55RP20-S2E ATコマンド概要
W55RP20-S2Eは、製品の設定および制御のために様々なコマンドを提供します。各コマンドは2バイトのアルファベット文字列で構成され、すべて大文字です。これらのコマンドを使用することで、ユーザーはシリアルデバイスまたはメインMCUにスクリプトを追加して製品の設定を行ったり、ネットワーク経由でW55RP20-S2Eモジュールを制御するプログラムを作成したりできます。
各コマンドはパラメータによって読取り/書込みの操作が可能で、読取り専用コマンドも存在します。
コマンドの入力およびシリアルポートデバイスのコマンドモードへの切替は、データUARTポートを使用して行います。Debug UARTポートではコマンドの入力や操作はサポートされていません。
シリアルおよびEthernetネットワーク経由でコマンドによる製品設定時には同一の2バイト文字列を使用し ますが、送信フレーム形式に違いがあります。本書では、すべてのコマンドの説明と各送信方法およびそのフレーム形式について案内します。
異なるコマンドモードは以下の通りです。
-
WIZnetが提供する設定ツールは、W55RP20-S2Eを制御するために同一のコマンドセットを使用します。
-
例えば、MACアドレスを確認するMCコマンドや、Firmwareを確認するVRコマンドは同一です。
略語
略語 | 説明 |
---|---|
CR | キャリッジリターン、カーソルを行頭(開始位置)に移動('\r', 0x0D) |
LF | ラインフィード、カーソルを下の新しい行に移動('\n', 0x0A) |
N | コマンド数 |
RW | 読取り / 書込み |
RO | 読取り専用 |
WO | 書込み専用 |
コマンドセットの使用方法
シリアルコマンドモードによるデバイス制御
以下の2つの方法のいずれかでシリアルコマンドモードに入ることができます。
1. ハードウェアトリガピンを使用してコマンドモードに入る
- W55RP20-S2EのHW_TRIGピンを使用してコマンドモードに入ります。
- 電源投入時にピンを確認し、コマンドモードに入ります。リブート時にもトリガピンを使って再度コマンドモードに入ることができます。
- トリガピンはプルアップし、Lowアクティブで動作します。
- この方法は、製品動作中に設定を変更したい場合に使用します。
- ハードウェアHW_TRIGピンをLowに設定します。
- W55RP20-S2Eの電源を入れます。
· シリアルコマンドモードで動作している場合、Debug UARTポートで以下のメッセージを確認できます。
· <code>> SEG:AT Mode </code>
- シリアルポート(データUARTポート)から設定が必要なコマンドとパラメータを入力します。
- [[#ex|EX]]コマンドを使用してデータ伝送モード(GWモード)に切り替えます。
· データ伝送モードへの切替が成功すると、Debug UARTポートで以下のメッセージを確認できます。
· <code>> SEG:GW Mode </code>
2. コマンドモードスイッチコードを使用してコマンドモードに入る
- W55RP20-S2Eが提供するコマンドモードスイッチコードを使用してコマンドモードに入ることができます。
- コマンドモードスイッチコードは、設定ツールで有効化されている場合のみ使用可能です。(デフォルト:有効)
- コ マンドモードスイッチコードは3バイトのHexコードで構成されており、必要に応じて別の値に変更できます。コードはHex値のみ受け付けます。(デフォルト:Hex [2B][2B][2B])
- 設定ツールで「シリアルコマンドモードスイッチコード」が有効か、および3バイトの「コマンドモードスイッチコード」を確認します。
- データUARTポートから「コマンドモードスイッチコード」を入力してモードを切り替えます。
· コマンドモードへの切替時の注意事項は下記参照。
· シリアルコマンドモードで動作している場合、Debug UARTポートで以下のメッセージを確認できます。
· <code>> SEG:AT Mode </code>
- シリアルポートから設定が必要なコマンドとパラメータを入力します。
- [[#ex|EX]]コマンドを使用してデータ伝送モードに切り替えます。
· データ伝送モードで動作している場合、Debug UARTポートで以下のメッセージを確認できます。
· <code>> SEG:GW Mode </code>
-
データUARTポートによるコマンドモードスイッチトリガコード
-
文字列 '+++'
トリガコードを使用してコマンドモードを切り替える際はご注意ください。
- 「コマンドモードスイッチコード」の開始と終了には、**少なくとも500ms**の時間間隔が必要です。これによりスイッチコードとして認識されます。
- 「3バイトコマンドモードスイッチコード」の各バイト間の入力時間は**500ms未満**でなければなりません。
- コマンドモードスイッチコードの末尾にCRやLFを追加しないでください(逆に、モード切替後のシリアルコマンドは必ずCRまたはLFで終了してください)。
- 上記1と2のデフォルト値は**500ms**です。これらの値は、シリアルデータパッキングオプションのタイマー値が設定されている場合、そのタイマー値に変更されます。
シリアルコマンドフレーム形式
各コマンドの末尾にはCRおよびLFを必ず含めてください。複数のコマンドを同時に入力する場合も、各コマンドの末尾にCRおよびLFを含める必要があります。
Getリクエスト
[2バイトコマンドコード] [CR] [LF]
- パラメータなしでコマンドを入力してください。
- コマンドに関連する応答が返されます。
設定リクエスト
[2バイト コマンドコード] [パラメータ] [CR] [LF]
- 設定したいコマンドおよびパラメータを入力してください。
- 特に応答はなく、コマンドに関連するフィールド値が即座に変更されます。
- 設定を保存するには**SVコマンドを、IP割り当て方式やその他初期動作の変更にはRT**コマンドを使用してください。
* 注: UARTコマンドのエコーバックは**EC**コマンドで確認できます。
Ethernetネットワークを利用したデバイス制御
ユーザーは、下記のコマンドを用いてEthernet経由でW55RP20-S2Eを制御または監視できます。コマンド送信にはUDPまたはTCPClient を使用し、コマンド処理用のポート番号は50001です。
コマンド送信用ネットワーク情報: UDP / TCPサーバー : 50001(ユーザーはデバイスに対しUDP/TCPClient でコマンド送信が可能)
Ethernetコマンドフレームフォーマット
W55RP20-S2EをEthernet経由で制御する際は、コ マンドコード送信前に2つの追加コマンドが必要です。他の設定や動作は、データUARTポート経由でシリアルコマンドコードを送信する場合と同じです。
追加される2つのコマンドはMAとPWです。
-
[MA] コマンド
-
このフィールドは製品のMACアドレスを示します。
-
TCPおよびUDPいずれの場合も、2バイトのMAコマンドの後に6バイトのMACアドレスを含める必要があります。
-
ユーザーがUDP経由でGetリクエストのみをブロードキャストしたい場合、該当フィールド値をブロードキャストMACアドレスに設定可能です。複数のピアから応答を受け取れます。設定ツールの検索機能はこのように実装されています。
-
[PW] コマンド
-
デバイスコマンド処理のため、ユーザーはUDPまたはTCPClient を使用する必要があります(UDPまたはTCPサーバーが動作中)。
-
データはブロードキャストIPアドレス255.255.255.255に送信され、同一ネットワーク内のすべてのピアに送信可能です。
-
FF:FF:FF:FF:FF:FF
-
0x20の16進数はASCIIコードで空白を意味します。
Getリクエスト
単一コマンド送信時
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] [Command] [CR] [LF]
複数コマンド送信時
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] ([Command] [CR] [LF]) * コマンド数
- ‘Getリクエスト’の応答は、‘リクエスト’と同一形式でパラメータが含まれます。
設定リクエスト
単一コマンド送信時
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] [Command] [Parameters] [CR] [LF]
複数コマンド送信時
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] ([Command] [Parameters] [CR] [LF]) * コマンド数
- ‘設定リクエスト’では、製品設定変更に対する追加応答は不要です。
- 変更後の設定を確認したい場合は、‘設定リクエストフレーム’の最後にパラメータなしのコマンドを送信してください(Set+Getリクエスト形式)。
Ethernetコマンド例
例1:UDP Getコマンドフレーム
- UDP経由で複数デバイスからMACおよびローカルIPを取得する場合
- Search IDは未使用
ユーザーからのリクエスト |
---|
コマンドフレーム
MA [FF FF FF FF FF FF] [CR] [LF] PW [ ] [CR] [LF] MC [CR] [LF] LI [CR] [LF]
コマンドフレームのHexコード版
4D 41 FF FF FF FF FF FF 0D 0A 50 57 20 0D 0A 4D 43 0D 0A 4C 49 0D 0A
W55RP20-S2Eからの応答 |
---|
- ‘Getリクエスト’の応答は‘設定リクエスト’と同じ形式です。
コマンドフレーム
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] MC [00 08 DC 00 00 11] [CR] [LF] LI [192.168.11.2] [CR] [LF]
コマンドフレームのHexコード版
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4D 43 00 08 DC 00 00 11 0D 0A 4C 49 31 39 32 2E 31 36 38 2E 31 31 2E 32 0D 0A
例2:TCP Getコマンドフレーム
- MACアドレスが00:08:DC:00:00:11のデバイスのローカルIPをTCP経由で取得する場合
- Search IDは未使用
ユーザーからのリクエスト |
---|
コマンドフレーム
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] LI [CR] [LF]
コマンドフレームのHexコード版
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4C 49 0D 0A
W55RP20-S2Eからの応答 |
---|
コマンドフレーム
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] LI [192.168.11.2] [CR] [LF]
コマンドフレームのHexコード版
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4C 49 31 39 32 2E 31 36 38 2E 31 31 2E 32 0D 0A