Skip to content

Commit

Permalink
Add BLE class docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
BojanSof committed Apr 25, 2024
1 parent 80f74da commit 75f1dd8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/pydevdtk/coms/ble.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ def __str__(self) -> str:


class BleCharacteristic:
"""BLE characteristic description"""

def __init__(self, uuid: str, properties: list[str]):
"""
Initializes a new instance of the BleCharacteristic class.
Expand All @@ -80,6 +82,8 @@ def __init__(self, uuid: str, properties: list[str]):


class BleService:
"""BLE service description"""

def __init__(self, uuid: str, characteristics: list[BleCharacteristic]):
"""
Initializes a new instance of the BleService class.
Expand All @@ -97,6 +101,12 @@ def __init__(self, uuid: str, characteristics: list[BleCharacteristic]):


class Ble:
"""
A class that allows to utilize the BLE module of the device,
including scanning for BLE devices, connecting to BLE devices,
and data operations including read, write and notify.
"""

def __init__(self):
"""
Initializes a new instance allowing to utilize the BLE module of the
Expand Down

0 comments on commit 75f1dd8

Please sign in to comment.