toio を Rust で制御するライブラリ

# toio-rs

toio を [Rust](https://www.rust-lang.org/) から動かすためのライブラリを作ったのでその紹介をします．

<a href="https://github.com/yushiomote/toio-rs"><img src="https://github-link-card.s3.ap-northeast-1.amazonaws.com/yushiomote/toio-rs.png" width="460px"></a>

![](https://raw.github.com/wiki/YushiOMOTE/toio-rs/demo.gif)

## いきさつ

おばあちゃんから娘（当時2歳）に toio が届きましたが，遊び方がわからないで放置されていました．これではもったいないので代わりにお父さん（当時32歳）が遊ぶことにしました．Rust で制御してみようと思ったのですが，ライブラリが見つからなかったので作りました．

## 主な特徴

* [toio™コア キューブ 技術仕様 2.1.0](https://toio.github.io/toio-spec/docs/2.1.0/about) の機能に対応．
* [JavaScript 版](https://github.com/toio/toio.js/) 相当の機能を持ってるはず．
* かんたんな API （進め！戻れ！光れ！）と，BLE メッセージレベルの細かい API を提供．
* async/await に対応している．
* cross platform （になろうとしている）
    * MacOS に対応
    * Linux 実装中
    * Windows はまだ始まっていない

## 設計と実装

![toio-rs (1).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/218662/1a8fcf6f-8977-7625-57bf-ae2c0504d6a8.png)

### BLE Abstraction

toio は Bluetooth 4.0 以降追加された Bluetooth Low Energy (BLE) とよばれる低消費電力の Bluetooth 通信規格で制御されます．そこで Rust の Bluetooth ライブラリを使います．

* macOS 用に [core_bluetooth](https://github.com/pingw33n/rust_core_bluetooth)
* Linux 用に [bluez](https://github.com/laptou/bluez-rs)
* Windows では [winrt](https://github.com/microsoft/winrt-rs) (予定)

[btleplug](https://github.com/deviceplug/btleplug) という cross platform なライブラリもありましたが，Service でデバイス検知できないなど現状少し機能が足りてなさそうでしたので個別にライブラリを使いました．

これらのライブラリを使った上で，BLE の基本的な操作（デバイス検索，接続，書き込み，読み込みなど）を抽象化します．

### Toio Protocol

[コアキューブ技術仕様](https://toio.github.io/toio-spec/docs/2.1.0/ble_communication_overview) に従って，各種メッセージ構造体を定義しました． [serde](https://github.com/serde-rs/serde) というシリアライザーをつかって toio が理解できるバイト列に変換できるようになっています．

構造体一覧は[こちら](https://docs.rs/toio/0.1.4/toio/proto/index.html)

### Low-level API

上記の構造体を toio に対して送信または受信するための API です．上記 Toio protocol で用意した構造体をシリアライズして， BLE Abstraction で用意した関数経由で送受信します．

### High-level API

Low-level API を少しラップして，よりシンプルな API を提供します．例えば，キューブを移動させる API はこんな感じです．

```rust
pub async fn go<'_>(
    &'_ mut self,
    left: isize, // 左車輪回転速度
    right: isize, // 右車輪回転速度
    duration: Option<Duration> // 回転時間
) -> Result<()>;
```

用意した API をざっくり一覧にまとめるとこんな感じになります．

* キューブの検索
* キューブの移動
* ライトの ON/OFF や点灯パターン指定
* 音の再生
* ID（Standard ID, Position ID）の取得
* 各種ステートの取得（バッテリ残量，ボタンの ON/OFF，傾き等）
* イベント（各種ステート変化）のサブスクライブ

API一覧は[こちら](https://docs.rs/toio/0.1.4/toio/struct.Cube.html)

## ライブラリの使い方

`Cargo.toml` の依存関係にこちらを追加します．API は基本的に `async` なので `tokio` という非同期ライブラリを一緒に入れます．

```toml
[dependencies]
toio = "0.1.4"
tokio = "0.2"
```

(`tokio` は Rust の async 関数を実行するための有名な非同期ライブラリです．名前が似すぎてて `rust toio` でググってもタイポ判定されて `tokio` でひっかかります）

### とりあえず前進

こちらは 3 秒間キューブを直進させるプログラムです．PC の Bluetooth (BLE) を有効にして，近くに電源を入れたキューブを置いておきます．そこで，このプログラムを実行します．

```rust
use std::time::Duration;
use toio::Cube;
use tokio::time::delay_for;

#[tokio::main]
async fn main() {
    // 一番近い toio キューブを見つける．
    let mut cube = Cube::search().nearest().await.unwrap();

    // 見つかったキューブに接続する．
    cube.connect().await.unwrap();

    // 右の車輪を速度 20 で正転，左も 20．この API は toio に指示を出してすぐもどってくる．
    cube.go(20, 20, None).await.unwrap();

    // 3秒間待つ．
    delay_for(Duration::from_secs(3)).await;

    // プログラムが終了するとコネクションは自動的に切断される（`cube` が `Drop` すると切断）
}
```

### Lチカ

LED を光らせます．

```rust
    // LED を RGB それぞれ 255 の強さで光らせる (範囲は 0 ~ 255)
    cube.light_on(255, 255, 255, None).await.unwrap();

    // 2 秒待つ．
    delay_for(Duration::from_secs(2)).await;

    // LED を消す．
    cube.light_off().await.unwrap();
```

### 音を鳴らす

キューブ内に用意されてる効果音を再生します．

```rust
    // Enter というプリセット効果音を再生
    cube.play_preset(SoundPresetId::Enter).await.unwrap();
```

また，Note を指定して音を鳴らします．

```rust
    // Note を指定して音を再生．
    cube.play(
        3,
        vec![
            SoundOp::new(Note::C5, Duration::from_millis(500)),
            SoundOp::new(Note::A6, Duration::from_millis(500)),
        ],
    )
    .await
    .unwrap();
```

### バッテリー情報などを取得

```rust
    println!("version   : {}", cube.version().await.unwrap());
    println!("battery   : {}%", cube.battery().await.unwrap());
    println!("slope     : {}", cube.slope().await.unwrap());
    println!("collision : {}", cube.collision().await.unwrap());
    println!("button    : {}", cube.button().await.unwrap());
```

他の例は[こちら](https://github.com/YushiOMOTE/toio-rs/tree/master/examples)．

## 動作確認

動作確認ということで，このライブラリを使っていくつかかんたんな toio プログラムを作りました．

### サンプル１: midi を演奏させる．

[![](http://img.youtube.com/vi/iaH0Cv1yn7A/0.jpg)](http://www.youtube.com/watch?v=iaH0Cv1yn7A)

![](https://cultofthepartyparrot.com/parrots/hd/ultrafastparrot.gif) < 興味ないね

MIDI ファイル を読み込んで，`toio` キューブに再生させるコマンドラインプログラムです．どの楽譜をどの cube に演奏させるかをオプションで指定できます．

`toio` は Note の配列を受け取ってそのとおり演奏する API を持っています．ただ 1 度に最大 59 個しか Note を送れないため，59 個再生時間相当待機して，また次の 59 個を送信するという動きをします．

<a href="https://github.com/yushiomote/toio-midi"><img src="https://github-link-card.s3.ap-northeast-1.amazonaws.com/yushiomote/toio-midi.png" width="460px"></a>

MIDI に関する知識が浅いので，ちょっとファイルによってはバグか誤解かで再生できないかもです．複数キューブの同期に苦労しました．まだずれてるかもです．

### サンプル２: ゲームコントローラーで制御する．

Rust にはゲームコントローラーからの入力を受け付けるライブラリがあるので，それを利用しました．動作確認は手元にあった PS4 用の DualShock 4 コントローラでためしています．

![](https://raw.github.com/wiki/YushiOMOTE/toio-con/toio-con.gif)

<a href="https://github.com/yushiomote/toio-con"><img src="https://github-link-card.s3.ap-northeast-1.amazonaws.com/yushiomote/toio-con.png" width="460px"></a>

### サンプル３: 鬼ごっこ

![](https://raw.github.com/wiki/YushiOMOTE/toio-hazard/demo.gif)

<a href="https://github.com/yushiomote/toio-hazard"><img src="https://github-link-card.s3.ap-northeast-1.amazonaws.com/yushiomote/toio-hazard.png" width="460px"></a>

鬼ごっこです．これは 2 つ以上の `toio` キューブを使います． 2つのうち1つは逃げる役，残りは全員鬼役です．逃げる役は ゲームコントローラーでプレイヤーが操作できます．他の鬼キューブは自動で勝手に追いかけてきます．できるだけ長く逃げましょう．

鬼と接触するたびにプレイヤーのライフが減り， LED が危ない色になります（バイオ的な）．ライフがゼロになるとゲームオーバー．

鬼プログラムの種類は拡張可能で，[鬼 `trait`](https://github.com/YushiOMOTE/toio-hazard/blob/5156eb5f976c5f32c0b29b3f4b3f0d3e980e991e/src/enemies/mod.rs#L10) を実装すると具体的な鬼が実装できます．

## まとめ

娘（現在 3 歳）も最近はやっと toio で遊べるようになりました．お父さんと取り合いになることもあります．

Rust は js などとはまた違ったライブラリの ecosystem を持ってると思うので，別の楽しみ方も見えてくるかもしれません．Linux & Windows 対応がまだですがゆっくり作っていきたいです．