変更履歴 — Hapbeat Python SDK

This content is not available in your language yet.

hapbeat-python-sdk（import 名: hapbeat）の主要な変更点をまとめます。

0.2.0 — 送信をユニキャスト化

変更（既定の挙動）

PLAY / STOP / STOP_ALL とクリップストリームを、PING に応答した既知デバイスへユニキャスト送信するようになりました（connect(unicast=False) で従来のブロードキャストに戻せます）。Wi-Fi AP は、同じ AP に省電力状態の端末が 1 台でもいるとブロードキャストフレームを次の DTIM ビーコン（100〜300 ms 周期）まで保留します。これが単発コマンドの発火遅れ、連続ストリームの周期的な途切れとして出ていました。デバイス側の設定では回避できない（原因は無関係な他端末）ため、送信側で対処します。 Unity SDK で実測・検証済みの方針をそのまま移植したものです。
- 応答があったデバイスが 1 台も無い間はブロードキャストで送ります（起動直後など）。
- ユニキャストとブロードキャストの二重送信はしません。
- target に一致しないデバイスは宛先から外します。アドレス未報告のデバイスは宛先に残します（デバイス側で同じ判定をするため、外すと取りこぼしになる）。
- 既知デバイスがいて全て target 不一致だった場合、コマンドはブロードキャストにフォールバックします（キャッシュしたアドレスが古いときに STOP が消えてループ再生が止まらなくなるのを防ぐため）。ストリームは送信しません（数百パケット分の電波を無駄にするため。取りこぼしても何も残らない）。
- PING と CONNECT_STATUS はデバイス検出のためブロードキャストのままです。
キープアライブが PING も送るようになりました（従来は CONNECT_STATUS のみ）。デバイスが PONG を返すのは PING に対してだけなので、これが無いとユニキャストの宛先表が device_ttl で空になり、以後ずっとブロードキャストに戻ってしまいます。 app_name を渡していない接続でもキープアライブが動くようになりました。

追加

connect(unicast=..., device_ttl=...) — ユニキャストの有効/無効と、最後の PONG から何秒間デバイスを宛先として保持するか（既定: キープアライブ間隔 × 3、最小 5 秒）。
protocol.address_matches(target, device_address) — ファームウェアの addressMatch() と同一セマンティクスの判定関数。contracts §4.2 の例表をそのまま pytest に移植しています。
UdpClient.send_many(packet, addrs)。
hapbeat コマンドを実行したときに、新しい版が公開されていれば 1 行だけ知らせるようになりました。同じ版については 24 時間に 1 回まで（hapbeat play のような短命コマンドを連続実行してもうるさくならないように間引きます）。新しい版が出た場合は間隔を待たずに知らせます。
- import hapbeat では一切ネットワークにアクセスしません。 CI やオフライン環境でライブラリの import が外部通信するのは副作用として不適切なため、確認は CLI 実行時のみです。
- コマンドの実行を待たせません。取得済みの情報が無い回は裏で取りに行くだけで、その回は何も出しません（次に CLI を使ったときに出ます）。
- 無効化: HAPBEAT_NO_UPDATE_CHECK=1

修正

Windows で、応答しないデバイスへ送信した後に受信スレッドが停止し、以後デバイスを一切検出できなくなる問題を修正しました。ICMP port unreachable が次の recvfrom() で ConnectionResetError として現れるため、SIO_UDP_CONNRESET=False で抑止し、受信ループも回復可能なエラーで停止しないようにしています。ユニキャストでは電源 OFF / 再起動中のデバイスに送ることが日常的に起きるため、この修正はユニキャスト化とセットで必須です（hapbeat-helper の同種修正と同じ対処）。

注意

部分ワイルドカードは使えません。 * はセグメント全体が * のときだけワイルドカードとして働きます（player_1/pos_* は不一致、player_1/* は一致）。 contracts の例表に誤りがあったため、仕様側も併せて訂正しました。

0.1.0 — 初の公開リリース

Hapbeat 触覚デバイスを Wi-Fi UDP で駆動する Python SDK。コア機能は実行時依存ゼロ（標準ライブラリの socket のみ）で、OSC ブリッジは任意の追加依存です。

Fire API（level-1）

connect() / Hapbeat.play / stop / stop_all / ping / connect_status。
デバイス検出（PING/PONG）付きの UDP ブロードキャスト transport。
受信ソケットは既定で ephemeral（OS 任せ）なローカルポートに bind するため、 UDP 7700 を占有する hapbeat-helper / Hapbeat Studio と共存できます。

触覚の編集側（EventMap）

EventMap.from_manifest / from_kit / from_dict — kit manifest（schema 2.0.0）の events（command）と stream_events（clip）バケットを読み込みます。
Haptic file EventMap.from_file("haptics.json") — kit を参照しつつ、イベント単位の target / gain を上乗せするオーバーレイ。呼び出し側が target を渡さなくても play(id) が解決します（Unity SDK の EventMap と同等）。

command / clip 再生

play(id) が manifest を見て自動分岐します。command（デバイスが導入済みクリップを再生）と clip（SDK が WAV を UDP でストリーミング）。
ClipStreamer — ペーシングした STREAM_BEGIN/DATA/END（256 ms リング対応）、セッション単位で単一ストリーム。play_clip / play_clip_file / stream_pcm （アドホック PCM。例: ステレオの方向手がかり）/ preload_clips。
16 kHz モノラル PCM16 の WAV（実行時リサンプルなし。16 kHz 以外は警告）。

ツール

汎用 OSC ブリッジ（/hapbeat/*）。pip install "hapbeat-python-sdk[osc]" で入る任意依存です。hapbeat osc-bridge --haptics/--kit が command/clip を振り分け、イベント単位の target を適用します。
ブラウザ launchpad（hapbeat launchpad）— イベント / メトロノーム / 呼吸 / モールスを試せるローカル web ページ。各カードに等価な CLI コマンドを表示します。
hapbeat CLI: scan / play / stop / stop-all / ping / osc-bridge / launchpad。

サンプル

minimal、clip_project（kit をプロジェクト内に同梱）、osc_remote（TouchOSC リモート）、 psychophysics_experiment、breathing_pacer、metronome、haptic_pad、 task_notifier、morse_text — いずれも単一ファイル・標準ライブラリのみ。

未実装（level-2）: clip のリアルタイム gain/pan バインドとマルチソースミキシング、 mDNS 検出、高レベルなトリガー抽象化。