Skip to content

tinygo-keeb/workshop-conf2025badge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tinygo-keeb/workshop-conf2025badge

このページは conf2025badge を用いた workshop のための記事です。 不明点はこのリポジトリの Issue や twitter:sago35tk で質問いただければサポートします。

ハードウェアの組み立ては以下を参照してください。

環境設定

TinyGo のインストール

以下のインストールが必要です。 TinyGo については、適宜最新バージョンを使用してください。

ただし Go と TinyGo で Version の組み合わせがあるので注意が必要です。 TinyGo は基本的に最新および直前 Version の Go と組み合わせて使う必要があります。

TinyGo 対応する Go
0.39.0 1.25 - 1.24
0.38.0 1.24 - 1.23

それぞれの実行体に PATH が通っていれば使うことができます。 少し Version が古いですが以下も参考になると思います。

インストールできたかの確認は以下で実施することができます。

$ tinygo version
tinygo version 0.39.0 windows/amd64 (using go version go1.25.0 and LLVM version 19.1.2)
$ tinygo build -o out.uf2 --target xiao-rp2040 --size short examples/serial
   code    data     bss |   flash     ram
   9896     108    5256 |   10004    5364
$ tinygo flash --target xiao-rp2040 --size short examples/serial
   code    data     bss |   flash     ram
   9896     108    5256 |   10004    5364

$ tinygo monitor --target xiao-rp2040
Connected to COM12. Press Ctrl-C to exit.
hello world!
hello world!
hello world!

Windows + WSL2

WSL2 上の Ubuntu などには linux 版の TinyGo を使うことができます。 しかし WSL2 から Windows ホスト上の USB につながっているものを直接見ることはできないため苦労が付きまといます。 WSL2 を使う場合においても、基本的には Windows 版の TinyGo を Windows のパスにインストールするほうが良いです。 この場合、 Go も Windows 版をインストールしておく必要があります。

どうしても WSL2 上の TinyGo からやり取りしたい場合は以下のように usbipd を使う手もあります。 しかし tinygo flash をするたびに usbipd の attach が必要となるためあまり快適ではない気がします。

Linux での設定

Linux で tinygo flashtinygo monitorVial を使うには udev rules の設定が必要です。 以下の内容で /etc/udev/rules.d/99-conf2025badge-udev.rules を作成し再起動してください。

# RP2040
# ref: https://docs.platformio.org/en/latest/core/installation/udev-rules.html
ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="[01]*", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1", ENV{ID_MM_PORT_IGNORE}="1"

# Vial
# ref: https://get.vial.today/manual/linux-udev.html
KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{serial}=="*vial:f64c2b3c*", MODE="0660", GROUP="users", TAG+="uaccess", TAG+="udev-acl"

上記と同じ内容のファイルが以下にあります。

上記ファイルは以下のドキュメントから作成しています。 詳細等を確認する場合は適宜参照してください。

TinyGo の dev branch 版

開発中の最新 Version を使いたい場合、 GitHub Actions でビルドされた Artifact > release-double-zipped をダウンロードしてください。

詳細は以下を参照してください。

LSP / gopls 対応

TinyGo は、 machine package などを GOROOT に配置しているため設定を行うまでは gopls 等でエラーが表示され machine.LED の定義元へのジャンプ等が出来ません。 TinyGo は machine package など (Go を良く知っていても) 慣れていない package 構成であったり、 build-tag による分岐などが多いため TinyGo 用の LSP の設定をしておいた方が無難です。

公式ドキュメントは以下にあります。

VSCode の場合は TinyGo という拡張をインストールすると良いです。 Vim (+ vim-lsp) の場合は github.com/sago35/tinygo.vim を使ってみてください。

日本語の情報としては以下に記載しています。

コマンドライン補完 (Bash / Zsh / Clink)

Bash / Zsh / Clink を使っている場合は、以下をインストールすることでコマンドライン補完を導入できます。

https://github.com/sago35/tinygo-autocmpl

開発対象

conf2025badge のマイコンは RP2040 (Cortex M0+) で、マイコンボードは Seeed Studio XIAO RP2040 を使用しています。

主な機能は以下の通りです。

  • XIAO RP2040
  • RGB LED 付きの 2 キー
  • マウスカーソルの移動などに使用できる 2 軸アナログジョイスティック
  • ロータリーエンコーダー
  • 有機 EL ディスプレイ (OLED) - 128x64 単色
  • ブザー

回路図、ファームウェア、ピン配置等は以下から確認することができます。

組み立て

はんだ付け等の手順はビルドガイドにて。

TinyGo の基本

最初にこのリポジトリをどこかに git clone しておいてください。 以降、このリポジトリのルートからコマンドを実行していきます。 ソースコードを変更してみる場合は、ローカルのコードを修正してください。

$ git clone https://github.com/tinygo-keeb/workshop-conf2025badge

$ cd workshop-conf2025badge

# VS Code などを立ち上げる
$ code .

ソースコードは ./00_basic などのパスにあります。

ビルド+書き込み方法

TinyGo ではコマンドラインからビルド+書き込みを行うことができますが、ここでは手動での書き込み方法を学びます。 RP2040 搭載のボードは BOOT / BOOTSEL と呼ばれているボタン (XIAO RP2040 の場合は B) を押しながらリセット (リセットボタンを押す、 USB に接続する、等) をすることでブートローダーに遷移することができます。 ブートローダーに遷移すると PC からは外付けドライブとして認識するので、あとは書き込みたいバイナリファイル (*.uf2) を D&D などでコピーすることで書き込みできます。

ここでは以下を書き込みしてみてください。

キースイッチ部の LED が光っていたら書き込み成功です。

※この書き込み方法は TinyGo 以外で作られた uf2 ファイルに対しても有効です

上記の 00_basic.uf2 を自分で作成する場合は以下のコマンドを実行します。 エラーメッセージ等が表示されず、 00_basic.uf2 ができていれば成功です。

$ tinygo build -o 00_basic.uf2 --target xiao-rp2040 --size short ./00_basic/
   code    data     bss |   flash     ram
  23348     228    5312 |   23576    5540

ビルド+書き込み方法 (その2) + シリアルモニター

tinygo flash コマンドを用いてビルドと書き込みを一度に実施することもできます。 エラーメッセージ等が表示されなければ正常に書き込みが完了しています。 Linux 環境で失敗する場合は、前述の udev rules の設定を確認してください。

$ tinygo flash --target xiao-rp2040 --size short examples/serial
   code    data     bss |   flash     ram
   9896     108    5256 |   10004    5364

上記で書き込んだ examples/serial はシリアル出力に hello world! と表示する例です。 以下で動作を確認することができます。

$ tinygo monitor
Connected to COM7. Press Ctrl-C to exit.
hello world!
hello world!
hello world!

うまく接続できない場合は port を調べて --port オプションを追加してください。 xiao-rp2040 は、 RP2040 マイコンを使うほかのボードと共通の USB VID/PID を使っているので Boards のところが正しく表示されないケースがありますが気にしないでください。

$ tinygo ports
Port                 ID        Boards
COM7                 2E8A:000A xiao-rp2040

$ tinygo monitor --port COM7
Connected to COM7. Press Ctrl-C to exit.
hello world!
hello world!
hello world!

tinygo flashtinygo monitor を一つにまとめた tinygo flash --monitor という実行方法もあります。 が、環境によっては接続先ポートを誤ったりするケースがあるため、うまく動かない場合は上記のように別で実行してください。

$ tinygo flash --target xiao-rp2040 --size short --monitor examples/serial
   code    data     bss |   flash     ram
   9896     108    5256 |   10004    5364
Connected to COM7. Press Ctrl-C to exit.
hello world!
hello world!
hello world!

macOS 15 Sequoia で tinygo flash 出来ない場合 (TinyGo 0.37 以前のみ)

※この問題は micchie さんにより修正され TinyGo 0.38 にマージされました

