SiFli CodeKit¶
SiFli CodeKitは、SiFli-SDK開発向けのVS Code拡張機能です。SDKツールのインストール、ボードの選択、サンプルのビルド、ファームウェアの書き込み、シリアルコンソールを開くといった操作をガイド付きで実行できます。
IDEでの操作を希望する場合は、この手順を使ってください。各ボタンで実行されるコマンドを確認したい場合は、SiFli-SDKの手動セットアップガイドを参照してください。
このページは初回セットアップ向けです。hello_worldが動作したら、CodeKitの普段の使い方、開発環境を再現するための要件、対応範囲と障害時の切り分け方をCodeKitツールリファレンスで確認してください。
必要なもの¶
ハードウェア
- SiFli-SDKが対応するSF32開発ボード。
- ボードのUSB-to-UARTポートに接続するUSB Type-Cデータケーブル。
- Windows、macOS、またはLinuxを実行するコンピューター。
ソフトウェア
- Visual Studio Code
- SiFli CodeKit拡張機能。
- CodeKitがSiFli-SDKのクローンまたはインポートを求める場合はGit。
公式リファレンス
CodeKitのインストール¶
- VS Codeを開く。
- Extensionsを開く。
- SiFli-SDK-CodeKitを検索する。
- 拡張機能をインストールする。
- 求められたらVS Codeを再読み込みする。
SDK管理を開くには、VS CodeのサイドバーにあるSiFliアイコンをクリックし、SDK Managerを選択します。または、View > Command Palette(既定のショートカットはF1)を開き、Manage SiFli SDK installationを実行します。メニュー名は拡張機能のバージョンによって異なる場合があります。上記リンクの公式インストールガイドも参照してください。
Tip
必要なアクションが見つからない場合は、Command Paletteを開いてSiFliを検索してください。
SiFli-SDKのインストールまたは選択¶
CodeKitのセットアップ手順でSiFli-SDKをインストールするか、すでにクローンしたSDKの場所を指定してください。多くのユーザーには、バージョンが固定され、テスト済みのRelease/Tagが適しています。新しい機能や修正が必要で、安定性が低い可能性を許容できる場合はBranchを選んでください。公式ガイドでは、release/vX.Yは、より不安定なmainブランチを使わずに、そのリリース系列の最新の修正や機能を取り込む方法として説明されています。ただし、その内容は時間とともに変わる可能性があります。
中国本土から利用する場合、公式ガイドではSDKの取得元にGitee、ツールチェーンのダウンロード元にSiFli国内ミラーを推奨しています。
CodeKitがSDKの場所を尋ねてきた場合は、スペースを含まない短いパスを選んでください。例えば次のとおりです。
CodeKitはSDK自体のインストーラーと環境スクリプトを使用します。結果は手動セットアップと一致するはずです。コンパイラー、Python環境、ビルドツール、書き込みツールがまとめて準備されます。
サンプルを開く¶
SDKのhello_worldサンプルから始めます。
そのプロジェクトフォルダーをVS Codeで開きます。CodeKitのプロジェクト取り込みウィザードが表示されたら、hello_worldを選択し、SDKのルートフォルダーを自動検出させてください。
ボードの選択¶
ハードウェアに合ったボード構成を選択してください。SF32LB52-DevKit-LCDクラスのボードの場合、一般的なボード名は次のとおりです。
別のボードを使用する場合は、CodeKitの一覧またはSDKの対応ボード資料から該当するボード名を選択してください。ボード名に応じて、メモリーレイアウト、ピン割り当て、フラッシュ設定、デフォルトの周辺機能が決まります。
ビルド¶
CodeKitのBuildアクションを実行します。ビルドが成功すると、次のようなボード固有の出力フォルダーが作成されます。
ビルドが即座に失敗する場合は、CodeKitがSiFli-SDKのインストール場所を認識しているか、SDK環境のインストールが完了しているかを確認してください。
書き込み¶
USB-to-UARTポート経由でボードを接続し、CodeKitのFlashまたはDownloadアクションを実行します。
シリアルポートの入力を求められたら次のようにします。
- Windowsでは、対応する
COMポートを選択します。 - macOSでは、
/dev/tty.*ではなく/dev/cu.*デバイスを選択します。 - Linuxでは、対応する
/dev/ttyUSB*または/dev/ttyACM*デバイスを選択します。
書き込みツールがUARTダウンロードモードに入れない場合は、転送を始める直前にボードをリセットしてください。それでも解決しない場合は、ボード固有の書き込み手順を確認してください。
シリアルコンソールを開く¶
CodeKitのシリアルモニター、VS Codeのシリアルツール、または別のターミナルプログラムを使用してください。リセット後、コンソールには読み取り可能なブート出力とhello_worldサンプルの出力が表示されるはずです。
読み取れるブートログが表示されれば、ボードとシリアル設定は正しい状態です。文字化けする場合は、ほかのシリアルツールを閉じ、サンプルで使われているボーレートを確認してください。
成功の確認¶
次の条件を満たしたら、次の作業に進めます。
- CodeKitがSDKの場所を認識している。
- 選択したボードがハードウェアと一致している。
- ビルドと書き込みのアクションが完了する。
- リセット後、シリアルコンソールに
hello_worldの出力が表示される。
トラブルシューティング¶
| 症状 | 確認事項 |
|---|---|
| シリアルポートが表示されない | データケーブル、別のUSBポート、またはボードのUSB-to-UARTコネクターを試してください。 |
| CodeKitがSDKを見つけられない | CodeKitのセットアップフローを再実行し、SiFli-SDKのルートフォルダーを選択してください。 |
| ビルド時にツールが見つからない | CodeKitでツールチェーンを再インストールするか、SDKのインストーラーを一度手動で実行してください。 |
| 書き込みが開始しない | ツールがUARTダウンロードモードに入れない場合は、転送直前にボードをリセットしてください。それでも解決しない場合は、ボード固有の書き込み手順を確認してください。 |
| シリアル出力が読み取れない | ボーレートを確認し、開いているシリアルモニターが1つだけであることを確認してください。 |
次に進む先¶
- SiFli-SDKを使って、対応するターミナルコマンドを理解してください。
hello_worldが動作したら、ペリフェラル入門に進んでください。- 実際の製品機能に取り組み始める際は、Bluetooth概要、グラフィックス概要、オーディオ概要、低消費電力の概要を確認してください。
再現可能な構成を記録する¶
CodeKitとSDKのバージョン、選択したリリースタグまたはブランチ、正確なボードターゲットを記録してください。メニューやコマンド名が本ページと異なる場合は、最新の公式インストールガイドと、SDKの対応ボード一覧を、インストール済みのバージョンに対する基準として参照してください。
最終更新: