Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: export ADAPTER_ constants for the underlying usb device #27

Merged
merged 2 commits into from
Nov 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/bluetooth_adapters/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,24 @@
from .models import (
ADAPTER_ADDRESS,
ADAPTER_HW_VERSION,
ADAPTER_MANUFACTURER,
ADAPTER_PASSIVE_SCAN,
ADAPTER_PRODUCT,
ADAPTER_PRODUCT_ID,
ADAPTER_SW_VERSION,
ADAPTER_VENDOR_ID,
AdapterDetails,
)
from .systems import get_adapters
from .util import adapter_human_name, adapter_unique_name
from .util import adapter_human_name, adapter_model, adapter_unique_name

__all__ = [
"AdvertisementHistory",
"BluetoothAdapters",
"BlueZDBusObjects",
"adapter_human_name",
"adapter_unique_name",
"adapter_model",
"get_bluetooth_adapters",
"get_bluetooth_adapter_details",
"get_dbus_managed_objects",
Expand All @@ -40,6 +45,10 @@
"ADAPTER_SW_VERSION",
"ADAPTER_HW_VERSION",
"ADAPTER_PASSIVE_SCAN",
"ADAPTER_MANUFACTURER",
"ADAPTER_PRODUCT",
"ADAPTER_VENDOR_ID",
"ADAPTER_PRODUCT_ID",
"WINDOWS_DEFAULT_BLUETOOTH_ADAPTER",
"MACOS_DEFAULT_BLUETOOTH_ADAPTER",
"UNIX_DEFAULT_BLUETOOTH_ADAPTER",
Expand Down
13 changes: 13 additions & 0 deletions src/bluetooth_adapters/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
from __future__ import annotations

from .const import DEFAULT_ADDRESS
from .models import (
ADAPTER_PRODUCT,
ADAPTER_PRODUCT_ID,
ADAPTER_VENDOR_ID,
AdapterDetails,
)


def adapter_human_name(adapter: str, address: str) -> str:
Expand All @@ -12,3 +18,10 @@ def adapter_human_name(adapter: str, address: str) -> str:
def adapter_unique_name(adapter: str, address: str) -> str:
"""Return a unique name for the adapter."""
return adapter if address == DEFAULT_ADDRESS else address


def adapter_model(details: AdapterDetails) -> str:
"""Return a model for the adapter."""
if (vendor_id := details.get(ADAPTER_VENDOR_ID)) and vendor_id != "Unknown":
return f"{details[ADAPTER_PRODUCT]} ({vendor_id}:{details[ADAPTER_PRODUCT_ID]})"
return details.get(ADAPTER_PRODUCT) or "Unknown"
31 changes: 31 additions & 0 deletions tests/test_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
import bluetooth_adapters.dbus as bluetooth_adapters_dbus
from bluetooth_adapters import (
DEFAULT_ADDRESS,
AdapterDetails,
AdvertisementHistory,
BlueZDBusObjects,
adapter_human_name,
adapter_model,
adapter_unique_name,
get_adapters,
get_bluetooth_adapters,
Expand Down Expand Up @@ -580,3 +582,32 @@ def test_adapter_unique_name():
"""Test adapter unique name."""
assert adapter_unique_name("hci0", DEFAULT_ADDRESS) == "hci0"
assert adapter_unique_name("hci0", "aa:bb:cc:dd:ee:ff") == "aa:bb:cc:dd:ee:ff"


def test_adapter_model():
"""Test adapter model."""
windows_details = AdapterDetails(
{
"address": "00:00:00:00:00:00",
"passive_scan": False,
"sw_version": "18.7.0",
"manufacturer": "Microsoft",
"product": "Unknown Windows Model",
"vendor_id": "Unknown",
"product_id": "Unknown",
}
)
assert adapter_model(windows_details) == "Unknown Windows Model"
linux_details = AdapterDetails(
{
"address": "00:1A:7D:DA:71:04",
"manufacturer": "XTech",
"product": "Bluetooth 4.0 USB Adapter",
"vendor_id": "0a12",
"product_id": "0001",
"hw_version": "usb:v1D6Bp0246d053F",
"passive_scan": False,
"sw_version": "homeassistant",
}
)
assert adapter_model(linux_details) == "Bluetooth 4.0 USB Adapter (0a12:0001)"