Config tool Guide
概要
本ドキュメントは、Config-toolの詳細な使用方法を提供します。
Config Tool対応リストおよびダウンロード
Wiznet Configuration toolは、ネットワーク上の製品に対して検索、設定変更、Firmwareのアップロードなどを行うことができる設定ツールです。
Configuration Toolは、Github上のWIZnetページにてWIZnet-S2E-Tool-GUIという名前で公開されています。 そのリポジトリのリリースページから、実行ファイルの最新版をダウンロードできます。
Pythonで構築されており、どのOS上でも動作します。
- Githubリポジトリ: WIZnet-S2E-Tool-GUI Github repository
- 最新版のダウンロード: WIZnet-S2E-Tool-GUI Github repository: Release
Config Toolのレイアウト
プログラムをインストールして実行すると 、以下の起動画面が表示されます。
 |
| 図: Configuration Tool レイアウト |
設定プログラムは、上記画像のように機能ごとに分けられます。
① 上部アイコンメニュー
- Config Toolの上部に位置し、製品の検索、Firmwareのアップロード、再起動、初期化などが行えます。
 |
| 図: アイコンメニュー |
-
1) Device検索
-
同一ネットワーク上に接続されたDeviceを検索します。
-
UDPブロードキャスト（ネットワーク内のモジュールを検索、複数モジュール製品が検索可能）およびTCPユニキャスト（単一モジュールの検索）で検索できます。
-
ネットワークを利用したDevice検索はTCP/UDPポート50001を使用します。ファイアウォールやウイルス対策ソフトがそのポートをブロックしている場合、Device検索が失敗 することがあります。
-
その場合は、テストの前にファイアウォールやウイルス対策ソフトを無効にすることを推奨します。
-
複数のネットワークアダプタを使用している場合、ネットワークインターフェースのメトリック優先度によってパケット転送が失敗することがあります。
OSの設定で使用しているネットワークアダプタ以外を無効にして再度テストしてください。
VMwareやVirtual Boxなどの仮想マシン（VM）を使用している場合、VMのネットワーク用に作成された「仮想イーサネットアダプタ」によってこの状況が発生することがあります。
VMwareやVirtual Boxなどの仮想マシン（VM）を無効にするか、TCPユニキャストで検索してください。 -
2) 設定適用
-
変更した設定を保存し、Deviceに適用します。
-
設定変更が成功すると、Config-toolに反映されます。
-
操作完了後、製品は自動的に再起動します。
-
3) Firmwareアップロード
Firmwareアップロード中は絶対に電源を切らないでください 製品が故障する原因となります
- 製品Firmwareを更新するためにWiznetから提供されたFirmwareバイナリファイルを選択します。
- 操作完了後、製品は自 動的に再起動します。
- Firmwareアップロードが成功すると、以下のメッセージがポップアップ表示されます。
 |
| 図: ポップアップメッセージ - Firmwareアップロード成功 |
-
DeviceFirmwareをネットワーク経由でアップロードする機能はTCPポート50002を使用します。 ファイアウォールやウイルス対策ソフトがそのポートをブロックしている場合、DeviceFirmwareのアップロードが失敗することがあります。
その場合は、テストの前にファイアウォールやウイルス対策ソフトを無効にすることを推奨します。 -
Firmwareを更新する際は、Config-toolを実行しているPCのIP帯域がDeviceと一致している必要があります。
DHCPモード（自動IP割り当て）を使用する場合、PCと製品の両方が同じルーターからIP割り当てを受けるようにしてください。
スタティックモード（直接IP割り当て）を使用する場合は、以下の例のように設定してください。
例) DeviceIP : 192.168.11.2
PC IP: 192.168.11.3（同じクラスCプライベートIP帯域内の別のIPアドレス） -
誤ったFirmwareでアップロードを行った場合、製品の正常動作は保証できません。
-
4) Deviceリセット
-
選択したDeviceを再起動します。
-
5) 工場出荷時リセット
-
Deviceの設定を工場出荷時のデフォルト値にリセットします。
-
操作完了後、Deviceは自動的に再起動します。
-
6) 設定保存
-
選択したDeviceの現在のすべての設定をファイルに保存します。
-
環境変更による再設定や、現在の設定を他のDeviceに適用する際に便利です。
-
7) 設定読込
-
設定保存機能で保存したファイルから設定を読み込みます。
-
読み込み後、「設定適用」ボタンを押すことで設定をDeviceに適用できます。
-
8) 終了
-
Configuration toolを終了します。
② ネットワークインターフェース設定
- 複数種類のネットワークアダプタを使用している場合、アダプタの一覧と使用中のバンドが表示され、環境に応じて使用するネットワークバンドを選択できます。
 |
