概要

前回の記事ではRaspberry Pi上でWebカメラを起動してストリーム配信が行えることを確認しました。
今回はPython上でストリーム配信や画像取得を操作するために開発環境を構築します。
現状のままでもRaspberry PiでVimなどを操作して直接開発もできるのですが、やはり統合開発環境を構築した方が開発がやりやすいです。
普段は別のPCで編集もできるよう、Raspberry Piとリモート接続での開発環境を両方作成したいと思います。

調査

リモート接続が可能な開発環境を少し調べたところ、Visual Studio Code（以後VSCode）とPyCharmがあるようでした。
双方比較したところ、PyCharmでリモート接続を使用したい場合は年間ライセンスを購入する必要がありました。（30日の試用期間ではリモート接続が可能です）
ライセンスを購入する余裕がないので、今回はVSCodeを採用します。

インストール

リモート端末とRaspberry Pi両方にVSCodeをインストールします。

1.Windowsにインストール

下記URLからVSCodeをダウンロードしてインストール。
Windows、Macなどの端末用のインストール手順は色々なところに記載されているので今回は省略します。
https://code.visualstudio.com/

2.Raspberry Piにインストール

インストールする場合OSによってコマンドを変更する必要がある。下記URLの「Linux」項目内の「APT instructions」か「YUM instructions」に記載されているコマンドを実行。
今回はRaspbeanを使用しているので、「APT instructions」の項目に記載されているコマンドを実行。

APT_instructions

# 実行前に必ず管理者権限に切り替える
sudo -s

