blesession

One BLE session, instrumented — for Home Assistant BLE integrations built on bleak.

Connect, subscribe to notifications, exchange frames with per-step timeouts, disconnect — and come out the other side with where the time went, where it failed, which radio it went over, and one sentence on what that most likely means, ready to publish as sensor attributes so a failed session at 3 am can be read off the entity without debug logging.

Status

0.1.0 — first release. hass-ble-esl 0.10.0 runs on it, verified on device over a Bluetooth proxy; hass-omron is next. The library is tested without Home Assistant (pytest). Read docs/design.md for what belongs here, what deliberately does not, how a Bluetooth-proxy route works without importing Home Assistant, and the rollout plan.

The design is extracted from two integrations that already carry this instrumentation and have drifted apart:

• hass-ble-esl — e-paper shelf labels (write an image, wait for the panel)
• hass-omron — blood pressure monitors (bonded, unlock, read record memory)

and is meant to be adopted by the rest of the family (hass-catprinter, hass-niimbot, hass-gicisky, hass-zhsunyco, hass-lywsd02, hass-marklife, hass-minibig, hass-vson, …), which today each hand-roll the same notification wait and have no failure attribution at all.

What it provides

What it does not provide

Retry counts, backoff, packet pacing, lock scope, bonding and pairing, cooldowns, advertisement parsing, protocol frames. Those are the parts each integration learned from its own device and keeps.

Layout

src/blesession/         pure Python + bleak, tested without Home Assistant
src/blesession/hass.py  imports homeassistant lazily; only used inside HA
docs/design.md          the design

from blesession import Notifications, SessionTrace, ble_session, build_report, stages

trace = SessionTrace(stage_map={"start": stages.AUTH})
try:
    async with ble_session(ble_device, trace=trace) as client:
        async with Notifications(client, NOTIFY_UUID, settle=0.5) as replies:
            with trace.timed("start"):
                await client.write_gatt_char(WRITE_UUID, START, response=False)
                await replies.next(timeout=5, step="start")
            with trace.timed("transfer"):
                ...
except ConnectionError as exc:          # every session error is one
    report = build_report(operation="write", trace=trace, exc=exc,
                          facts=radio_facts(hass, address, trace.link), noun="tag")
    # {'operation': 'write', 'success': False, 'error': ..., 'failed_stage': 'auth',
    #  'failed_detail': 'start', 'likely_cause': ..., 'via': ..., 'connect_s': ..., ...}

License

MIT