bundle.ble.scanner
==================

.. py:module:: bundle.ble.scanner

.. autoapi-nested-parse::

   High-level helpers for BLE discovery and presentation.



Attributes
----------

.. autoapisummary::

   bundle.ble.scanner.log
   bundle.ble.scanner.DEFAULT_SCAN_TIMEOUT


Classes
-------

.. autoapisummary::

   bundle.ble.scanner.ScanResult
   bundle.ble.scanner.Scanner


Functions
---------

.. autoapisummary::

   bundle.ble.scanner.discover


Module Contents
---------------

.. py:data:: log

.. py:data:: DEFAULT_SCAN_TIMEOUT
   :value: 5.0


.. py:class:: ScanResult(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`


   Entity describing a scan run and its collected devices.


   .. py:attribute:: timeout
      :type:  float
      :value: None



   .. py:attribute:: devices
      :type:  list[bundle.ble.device.Device]
      :value: None



   .. py:method:: sorted_devices() -> list[bundle.ble.device.Device]


   .. py:method:: lines() -> list[str]


.. py:class:: Scanner(/, **data: Any)

   Bases: :py:obj:`bundle.core.Entity`


   Collect advertisement snapshots from nearby peripherals.


   .. py:attribute:: timeout
      :type:  float
      :value: None



   .. py:method:: scan(*, timeout: float | None = None) -> ScanResult
      :async:



.. py:function:: discover(*, timeout: float = DEFAULT_SCAN_TIMEOUT) -> list[bundle.ble.device.Device]
   :async: