ArduinoOSCを使ってOSC通信をしてみる #Arduino

2020.05.20 追記
[ArduinoOSC] を大幅にアップデートしたため、それに合わせてこちらの記事も修正しました。

結論と使い方

とにかくラクにOSCを送受信したかったので、ArduinoOSC ってやつを作りました。
こんな感じでサクッと送受信ができます。
WiFiではなくEthernetで使いたいときは、OscWiFi -> OscEther に変更して使ってください。

#include <ArduinoOSC.h>

int i; float f; String s;

void setup()
{
    // WiFi stuff
    WiFi.begin(ssid, pwd);
    WiFi.config(ip, gateway, subnet);

    // 受信したOSCパケットを直接変数にバインドします
    OscWiFi.subscribe(bind_port, "/bind/values", i, f, s);

    // デフォルト毎秒30回で、OSCパケットを定期的に送信し続けます
    OscWiFi.publish("127.0.0.1", publish_port, "/publish/value", i, f, s);
}

void loop()
{
    OscWiFi.update(); // 自動的に送受信するために必須
}

単発でのOSC送信も一行で可能です。

OscWiFi.send("127.0.0.1", send_port, "/send", 1, 2.2, "hello");

ラムダ式の引数として受信したOSCパケットをバインドすることも可能です。

OscWiFi.subscribe(bind_port, "/lambda/bind/args",
    [&](int i, float f, String s)
    {
        Serial.print("/lambda/bind/args ");
        Serial.print(i); Serial.print(" ");
        Serial.print(f); Serial.print(" ");
        Serial.print(s); Serial.println();
    }
);

もちろん、これまで通り OscMessage を引数にしたラムダ式も使えます。

OscWiFi.subscribe(recv_port, "/lambda/msg",
    [](const OscMessage& m)
    {
        Serial.print(m.remoteIP()); Serial.print(" ");
        Serial.print(m.remotePort()); Serial.print(" ");
        Serial.print(m.size()); Serial.print(" ");
        Serial.print(m.address()); Serial.print(" ");
        Serial.print(m.arg<int>(0)); Serial.print(" ");
        Serial.print(m.arg<float>(1)); Serial.print(" ");
        Serial.print(m.arg<String>(2)); Serial.println();
    }
);

もっと詳細な使い方は、README をご参照くださいませ。
以下、補足です。

ところでOSCってなに

詳細はWikipediaをご覧ください。

簡単に言うと

主にUDPの通信プロトコル
主にLAN内で、リアルタイム性の高い短いメッセージをやりとりする
音楽、インタラクティブアート系のソフトウェアの通信によく使われる

いろんなアプリケーション間で通信するのにとても便利で重宝します。
こちらの記事の言い回しを真似させてもらいました。

Arduinoで使える有名なライブラリ

OSC
- OSCのプロトコルを開発したCNMATの純正のやつ
- 詳細省きますが、エンコード・デコードやSLIP-SERIALが一手間で、だるい
ArdOSC
- Arduino UNOなど + Ethernetシールドを前提としたOSCライブラリ
- つまりW5100が必須

とかです。

OSCのパケット構造は、Unityですがこちらの記事の「OSCについて」の項目でざっくりわかりやすく説明してくれています。openFrameworksではこちらの記事でもとてもわかり易く解説されています。

動機

ESPとかいろんなプラットフォームで、とにかくサクッと使いたい
~~シリアルでOSC (っぽい感じで) 使いたい~~
- -> シリアル対応は削除しました。サクッとシリアル通信したいときは MsgPacketizer をどうぞ。

特徴

ESPなどのWiFi、EthernetでのUDP、~~シリアル~~ などで使える
簡単にOSCに使えるアプリ・フレームワークからサクッと送受信できる
- Max, Pd, Processing, openFrameworks, P5.js など (~~例としてMaxのサンプルがあります~~)
  - -> いろいろ追加してますが、欲しいアプリがあったらご連絡くださいませ
~~シリアルでも同じ感覚で使える (エセですが)~~

制限とTODO

~~現状 int32, float, String のメッセージのみ対応、拡張予定~~
~~シリアル用エセ拡張はまだMaxのみ、自分が必要なときに随時追加予定~~
~~あまりいないと思いますが、シリアル拡張ほしいアプリあればコメントください~~
Arduino Uno などのSTLが使えないマイコンでは、色々なサイズ制限があります (機能はフルで使えます)

まとめ

OSC最高ですね。
~~シリアルでも (エセですが) 使えて楽ちんですね。~~
OSC使ったことない方も、ぜひこの機会につかってみてください。
プルリク・Issue・コメントおまちしています！
~~(はやくシリアルも安定稼働させます、、、)~~