$TINYGOROOT/targets/rp2040.jsonmsd-volume-nameNO NAME を追加してください。
$TINYGOROOT は tinygo env で調べることができます。

変更後の JSON ファイルは以下です。

{
    "inherits": ["cortex-m0plus"],
    "build-tags": ["rp2040", "rp"],
    "flash-1200-bps-reset": "true",
    "flash-method": "msd",
    "serial": "usb",
    "msd-volume-name": ["RPI-RP2", "NO NAME"],
    "msd-firmware-name": "firmware.uf2",
    "binary-format": "uf2",
    "uf2-family-id": "0xe48bff56",
    "rp2040-boot-patch": true,
    "extra-files": [
        "src/device/rp/rp2040.s"
    ],
    "linkerscript": "targets/rp2040.ld",
    "openocd-interface": "picoprobe",
    "openocd-transport": "swd",
    "openocd-target": "rp2040"
}

macOS で 「ディスクの不正な取り出し」 の通知がたまっていくのを何とかしたい

ターミナルを開いて以下を実行して再起動すると、通知が出なくなるようです。

$ sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.DiskArbitration.diskarbitrationd.plist DADisableEjectNotification -bool YES && sudo pkill diskarbitrationd

元に戻したい場合は以下を実行して再起動してください。

$ sudo defaults delete /Library/Preferences/SystemConfiguration/com.apple.DiskArbitration.diskarbitrationd.plist DADisableEjectNotification && sudo pkill diskarbitrationd

See: https://www.reddit.com/r/mac/comments/vsn1t6/how_to_disable_not_ejected_safely_notification_on/

どうしても書込みが出来ない

以下の可能性があります。

  • USB ケーブルに問題がある
    • tinygo ports で認識するか、あるいはドライブとして認識するかを確認する
  • 外付けドライブへの書き込みが制限されている
    • 会社のパソコン等はセキュリティの兼ね合いで書き込みが制限されているケースがある
    • この場合、 tinygo flash も uf2 のコピーもできない

L チカ

以下を実行してください。

$ tinygo flash --target xiao-rp2040 --size short ./01_blinky1/

無事に XIAO RP2040 の RGB LED が光ることが確認出来たらソースコードを変更して色や点滅速度を変えてみましょう。 以下の black や white のところに color.Color を設定することができます。

// 01_blinky1/main.go
for {
    time.Sleep(time.Millisecond * 500)
    ws.PutColor(black)
    time.Sleep(time.Millisecond * 500)
    ws.PutColor(white)
}

その他の色の例は以下になります。 RGBA を指定して任意の色を設定することができます。 0xFF を小さい値にすることで光り方を (ある程度) 弱めることができます。

red     = color.RGBA{R: 0xFF, G: 0x00, B: 0x00, A: 0xFF}
green   = color.RGBA{R: 0x00, G: 0xFF, B: 0x00, A: 0xFF}
blue    = color.RGBA{R: 0x00, G: 0x00, B: 0xFF, A: 0xFF}
yellow  = color.RGBA{R: 0xFF, G: 0xFF, B: 0x00, A: 0xFF}
cyan    = color.RGBA{R: 0x00, G: 0xFF, B: 0xFF, A: 0xFF}
magenta = color.RGBA{R: 0xFF, G: 0x00, B: 0xFF, A: 0xFF}

L チカ (その2)

キーを光らせてみましょう。 基板には WS2812B 互換の SK6812MINI-E が 2 個搭載されています。

以下を実行してください。 無事に動いたらソースコードを変更して色や点滅速度や点滅パターンを変えてみましょう。

$ tinygo flash --target xiao-rp2040 --size short ./02_blinky2/

先ほどの例とは異なり PutColor() の代わりに WriteRaw() が使われています。
基板上の上側のボタンが 0 番目の LED で、下側のボタンが 1 番目の LED となります。
コードにあるように ws.WriteRaw() を使うと複数の LED を一度に制御することが可能です。

// 上下両方の LED を白色にする
ws.WriteRaw([]uint32{0xFFFFFFFF, 0xFFFFFFFF})