| 図：ネットワークアダプタ |
③ 検索されたDevice一覧
 |
| 図：Deviceリスト |
- 検索機能で見つかったDeviceの一覧が表示されます。
- 検索結果には見つかったDeviceの数が表示されます。
- 各DeviceはMACアドレスとDevice名で識別されます。
- 見つかったDeviceをクリックして選択できます。
④ 検索IDコード & 検索方法
 |
| 図：検索IDコード & 検索方法 |
- 検索IDコード
- 検索識別コードが設定されている場合、ここにコードを入力します。
- 製品リストに表示する製品を検索する 際には、同じコードを入力する必要があります。
- 検索方法
- 製品の検索方法を選択します。
- デフォルト値はUDPブロードキャストです。
- UDPブロードキャストはネットワーク内のモジュールを検索でき、複数のモジュール製品を検索することが可能です。
- TCPユニキャストは特定のDeviceのIPとポート50001を使用して、1台のDeviceのみを検出します。
ルーターのポートフォワーディング機能と併用することで、ローカルネットワーク外からDeviceの検出や設定変更が可能です。
⑤ Statusバー
 |
| 図：Statusバー |
- 検索アクションの進行状況や結果を表示します。
複数のDeviceがある場合、選択したDeviceのMACアドレスがまとめて表示されます。 - Firmwareアップデート実行時は進行状況バーも表示されます。
⑥ 一般Option
- 製品詳細設定の表示および変更
- 基本設定 / Option / MQTTOption / 証明書マネージャタブで設定（W55RP20-S2E時点）
| |
| ------------------------------------------------------------------------------------ |
|
|
| 図：基本設定タブ |
1) Device情報
- Typeには選択したDevice名、VersionにはDeviceのFirmwareバージョンが表示されます。
2) 検索識別コード
- 範囲および区切り文字：最大8バイトの文字列
- デフォルト：Null（使用しない）
- 検索識別コードは、製品検索時の識別用Optionです。
- このOptionを設定した場合、製品検索時に同じコードを入力しないと検出されたDevice一覧に表示されません。
3) ネットワーク設定
- Static（デフォルト）
- Static IPアドレス割り当てモードを選択します。このOptionを選択すると、ローカルIP、サブネットマスク、ゲートウェイ、DNSサーバの入力欄が有効になります。
パブリックIPアドレスとプライベートIPアドレスの両方を設定できます。 - TCPClientまたはTCPミックスモードを使用する場合、転送先のホストがIPアドレスではなくドメイン名の場合はDNSアドレスの設定が必要です。
- DHCP
- ルーター（NATルーター）内蔵のDHCPサーバを通じて自動的にIPアドレスを取得する方式です。
一般的にはルーターの動的IP割り当て範囲からプライベートIPアドレスが割り当てられますが、パブリックIPアドレスの割り当ても可能です。 - DHCPサーバ側でIPアドレス、ゲートウェイアドレス、サブネットマスク、DNSアドレスが全て割り当てられるため、設定は不要です。
 |
