ble_server
読み取り中…
検索中…
一致する文字列を見つけられません
ble_interface.py
[詳解]
1"""BLE GATTサーバー実装が満たす共通インターフェースを定義する。"""
2
3from abc import ABC, abstractmethod
4from typing import Callable, Optional
5
6RawDataCallback = Callable[[bytes], None]
7
8
9class IBleGattServer(ABC):
10 """BLE GATTサーバーの開始・停止・受信通知・応答値の契約。"""
11
12 @abstractmethod
13 async def start(self) -> None:
14 """BLEアドバタイズとGATTサービスを開始する。
15
16 Raises:
17 RuntimeError: アダプタ未検出、またはD-Bus接続に失敗した場合。
18 """
19 pass
20
21 @abstractmethod
22 async def stop(self) -> None:
23 """BLEアドバタイズとGATTサービスを停止し、通信リソースを解放する。"""
24 pass
25
26 @abstractmethod
27 def set_on_data_received_callback(self, callback: Optional[RawDataCallback]) -> None:
28 """受信ペイロードを通知するコールバックを登録または解除する。
29
30 Args:
31 callback: 生バイト列を受け取る関数。Noneを渡すと登録を解除する。
32 """
33 pass
34
35 @property
36 @abstractmethod
37 def is_running(self) -> bool:
38 """GATTサービスとアドバタイズが稼働中ならTrueを返す。"""
39 pass
40
41 def set_response(self, value: bytes) -> None:
42 """クライアントがreadする処理結果を設定する。
43
44 Args:
45 value: 成功を示す ``b'ACK'`` または失敗を示す ``b'NACK'``。
46
47 応答Characteristicを持たない実装では何もしない。
48 """
BLE GATTサーバーの開始・停止・受信通知・応答値の契約。
None stop(self)
BLEアドバタイズとGATTサービスを停止し、通信リソースを解放する。
None set_on_data_received_callback(self, Optional[RawDataCallback] callback)
受信ペイロードを通知するコールバックを登録または解除する。
None set_response(self, bytes value)
クライアントがreadする処理結果を設定する。
bool is_running(self)
GATTサービスとアドバタイズが稼働中ならTrueを返す。
None start(self)
BLEアドバタイズとGATTサービスを開始する。