summaryrefslogtreecommitdiff
path: root/docs/library/ubluetooth.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/ubluetooth.rst')
-rw-r--r--docs/library/ubluetooth.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst
index e103932ef..0cac16f5f 100644
--- a/docs/library/ubluetooth.rst
+++ b/docs/library/ubluetooth.rst
@@ -204,7 +204,7 @@ Broadcaster Role (Advertiser)
Observer Role (Scanner)
-----------------------
-.. method:: BLE.gap_scan(duration_ms, [interval_us], [window_us])
+.. method:: BLE.gap_scan(duration_ms, [interval_us], [window_us], [active])
Run a scan operation lasting for the specified duration (in **milli**\ seconds).
@@ -228,6 +228,8 @@ Observer Role (Scanner)
* 0x03 - ADV_NONCONN_IND - non-connectable undirected advertising
* 0x04 - SCAN_RSP - scan response
+ ``active`` can be set ``True`` if you want to receive scan responses in the results.
+
When scanning is stopped (either due to the duration finishing or when
explicitly stopped), the ``_IRQ_SCAN_DONE`` event will be raised.