// 上側の LED を緑、下側を白色にする
ws.WriteRaw([]uint32{0xFF0000FF, 0xFFFFFFFF})

WriteRaw() は uint32 で色を指定することができます。 最上位から 8 bit ずつ Green / Red / Blue という形で値を設定します。 例えば以下のようになります。

colors := []uint32{
    0xFFFFFFFF, // white
    0xFF0000FF, // green
    0x00FF00FF, // red
    0x0000FFFF, // blue
}

USB CDCで Hello World

Printf デバッグなどにも使えるし何かと使いどころのある USB CDC も実行しておきましょう。 USB CDC は Universal Serial Bus Communications Device Class の略で、雑な説明としてはパソコンとマイコン間で通信を行うためのものです。 説明するよりも実際に試したほうが分かりやすいので、まずは以下を実行してみてください。

$ tinygo flash --target xiao-rp2040 --size short examples/serial

$ tinygo monitor

Windows で実行すると以下のようになります。

$ tinygo flash --target xiao-rp2040 --size short examples/serial
   code    data     bss |   flash     ram
   9896     108    5256 |   10004    5364

$ tinygo monitor
Connected to COM7. Press Ctrl-C to exit.
hello world!
hello world!
hello world!
(以下省略)

examples/serial は以下のようなソース (./03_usbcdc-serial) です。 hello world! を表示してから 1 秒待つ、を繰り返しています。 こちらも待ち時間や、表示文字列の変更、あるいは fmt.Printf() を使った書き込み、などに変えてみてください。

$ tinygo flash --target xiao-rp2040 --size short ./03_usbcdc-serial/

標準入力は以下のようなソース (./04_usbcdc-echo/) で扱うことができます。 改行は Enter / Return キーを押した後 Ctrl-j を押す必要があります。

$ tinygo flash --target xiao-rp2040 --size short ./04_usbcdc-echo/
// ./04_usbcdc-echo/main.go
package main

import (
	"bufio"
	"fmt"
	"os"
)

func main() {
	scanner := bufio.NewScanner(os.Stdin)
	for scanner.Scan() {
		fmt.Printf("you typed : %s\n", scanner.Text())
	}
}

ロータリーエンコーダー

tinygo-org/drivers にある encoders/quadrature を使うことができます。

conf2025badge 用に設定を合わせたものは以下の通りです。

// ./05_rotary/main.go
enc := encoders.NewQuadratureViaInterrupt(
    machine.GPIO3,
    machine.GPIO4,
)
enc.Configure(encoders.QuadratureConfig{
    Precision: 4,
})

以下のコマンドで書き込み、動作確認が可能です。 ロータリーエンコーダーを動かすと value の表示が更新されます。 LED と連動させてみたりすると面白いでしょう。

$ tinygo flash --target xiao-rp2040 --size short ./05_rotary/
   code    data     bss |   flash     ram
  10080     108    5712 |   10188    5820

$ tinygo monitor
Connected to COM7. Press Ctrl-C to exit.
value:  -1
value:  -2
value:  -1
value:  0
value:  1
value:  2
(以下省略)

なおロータリーエンコーダーは押下するとボタンとして扱うことができます。 ロータリーエンコーダーの押下状態の取得については後述します。

ロータリーエンコーダーの押下状態を取得する

ロータリーエンコーダーを押下すると GND と接続されて Low になります。 (プルアップしておけば) 押下していない状態では High になります。

基本的には以下のようなコードになります。

// ./13_rotary_button/main.go
if !btn.Get() {
    println("pressed")
} else {
    println("released")
}
$ tinygo flash --target xiao-rp2040 --size short ./13_rotary_button/
   code    data     bss |   flash     ram
  10024     108    5256 |   10132    5364

$ tinygo monitor

ロータリーエンコーダーを押すと、tinygo monitor を実行中の terminal に pressed が出力されます。

アナログジョイスティック

アナログジョイスティックは XY の二軸に対してアナログ値として認識されます。 なので以下のように扱うことができます。

