【Visual Studio Code】Raspberry PiへのリモートSSH接続

env eye_catch

Visual Studio Code(以降はVSCodeと呼称)の拡張機能「Remote Development」を使用すると、クライアントのVSCodeからRaspberry Piのフォルダツリーの閲覧やファイル操作、ターミナルからBashコマンドを実行することが可能になります。コーディングのみならずVSCodeのデバッグ機能や拡張機能をそのまま適用することができるため、Raspberry Pi上での作業効率化に繋がります。

VSCodeのリモートSSHと合わせて、「VNC Viewerによるリモートデスクトップ接続」「sambaによるファイルサーバ化の設定」を完了させておくと、Raspberry Piに直接ログインすることなく、ほとんどの操作をクライアントPCから実施可能となります。Raspberry Pi用にディスプレイや、キーボード・マウスといった周辺機器を準備する必要がなくなるため、Raspberry Piを購入した場合は、まずこの3つの設定を済ませておくことをお勧めします。

本記事では、VSCodeのリモートSSH接続の設定方法を紹介します。前述のsambaによるファイルサーバ化の設定を行う場合は以下の記事を参考にしてください。

関連記事

この記事では、Raspberry Piをファイルサーバ化する方法をご紹介します。 ファイルサーバ化することで、別のクライアントマシンのエクスプローラからRaspberry Piのストレージ領域に直接アクセスすることが可能となります。 […]

access-samba-from-win3

動作確認環境


(クライアントPC)
OS: Windows 10 Home (64bit)
CPU: Intel Core i7-9750H
VS Code: version 1.53
VS Codeは下記の手順でインストール、設定したものです。
関連記事

Visual Studio Code(以降はVS Codeと呼称する)は、Microsoft社が提供するコードエディタで、拡張機能が豊富なことから導入している方も多いと思います。 実際、私の勤務先でも日常的に使用しています。Remot[…]

(サーバマシン)

商品名: Raspberry Pi 3 MODEL B
OS:
Raspbian Buster with desktop

Raspbian は下記の手順でインストール、設定したものです。

関連記事

この記事では、Raspberry Piの購入後に実施する以下の2点について、書いています。 1. OS(Raspbian)インストール 2. 初期セットアップ この記事は以下のような方向けのものになります。 Raspberr[…]

raspberry-pi-initial-set-up

 

広告

 

1. 拡張機能「Remote Development」のインストール(クライアントPC側)


1-1. ブロックのアイコンメニューを選択し、検索バーに「Remote Development」と入力する

search_remote_development

 

1-2. 「Remote Development」を選択し、「Install」をクリックする

install_remote_development

 

1-3. モニター風のアイコンが追加されるので選択する

check_server_machine

この時点では、SSH接続先の候補は存在しません。2章以降の手順を実行することで、Raspberry Piが選択できるようになります。

 

広告

2. Raspberry PiのSSHサーバ機能を有効化(サーバマシン側)


2-1. Raspberry Piに任意のユーザでログインし、ホームメニューの「設定」->「Raspberry Piの設定」を選択する

settings_raspberry

 

2-2. 「インターフェース」タブで「SSH」の「有効」にチェックを入れて「OK」を選択する

validate_ssh_in_raspberry

 

※クライアントPC側のコマンドプロンプトから、以下のコマンドを実行することで、ssh接続が有効になっていることを確認できます。

 

3. SSHのconfigファイルの作成(クライアントPC側)


3-1. メモ帳などのテキストエディタを使用して、以下のフォーマットでconfigファイルを作成する

{Raspberry PiのIPアドレス}は、Raspberry Pi上のターミナルで「ifconfig」コマンドを実行した際に表示される「inet」に続く文字列になります。
Raspberry Pi側でポートを変更されている場合は「port {ポート番号}」を、SSH接続方式を「公開鍵認証方式」としている場合は「IdentityFile {秘密鍵のパス}」を任意に追加してください。(configファイルの各項目の説明はこちらの記事が参考になります。)
3-2. ユーザフォルダ配下の.sshフォルダ(C:\Users\{ユーザ名}\.ssh)に、configという名前でファイルを保存する
store_ssh_config
.sshフォルダが見つからない場合は、「隠しファイル」が非表示となっている可能性があります。エクスプローラの表示設定から「隠しファイル」にチェックを入れてみてください。
configファイルをメモ帳で作成した場合は、拡張子「.txt」が付与されますので、ファイル名の変更から手動で削除してください。エクスプローラの表示設定で非表示となっている場合は、「ファイル名拡張子」にチェックを入れて表示するように設定してください。
広告

4. リモートSSH接続の動作確認


4-1. 手順1-3と同様にモニター風のアイコンを選択する

check_ssh_connect_target

手順3で作成したconfigファイルのHost名が、接続先に候補に追加されていることが確認できます。
4-2. SSH接続するHost名の左に表示されているアイコンを選択する
connect_ssh_in_vscode
4-3. Raspberry Piへのログイン時に使用しているパスワードを入力する
enter_passward_ssh_in_vscode
パスワードは手順3のconfigファイルに記載したユーザのものを入力する必要があります。
「公開鍵認証方式」でSSH接続する場合は、公開鍵のパスワードが求められます。

 

4-4. フォルダツリーやターミナルから、Raspberry Piのリソースを閲覧できていることが確認できる

check_raspberry_resource_through_remote_ssh

 

広告

 

おまけ


VSCodeの拡張機能は、クライアントPCとサーバマシンで別々に管理されています。

サーバマシンのリソースに対してVSCodeの拡張機能を適用する場合は、拡張機能を「Install in SSH」ボタンから再度インストールする必要があります。

install_extension_in_ssh_in_vscode

 

広告