【ポケモン×Arduino_01】Arduino Leonardo環境構築～動かしてみる

 ※本記事は、ポケモン剣盾をArduino Leonardoで自動化するための導入方法について書いた記事です。「Arduinoって何？」って方は前回の記事をご覧ください。

本記事は、

・Arduino Leonardoの入手

・Arduinoに書き込むための環境構築

・ライブラリ付属のプログラムを書き込み～実行

についてまとめたものです。

2022.05.23追記：導入に関しての質問などが増えてきており、文章だけだと分かりにくい箇所があるため、導入手順をまとめた動画を公開します。

 

2021/12/11追記：導入などにあたって頻出の質問については別ページにまとめました。コメントなどで質問する前に、こちらを確認してみてください。

目次:

・自動化に必要なもの

・Arduino Leonardoの入手

・Arduino IDEの導入

・ライブラリの導入

・サンプルスケッチの書き込み

 

自動化に必要なもの

前回の記事の復習です。 

---

 自動化を行うにあたり物理的に必要なものは以下の4つとなります（工具などは要りません）。

・Nintendo Switch（liteも可、ただし下記のケーブルの端子に注意）とポケモン剣盾（ソフト） 

・Arduino Leonardoボード（搭載しているマイコンは「ATmega32U4」）

・PC（執筆者はWindows。Mac等の方は他のサイトの解説も参考にしてください）

・ArduinoとPCをつなぐケーブル（純正ボード等ならmicro USBケーブルが付属。SwitchのドッグのUSB端子に接続する場合はそのままでOK、携帯モードやSwitch liteならTypeA→TypeCへの変換が必要）

 

また、PCでArduino用のプログラムを作成、 書き込みをするために

・ Arduino IDE

・Switchコントローラーとして認識させるためのライブラリ

が必要となります（無料で揃います）。

---

 

 以上の必要なものについて、順に解説します。

Arduino Leonardoの入手

 Arduino Leonardoの特徴を復習します。

・Arduino Leonardoは、最も標準的なモデルであるArduino UNOの廉価版

・LeonardoはHID機能（コントローラーとして認識する機能）が標準搭載。UNOより簡単。

以上の理由から、本ブログではArduino Leonardoを使用します。 

 Arduino Leonardoは、純正のボードの他に、さまざまな互換品が販売されています。どちらを買うべきか、結論から言うと、互換品で問題ないと思います。基本的には純正ボードを買うのが最も確実ですが、買うボードの種類さえ間違えなければ互換品の方が安く買えます。

（私は互換品しかもっていません）

私が持っているのは以下の製品です。

基本的に「Arduino Leonardo（互換）」「ATmega32U4」と書いてある製品で、評価が低くなければ大丈夫かと思います。以下のようなものを選んでください。

Arduino Arduino Leonardo (ピンソケット・ピンヘッダ実装済) 【A000057】

KEYESTUDIO Leonardo R3開発ボード+ USBケーブル for Arduinoと互換

Arduino Arduino Leonardo (ピンソケット・ピンヘッダ実装済) 【A000057】

楽天市場 Amazon Yahooショッピング by カエレバ

 

 

 注意：ATmega328、ATmega16U2などと書かれている製品はLeonardoではありません。おそらくUNOの互換品です。本ブログで紹介するプログラムは使えません。

こちら↓の互換品でも動作を確認しました（Aliexpressで購入しました。小さいですがLeonardo互換品のようです）。正規品と比べてピン（ボタンやセンサーなどのパーツを接続するところ）などが減っている代わりに、ケーブル無しで直接USB TypeAとして挿すことができます。本ブログでは基本的にHID機能のみ使用し、ピンを使うことはないので問題ありません。

執筆者は現在こちら↓を使って自動化しています 。ただし、最初の1台は機能が限定されていない通常の大きさのものをおすすめします。（トラブルの際に原因がわかりにくいため）

 

Aliexpressで購入した互換品についてはこちらで紹介しています。

Arduino IDEの導入

 Arduino IDEとは、Arduino用のプログラムを開発するためのPC用のソフトウェア、統合開発環境（Integrated Development Environment）のことです。

 Arduinoでプログラム（＝スケッチと呼びます）を書く→ボードに書き込む

の一連の動作は基本的にこのIDEで完結します。

↓Windows 10でのインストール手順を解説します。（Mac等も同様かと思います。他のサイトを参考にしてください。）

※注意

以下の手順は2021/02/11時点のものとなります。サイトの表示やバージョン等が異なる場合があります。バージョンは基本的に最新のもので大丈夫です。

Arduino IDEのインストール

 Arduinoの公式ページより、自分のPCに合うインストーラーを選択します。

寄付を求められますが、無料で問題なく使用できます。 

ダウンロードしたファイル（.exe等）からインストールします。

 

ライブラリの導入

ライブラリとは、簡単に言えば便利なプログラムのセットです。頻繁に使う複雑なコードをライブラリにすることで、簡単に使えるようになります。（料理に例えれば、醤油や出汁、砂糖などがコード、それを調合しためんつゆがライブラリです。めんつゆが1本あれば簡単にうどんが作れます。）

Arduinoでは、Nintendo Switchのコントローラーとして認識、使用するためのライブラリが複数の有志の方によって配布されています。

本ブログでは以下のライブラリをお借りして使用しております。

 

上記の記事の通りにライブラリをインストールしてください。

以下では、執筆者自身がつまづいた内容を兼ねて簡単に解説します（上の記事を読んだうえで参考にしてください）。

NintendoSwitchControllライブラリ

GitHubよりライブラリをダウンロードして展開します。

＞展開した「NintendoSwitchControll-master」フォルダをArduinoのライブラリのあるディレクトリ（.../Documents/Arduino/librariesなど）に移動する。