| 図：Optionタブ |
1) TCPタイムアウト
- TCP再送リトライ回数を設定できます。
- 値：1～255
2) Statusピン
- フロー制御機能DTR、DSRを有効にします。
3) シリアルデバッグ
- このOptionを設定すると、デバッグUARTが製品情報やエラー状況を出力します。
- デバッグUARTのシリアル設定は921600-8-N-1:Noneで固定されています。
- Enable with DataOptionを設定すると、Serial to Ethernet（S2E）やEthernet to Serial（E2S）のデータを監視できます。
4) シリアルコマンドモード
- チェックを入れると、シリアルデータ受信中にコマンドモード切替コードを受信した場合、データ転送モード（GWモード）からシリアルコマンドモード（ATモード）に切り替わります。デフォルト：有効
- シリアルコマンドモードでは、2バイトのシリアルコマンド（AT CMD）を使用して製品の各種設定を変更・監視できます。
- シリアルコマンドモードに切り替えると、既存のTCP接続は切断されます。
- トリガーコード
- 設定されたトリガーコードをシリアルデータとして入力するとATモードになります。
- デフォルト：[2B][2B][2B]（+++）
- 各バイトの値はHEXコードのみ認識します。
5) 接続パスワード（TCPサーバーモードのみ）
- 最大8バイトの文字列
- デフォルト：Null（使用しない）
- 接続パスワードはTCPサーバーモードでのみ 有効（TCPミックスモードでTCPサーバーとして接続時も可能）
- TCPClientがDevice接続後5秒以内に接続パスワードを送信しない場合、自動的にTCP接続が切断されます。
 |
| 図：MQTTOptionタブ |
1) MQTT認証情報
- ユーザー名、パスワード
- 最大128文字
- 空白設定可能
2) MQTTOption
- ClientID
- 最大128文字
- 空白設定可能だが非推奨
- Keep-Alive
- 0～65535で設定可能
- 未使用時は0に設定
- QoS
- 0,1,2から選択可能
3) MQTTTopic
- パブリッシュTopic
- 最大128文字
- SubscribeTopic
- 最大128文字
- SubscribeTopicは最大3つまで
 |
| 図：証明書タブ |
1) ルートCA
- Option：None、Optional、Verifyの3つから選択可能
- ファイル読み込み：保存済みのルートCAファイルを読み込む
- Deviceに保存：インポートしたファイルをDeviceに保存
2) Client証明書
- 有効化チェックボックス：チェックで有効化
- ファイル読み込み：保存済みのClient証明書ファイルを読み込む
- Deviceに保存：インポートしたファイルをDeviceに保存
3) 秘密鍵
- ファイル読み込み：保存済みの秘密鍵ファイルを読み込む
- Deviceに保存：インポートしたファイルをDeviceに保存
⑦ チャンネルOption
 |
