VSCodeでArduino

2024年1月12日

2024年2月8日

インストールおよび環境設定

VSCodeへのインストール

VSCodeにArduino拡張を入れるためには、通常のVSCodeの拡張を入れるのと同じ手順です。

つまり、

左側のメニューの拡張をクリックするか、Shift + Control + Xを押すかすると、拡張の一覧が出て来ますので、そこでインストールを選択すれば入ります。

インストール自体は割とすぐに終わります。

この時、arduino-cliもセットでインストールされます(つまりバンドルされています)。

また、arduino-cli config initも同時に行われていて、~/.arduino5/が作成され、そこに必要なファイルが置かれます。この環境は自分でarduino-cliをインストールした時のものと同じですから、たとえば既にarduino-cliの環境を作っている場合は、それが使われます。

ただし、何もしないでいるとarduino-cliはバンドルされたもの(ちょっと古かったりする)が使われますので、それを使わないで自分のインストールしたarduino-cliを使いたい場合は、環境設定でその旨を指定してやる必要があります。

ssh環境でのインストール

Remote - SSH拡張を入れていて使っている状態になっていると、拡張はsshの先に入ります。これは何が起きるかと言えば、sshの先のコンピュータ上でArduinoの開発が行えるということです。

私の環境の例で言えば、VSCodeはWindowsデスクトップの上で動いていますが、開発するためのコンピュータはsshで接続した先のOrange Pi 5です。この上では色々なものを開発していますが、Arduinoの開発もその上で行っています。ターゲットのボードもこの先につながっています。

これがこのままWindowsのVSCodeの上から操作できると都合が良いのですが、VSCodeのArduino拡張は、Remote - SSH拡張とセットで使えば、これが自動的に実現できるわけです。

なお、Remove - SSH拡張は接続先に独自の環境を作ります。これは~/.vscode-server/extensions/の下に作られます。バンドルされたarduino-cliもこの下に置かれています。

環境設定

環境設定も他の拡張と同じように、「環境設定」を開くとメニュー形式で設定可能です。

以下はその設定項目です。

オプション	説明
arduino.useArduinoCli	Arduino CLIを使用するか(`true`) 、従来の Arduino IDEを使用するか(`false`) - デフォルトは`true`です(最新版)。バンドルされたバージョンの Arduino CLI を使用するためには`arduino.path`と`arduino.commandPath`値を未設定のままにするか、Arduino CLIのカスタムバージョンを指すようにします。
arduino.path	Arduino インストールへのパス。この設定を変更してフルパスを含めることで、Arduinoのカスタムバージョンを使用できます。例: `C:\\Program Files\\Arduino`(Windowsの場合)、`/Applications`(Macの場合)、`/home/<username>/Downloads/arduino-1.8.1`(Linuxの場合)。変更後は再起動が必要です。デフォルト値は、従来の Arduino IDEインストールパスから自動的に検出されます。Arduino CLI を使用するには、arduino-cli実行可能ファイル (例: `/usr/local/bin`)を含むパスを使用するか、バンドルされたバージョンの Arduino CLI を使用するように未設定のままにしておきます。
arduino.commandPath	`arduino.path`を基準にした実行可能ファイル(またはスクリプト)への相対パス。デフォルト値は`arduino_debug.exe`(Windows)、`Contents/MacOS/Arduino`(Mac)、`arduino`(Linux)の場合です。この設定を変更することで、カスタム起動スクリプトを使用して Arduino を実行することもできます。(変更後は再起動が必要です) 例: `run-arduino.bat`(Windows)、`Contents/MacOS/run-arduino.sh`(Mac)、`bin/run-arduino.sh`(Linux)の場合。Arduino CLIのバンドルバージョンを使用するには、このオプションを未設定のままにしておきます。Arduino CLIのカスタムバージョンを使用するには、`arduino-cli`を使用します。
arduino.additionalUrls	サードパーティパッケージの追加のボードマネージャーのURLを文字列配列として指定すます。デフォルト値は空です。
arduino.logLevel	CLI出力ログレベル。`info`または`verbose`。デフォルト値は`info`です。
arduino.clearOutputOnBuild	アップロードまたは検証する前に、出力ログをクリアする。デフォルト値は`false`です。
arduino.allowPDEFiletype	VSCodeのArduino拡張機能で Arduino の 1.0.0 より前のバージョンの .pde ファイルを開くことができるようにします。デフォルト値は`false`です。
arduino.disableTestingOpen	オープンステータスをチェックするためのシリアルポートへのテストメッセージの自動送信を有効/無効にします。デフォルト値は`false`(テストメッセージが送信されます)です。
arduino.disableIntelliSenseAutoGen	`true`の場合、vscode-arduinoはArduinoのコンパイラー出力を分析してtrueIntelliSense設定(例えば`.vscode/c_cpp_properties.json`)を自動生成しません。
arduino.analyzeOnOpen	`true`の場合、プロジェクトを開いたときに自動的に分析が実行されます。`arduino.analyzeOnSettingChange`が`true`の場合にのみ機能します。
arduino.analyzeOnSettingChange	`true`の場合、ボード、構成、またはスケッチ設定が変更されたときに解析が自動的に実行されます。