キッティングツール

はじめに

本書では、KC4-C-100A/KC-4-C-101Aのキッティングツールをご利用する方に操作方法を説明します。

キッティングツールでできること

キッティングツールでは本製品に対して、以下の操作が可能です。

キッティングツール操作中は電源を落とさないでください。

キッティングツールを起動する

PCとデバイスをUSBケーブルで接続して、デスクトップにある「KC4-C-KittingTool.exe」のショートカットをクリックします。

起動まで20秒~40秒ほどかかる場合がございます。※お使いのPCのスペックに依存します。

しばらく待つと以下の画面が表示されます。

apn1

しばらく待つと「デバイス情報確認完了」のポップアップが表示されます。

kitthing_tool2

「一覧」に接続中のデバイスが表示されます。選択すると左下画面にデバイス情報が表示されます。

device

レシピツールを起動する

「はじめよう」の「レシピツール/キッティングツールをインストールする」を参考にレシピツールの準備を行います。

デバイスをPCと接続した状態で、以下の「レシピツール起動」をクリックします。

recipe1

しばらくするとブラウザでレシピツールが表示されます。

browser

デバイスをPCと接続していない状態でキッティングツールを起動した場合でもレシピツールの起動/終了が可能です。ただし、デバイス情報をブラウザに渡せないため、製品名とレシピエンジンのバージョンを手動で入力いただく必要があります。

レシピツールを終了する

以下の「レシピツール終了」をクリックします。

レシピツールが終了します。
recipe2

レシピ実行ファイルを書込む

以下の「レシピ更新」をクリックします。

recipe_make

次の画面に切り替わります。

  1. 「選択」でレシピツールで作成したレシピ実行ファイルを選択します。
  2. レシピ実行ファイルを書き込みたいデバイスを選択します。複数台選択が可能です。
  3. 「書込む」をクリックします。

kitthing_tool5

次の画面が表示されますので「OK」をクリックしてください。

レシピ実行ファイルの書込みが始まります。

kitthing_tool6

書込みが完了したら次の画面が表示されますのでしばらくお待ちください。

この画面が表示されたらレシピ実行ファイルの書込みは完了です。

kitthing_tool7

設定値の読込み・書込み・設定ファイル出力

以下の「設定値読込み/書込み」をクリックしてください。

apn2

「設定値読込み/書込み」をクリックすると『はじめに設定を読込むデバイスを選択し、「読込み」を実行してください』とポップアップが表示されますので、「OK」をクリックしてください。

read_settins_data_popup

読込みたいデバイスを選択し、「読込み」をクリックすると設定値の読込みが開始されます。

read_settins_data_device2

読込みが完了した後「設定値読込み完了」のポップアップが表示されますので「OK」をクリックしてください。

read_settins_data_device_comp

また、設定値をファイル出力して保存ができます。「設定ファイル出力」をクリックするとJSONファイルとして設定値が出力できます。

このファイルを利用して、別の製品に設定を書込みを行うこともできます。「設定ファイル読込み」をクリックして、出力したJSONファイルを選択してください。

次に、「書込み」をクリックすると、デバイスに反映されます。

パスワードを設定する

デバイスには操作を制限するためにパスワードを設定することができます。パスワードが設定されている製品はパスワードを解除しないかぎりキッティングツールでの操作ができません。
なお、初期状態では、パスワードは設定されていません。

パスワードを設定するには、以下の「パスワード設定」をクリックします。

password

