Bleak

======================

Changed
-------

* Changed minimum ``winrt`` package version to 1.0.21033.1. Fixes 589.

Fixed
-----

* Fixed unawaited future when writing without response on CoreBluetooth backend.
Fixes 586.

======================

Added
-----

* Added ``mtu_size`` property for clients.
* Added WinRT backend.
* Added ``BleakScanner.discovered_devices`` property.
* Added an event to await when stopping scanners in WinRT and pythonnet backends. Fixes 556.
* Added ``BleakScanner.find_device_by_filter`` static method.
* Added ``scanner_byname.py`` example.
* Added optional command line argument to specify device to all applicable examples.

Changed
-------

* Added ``Programming Language :: Python :: 3.9`` classifier in ``setup.py``.
* Deprecated ``BleakScanner.get_discovered_devices()`` async method.
* Added capability to handle async functions as detection callbacks in ``BleakScanner``.
* Added error description in addition to error name when ``BleakDBusError`` is converted to string.
* Change typing of data parameter in write methods to ``Union[bytes, bytearray, memoryview]``.
* Improved type hints in CoreBluetooth backend.
* Use delegate callbacks for ``get_rssi()`` on CoreBluetooth backend.
* Use ``objc.python_method`` where possible in ``PeripheralDelegate`` class.
* Using ObjC key-value observer to wait for ``BleakScanner.start()`` and ``stop()``
in CoreBluetooth backend.

Fixed
-----

* Fixed ``KeyError`` when trying to connect to ``BLEDevice`` from advertising
data callback on macOS. Fixes 448.
* Handling of undetected devices in ``connect_by_bledevice.py`` example. Fixes 487.
* Added ``Optional`` typehint for ``BleakScanner.find_device_by_address``.
* Fixed ``linux_autodoc_mock_import`` in ``docs/conf.py``.
* Minor fix for disconnection event handling in BlueZ backend. Fixes 491.
* Corrections for the Philips Hue lamp example. Merged 505.
* Fixed ``BleakClientBlueZDBus.pair()`` method always returning ``True``. Fixes 503.
* Fixed waiting for notification start/stop to complete in CoreBluetooth backend.
* Fixed write without response on BlueZ < 5.51.
* Fixed error propagation for CoreBluetooth events.
* Fixed failed import on CI server when BlueZ is not installed.
* Fixed notification ``value`` should be ``bytearray`` on CoreBluetooth. Fixes 560.
* Fixed crash when cancelling connection when Python runtime shuts down on
CoreBluetooth backend. Fixes 538.
* Fixed connecting to multiple devices using a single ``BleakScanner`` on
CoreBluetooth backend.
* Fixed deadlock in CoreBluetooth backend when device disconnects while
callbacks are pending. Fixes 535.
* Fixed deadlock when using more than one service, characteristic or descriptor
with the same UUID on CoreBluetooth backend.
* Fixed exception raised when calling ``BleakScanner.stop()`` when already
stopped in CoreBluetooth backend.

======================

Added
-----

* Updated ``dotnet.client.BleakClientDotNet`` connect method docstring.
* Added ``AdvertisementServiceData`` in BLEDevice in macOS devices
* Protection levels (encryption) in Windows backend pairing. Solves 405.
* Philips Hue lamp example script. Relates to 405.
* Keyword arguments to ``get_services`` method on ``BleakClient``.
* Keyword argument ``use_cached`` on .NET backend, to enable uncached reading
of services, characteristics and descriptors in Windows.
* Documentation on troubleshooting OS level caches for services.
* New example added: Async callbacks with a queue and external consumer
* ``handle`` property on ``BleakGATTService`` objects
* ``service_handle`` property on ``BleakGATTCharacteristic`` objects
* Added more specific type hints for ``BleakGATTServiceCollection`` properties.
* Added ``asyncio`` task to disconnect devices on event loop crash in BlueZ backend.
* Added filtering on advertisement data callbacks on BlueZ backend so that
callbacks only occur when advertising data changes like on macOS backend.
* Added fallback to try ``org.bluez.Adapter1.ConnectDevice`` when trying to connect
a device in BlueZ backend.
* Added UART service example.

Fixed
-----

* Fixed wrong OS write method called in ``write_gatt_descriptor()`` in Windows
backend. Merged 403.
* Fixed ``BaseBleakClient.services_resolved`` not reset on disconnect on BlueZ
backend. Merged 401.
* Fixed RSSI missing in discovered devices on macOS backend. Merged 400.
* Fixed scan result shows 'Unknown' name of the ``BLEDevice``. Fixes 371.
* Fixed a broken check for the correct adapter in ``BleakClientBlueZDBus``.
* Fixed 445 and 362 for Windows.

Changed
-------

