🐝

Visual Studio CodeでMicropython開発環境構築

2022/10/06に公開

はじめに

この記事ではVisual Studio Code(以下、VSCodeと略します)を使ってESP32の開発環境を構築する方法について記述しています。

VSCodeはMicrosoft社が開発したコードエディタの一つで、Mac、Windows、Linuxのプラットフォームで動作するオープンソフトウェアで、無料で使用することができます。
拡張機能を追加することでさまざまな開発環境に対応することができます。

開発に使用するPCはMacとWindowsの両方について紹介していますので、該当ユーザはアコーデオンを展開して下さい。。

In English

This article describes how to build an ESP32 development environment using Visual Studio Code and Pymakr extention in Japanese.

VSCodeのインストール

下のリンクから自分のPCにあったファイルをダウンロードしてインストールして下さい。
https://code.visualstudio.com/

WindowsユーザはMicrosoft Storeからインストールすることもできます。

Node.jsのインストール

以下のサイトから自分のPCに合ったLTSバージョンのファイルをダウンロードしてインストールして下さい。
https://nodejs.org/ja/

Pymakrのインストール

PymakrはPycomというデバイス用の拡張機能です。インストールすると最新のバージョン2系がインストールされます。残念ながら、バージョン2系はPycomでないデバイスは認識しないようです
一旦、最新のバージョン2系をインストールした後、バージョン1系の最新バージョンにダウングレードすると認識するようになります。

Macユーザ

Macユーザ

VSCodeインストール直後の画面(日本語環境は設定済み)
altVSCodeインストール直後の画面
VSCodeインストール直後の画面

画面左側のアクティビティバー(縦長の黒い部分)にある拡張機能をクリックし、検索欄にpymakrと入力し、インストールボタンをクリック。

alt拡張機能の追加
拡張機能の追加

最新のバージョン2系がインストールされます。(この例では、v2.22.5)
altpymakrV2がインストールされる
pymakrV2系がインストールされる

青いアンインストールボタンの横のVをクリックしてプルダウンメニューを表示させ、別のバージョンをインストールするを選択します。
altpymakrのダウングレード
pymakrV2のダウングレード

バージョン1系の最新バージョンを選択するとダウングレードが始まります。
青い再読み込みが必要ですのボタンをクリックして完了です。
altpymakrのダウングレード完了
pymakrV2のダウングレード完了

Windowsユーザ

Windowsユーザ

VSCodeインストール直後の画面(日本語環境は設定済み)
altVSCodeインストール直後の画面
VSCodeインストール直後の画面

画面左側のアクティビティバー(縦長の黒い部分)にある拡張機能をクリック

alt拡張機能の追加
alt拡張機能の追加

拡張機能検索欄にpymakr と入力しエンタキーを押す。
altpymakrの検索
altpymakrの検索

Pymakrインストールボタンをクリックしてインストールする。
altpymakrのインストール
altpymakrのインストール

最新のバージョン2系がインストールされます。(この例では、v2.22.5)
altpymakrV2がインストールされる
pymakrV2がインストールされる

青いアンインストールボタンの横のVをクリックしてプルダウンメニューを表示させ、別のバージョンをインストールするを選択します。
altpymakrのダウングレード
pymakrV2のダウングレード

バージョン1系の最新バージョンを選択するとダウングレードが始まります。
青い再読み込みが必要ですのボタンをクリックして完了です。
altpymakrのダウングレード完了
pymakrV2のダウングレード完了

VSCodeを起動する度にPymakrのアップグレードを促す表示がされますが、アップグレードしないで下さい。ESP32ボードを認識しなくなる可能性があります。

VSCodeの設定と接続確認

PCとESP32開発ボードをUSBケーブルで接続します。

Macユーザ

Macユーザ

VSCodeを立ち上げる、画面最下部のステータスバーに以下のように表示されていればpymakrのインストールができています。(この例ではステータスバーが青色で表示されていますが、VSCodeの環境設定によって異なる色で表示されます。)
altpymakr console
pymakr console

自動接続の無効化

PymakrにはPycom製のボードを探して自動接続する機能が搭載されていますが、その他のメーカの開発ボードは対象にならないので、この機能を無効にして、シリアルポートのアドレスを静的に設定する必要があります。

