File: windows.rst

package info (click to toggle)
bleak 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,828 kB
  • sloc: python: 10,660; makefile: 165; java: 105
file content (38 lines) | stat: -rw-r--r-- 1,024 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Windows backend
===============

The Windows backend of bleak is written using `PyWinRT <https://github.com/pywinrt/pywinrt>`_
to provide bindings for the Windows Runtime (WinRT).

The Windows backend implements a ``BleakClient`` in the module ``bleak.backends.winrt.client``, a ``BleakScanner``
method in the ``bleak.backends.winrt.scanner`` module. There are also backend-specific implementations of the
``BleakGATTService``, ``BleakGATTCharacteristic`` and ``BleakGATTDescriptor`` classes.

Specific features for the Windows backend
-----------------------------------------

Client
~~~~~~
 - The constructor keyword ``address_type`` which can have the values ``"public"`` or ``"random"``. This value
   makes sure that the connection is made in a fashion that suits the peripheral.

API
---

Utilities
~~~~~~~~~

.. automodule:: bleak.backends.winrt.util
    :members:

Scanner
~~~~~~~

.. automodule:: bleak.backends.winrt.scanner
    :members:

Client
~~~~~~

.. automodule:: bleak.backends.winrt.client
    :members: