Skip to content

Commit 69f634e

Browse files
committed
v1.0.0
Way overdue to use a real major version number. 😅
1 parent cefe9d8 commit 69f634e

4 files changed

Lines changed: 18 additions & 14 deletions

File tree

CHANGELOG.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,39 @@ and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0
1010
`Unreleased`_
1111
=============
1212

13+
`1.0.0`_ (2025-06-28)
14+
=====================
15+
1316
Added
1417
-----
1518
* Added ``pair`` parameter to ``BleakClient()`` constructor to allow pairing before connecting. Fixes #309.
1619
* Added ``notification_discriminator`` parameter to ``start_notify()`` on CoreBluetooth backend. Merged #1742.
1720

1821
Changed
1922
-------
20-
* Enabled extended advertising scanning in the WinRT backend.
23+
* Enabled extended advertising scanning in the WinRT backend. Merged #1705.
2124
* Made `response` argument of class ``BleakClient.write_gatt_char()`` explicitly optional. Fixes #1730.
2225
* Updated Poetry build system version to ``>=2.0``. Merged #1718.
2326
* Log to stderr instead of stdout when ``BLEAK_LOGGING`` is enabled. Merged #1709.
2427
* Updated ``winrt`` backend to use PyWinRT >= 3.1.
2528
* Changed return type of ``connect()``, ``disconnect()``, ``pair()`` and ``unpair()`` methods to ``None``.
2629
* Moved backend-specific arg types to new ``bleak.args`` sub-package.
27-
* ``BLEDevice.name`` will now return ``None`` instead of the address when the name is not available.
28-
* Deprecated ``protection_level`` kwarg for pairing in WinRT backend.
30+
* ``BLEDevice.name`` will now return ``None`` instead of the address when the name is not available. Merged #1762.
31+
* Deprecated ``protection_level`` kwarg for pairing in WinRT backend. Merged #1770.
2932

3033
Fixed
3134
-----
3235
* Fixed resolvable private address not updated after connecting in BlueZ backend. Fixes #1737.
3336
* Fixed possible ``KeyError`` when getting services in BlueZ backend. Fixes #1435.
3437
* Fix D-Bus connection leak when connecting to a device fails in BlueZ backend. Fixes #1698.
3538
* Fixed possible deadlock when connecting on WinRT backend when device is already connected. Fixes #1757.
36-
* Fixed getting notifications from devices connected to BLE adapters with index >9 (hci10, hci11, ...)
39+
* Fixed getting notifications from devices connected to BLE adapters with index >9 (hci10, hci11, ...). Merged #1744.
3740
* Fixed ATT error code 15 description to "Insufficient Encryption". Merged #1746.
3841

3942
Removed
4043
-------
4144
* Removed support for Python 3.8. The minimum supported version is now Python 3.9.
42-
* Removed deprecated parameters properties and methods.
45+
* Removed deprecated parameters, properties and methods.
4346
* Removed support for macOS < 10.13.
4447
* Removed support for BlueZ < 5.55.
4548

@@ -1081,7 +1084,8 @@ Fixed
10811084
* Bleak created.
10821085

10831086

1084-
.. _Unreleased: https://github.com/hbldh/bleak/compare/v0.22.3...develop
1087+
.. _Unreleased: https://github.com/hbldh/bleak/compare/v1.0.0...develop
1088+
.. _1.0.0: https://github.com/hbldh/bleak/compare/v0.22.3...v1.0.0
10851089
.. _0.22.3: https://github.com/hbldh/bleak/compare/v0.22.2...v0.22.3
10861090
.. _0.22.2: https://github.com/hbldh/bleak/compare/v0.22.1...v0.22.2
10871091
.. _0.22.1: https://github.com/hbldh/bleak/compare/v0.22.0...v0.22.1

bleak/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ class BleakClient:
474474
No longer is alias for backend type and no longer inherits from :class:`BaseBleakClient`.
475475
Added ``backend`` parameter.
476476
477-
.. versionchanged:: unreleased
477+
.. versionchanged:: 1.0
478478
Added ``pair`` parameter.
479479
"""
480480

@@ -560,15 +560,15 @@ async def connect(self, **kwargs: Any) -> None:
560560
Args:
561561
**kwargs: For backwards compatibility - should not be used.
562562
563-
.. versionchanged:: unreleased
563+
.. versionchanged:: 1.0
564564
No longer returns ``True``. Instead, the return type is ``None``.
565565
"""
566566
await self._backend.connect(self._pair_before_connect, **kwargs)
567567

568568
async def disconnect(self) -> None:
569569
"""Disconnect from the specified GATT server.
570570
571-
.. versionchanged:: unreleased
571+
.. versionchanged:: 1.0
572572
No longer returns ``True``. Instead, the return type is ``None``.
573573
"""
574574
await self._backend.disconnect()
@@ -582,7 +582,7 @@ async def pair(self, *args: Any, **kwargs: Any) -> None:
582582
that a characteristic that requires authentication is read or written.
583583
This method may have backend-specific additional keyword arguments.
584584
585-
.. versionchanged:: unreleased
585+
.. versionchanged:: 1.0
586586
No longer returns ``True``. Instead, the return type is ``None``.
587587
"""
588588
await self._backend.pair(*args, **kwargs)
@@ -596,7 +596,7 @@ async def unpair(self) -> None:
596596
This method is only available on Windows and Linux and will raise an
597597
exception on other platforms.
598598
599-
.. versionchanged:: unreleased
599+
.. versionchanged:: 1.0
600600
No longer returns ``True``. Instead, the return type is ``None``.
601601
"""
602602
await self._backend.unpair()
@@ -764,7 +764,7 @@ def callback(sender: BleakGATTCharacteristic, data: bytearray):
764764
.. versionchanged:: 0.18
765765
The first argument of the callback is now a :class:`BleakGATTCharacteristic`
766766
instead of an ``int``.
767-
.. versionchanged:: unreleased
767+
.. versionchanged:: 1.0
768768
Added the ``cb`` parameter.
769769
"""
770770
if not self.is_connected:

bleak/backends/winrt/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ async def pair(
519519
3. EncryptionAndAuthentication - Pair the device using
520520
encryption and authentication.
521521
522-
.. versionchanged:: unreleased
522+
.. versionchanged:: 1.0
523523
Issues :class:`DeprecationWarning` if used. The default
524524
behavior has changed and this argument should no longer
525525
be needed.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "bleak"
3-
version = "0.22.3"
3+
version = "1.0.0"
44
description = "Bluetooth Low Energy platform Agnostic Klient"
55
authors = [{ name = "Henrik Blidh", email = "henrik.blidh@nedomkull.com" }]
66
license = "MIT"

0 commit comments

Comments
 (0)