Source code for able.bluezdbus

"""
Globals defined for the bluezdbus backend
"""

from enum import Enum


[docs]class AdvertisementType(Enum):
    """Bluez defined advertising types"""

    BROADCAST = "broadcast"
    PERIPHERAL = "peripheral"


[docs]class DBusInterface(Enum):
    """Base class for interface types"""


[docs]class BluezServiceInterfaces(DBusInterface, Enum):
    """Bluez defined service interfaces"""

    BLUEZ_ORG = "org.bluez"
    ADAPTER_INTERFACE = "org.bluez.Adapter1"
    ADVERTISEMENT_INTERFACE = "org.bluez.LEAdvertisement1"
    GATT_CHARACTERISTIC_INTERFACE = "org.bluez.GattCharacteristic1"
    GATT_SERVICE_INTERFACE = "org.bluez.GattService1"
    GATT_MANAGER_INTERFACE = "org.bluez.GattManager1"
    ADVERTISING_MANAGER_INTERFACE = "org.bluez.LEAdvertisingManager1"
    DEVICE_INTERFACE = "org.bluez.Device1"


[docs]class DbusServiceInterfaces(DBusInterface, Enum):
    """Dbus defined service interfaces"""

    OBJECT_MANAGER_INTERFACE = "org.freedesktop.DBus.ObjectManager"
    DBUS_INTERFACE = "org.freedesktop.DBus"
    STATS_MANAGER_INTERFACE = "org.freedesktop.DBus.Debug.Stats"
    PROPERTIES_INTERFACE = "org.freedesktop.DBus.Properties"


[docs]def get_service_path(name: str, index: int):
    """Fetches/generates the path of an service"""
    return f"/org/bluez/{name}/service{index}"


[docs]def get_advertisement_object_path(name: str, index: int):
    """Fetches the path of an advertisement"""
    return f"/org/bluez/{name}/advertisement{index}"


[docs]def get_characteristic_path(service_path: str, index: int):
    """Fetches the path of an characteristic"""
    return f"{service_path}/char{str(index).zfill(4)}"