QUERY · ISSUE

docs: BLE Event handling seems to contradict general guidelines for IRQ handling

openby 32BTopened 2025-01-13updated 2025-11-06

docs

Documentation URL

https://docs.micropython.org/en/latest/library/bluetooth.html#event-handling

Description

In BLE event handling a suggestion is given to create copies of the ringbuffer parameters. This however, would violate the general guidelines given for interrupt routines which specifically warn against instantiating objects.
https://github.com/micropython/micropython/blob/99ac8193ea299e6d836b076149f561e58226ede6/docs/reference/isr_rules.rst?plain=1#L102

Code of Conduct

Yes, I agree

CANDIDATE · PULL REQUEST

docs/library/bluetooth: Add initial BLE documentation.

mergedby jimmoopened 2019-10-08updated 2019-10-11

docs

Still lots more to write (especially examples) but now that BLE support is enabled on both ESP32 and PYBD I thought it would be worth just getting the classes and methods listed.

Assessment

Q Qwen · high

Issue #16577 reports a documentation contradiction in BLE event handling where the docs suggest copying ringbuffer parameters in an ISR, which violates general ISR guidelines against object instantiation. PR #5192 is the initial BLE documentation that added the content in question. While PR #5192 created the problematic documentation, it does not resolve the contradiction identified in #16577. The PR is the source of the issue but doesn't fix it. The issue requires a follow-up PR or documentation update to correct the ISR handling guidance.

Suggested action

Keep issue #16577 open. The maintainer should create a new PR to fix the BLE documentation to align with ISR guidelines (e.g., suggest copying data in the main loop rather than in the ISR, or clarify that ringbuffer operations are safe in this specific context).