ステータスバーにある All commands をクリックして Pymakr > Global Settingを選択します。

altAllCommands
AllCommands

pymakar.jsonファイルが開くので、"auto_connect": true, となっているところを auto_connect": false, に変更します。

altauto_connect
auto connect

開発用ディレクトリ(フォルダ)の作成

Finderもしくはターミナルを使用して、プログラムを保存するデュレクトリ(フォルダ)を適当な名前で作成して下さい。

設定ファイルの編集

  1. VSCodeメニューバーのファイルをクリックし、フォルダを開く... (日本語化していない場合はOpen Folder...) を選択します。
  2. 先に作成したディレクトリを選択して下さい。
  3. ステータスバーの All commands をクリックします。
  4. Pymakr > Project settingsを選択します。
  5. pymakr.confファイルが開くので、"address": "/dev/tty.usbserial-XXX", の部分を環境に合わせて設定します。($ ls /dev/tty.usb*で調べることができます。)

altprojectsettings
projectsettings

パソコンとESP32開発ボートの接続確認

VSCode画面最下部のステータスバーが次のようにX Pymakr Consoleのように表示されている場合はMacとESP32開発ボードが接続されていない状態ですので、X Pymakr Consoleと表示されている部分をクリックして接続します。
altNotConnected
Not Connected

接続されると下のように、Xがチェックマークに変わって表示されます。
altConnected
Connected

ターミナル部分にには

>>> Connecting to /dev/tty.usbserial-14110...
>>>

のように表示されます。

Windowsユーザ

Windowsユーザ

VSCodeを立ち上げる、画面最下部のステータスバーに以下のように表示されていればpymakrのインストールができています。(この例ではステータスバーが青色で表示されていますが、VSCodeの環境設定によって異なる色で表示されます。)
altpymakr console
pymakr console

自動接続の無効化

PymakrにはPycom製のボードを探して自動接続する機能が搭載されていますが、その他のメーカの開発ボードは対象にならないので、この機能を無効にして、シリアルポートのアドレスを静的に設定する必要があります。

ステータスバーにある All commands をクリックして Pymakr > Global Settingを選択します。

altAllCommands
AllCommands

pymakar.jsonファイルが開くので、"auto_connect": true, となっているところを auto_connect": false, に変更します。

altauto_connect
auto connect

開発用ディレクトリ(フォルダ)の作成

エクスプローラーを使用して、プログラムを保存するデュレクトリ(フォルダ)を適当な名前で作成して下さい。

フォルダ作成時に下のようなメッセージが表示された場合は、 親フォルダー... の左側をクリックしてチェックマークを入れ、はい、作成者を信頼しますのボタンをクリックします。

altWarnning
Warnning

設定ファイルの編集

  1. VSCodeメニューバーのファイルをクリックし、フォルダを開く... (日本語化していない場合はOpen Folder...) を選択します。
  2. 先に作成したディレクトリを選択して下さい。
  3. ステータスバーの All commands をクリックします。
  4. Pymakr > Project settingsを選択します。
  5. pymakr.confファイルが開くので、"address": "COM6", の部分を環境に合わせて設定します。(大文字でないと認識しません。デバイスマネージャーのポートで調べることができます。)

altprojectsettings
projectsettings

パソコンとESP32開発ボートの接続確認

VSCode画面最下部のステータスバーが次のようにX Pymakr Consoleのように表示されている場合はパソコンとESP32開発ボードが接続されていない状態ですので、X Pymakr Consoleと表示されている部分をクリックして接続します。
altNotConnected
Not Connected

接続されると下のように、Xがチェックマークに変わって表示されます。
altConnected
Connected

ターミナル部分にには

>>> Connecting to COM6...

>>>

のように表示されます。

サンプルプログラムの実行

hello.pyというファイル名で、以下のように入力します。

print("Hello, world!")

ステータスバーのRunをクリックするとプログラムが実行されます。
altRun
Run

>>> Running hello.py

>>> 
>>> 
Hello, world!
>
MicroPython v1.19.1 on 2022-06-18; ESP32 module with ESP32
Type "help()" for more information.
>>> 
>>> 

以上でこの記事は終了です。
次はIoT定番のLちかの記事を書く予定です。

Discussion