* Using handles to identify the services. Added `handle` abstract property to `BleakGATTService`
and storing the services by handle instead of UUID.
* Changed ``BleakScanner.set_scanning_filter()`` from async method to normal method.
* Changed BlueZ backend to use ``dbus-next`` instead of ``txdbus``.
* Changed ``BleakClient.is_connected`` from async method to property.
* Consolidated D-Bus signal debug messages in BlueZ backend.

Removed
-------

* Removed all ``__str__`` methods from backend service, characteristic and descriptor implementations
in favour of those in the abstract base classes.

======================

Added
-----

* Added ``AdvertisementData`` class used with detection callbacks across all
supported platforms. Merged 334.
* Added ``BleakError`` raised during import on unsupported platforms.
* Added ``rssi`` parameter to ``BLEDevice`` constructor.
* Added ``detection_callback`` kwarg to ``BleakScanner`` constructor.

Changed
-------

* Updated minimum PyObjC version to 7.0.1.
* Consolidated implementation of ``BleakScanner.register_detection_callback()``.
All platforms now take callback with ``BLEDevice`` and ``AdvertisementData``
arguments.
* Consolidated ``BleakScanner.find_device_by_address()`` implementations.
* Renamed "device" kwarg to "adapter" in BleakClient and BleakScanner. Fixes
381.

Fixed
-----

* Fixed use of bare exceptions.
* Fixed ``BleakClientBlueZDBus.start_notify()`` misses initial notifications with
fast Bluetooth devices. Fixed 374.
* Fix event callbacks on Windows not running in asyncio event loop thread.
* Fixed ``BleakScanner.discover()`` on older versions of macOS. Fixes 331.
* Fixed disconnect callback on BlueZ backend.
* Fixed calling ``BleakClient.is_connected()`` on Mac before connection.
* Fixed kwargs ignored in ``BleakScanner.find_device_by_address()`` in BlueZ backend.
Fixes 360.

Removed
-------

* Removed duplicate definition of ``BLEDevice`` in BlueZ backend.
* Removed unused imports.
* Removed separate implementation of global ``discover`` method.

=====================

Added
-----

* Added new attribute ``_device_info`` on ``BleakClientBlueZDBus``. Merges 347.
* Added Pull Request Template.

Changed
-------

* Updated instructions on how to contribute, file issues and make PRs.
* Updated ``AUTHORS.rst`` file with development team.

Fixed
-----

* Fix well-known services not converted to UUIDs in ``BLEDevice.metadata`` in
CoreBluetooth backend. Fixes 342.
* Fix advertising data replaced instead of merged in scanner in CoreBluetooth
backend. Merged 343.
* Fix CBCentralManager not properly waited for during initialization in some
cases.
* Fix AttributeError in CoreBluetooth when using BLEDeviceCoreBluetooth object.

=====================

Added
-----

* Timeout for BlueZ backend connect call to avoid potential infinite hanging. Merged 306.
* Added Interfaces API docs again.
* Troubleshooting documentation.
* noqa flags added to ``BleakBridge`` imports.
* Adding a timeout on OSX so that the connect cannot hang forever. Merge 336.

Changed
-------

* ``BleakCharacteristic.description()`` on .NET now returns the same value as
other platforms.
* Changed all adding and removal of .NET event handler from ``+=``/``-=`` syntax to
calling ``add_`` and ``remove_`` methods instead. This allows for proper
removal of event handlers in .NET backend.
* All code dependence on the ``BleakBridge`` is now removed. It is only imported to
allow for access to UWP namespaces.
* Removing internal method ``_start_notify`` in the .NET backend.
* ``GattSession`` object now manages lifetime of .NET ``BleakClient`` connection.
* ``BleakClient`` in .NET backend will reuse previous device information when
reconnecting so that it doesn't have to scan/discover again.


Fixed
-----

* UUID property bug fixed in BlueZ backend. Merged 307.
* Fix for broken RTD documentation.
* Fix UUID string arguments should not be case sensitive.
* Fix ``BleakGATTService.get_characteristic()`` method overridden with ``NotImplementedError``
in BlueZ backend.
* Fix ``AttributeError`` when trying to connect using CoreBluetooth backend. Merged 323.
* Fix disconnect callback called multiple times in .NET backend. Fixes 312.
* Fix ``BleakClient.disconnect()`` method failing when called multiple times in
.NET backend. Fixes 313.
* Fix ``BleakClient.disconnect()`` method failing when called multiple times in
Core Bluetooth backend. Merge 333.
* Catch RemoteError in ``is_connected`` in BlueZ backend. Fixes 310,
* Prevent overwriting address in constructor of ``BleakClient`` in BlueZ backend. Merge 311.
* Fix nordic uart UUID. Merge 339.