$ tinygo flash --target xiao-rp2040 --size short ./06_joystick/
   code    data     bss |   flash     ram
  60136    1568    5264 |   61704    6832

$ tinygo monitor --target xiao-rp2040
Connected to COM10. Press Ctrl-C to exit.
6E10 7E10
6E00 7E30
(以下省略)

左から X 軸値 (電圧を表す値)、 Y 軸値を表します。 何もしていないときは 0x8000 に近い値が表示されます。

OLED

tinygo-org/drivers にある ssd1306/i2c_128x64 を使うことができます。

conf2025badge 用に設定を合わせたものは以下の通りです。

// ./07_oled/main.go
machine.I2C1.Configure(machine.I2CConfig{
    Frequency: machine.TWI_FREQ_400KHZ,
    SDA:       machine.GPIO6,
    SCL:       machine.GPIO7,
})

display := ssd1306.NewI2C(machine.I2C1)
display.Configure(ssd1306.Config{
    Address: 0x3C,
    Width:   128,
    Height:  64,
})

以下のコマンドで書き込み、動作確認が可能です。

$ tinygo flash --target xiao-rp2040 --size short ./07_oled/

図形を描画する

$ tinygo flash --target xiao-rp2040 --size short ./08_oled_tinydraw/

文字列を描画する

$ tinygo flash --target xiao-rp2040 --size short ./09_oled_tinyfont/

アニメーションさせる

display.ClearBuffer()display.Display() を用いることでちらつきなく画面を書き換えることができます。

$ tinygo flash --target xiao-rp2040 --size short ./11_oled_animation/

日本語を表示する

現在 BDF と OTF/TTF フォントのいずれかが表示できます。
conf2025badge のような 1bit color の小型ディスプレイだと BDF フォントが適しています。
以下にて使用することができます。

$ tinygo flash --target xiao-rp2040 --size short ./17_oled_japanese_font/

キー押下状態を取得する

conf2025badge のキーは、 1 キーに対してマイコンの入力ピンを 1 つ用意する形になっています。 読み取るには入力ポートに設定を行い Get() を使って状態を読み取ります。 回路との兼ね合いで machine.PinInputPullup にしておく必要があります。

$ tinygo flash --target xiao-rp2040 --size short ./12_key_input/

$ tinygo monitor
上側のボタンが押されました
上側のボタンが押されました
上側のボタンが押されました
上側のボタンが押されました
下側のボタンが押されました
(省略)

自作キーボードで多数のキー入力を扱う場合

例えば HHKB などは 70 キーぐらいのキーがあります。 これを前述のやり方を使ってマイコンから読み取ろうとすると、マイコンに 70 ピンぐらいの入力ピンが必要となります。 これはなかなかに厳しいので、様々な読み取り方が考案されています。 代表的なものには matrix という方式があります。

興味がある人は以下を読んでみてください。

Pin 入力を使った USB HID Keyboard

キーの押下状態を使って USB HID Keyboard を作ってみましょう。 以下のコードにより押下状態と A キーを連動させることができます。 TinyGo では machine/usb/hid/keyboard を import して keyboard.Port() をコールするとキーボードとして認識させることができます。

// ./14_hid_keyboard/main.go
kb := keyboard.Port()
for {
    if !btn.Get() {
        kb.Down(keyboard.KeyA)
    } else {
        kb.Up(keyboard.KeyA)
    }
    time.Sleep(1 * time.Millisecond)
}
$ tinygo flash --target xiao-rp2040 --size short ./14_hid_keyboard/

上側のキーを押して動作を確認してみましょう。

Pin 入力を使った USB HID Mouse

キーの押下状態を使って今度は USB HID Mouse を作ってみましょう。 以下のコードによりボタンの押下がマウスの左クリックになります。

// ./15_hid_mouse/main.go
m := mouse.Port()
for {
    if !btn.Get() {
        m.Press(mouse.Left)
    } else {
        m.Release(mouse.Left)
    }
}
$ tinygo flash --target xiao-rp2040 --size short ./15_hid_mouse/