次に以下の手順でパスワードを設定します

  1. パスワードを設定したいデバイスを選択します。複数台選択が可能です。
  2. パスワードを入力します。入力する文字は、半角英字の大文字小文字と数字、記号(/*+-.,!#$&()~|)をそれぞれ1文字ずつ含む、最低8桁~16桁となります。
  3. 設定をクリックします
  4. 画面が表示されますので、「はい」をクリックします

「パスワード設定完了しました」の表示がでたら設定は完了です。

パスワード設定をクリアするには以下「設定したパスワードをクリアする」のチェックをつけて、設定をクリックしてください。

password_clear

パスワードを解除する

パスワードがかかっているデバイスに対して操作を行うためにはパスワードを解除する必要があります。

解除をする方法は複数台をまとめて解除する方法と個々に解除する方法の2つがあります。

password_kaijo

(A)一括で解除

①「パスワード(一括)を使用する」にチェックを入れて、②パスワード(一括)にパスワードを入力して「更新」をクリックします。

パスワードが一致しているデバイスのロックを解除することができます。ただし、パスワード(個別)が記載されているデバイスについては、パスワード(個別)でロックを解除します。

(B))個別で解除

③パスワード(個別)にパスワードを入力して[確定]をクリックします。

次に、④の更新でデバイス情報を更新しますと、パスワードが一致してロック解除できたら認証のステータスが「ロック解除済み」と表示されます。

ファームウェアを更新する

ファームウェアの修正があった場合に更新(書込み)することができます。

※ファームウェア入手先について

最新のファームウェアを弊社ホームページに掲載いたします。

以下の[ファームウェア更新]をクリックします。
firmware1

以下の手順で書込みます

①「選択」で書込むファームウェアを選択してください

②更新(書込む)したいデバイスを選択します。複数台選択が可能です。

③「書込む」をクリックして更新を開始します。
firmware2

次のポップアップが表示されますので、「OK」をクリックしてください

firmware3

書込み完了の旨のポップアップが表示されたら書込み完了です

firmware4

ログの取得

本ツールからデバイス内のログを取得(吸出し)することができます。

log

ログは以下の3種類があり、それぞれ取得できます。

種類 ログの説明
FLASHログ(初期出力) デバイスの動作情報がログに保存されます。
FLASHログ(ユーザーログ) お客様が追加したログが保存されます。
FATALログ 致命的なデバイス異常を検知した後、デバイスが復旧の為のリセットを実施した場合にログが保存されます。

※ログは古い情報のログメッセージから自動的に削除されます。
※2000件/日を超えたログは保存されません。

設定値の内容について

設定値の内容について説明いたします。

APNの設定

使用するSIMに応じて設定するAPNの設定情報が異なります。各SIM購入(契約)先に記載されていますのでそちらから設定情報を入手してください。また、FOTA通信とレシピ用通信の通信費を分けるなどの特別な要望がない場合は「FOTA用APN」、「レシピ用APN」に同じ設定値を入力してください。

APNには、PDP TypeAPNを「,」区切りで入力します。

認証パラメータには、IDPasswordおよび認証タイプ(認証方法)を「,」区切りで入力します。

APNの設定には、PDP Type認証タイプの設定があります。以下に各種類と設定値の対応表を記載します。

PDP Typeの種類

PDP Type 設定値
IPv4(IP) 1
IPv6 2
IPv4v6 3

認証タイプの種類

認証方法 設定値
なし 0
PAP 1
CHAP 2
PAP or CHAP 3

設定例

APNの設定情報が上記の場合、APNは「1,"testAPN"」、認証パラメータは「"testuser","testpw",3」となります。

set_apn_data2

設定が終わったら、「書込み」をクリックしてください。

set_apn_data_end2

確認ポップアップが出ますので「OK」をクリックすることで、端末への書込みが開始されます。

set_apn_data_end_dialog

書込みが完了すると「設定値書込み完了」のポップアップが出ますので、「OK」をクリックしてください。

set_apn_data_complete_dialog

これで、APNの設定が完了となります。

FOTA

キッティングツールのFOTAに関係する項目を説明します。

SoftBank社のSIM挿入時は本設定に関わらず通信機能のファームウェア更新が動作する場合があります。

FOTA用APNの設定を除き、工場出荷時の初期設定としてFOTAが動作する設定値が書込まれています。重大な不具合修正等により弊社が配信した更新用ファームウェアのFOTAが適用される場合があります。個別の事情に関わらずFOTAが動作してしまう等の影響がある為、お客様独自の設定値で上書きすることが可能です。

  1. キッティングツールを起動して、 [設定値読込み/書込み] をクリックしてください。
  2. 「はじめに設定を読込むデバイスを選択し、「読込み」を実行して下さい」のポップアップが表示されたら「OK」をクリックしてください。
  3. 読込みたいデバイスを選択し、「読込み」をクリックしてください。
  4. 「設定値読込み完了」ポップアップが表示されたら「OK」をクリックしてください。
  5. 設定項目から[FOTA用APN]を選択してください。

kittingtool_FOTA1_1

  1. 下記説明に従い設定してください。
項目 説明
APN設定 FOTAを利用する場合は[利用する]をチェック、利用しない場合は[利用する]のチェックを外してください。
APN SIMに対応したAPNを設定してください。
認証パラメータ APNに応じた認証パラメータを設定してください。
  1. 設定項目から[FOTA]を選択してください。

kittingtool_FOTA2_1

  1. 下記説明に従い設定してください。
項目 説明
機能のON/OFF FOTAを利用する場合はチェック、利用しない場合はチェックを外してください。
アクセス周期 更新用ファームウェア確認をする周期[秒] ※
サーバURL FOTAサーバのURL。利用可能なサーバURLを設定してください。
ルート証明書 FOTAサーバのルート証明書。pem形式となります。
サーバURLに設定したサーバ向けの証明書を設定してください。

※ 工場出荷状態からの初回電源オン後の最初の圏内ネットワーク接続が行われた際にFOTAが実施されますが、以降はアクセス周期に設定した時間経過毎に更新用ファームウェアの確認が実施されます。FOTA配信前の事前評価用デバイスなどの一時的な短縮を除き、実運用時のアクセス周期は172800[秒](=2日)以上の値を設定してください。

  1. 設定完了後、「書込み」をクリックしてください。

その他

その他、以下の設定が可能です。

パスワードを知らない第三者の利用を防止する為、適切なパスワード管理を行い、チェックは外しておく事を推奨します。

有効にするとシリアル通信が不安定になる可能性があります。

出荷設定に戻す

「出荷設定に戻す」を実施すると、デバイスのレシピ実行ファイルはクリアされ、設定値は工場出荷時の状態に戻すことができます。

上部タブの「その他」から「出荷設定に戻す」をクリックしてください。

reset

次の手順で出荷設定に戻すことができます。

  1. 出荷設定に戻したいデバイスを選択します。複数台選択が可能です。
  2. 「出荷設定に戻す」をクリックします。
  3. 「設定値とレシピ実行ファイルが出荷時にリセットされます。実行しますか?」と表示されたら、「はい」をクリックします。
  4. 一覧が表示され、選択したデバイスのステータスが出荷設定に戻しています...と表示されたら、出荷設定に戻す処理が開始されます。

なお、初期設定ではパスワードが設定されていても、この「出荷設定に戻す」により、強制的にパスワードを削除します。

詳しくは「その他」の「パスワード忘却時強制リセット許容」を参照してください。

reset_password2

操作履歴の出力

キッティングツールにおいて本製品に対して実行した操作の履歴をCSVファイルで出力することができます。

上部タブの「ファイル」から「操作履歴の出力」をクリックして、出力するCSVファイル名を指定してください。

※出力できる操作履歴は、キッティングツールの起動から終了までの履歴となります。ツールを終了すると履歴がクリアされます。
※一度出力するCSVファイルを指定すると、ツールの終了まで自動でCSVファイルが更新されます。
※次回起動時に改めてCSVファイル名を指定する必要があります。

operation_log

以下の操作とその状態が出力の対象です。

以下の項目がCSVファイルで出力されます。

項目 説明
日時 操作の日時
ポート 操作対象デバイスの接続ポート
製品名 操作対象デバイスの製品名
IMEI 操作対象デバイスの識別番号
レシピID 操作対象デバイスに書き込まれているレシピID
レシピエンジン 操作対象デバイスのレシピエンジンのバージョン
MCU 操作対象デバイスのMCUファームウエアのバージョン
Bluetooth® 操作対象デバイスのBluetooth®ファームウェアのバージョン
モデム 操作対象デバイスのモデムファームウエアのバージョン
認証 パスワードロックの状態
操作 操作の内容とその状態
操作の備考 レシピ実行ファイルのファイルパス等、操作に関連する情報

その他

制限事項や注意事項

複数台同時更新について

本ツールは以下の操作において複数台同時更新をサポートしています。

サポートする最大数は8台です。

電源の落とし方について

USBケーブルを抜いた後、ボタンを4秒以上押下し電源オフ後に電源ケーブルを抜いてください。
キッティングツール操作中に電源を落とした場合、内蔵メモリのデータが破損し起動出来なくなる場合があります。