. <( wget -O - https://code.headmelted.com/installers/apt.sh )

上記のコマンドを実行したところ、こちらの環境ではE: 認証されていないパッケージがあり、-y オプションが --allow-unauthenticated なしで使用されました Visual Studio Code install failed.と表示されてインストールに失敗してしまいました。
いくつかのサイトを確認したところ、上記のコマンド実行後に下記コマンドを実行すればインストールに成功したとの記載がありました。
もしインストールに失敗する場合は下記コマンドを追加で実行します。

sudo apt install code-oss -y --allow-unauthenticated

追記（2019年4月）
現在、最新のパッケージをインストールすると黒いウィンドウしか表示されないという問題が発生しているようです。
インストール後にVSCodeを実行した際に同様の問題が発生した場合はバージョンを下げたパッケージをインストールするしかないようです。
こちらの環境でも同様の問題が発生したので一旦バージョンをさげてインストールを行いました。
https://github.com/headmelted/codebuilds/issues/64

sudo apt install code-oss=1.29.0-1539702286 -y --allow-unauthenticated

インストール後の設定

インストール直後のままではPythonのデバッグができないので各種拡張機能を入れていきます。
左枠の一番下のアイコンをクリックして拡張機能を開きます。
リモート用とRaspberry Pi共通です。

拡張機能を検索する場合は左上のテキスト欄に任意の検索文字列を入れることで当てはまるものの一覧が表示されます。

1. 必須の拡張機能

こちらを入れないとVSCodeでデバッグなどができないので必ずインストール。
インストール後に「再読み込み」をクリック。
Python

2. 日本語化

個人的に日本語化していた方がやりやすいのでこちらもインストール。
Japanese Language Pack for Visual Studio Code

3. その他の設定（任意）

入れておいた方が使いやすい機能も記載しておきます。
拡張機能を増やすと容量を圧迫してしまいますが、フォーマット自動化などコーディングがやりやすくなるのである程度は入れた方が良いと思っています。

1. テーマの変更

VNC Viewer経由だと画質設定をHighに上げていても黒背景だと文字が潰れる事が結構あるのでテーマを変更する。
「ファイル」、「基本設定」、「配色テーマ」をクリック。
Dark以外の好みのテーマを選択する。（これはLight(Visual Studio)を選択した場合）
他のテーマにしたい場合は拡張機能で好きなテーマをインストールして選択する。

2. vscode-icons

開いているワークスペース内のファイル・フォルダ等の種類に応じてアイコンが追加される。
視認性が良くなる。

3. Path Autocomplete

パス入力時に候補を表示してくれる。

4. Trailing Spaces

行末尾の不要な空白を強調表示。
こちらをインストール後に「ファイル」、「基本設定」、「設定」をクリックして表示されるSettingsの上部テキストランにfiles.trimTrailingWhitespaceを入力。
Files: Trim Traillng Whitespaceにチェックを入れると保存時に自動で不要な空白を削除してくれる。

5. Settingsの変更

既存の設定から変更した方が視認性が良くなると思われる項目の一覧を記載。
「ファイル」、「基本設定」、「設定」をクリックしてSettingsを表示する。

5.1 空白文字の表示
「テキストエディター」をクリックしてRender Whitespaceの部分をNoneからallに変更

5.2 ファイルの末尾に改行を追加&不要な改行と空白を削除
「ファイル」をクリックしてInsert Final Newline、Trim Final Newline、Trim Trailing Whitespaceにチェックを追加

5.3 関数名補間時に自動で括弧も補間する(Python)

「拡張機能」、「Python」をクリック。
Auto Complete: Add Bracketsにチェックを追加。

5.4 Python3.6のインストール(Raspberry Piのみ)
Raspberry PiにはPython2.7とPython3.5がインストールされているが、Python3系を3.6へアップデートする。
VSCodeの設定ではないが、Python3.6系列で5.5以降を実行するためにここに記載している。

ターミナルを起動して下記コマンドを実行。

# ビルドのためのパッケージをインストール
sudo apt install build-essential tk-dev libncurses5-dev libncursesw5-dev libreadline6-dev libdb5.3-dev libgdbm-dev libsqlite3-dev libssl-dev libbz2-dev libexpat1-dev liblzma-dev zlib1g-dev

cd /opt
# 3.6の最新版3.6.8をダウンロード(opt配下なので要sudo、他のフォルダの場合はsudo不要)
sudo wget https://www.python.org/ftp/python/3.6.8/Python-3.6.8.tar.xz
sudo tar xf Python-3.6.8.tar.xz # (opt配下なので要sudo)
cd Python-3.6.8
sudo ./configure                # (opt配下なので要sudo)
sudo make                       # (opt配下なので要sudo)
sudo make install

インストールが完了したらpython3.6 --versionとpip3.6 -Vをそれぞれ実行してバージョンの確認を行う。

そのままだと使いにくいのでエイリアスの登録を行う。
vim ~/.bashrcをターミナルで実行後、テキストの末尾に下記を追加後、再起動を行う。
追加後、python --versionとpip -Vをそれぞれ実行して先程確認したバージョンと同一になっていることを確認する。

alias python='python3.6'
alias python3='python3.6'
alias pip='python3.6 -m pip'
alias pip3='python3.6 -m pip'

5.5 自動整形の設定(Python)
Pythonはコーディング規約が存在します。コーディング後に手動で整形をするより自動整形をしてくれた方が便利なのでパッケージをインストール後、VSCodeの設定を行います。

ターミナルを起動して下記コマンドを実行。

# Raspberry Pi側で許可がありませんとエラーが出た場合はsudoを付ける
pip install flake8
pip install autopep8

VSCodeを起動して「ファイル」、「基本設定」、「設定」をクリックしてSettingsを表示する。

python.linting.pylintEnabledを検索してチェックを外しpylintを無効化する。

python.linting.enabledを検索してチェックがついていることを確認する。ついていない場合はチェックをつける。

python.linting.flake8Enabledを検索してチェックを付け、flake8を有効化する。

python.linting.flake8Argsを検索してsettings.jsonを開き、下記を追加する。

    "python.linting.flake8Args": [
        "--ignore=W293, W504"
    ]

python.formatting.providerを検索してautopep8が選択されていることを確認する。

リモート接続用の設定

こちらはリモート接続用のPCのみ設定します。
下記設定だけではリモートでのデバッグまでは実行不可です。リモートでのファイル編集のみ可能となっています。
リモートでのデバッグ方法についてはいずれ追記します。

拡張機能の検索欄にSSH FSを入力して検索し、インストール。
エクスプローラーを表示した際に左下にSSH FILE SYSTEMSという項目が追加されているので右クリックを押し、「Create a SSH FS Configration」をクリック。

Nameに付けたい設定ファイル名を入れ、Locationを「Global settings.json」か「Workspace settings.json」どちらかを設定して「Save」をクリック。

「Save」をクリック後にsettings.jsonが表示されるので下記の項目を入力した後、一番下に表示されている「Save」をクリックして保存する。

Host: 接続先のRaspberry PiのIPアドレス
Port: ポート番号を入力。デフォルトでは22が設定されている
Root: 接続先のルートパス
Username: ログイン時のユーザ名
Username: ログイン時のパスワード。に設定した場合、毎回接続時にパスワード入力を要求される

作成した設定ファイルを右クリックし、「Connect as Workspace folder」をクリック。
設定ファイルの横のアイコンが緑色に変化すれば正常に接続が出来たことを示す。

実行確認

これらの設定が完了したらデバッグの実行確認をします。
Raspberry Pi側のVSCodeを起動して、下記Pythonファイルを作成してデバッグが実行できるかを確認します。
正常に実行できた場合、/tmp/test.jpgが作成されています。
また、作成後にリモート端末でSSH FS経由で接続して作成したファイルが閲覧・編集できるかも確認します。

test.py

import subprocess

cmd = ['fswebcam', '/tmp/test.jpg']
result = subprocess.run(cmd, stdout=subprocess.PIPE)
print(result)

総括

前回と合わせて、これでストリーム配信の準備とPythonによるアプリケーション作成の準備ができました。
次回はPythonからストリーム配信や画像の撮影を実行するプログラムを作成したいと思います。

参考

この記事を書くにあたって、以下のサイトを参考にさせて頂きました。

改訂【インストール編】Raspberry PiでのプログラミングもエディターはVisual Studio Code！
VSCodeのオススメ拡張機能 24 選 (とTipsをいくつか)
Raspberry piにPython3.6を入れてみた
 Raspberry Pi 3 Model B, 設定について自分用メモ(パスワード変更や、Python3導入, カメラ利用など)
VS Code コーディング規約を快適に守る
 VSCodeのPython開発環境でpylintの代わりにflake8を導入し自動整形を設定する
 パソコンのVS CodeからラズパイのPythonファイルを直接編集しよう！

Raspberry Piで室内カメラを作る②

概要

調査