bluepyで、ペアリング成功、ペアリング失敗、ペアリング切断の検出を行いたい

Question

わからないこと

bluepyライブラリを使って、ペアリング成功、ペアリング失敗、ペアリング切断の検出を行いたいのですが、実現法が分からず困っています。

実現したいこと

RasberryPi Zero WをBLEセントラルにしたいと考えています。

今回はbluepyを使って、セントラルとしての機能を作成します。
接続相手のペリフェラルのMACアドレスは今回決め打ちであるため、
btle.Peripheral()を引数無しでインスタンス化した後、
Peripheral.connect(macAdrr)を呼び出してペリフェラルに接続を行います。

このあと、
・ペアリングが成功した時
・ペアリングが失敗した時
・ペアリング成功し、通信を行っている最中に相手が落ちてしまうなどしてペアリングが切断されてしまった時
それぞれのイベントをハンドリングし、適宜処理を行いたいと考えています。

認識していること

通知イベントのハンドルは、DefaultDelegateクラスを継承したクラスを定義し、
オーバーライドしたhandleNotification()でハンドリングすることで行うのはよく理解できました。
ただ、handleNotification()はあくまで「ペリフェラルから通知を受信したとき」にコールバックされるものであり、
接続・切断の発生といった、通信モジュールの状態変化の際にコールバックがあるものではないと認識しています。

コードイメージ

まだ設計段階なので本物のコードはないのですが、実装イメージとしては以下の通りです。
（bluepyのコード例を借りて即興で作りました）
ペリフェラルにコネクトした後メインループに入って他タスクからのキューメッセージを待受け、
他タスクからメッセージが来たらペリフェラルにWrite要求を発行します。
「p.connect()の失敗or成功」及び「メインループに入った後のペアリング切断」をなんらかの方法でハンドリングしたいです。

import btle

# 通知をハンドルするデリゲート用クラス
class MyDelegate(btle.DefaultDelegate):
    def __init__(self, params):
        btle.DefaultDelegate.__init__(self)
        # ... initialise here

    def handleNotification(self, cHandle, data):
        # ペリフェラルからの通知受信時に行う処理をここに書く
        # （通信モジュールの状態変化はここでハンドルすることはできない？）

# 他タスクスレッド生成などの初期処理がこのあたりに記述される。今回は省略

# インスタンス生成
p = btle.Peripheral()

# 通知ハンドル用クラスをセット
p.withDelegate( MyDelegate(params) )

# ペリフェラルにコネクト
p.connect('XX:XX:XX:XX:XX:XX')

# サービスを取得（サービスは1つだけの想定です）
svc = p.getServiceByUUID( service_uuid )

# キャラクタリスティックを取得（キャラクタリスティックも1つだけの想定です）
ch = svc.getCharacteristics( char_uuid )[0]

# Main loop --------
while True:
	# ここで他タスクからのキューメッセージをブロッキングで待つ
	event_id = waitMsg()
	
	if event_id == DATA_SEND_REQ_EVENT:
		# データWrite要求発行（今回の通信はセントラル⇒ペリフェラル方向のみです）
		ch.write( data )

Comments

[y_waiwai]

コードを提示しましょう

Answer 1

・「接続(establish connection）の成功／失敗のハンドリング」ですが、
「接続相手のペリフェラルのMACアドレスは今回決め打ちである」とのことなので
一例として、下記のような動作を行う関数connect_with_retryを考えてみました。
１. 接続先ペリフェラルのMACアドレスを指定して接続を試みる。
２．接続開始から、指定した時間（例：10秒）経過しても接続できない場合は、指定した回数接続を試みる。
３．指定した回数（例：3回）行っても、接続できない場合は、「失敗」を返す。
４．指定した回数内で接続に成功した場合は「成功」を返す

def connect_with_retry(p: btle.Peripheral, macaddr: str, timeout=None, retry_count=1) -> bool:
    for _ in range(retry_count):
        try:
            p.connect(macaddr, timeout=timeout)
            print("接続に成功しました。")
            return True
        except btle.BTLEDisconnectError:
            print("タイムアウトしました。接続を再試行します。")
    else:
        print("規定のリトライ回数を超過しました。接続に失敗しました。")
        return False

# 使用側
p = btle.Peripheral()
p.withDelegate( MyDelegate(params) )
if connct_with_retry(p, 'XX:XX:XX:XX:XX:XX', timeout=10, retry_count=3) == False:
    # 接続失敗時の処理

・「ペアリング成功し、通信を行っている最中に相手が落ちてしまうなどしてペアリングが切断されてしまった時」
これについては一定間隔で btle.PeripheralオブジェクトのgetState()関数を呼ぶようにすればよいと思います。
getState()関数を呼んだ段階で、仮に通信が切断されてしまっている場合は、、btle.BTLEDisconnectErrorが発生するはずなので、try...exceptで補足し、execept節に適切な処理を書けばいいのではないでしょうか。

Comments

[eleele28]

ありがとうございます！
メソッド読んだ後に発生する例外で判断するんですね！
通知受信時のhandleNotification()みたいに非同期イベントとしてハンドリングすることは不可能なんでしょうか…？

[退会済みユーザー]

>通知受信時のhandleNotification()みたいに非同期イベントとしてハンドリングする
ここでの「非同期イベントとしてハンドリングする」とは厳密にはどのような意味でしょうか？

仮に（”非同期イベント"の定義は無視するとして）「通知受信時のhandleNotification()みたいにハンドリングする」の意味を
「通信中に切断等が発生した場合のbtle.BTLEDisconnectError等を、処理ごとにtry...catch 節で素直に捕捉して処理するのではなく、MyDelegateクラスの中に関数を用意して、その関数の中で処理したい」という意味であれば、
元のbtle.pyのBluepyHelper._waitResp関数に手を加えるか、例外発生時の処理を捕捉する関数をデコレータとして作り、メイン処理の関数をそのデコレータでラップすることで対応できるとは思います。

[eleele28]

言葉が足りず申し訳ありません。
まさにそういうイメージです。
丁寧に説明して頂き、ありがとうございました。