RaspberryPi Pico CircuitPythonでUSB HIDを作る方法【自作マウス・自作キーボード】

【サンハヤト Sunhayato】サンハヤトブレッドボードエコノミーパック SRH-21CE

ポチップ

ブレッドボード

サンハヤト製がおすすめです。少々固いですが、品質は高いです。スペースが広いので配線・デバッグが楽に行えます。

あきばお〜楽天市場支店

¥1,131 （2023/11/26 14:15時点 | 楽天市場調べ）

ポチップ

抵抗

お手持ちのものでOKです。ない方は一度セットで揃えてしまうと送料と時間が節約できます。

ELEGOO 17値1％抵抗器、0オーム〜1Mオーム（525本）

¥1,500 （2022/02/22 10:06時点 | Amazon調べ）

uxcell タクトスイッチ押しボタンスイッチ 6mmx6mmx4.3mm パネル PCB 瞬間的プッシュボタン 2ピン DIP 10本入り

ポチップ

タクトスイッチ

ブレッドボードで使えるものならOKです。

¥656 （2022/06/18 07:46時点 | Amazon調べ）

https://docs.circuitpython.org/projects/hid/en/latest/index.html

ポチップ

プログラム概要

今回のプログラムの概要は以下の通りです。

タクトスイッチを設定する
タクトスイッチAが押されたら、キーボードの「a」を送信
タクトスイッチBが押されたら、マウスの「右クリック」を送信

実行結果

後述するプログラムの実行結果です。

タクトスイッチAを押して「a」キーをメモ帳上に入力。途中手動で「半角/全角]キーを押しているので表示が「あ」になっています。

入力後、タクトスイッチBを押して、メモ帳上に右クリックメニューを表示しています。

全体コード

全体コードは以下の通りです。詳細な内容は後述する「コードのポイント」で解説します。

import board, digitalio, usb_hid

from adafruit_hid.keyboard import Keyboard
from adafruit_hid.keyboard import Keycode
from adafruit_hid.mouse import Mouse

# GP16,18ピンを入力に設定します
tactA = digitalio.DigitalInOut(board.GP16)
tactA.switch_to_input(pull=digitalio.Pull.DOWN)

tactB = digitalio.DigitalInOut(board.GP18)
tactB.switch_to_input(pull=digitalio.Pull.DOWN)

# キーボード・マウスのオブジェクトを作成します
keyboard = Keyboard(usb_hid.devices)
mouse    = Mouse(usb_hid.devices)

# 前回値用の変数を初期化します。
beforeA = 0
beforeB = 0

print("Loop start ")

while True:

    # タクトスイッチA,Bが押されているか取得
    nowA = tactA.value
    nowB = tactB.value

    # タクトスイッチAが押された(立ち上がり)
    if nowA == 1 and beforeA == 0:
        print("sendA")
        keyboard.send(Keycode.A)

    # タクトスイッチBが押された(立ち上がり)
    if nowB == 1 and beforeB == 0:
        print("sendB")
        mouse.click(Mouse.RIGHT_BUTTON)
    
    # 前回値として現在のスイッチの状態を保存します。
    beforeA = nowA
    beforeB = nowB

※ 2023/05/30 import部分のコード修正しました。
なかちゃんさん、ありがとうございます。

プログラムの自動実行(電源ONで実行)をさせたい場合は、プログラムのファイル名を「code.py」にしてPicoに保存してください。

コードのポイント

入力ピンの設定

タクトスイッチをつなげたGP16・18ピンを入力に設定します。

今回の回路はタクトスイッチが押された場合のみ、電源(3V3)から電気が流れる回路なのでピンの設定を「Pull.DOWN」に設定します。

# GP16,18ピンを入力に設定します
tactA = digitalio.DigitalInOut(board.GP16)
tactA.switch_to_input(pull=digitalio.Pull.DOWN)

tactB = digitalio.DigitalInOut(board.GP18)
tactB.switch_to_input(pull=digitalio.Pull.DOWN)

タクトスイッチの状態取得

valueプロパティでタクトスイッチ(がつながったGP16,18)の状態を取得します。状態はタクトスイッチに応じて以下のように変化します。