| 図：チャンネルタブ |
1) Status & シリアルインターフェース
- Status
- BOOT：ブートエントリ状態で、製品の設定やFirmwareのアップデートが可能
- OPEN：TCP接続確立前の状態
- CONNECT：TCP接続確立
- UPGRATE：Firmware更新またはDHCP IP割り当て中
- ATMODE：シリアルATコマンドモード状態
- UDP：UDPモード状態
- シリアルインターフェース
- シリアルインターフェースの種類
2) 動作モード
- Deviceのネットワーク動作モードを設定します
- アプリケーションや目的に合わせて4つのモードから選択できます：TCPClientモード、TCPサーバーモード（デフォルト）、TCPClient/サーバー混合モード、UDPモード
- TCPClient
- 指定された宛先（TCPサーバー）にTCP接続を試み、接続が成功した場合は接続先のTCPサーバーと通信します。
- TCPサーバー
- TCPClientからの接続要求を待ち受け、Clientからの接続要求を受信するとTCP接続を確立し、接続が成功した場合にデータの送受信が可能です。
- TCP MIX
- TCPサーバーとして動作し、設定後にTCPClientからの接続を待機しているとき、シリアルデータが入力されると、
TCPサーバーモードを終了してTCPClientモードに切り替わり、入力されたリモートホストのIPアドレスとポートに接続してTCP接続を確立します。
TCP接続後、設定した時間（アイドルタイマー）内にデータの送受信が行われない場合、DeviceはTCPサーバーから切断され、TCP MIXモードの初期動作状態であるTCPサーバーモードで動作します。
- UDP
- 1:1 UDPモード
- 設定したリモート宛先ホストアドレス（ドメイン名）およびポート番号に通信します。
- 1:N UDPブロードキャスト
- リモートホストIPを192.168.x.255に設定すると、Device上でリモートポートが開いている192.168.x帯のDeviceにデータをブロードキャストできます。
- 1:N UDPレスポンスモード
- リモートホストIPが0.0.0.0に設定されている場合に利用可能です
- 送信元宛先にデータを送信できます
他の宛先からデータを受信した場合、新しい宛先アドレスに切り替わります - 複数のUDP宛先からデータが送信され、それにシリアルDeviceが応答するアプリケーションで利用できます。
3) ローカルポート、リモートホスト／ポート
- ローカルポート
- Deviceが開くポート
- リモートホスト
- Client時にDeviceが接続する宛先のIP（サーバーのIP）
- リモートポート
- DeviceがClient時に接続する宛先のポート（サーバーが開いているポート）
4) シリアルOption
- ボーレート
- 300、600、1200、1800、2400、4800、9600、14400、19200、28800、38400、57600、115200（デフォルト）、230400に対応
- データビット
- 7、8（デフォルト）に対応
- パリティ
- NONE（デフォルト）、ODD、EVENに対応
- ストップビット
- 1（デフォルト）、2に対応
- フロー制御
- NONE（デフォルト）：フロー制御を使用しない
- XON/XOFF：ソフトウェアフロー制御
- CTS/RTS：ハードウェアフロー制御
5) シリアルデータパッキング条件
- シリアルデータをユーザーの条件に合わせて収集・送信できる様々なシリアルデータパッキングOption
利用することで、ユーザーコマンドフレームや一度に送信する必要がある周期データなどをまとめて送信できます。 - 優先順位はキャラクター => サイズ => タイマーで、重複設定も可能です
- タイマー
- 0～65535(ms)、デフォルトは0（未使用）
- 指定時間データをバッファに貯めて一括送信します
- サイズ
- 0～255(byte)、デフォルトは0（未使用）
- 指定したデータサイズに達するまでバッファにデータを貯め、到達時に一括送信します
- キャラクター
- 1バイトキャラクター（16進コード）、デフォルトは0（未使用）
- 指定キャラクターが入力されるまでバッファにデータを貯め、指定キャラクターがデータ内に含まれる場合、指定キャラクターを含めて一括送信します。
バッファサイズを超えた場合は、指定キャラクターを除いたデータのみ送信します。
6) タイマー間隔
- アイドルタイマー
- 0～65535(s)、デフォルトは0（未使用）
- アイドルタイマーを設定すると、最後のデータ転送以降、指定時間データ送信がなければ接続を終了します。
- UDPには適用されません
- 再接続間隔
- 0～65535(ms)、デフォルトは3000（3秒適用）
- 再接続間隔は、TCPClient動作（TCP MIX内のTCPClientを含む）でTCP接続再試行の間隔を決定します。
- TCP接続試行が失敗した場合の再接続試行にはこのOptionが必要です。
- 最低1ms以上に設定してください。
7) TCPKeep-Alive間隔
- このOptionを有効にすると、製品がTCPモード（TCPサーバー、TCPClient、TCP MIXを含む）で動作している際にKeep-Aliveパケットを送信し、接続性を維持します。
- Keep-Aliveパケットに応答がない場合、TCP接続は切断されます（ソケットクローズ／切断）。
- Deviceは少なくとも1つのイーサネットパケ ットを送信した後にKeep-Aliveパケットの送信を開始します。
- イーサネットネットワーク機器はリモート機器の物理的な切断を検出できないため、問題発生時にTCP接続を確実に終了できるよう、このOptionの有効化を推奨します。
特にTCPサーバーモードで動作する場合、Keep-Aliveパケット送信設定がないと、リモートDeviceが物理的な切断中にシャットダウン／再接続を行った際、既存接続を終了できない状況になる可能性があります。 - 初回間隔
- 0～65535(ms)、デフォルトは7000（7秒適用）
- 最初のKeep-Aliveパケット送信前の間隔
- リトライ間隔
- 0～65535(ms)、デフォルトは5000（5秒適用）
- 各Keep-Aliveパケット送信間の間隔
8) タイムアウト
- 0～60000(ms)、デフォルトは2000（2秒適用）
- 指定時間内にSSL応答がない場合、タイムアウトを発生させます
- SSL TCPClientモードでのみ動作します