これでライブラリがArduino IDEで使えるようになります。

 

 デバイスIDの書き換え

 上記のライブラリを使用してスケッチをArduinoに書き込んでも、そのままではSwitchで反応してくれません。それは、Switch側がコントローラーとして認識してくれないためです。そこで必要なのがデバイスIDの書き換えです。

デバイスIDを書き換えることで、Arduino Leonardoをコントローラー（ここでは有線のホリコン）として認識してもらえるようになります。

 

 Arduino IDEを開き、ファイル＞スケッチ例　から適当な（内臓の）スケッチを開きます。

 スケッチ＞スケッチのフォルダを表示　します。

開いたフォルダから上へたどっていくと「Arduino」フォルダがあるので、そこからhardware/arduino/avr/boards.txt　としてboards.txtを探します。

 

 boards.txtをどこかにバックアップした上で、もう1つtxtをどこか（デスクトップなど）に保存してください。別の場所に保存したtxtをメモ帳以外のテキストエディタ（サクラエディタ等）で開きます（メモ帳だと失敗することがあります）。avrフォルダに入っているtxtを編集しようとしてもアクセス制限がされて保存できないかと思います。

leonardo.vid、pidとついたすべての列について、

leonardo.vid.0=0x0f0d
leonardo.pid.0=0x0092

のように変更してください。少し下の方にある、

leonardo.build.vid　なども同様にしてください。最後に保存したboards.txtを置き換えて終了です。

 サンプルスケッチの書き込み

 Arduino IDEやライブラリのインストールが終わったら、実際にスケッチをボードに書き込んでみましょう。

インストールしたライブラリには、サンプルのスケッチが付属しているので、それを開きます。ファイル＞スケッチ例＞NintendoSwitchController　の中から1つ選んで開きます。

それぞれのスケッチについては後述します。

 

PCにUSBでマイコンを接続してください。 ツール＞ボード　でArduino Leonardoを選択し、すぐ下のシリアルポートで接続したボードを指定してください。ポートがわからない場合は、（Windows）コントロールパネルからハードウェアとサウンド＞デバイスマネージャー＞ポート　で確認できます。

 左上の「検証」（✓マーク）を押すと、ウインドウ下部に　コンパイルしています　と表示されます。ライブラリがインストールされていて、スケッチに異常がなければ、　完了しました　に代わります。その場合、ボードをPCにつなぐことで書き込みができます。「検証」の隣の「マイコンボードに書き込む」を押すことで書き込みが始まります。ボードのランプが光っている間、書き込みが終わるまでは抜かないでください。

 

 書き込みが終わったら、ボードとUSBをPCから抜いてください。

最後に、 Switchに接続（ドックにUSBで接続 or USB TypeCに変換してSwitch (lite)本体に接続）します。うまく書き込めていれば、剣盾の主人公が勝手に動き出すかと思います。

※注意

Switchに別のコントローラーが既に認識されている場合は、Arduinoが2Pコン扱いとなり見かけ上反応していないことがあります。その場合はコントローラーの接続を外し（無線コントローラーの場合は一度Switchの画面を切るなどする）、再度ボードを挿しなおしてみてください。

Switchの設定＞コントローラーとセンサー＞入力デバイスの動作チェック　を選択することでも動作を確認できます。

 

サンプルスケッチ解説

サンプルスケッチの説明はGitHubならびに各スケッチ上に書いてあります。ここでは簡単な説明のみとします。スケッチ等の説明を読んでから使用してください。

---

※注意

2020/12/01に更新されたSwitchのバージョン11.0.0以降では、HOMEメニュー左下に「Nintendo Switch Online」のアイコンが追加されました。これにより、日付変更をする際の操作が1つ多く必要となり、サンプルスケッチの一部は正常に動作しません。

バージョン更新の影響があるサンプルファイルに（※）と記載します。

 

（※）のスケッチでは、以下の変更をすることで正常に使用することができます。

 以下では「auto_gain_watt」を例にします。

日付を変更する操作のうち

    // ホーム画面 > 設定
    pushButton(Button::HOME, 1000);
    pushHatButton(Hat::DOWN, 100);
    pushHatButton(Hat::RIGHT, 100, 4);
    pushButton(Button::A, 1000);
    // 設定 > 本体 > 日付と時刻

 のような部分について、

pushHatButton(Hat::RIGHT, 100, 4);　を 

pushHatButton(Hat::RIGHT, 100, 5);　に変更してください。

---

 サンプルスケッチ一覧

・auto_gain_watt 自動ワット稼ぎ（※）

日付変更バグ（時渡り）を利用してワイルドエリア等の巣穴のワットを回収し続けます。

・auto_hatching 自動孵化

ワイルドエリア（ハシノマはらっぱ）の育て屋からタマゴを1個ずつ回収、孵化を繰り返します。

・auto_raid_battle 自動レイドバトル

願いのかたまりを投げ入れてレイドバトル、ポケモン捕獲を繰り返します。

・IDkuji　無限IDくじ（※）

日付変更バグ（時渡り、ランクマッチ利用）を利用してIDくじを引き続けます。

・ransushouhi レイドバトル乱数消費（※）

日付変更バグ（時渡り、ランクマッチ利用）を利用して指定の日数だけレイドバトルの乱数を進めます。

・ release_pokemons自動ポケモン逃がし

1ボックス分のポケモンを逃がし続けます。

以上のスケッチを利用することで、

・ワットを稼いで金策

・孵化厳選を楽にして色違い入手

・IDくじでポイントアップやマスターボールの入手

などが可能となります。

2022.05.23追記：導入に関しての質問などが増えてきており、文章だけだと分かりにくい箇所があるため、導入手順をまとめた動画を公開します。

次回からは、執筆者が作成、改変したスケッチを公開していきます。