上側のキーを押して動作を確認しましょう。

MIDI を使ってみる

TinyGo は USB MIDI に対応しているので、 MIDI 音源にしたり、 MIDI 楽器にすることができます。
12 個のキーおよびロータリーエンコーダーの押し込みを使用することができます。

$ tinygo flash --target xiao-rp2040 --size short ./18_midi/

作成後は例えば以下のようなサイトで試すことができます。

Windows 環境では MIDI-OX を使うとよいでしょう。

buzzer を使う

ブザーを鳴らす方法はいろいろありますが、ここでは PWM を使用します。
TinyGo で PWM を使用する場合、マイコン毎の設定が若干残っていることに注意が必要です。

conf2025badge では以下の設定を使用することができます。
必要なのはどのピンを使うか、どの PWMGroup を使うか、です。

bzrPin := machine.GPIO1
pwm := machine.PWM0
speaker, err := tone.New(pwm, bzrPin)

このあとは tinygo.org/x/drivers/tone を使うと音を鳴らすことができます。

// C5 を鳴らす
speaker.SetNote(tone.C5)

// 音を止める
speaker.Stop()

書き込みは以下です。

$ tinygo flash --target xiao-rp2040 --size short ./22_buzzer/

sago35/tinygo-keyboard を使う

自作キーボードに必要な要素、というのは人によって違うと思います。 しかしその中でも

  • レイヤー機能
  • ビルドしなおすことなく設定変更できる
  • 各種スイッチ読み取り方法が package になっている

というあたりが必要なことが多いです。 そのあたりを毎回自前で作成するのは大変なので、何らかのライブラリなどを使うことが多いと思います。 ここでは、拙作の sago35/tinygo-keyboard を使って自作キーボードを作っていきましょう。

sago35/tinygo-keyboard を使うと以下のような機能を簡単に導入することができます。

  • 様々な方式のキー入力 (matrix や GPIO やロータリーエンコーダーなど) に対応
    • 自分で拡張を書くことも可能
  • レイヤー機能
  • マウスクリック、ポインタ移動との統合
  • TRRS ケーブルによる分割キーボードサポート
  • Vial による Web ブラウザ経由での書き換え
    • キーマップ
    • レイヤー
    • matrix tester (キースイッチの押下テスト)
    • マクロ機能

特に Vial での書き換えが重要であり、これにより各自の好みの設定に変更しやすいです。 Vial は以下にあり、 WebHID API に対応した Edge / Chrome などからアクセスすることで設定変更が可能です。

基本的な使い方

使い方の詳細については以下に記載しました。

conf2025badge の tinygo-keybord firmware

以下にあります。

koebiten

TinyGo 向けに 2D ゲームエンジン koebiten を開発しています。 これは、 Go 向け 2D ゲームエンジン Ebitengine の TinyGo 版のような位置づけです。 conf2025badge を含む複数のハードウェアへの対応、シンプルな API が特徴です。

サンプルの実行してみるだけでもよいでしょう。 以下から UF2 をダウンロードすることができます。

Zenn にて入門記事を作っているので参考にしてください。

トラブルシュート

  • プログラムの書き込みが出来ない

tinygo ports コマンドでマイコンが認識されているか確認してください。正常に認識されていれば、xiao-rp2040 が出力されます。 なお、 VID:PID が 2E8A:000A のものは複数あるため xiao-rp2040 と表示されずに pico と表示されるケースもあるので注意。

$ tinygo ports
Port                 ID        Boards
COM7                 2E8A:000A xiao-rp2040

認識されていない場合は、マイコンをPCから外して挿し直してください。

その他 Tips など

  • 写真や動画を撮るときは 30 フレーム / 秒とかにしておくと液晶がちらつかない

お知らせ

TinyGo 0.26 + Wio Terminal という組み合わせで技術書「基礎から学ぶ TinyGoの組込み開発」 (2022/11/12 発売) を執筆しました。本ページと合わせて確認してみてください。