JetBrains CLion + PlatformIO (macOS)¶

PlatformIO を macOS 上で JetBrains の C/C++ 開発用 IDE である CLion から使う方法についてごく簡単に整理してみました。

以下の記事を参考にさせて頂きました。インストール後の使い方についてはこちらのほうが詳しく記述されていますのでこちらも合わせてご参照ください。

CLionでPlatformIOを使って、M5StackのHello Worldを作るまで

インストール¶

Python 3 のインストール¶

Homebrew でインストールする場合

brew install python

PlatformIO Core のインストール¶

PlatformIO の CLI 版である PlatformIO Core をインストールします。こちらも Homebrew でインストールできるようですが、システムを汚したくない場合は推奨手順に従ってインストーラースクリプトを使います。これにより、ホームディレクトリの ~/.platformio/ 配下にインストールされます。

python3 -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"

次に、インストールしたシェルコマンドを使うためパスを設定します。手順に従って、~/.platformio/penv/bin にインストールされたコマンドに ~/.local/bin からリンクします。

ln -s ~/.platformio/penv/bin/platformio ~/.local/bin/platformio
ln -s ~/.platformio/penv/bin/pio ~/.local/bin/pio
ln -s ~/.platformio/penv/bin/piodebuggdb ~/.local/bin/piodebuggdb

その上で、~/.local/bin にパスを通します。(Bash なら ~/.bash_profile など)

export PATH="${HOME}/.local/bin:${PATH}"

PlatformIO for CLion プラグインのインストール¶

CLion に PlatformIO for CLion プラグインをインストールします。

PlatformIO for CLion

プロジェクトの作成¶

プロジェクトを新規作成¶

メニューの File > New > Project... から、新規プロジェクトを作成します。ターゲットに「PlatformIO」、Board に開発対象のデバイスを選択します。

New Project

既存のプロジェクトを開く¶

メニューの Open > Open... から、既存の PlatformIO プロジェクトのディレクトリを選択します。初めて CLion で開く場合、以下のように CMakeLists.txt を作成するか聞かれます。これは CLion でビルドおよびコード解析をおこなうために必要なファイルですので、「Yes」を選択します。

Create Makelists.txt

CLion での PlatformIO 管理について¶

CLion でビルドおよびコード解析をおこなうためには CMakeLists.txt および CMakeListsPrivate.txt というファイルが追加で必要になります。このファイルは、PlatformIO 用のプロジェクト設定 platformio.ini を元にして自動的に生成されます。必要なライブラリを追加するなど platformio.ini に変更があった場合はメニューから Tool > PlatformIO > Re-Init を実行することで更新します。手動で編集する必要もないため、gitignore に追加してコミット対象外にしておくと良いでしょう。

.gitignore 追加例

.idea
cmake-build-*
CMakeLists*.txt

PlatformIO プロジェクト設定¶

PlatformIO プロジェクトに対する各種設定は、CLion から離れて別途 PlatformIO のホーム画面からおこないます。

CLI から platformio home コマンドを実行するか、CLIon メニューの Tools > PlatformIO > Home から PlatformIO のホーム画面を表示します。設定用の Web サーバーがローカル PC 上で動作し、ブラウザを UI としてアクセスします。

注意点として、CLion で作成または開いたプロジェクトはそれだけでは認識されないようです。PlatformIO ホーム画面の「Import Arduino Project」で管理したいプロジェクトを一覧に取り込む必要があります。

プロジェクトの設定に変更を加えた場合は、CLion のメニューから Tool > PlatformIO > Re-Init を実行して設定を反映 (CMakeLists.txt ファイルを更新) してください。

基本操作¶

ファームウェアのビルド¶

Run/Debug Configurations の「PlatformIO Debug」を実行することで、ソースコードからファームウェアを作成します。

Build

ファームウェアの書き込み¶

Run/Debug Configurations の「PlatformIO Upload」を実行することで、ファームウェアをデバイスに書き込みます。

Upload