ble_server
読み取り中…
検索中…
一致する文字列を見つけられません
bluez_server.py
[詳解]
1"""BlueZ D-Busを使ってBLE GATTサービスとLEアドバタイズを提供する。"""
2
3import asyncio
4import logging
5from typing import Optional, Any, Dict
6
7from dbus_fast.aio import MessageBus, ProxyObject
8from dbus_fast.constants import BusType
9from dbus_fast import Variant, MessageType
10from dbus_fast.service import ServiceInterface, method, dbus_property, PropertyAccess
11
12from .ble_interface import IBleGattServer, RawDataCallback
13
14logger = logging.getLogger(__name__)
15
16# UUIDはBLEアプリのBleUuidsと一致させる。
17DEFAULT_SERVICE_UUID = "12345678-1234-1234-1234-123456789abc"
18DEFAULT_CHAR_MISSION_UUID = "12345678-1234-1234-1234-123456789abd"
19DEFAULT_CHAR_RESPONSE_UUID = "12345678-1234-1234-1234-123456789abe"
20DEFAULT_DEVICE_NAME = "MIRS-Robot"
21
22RESPONSE_ACK = b"ACK" # ミッションの検証とROS配信が成功したことを示す。
23RESPONSE_NACK = b"NACK" # ミッションを受理できなかったことを示す。
24
25# BlueZへ公開するサービス、Characteristic、AdvertisementのObject Path。
26BASE_APP_PATH = "/com/mirs/app"
27SERVICE_PATH = f"{BASE_APP_PATH}/service0"
28CHAR_PATH = f"{SERVICE_PATH}/char0"
29RESP_PATH = f"{SERVICE_PATH}/char1"
30ADV_PATH = "/com/mirs/advertisement0"
31
32
33class ObjectManagerInterface(ServiceInterface):
34 """BlueZへ公開するGATTオブジェクト階層を返すD-Bus ObjectManager。"""
35
36 def __init__(self, managed_objects: Dict[str, Dict[str, Dict[str, Variant]]]) -> None:
37 """BlueZへ返すObject Pathとinterfaceの辞書を保持する。"""
38 super().__init__("org.freedesktop.DBus.ObjectManager")
39 self._objects = managed_objects
40
41 @method()
42 def GetManagedObjects(self) -> "a{oa{sa{sv}}}": # type: ignore[override]
43 """BlueZへ公開するObject Pathとinterfaceの辞書を返す。"""
44 return self._objects
45
46
47class GattService1Interface(ServiceInterface):
48 """BLE GATTサービスのUUIDとPrimary属性を公開する。"""
49
50 def __init__(self, service_uuid: str) -> None:
51 """公開するGATTサービスのUUIDを設定する。"""
52 super().__init__("org.bluez.GattService1")
53 self._uuid = service_uuid
54
55 @dbus_property(PropertyAccess.READ)
56 def UUID(self) -> "s": # type: ignore[override]
57 """GATTサービスのUUIDを返す。"""
58 return self._uuid
59
60 @dbus_property(PropertyAccess.READ)
61 def Primary(self) -> "b": # type: ignore[override]
62 """サービスがprimary serviceであることを示す。"""
63 return True
64
65
66class GattCharacteristic1Interface(ServiceInterface):
67 """ミッションデータを書き込むGATT Characteristicを提供する。"""
68
69 def __init__(self, char_uuid: str, service_path: str, callback: Optional[RawDataCallback] = None) -> None:
70 """UUID、所属サービス、書き込み通知先を設定する。"""
71 super().__init__("org.bluez.GattCharacteristic1")
72 self._uuid = char_uuid
73 self._service_path = service_path
74 self.callback = callback
75
76 @method()
77 def WriteValue(self, value: "ay", options: "a{sv}") -> None: # type: ignore[override]
78 """書き込みバイト列を受信コールバックへ渡す。"""
79 raw = bytes(value)
80 logger.info(f"📨 WriteValue 受信: {len(raw)} bytes")
81 if self.callback:
82 try:
83 self.callback(raw)
84 except Exception as e:
85 logger.error(f"コールバック実行中に例外が発生しました: {e}", exc_info=True)
86
87 @dbus_property(PropertyAccess.READ)
88 def UUID(self) -> "s": # type: ignore[override]
89 """CharacteristicのUUIDを返す。"""
90 return self._uuid
91
92 @dbus_property(PropertyAccess.READ)
93 def Service(self) -> "o": # type: ignore[override]
94 """所属GATTサービスのObject Pathを返す。"""
95 return self._service_path
96
97 @dbus_property(PropertyAccess.READ)
98 def Flags(self) -> "as": # type: ignore[override]
99 """書き込み可能なCharacteristicであることを示す。"""
100 return ["write"]
101
102
104 """クライアントが処理結果を読むためのread専用Characteristic。"""
105
106 def __init__(self, char_uuid: str, service_path: str) -> None:
107 """応答CharacteristicのUUIDと所属サービスを設定する。"""
108 super().__init__("org.bluez.GattCharacteristic1")
109 self._uuid = char_uuid
110 self._service_path = service_path
111 self._value = RESPONSE_NACK
112
113 def set_value(self, value: bytes) -> None:
114 """クライアントへ返す応答Characteristicの値を更新する。"""
115 self._value = bytes(value)
116
117 @method()
118 def ReadValue(self, options: "a{sv}") -> "ay": # type: ignore[override]
119 """現在設定されている処理結果をバイト列で返す。"""
120 return bytearray(self._value)
121
122 @dbus_property(PropertyAccess.READ)
123 def UUID(self) -> "s": # type: ignore[override]
124 """応答CharacteristicのUUIDを返す。"""
125 return self._uuid
126
127 @dbus_property(PropertyAccess.READ)
128 def Service(self) -> "o": # type: ignore[override]
129 """所属GATTサービスのObject Pathを返す。"""
130 return self._service_path
131
132 @dbus_property(PropertyAccess.READ)
133 def Flags(self) -> "as": # type: ignore[override]
134 """読み取り専用Characteristicであることを示す。"""
135 return ["read"]
136
137
138class LeAdvertisement1Interface(ServiceInterface):
139 """サービスUUIDとローカル名をアドバタイズするLE Advertisement。"""
140
141 def __init__(self, service_uuid: str, local_name: str) -> None:
142 """Advertisementへ含めるサービスUUIDとローカル名を設定する。"""
143 super().__init__("org.bluez.LEAdvertisement1")
144 self._service_uuid = service_uuid
145 self._local_name = local_name
146
147 @method()
148 def Release(self) -> None:
149 """BlueZがAdvertisementを解放したことを記録する。"""
150 logger.info("BlueZ により Advertisement が解放されました。")
151
152 @dbus_property(PropertyAccess.READ)
153 def Type(self) -> "s": # type: ignore[override]
154 """広告形式としてperipheralを返す。"""
155 return "peripheral"
156
157 @dbus_property(PropertyAccess.READ)
158 def ServiceUUIDs(self) -> "as": # type: ignore[override]
159 """アドバタイズ対象のサービスUUIDを返す。"""
160 return [self._service_uuid]
161
162 @dbus_property(PropertyAccess.READ)
163 def LocalName(self) -> "s": # type: ignore[override]
164 """アドバタイズに含めるローカル名を返す。"""
165 return self._local_name
166
167
169 """BlueZ D-Bus APIを使うLinux向けBLE GATTサーバー実装。"""
170
172 self,
173 service_uuid: str = DEFAULT_SERVICE_UUID,
174 char_uuid: str = DEFAULT_CHAR_MISSION_UUID,
175 response_uuid: str = DEFAULT_CHAR_RESPONSE_UUID,
176 device_name: str = DEFAULT_DEVICE_NAME,
177 ) -> None:
178 """サービスUUID、Characteristic UUID、広告名を設定する。"""
179 self._service_uuid = service_uuid
180 self._char_uuid = char_uuid
181 self._response_uuid = response_uuid
182 self._device_name = device_name
183
184 self._callback: Optional[RawDataCallback] = None
185 self._bus: Optional[MessageBus] = None
186 self._adapter_path: Optional[str] = None
187 self._char_iface: Optional[GattCharacteristic1Interface] = None
188 self._resp_iface: Optional[GattResponseCharacteristic1Interface] = None
189 self._is_running = False
190 self._adapter_proxy: Optional[ProxyObject] = None
191
192 @property
193 def is_running(self) -> bool:
194 """サービス登録と広告が完了していればTrueを返す。"""
195 return self._is_running
196
197 def set_on_data_received_callback(self, callback: Optional[RawDataCallback]) -> None:
198 """GATT書き込みを通知するコールバックを登録または解除する。"""
199 self._callback = callback
200 if self._char_iface:
201 self._char_iface.callback = callback
202
203 def set_response(self, value: bytes) -> None:
204 """応答Characteristicの値をACKまたはNACKへ更新する。"""
205 if self._resp_iface:
206 self._resp_iface.set_value(value)
207
208 async def _detect_adapter_path(self, bus: MessageBus) -> str:
209 """BlueZ D-Bus階層から最初に見つかったhciアダプタのPathを返す。
210
211 Raises:
212 RuntimeError: BlueZへ接続できない、またはアダプタがない場合。
213 """
214 try:
215 intr = await bus.introspect("org.bluez", "/org/bluez")
216 except Exception as e:
217 raise RuntimeError(f"BlueZ D-Bus 探索失敗 (/org/bluez): {e}")
218
219 for node in intr.nodes:
220 if node.name.startswith("hci"):
221 return f"/org/bluez/{node.name}"
222 raise RuntimeError("Bluetooth アダプタ (hci0 等) が検出できませんでした。Bluetooth が有効か確認してください。")
223
224 async def start(self) -> None:
225 """GATTサービスをBlueZへ登録し、LEアドバタイズを開始する。"""
226 if self._is_running:
227 logger.warning("BLE サーバーは既に起動しています。")
228 return
229
230 logger.info(f"BlueZ GATT Server を起動します (Name: '{self._device_name}', Service: {self._service_uuid})...")
231 try:
232 self._bus = await MessageBus(bus_type=BusType.SYSTEM).connect()
233 self._adapter_path = await self._detect_adapter_path(self._bus)
234 logger.info(f"Bluetooth アダプタ検出: {self._adapter_path}")
235
236 managed_objects = {
237 SERVICE_PATH: {
238 "org.bluez.GattService1": {
239 "UUID": Variant("s", self._service_uuid),
240 "Primary": Variant("b", True),
241 }
242 },
243 CHAR_PATH: {
244 "org.bluez.GattCharacteristic1": {
245 "UUID": Variant("s", self._char_uuid),
246 "Service": Variant("o", SERVICE_PATH),
247 "Flags": Variant("as", ["write"]),
248 }
249 },
250 RESP_PATH: {
251 "org.bluez.GattCharacteristic1": {
252 "UUID": Variant("s", self._response_uuid),
253 "Service": Variant("o", SERVICE_PATH),
254 "Flags": Variant("as", ["read"]),
255 }
256 },
257 }
258
259 om_iface = ObjectManagerInterface(managed_objects)
260 svc_iface = GattService1Interface(self._service_uuid)
261 self._char_iface = GattCharacteristic1Interface(self._char_uuid, SERVICE_PATH, self._callback)
264
265 self._bus.export(BASE_APP_PATH, om_iface)
266 self._bus.export(SERVICE_PATH, svc_iface)
267 self._bus.export(CHAR_PATH, self._char_iface)
268 self._bus.export(RESP_PATH, self._resp_iface)
269 self._bus.export(ADV_PATH, adv_iface)
270
271 intr = await self._bus.introspect("org.bluez", self._adapter_path)
272 adapter = self._bus.get_proxy_object("org.bluez", self._adapter_path, intr)
273
274 gatt_mgr = adapter.get_interface("org.bluez.GattManager1")
275 await gatt_mgr.call_register_application(BASE_APP_PATH, {})
276 logger.info("GATT Application 登録完了")
277
278 adv_mgr = adapter.get_interface("org.bluez.LEAdvertisingManager1")
279 await adv_mgr.call_register_advertisement(ADV_PATH, {})
280 logger.info(f"BLE Advertisement 開始 (ローカル名: '{self._device_name}')")
281
282 # 切断時に再アドバタイズするためアダプタproxyを保持し、シグナルを購読する
283 self._adapter_proxy = adapter
284 self._bus.add_message_handler(self._on_properties_changed)
285 logger.info("デバイス切断監視を開始しました")
286
287 self._is_running = True
288 except Exception as e:
289 await self.stop()
290 raise RuntimeError(f"BLE サーバー起動処理でエラーが発生しました: {e}") from e
291
292 def _on_properties_changed(self, message) -> None:
293 """BlueZのPropertiesChangedシグナルを受け取り、切断時に再アドバタイズする。"""
294 try:
295 # add_message_handler は全メッセージを受け取るので対象シグナルだけ処理する
296 if (message.message_type != MessageType.SIGNAL
297 or message.interface != "org.freedesktop.DBus.Properties"
298 or message.member != "PropertiesChanged"):
299 return None
300 # message.body = [interface_name, changed_properties, invalidated_properties]
301 iface_name, changed, _ = message.body
302 if iface_name != "org.bluez.Device1":
303 return None
304 if "Connected" not in changed:
305 return None
306 connected = changed["Connected"].value
307 if not connected:
308 logger.info("デバイス切断を検知しました。アドバタイズを再開します...")
309 loop = asyncio.get_event_loop()
310 loop.create_task(self._restart_advertisement())
311 except Exception as e:
312 logger.warning(f"PropertiesChanged ハンドラで例外: {e}")
313 return None
314
315 async def _restart_advertisement(self) -> None:
316 """切断後にLEアドバタイズを再登録する。"""
317 if not self._bus or not self._adapter_proxy:
318 return
319 try:
320 adv_mgr = self._adapter_proxy.get_interface("org.bluez.LEAdvertisingManager1")
321 try:
322 await adv_mgr.call_unregister_advertisement(ADV_PATH)
323 except Exception:
324 pass
325 await asyncio.sleep(0.5)
326 await adv_mgr.call_register_advertisement(ADV_PATH, {})
327 logger.info(f"BLE Advertisement 再開 (ローカル名: '{self._device_name}')")
328 except Exception as e:
329 logger.error(f"Advertisement 再開に失敗しました: {e}")
330
331 async def stop(self) -> None:
332 """登録済み広告とGATTアプリケーションを解除し、D-Bus接続を閉じる。"""
333 if not self._bus:
334 return
335
336 logger.info("BlueZ GATT Server を停止しています...")
337 if self._adapter_path:
338 try:
339 intr = await self._bus.introspect("org.bluez", self._adapter_path)
340 adapter = self._bus.get_proxy_object("org.bluez", self._adapter_path, intr)
341
342 try:
343 adv_mgr = adapter.get_interface("org.bluez.LEAdvertisingManager1")
344 await adv_mgr.call_unregister_advertisement(ADV_PATH)
345 except Exception as e:
346 logger.debug(f"Advertisement 解除スキップ/エラー: {e}")
347
348 try:
349 gatt_mgr = adapter.get_interface("org.bluez.GattManager1")
350 await gatt_mgr.call_unregister_application(BASE_APP_PATH)
351 except Exception as e:
352 logger.debug(f"GATT Application 解除スキップ/エラー: {e}")
353 except Exception as e:
354 logger.debug(f"D-Bus 終了処理例外: {e}")
355
356 try:
357 self._bus.disconnect()
358 except Exception:
359 pass
360
361 self._bus = None
362 self._adapter_path = None
363 self._adapter_proxy = None
364 self._char_iface = None
365 self._resp_iface = None
366 self._is_running = False
367 logger.info("BlueZ GATT Server 停止完了")
BLE GATTサーバーの開始・停止・受信通知・応答値の契約。
None stop(self)
BLEアドバタイズとGATTサービスを停止し、通信リソースを解放する。
BlueZ D-Bus APIを使うLinux向けBLE GATTサーバー実装。
str _detect_adapter_path(self, MessageBus bus)
BlueZ D-Bus階層から最初に見つかったhciアダプタのPathを返す。
None stop(self)
登録済み広告とGATTアプリケーションを解除し、D-Bus接続を閉じる。
None set_response(self, bytes value)
応答Characteristicの値をACKまたはNACKへ更新する。
None start(self)
GATTサービスをBlueZへ登録し、LEアドバタイズを開始する。
Optional[GattCharacteristic1Interface] _char_iface
None _restart_advertisement(self)
切断後にLEアドバタイズを再登録する。
Optional[GattResponseCharacteristic1Interface] _resp_iface
None set_on_data_received_callback(self, Optional[RawDataCallback] callback)
GATT書き込みを通知するコールバックを登録または解除する。
bool is_running(self)
サービス登録と広告が完了していればTrueを返す。
None __init__(self, str service_uuid=DEFAULT_SERVICE_UUID, str char_uuid=DEFAULT_CHAR_MISSION_UUID, str response_uuid=DEFAULT_CHAR_RESPONSE_UUID, str device_name=DEFAULT_DEVICE_NAME)
サービスUUID、Characteristic UUID、広告名を設定する。
ミッションデータを書き込むGATT Characteristicを提供する。
None __init__(self, str char_uuid, str service_path, Optional[RawDataCallback] callback=None)
UUID、所属サービス、書き込み通知先を設定する。
"o" Service(self)
所属GATTサービスのObject Pathを返す。
None WriteValue(self, "ay" value, "a{sv}" options)
書き込みバイト列を受信コールバックへ渡す。
"s" UUID(self)
CharacteristicのUUIDを返す。
"as" Flags(self)
書き込み可能なCharacteristicであることを示す。
クライアントが処理結果を読むためのread専用Characteristic。
None __init__(self, str char_uuid, str service_path)
応答CharacteristicのUUIDと所属サービスを設定する。
"as" Flags(self)
読み取り専用Characteristicであることを示す。
None set_value(self, bytes value)
クライアントへ返す応答Characteristicの値を更新する。
"o" Service(self)
所属GATTサービスのObject Pathを返す。
"ay" ReadValue(self, "a{sv}" options)
現在設定されている処理結果をバイト列で返す。
"s" UUID(self)
応答CharacteristicのUUIDを返す。
BLE GATTサービスのUUIDとPrimary属性を公開する。
"b" Primary(self)
サービスがprimary serviceであることを示す。
"s" UUID(self)
GATTサービスのUUIDを返す。
None __init__(self, str service_uuid)
公開するGATTサービスのUUIDを設定する。
サービスUUIDとローカル名をアドバタイズするLE Advertisement。
None Release(self)
BlueZがAdvertisementを解放したことを記録する。
"as" ServiceUUIDs(self)
アドバタイズ対象のサービスUUIDを返す。
"s" Type(self)
広告形式としてperipheralを返す。
"s" LocalName(self)
アドバタイズに含めるローカル名を返す。
None __init__(self, str service_uuid, str local_name)
Advertisementへ含めるサービスUUIDとローカル名を設定する。
BlueZへ公開するGATTオブジェクト階層を返すD-Bus ObjectManager。
None __init__(self, Dict[str, Dict[str, Dict[str, Variant]]] managed_objects)
BlueZへ返すObject Pathとinterfaceの辞書を保持する。
"a{oa{sa{sv}}}" GetManagedObjects(self)
BlueZへ公開するObject Pathとinterfaceの辞書を返す。