タクトスイッチの状態	valueの内容
押された	1
押されていない	0

    # タクトスイッチの状態を取得します
    nowA = tactA.value
    nowB = tactB.value

スイッチが押された時だけ処理をする

以下のコードで、タクトスイッチが「押された時」を確認します。

今回のプログラムでは無限ループで連続的にスイッチを確認します。そのため単純に「タクトスイッチがONか？」を条件にしてしまうと、ゆっくりスイッチが押された場合に、
「2回(2ループの間)スイッチが押された」と判定されてしまいます。

そこで、以下のように条件にスイッチの「今回のループの値」と「前回のループの値」を使うことで、「スイッチが押された瞬間(立ち上がり)」1回だけを検知するようにします。

キーボード操作

タクトスイッチAが押された場合に、send関数を使ってPicoからPCにキーボードの「a」キーを送信します。

    # タクトスイッチAが押された(立ち上がり)
    if nowA == 1 and beforeA == 0:
        print("sendA")
        keyboard.send(Keycode.A)

PCが日本語入力モードの場合は「あ」が入力されます。

Muエディタで実行した場合でも、PCに向けてキーが送信されます。確認の為にPico単体でプログラムを実行する必要はありません。

マウス操作

タクトスイッチBが押された場合に、click関数を使ってPicoからPCにマウスの「右クリック」を送信します。

    # タクトスイッチBが押された(立ち上がり)
    if nowB == 1 and beforeB == 0:
        print("sendB")
        mouse.click(Mouse.RIGHT_BUTTON)

その他の操作方法

前述した関数やキー以外にも、様々な操作をPCに送信することができます。紹介は一部のみになるので、詳細は後述の公式リファレンスをご覧ください。

デバイス	関数	内容
keyboard	press	引数で指定したキーを押したままにします。
	release	引数で指定したキーを離します。
	send	引数で指定したキーを1度押して、離します。

デバイス	関数	内容
mouse	click	引数で指定したボタンを1度押して、離します。
	move	引数(x,y,wheel)でポインタ移動やスクロールを行います。
	press	引数で指定したキーを押したままにします。

公式リファレンス

まとめ

RaspberryPi Pico CircuitPythonで、キーボードやマウスなどの入力装置(HID)を作る方法を解説しました。

PicoとCircuitPythonの組み合わせは、ボードも低価格で、プログラムも短くてすむため、自作のキーボードや、ショートカットデバイスなどを「安く・簡単に」作るのに、おすすめの組み合わせだと思います。

「マウス・キーボードってどう作るんだろう？」「安くて簡単に作りたい」と考えている方は、ぜひPico+CircuitPythonで作ってみてください。

参考になればうれしいです。

自作する時間のない方は・・・

ここまでの解説をみて「作る時間ないな…」「自分にはちょっと難しそう…」と感じたら、以下のデバイスをおすすめします。

ボタンやダイヤルの動きはカスタマイズ可能。幅広いアプリで使えるので、画像編集から事務作業まで作業効率爆上がりです。Picoを使った自作デバイスは、このツール導入でできた空き時間で、ゆっくりと進めてみてください。

TourBox Elite [公式ストア] イラスト動画画像編集、片手デバイス、Bluetooth 5.0搭載、触覚フィードバック、カスタマイズキーボードショートカット、Clip Studio Paint GIMP SAI MediBang Photoshop Lightroom Premiere Davinci Resolve Illustrator、Windows/Mac PCに対応

¥39,960 （2023/05/02 11:16時点 | Amazon調べ）

ポチップ

お知らせ

今月の雑誌 Interfaceは、Pico W記事が満載です

今月の雑誌「Interface」は、RaspberryPi Pico Wの特集！

PicoWでのBluetoothやWi-Fiの使い方が重点的に解説され、Bluetoothの基礎知識、アプリの開発方法(3言語)、スマホと連携した赤外線リモコンの作り方などなど、Pico Wだらけな一冊になっています。（ChatGPTと作るPico W用アプリ開発まである)

Pico WやBluetoothに詳しくなりたい人は、是非チェックしてみてください。

Interface (インターフェース) 2024年 01月号

CQ出版

¥1,430 （2023/11/22 13:27時点 | Amazon調べ）