Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.bluetooth Namespace Reference

Namespaces

 active_update_coordinator
 
 active_update_processor
 
 api
 
 config_flow
 
 const
 
 diagnostics
 
 manager
 
 match
 
 models
 
 passive_update_coordinator
 
 passive_update_processor
 
 storage
 
 update_coordinator
 
 util
 

Functions

None _async_start_adapter_discovery (HomeAssistant hass, HomeAssistantBluetoothManager manager, BluetoothAdapters bluetooth_adapters)
 
None async_discover_adapters (HomeAssistant hass, dict[str, AdapterDetails] adapters)
 
None async_migrate_entries (HomeAssistant hass, dict[str, AdapterDetails] adapters, str default_adapter)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None async_update_device (HomeAssistant hass, ConfigEntry entry, str adapter, AdapterDetails details)
 
None async_update_listener (HomeAssistant hass, ConfigEntry entry)
 

Variables

list __all__
 
 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
 

Detailed Description

The bluetooth integration.

Function Documentation

◆ _async_start_adapter_discovery()

None homeassistant.components.bluetooth._async_start_adapter_discovery ( HomeAssistant  hass,
HomeAssistantBluetoothManager  manager,
BluetoothAdapters  bluetooth_adapters 
)
private
Start adapter discovery.

Definition at line 133 of file __init__.py.

◆ async_discover_adapters()

None homeassistant.components.bluetooth.async_discover_adapters ( HomeAssistant  hass,
dict[str, AdapterDetails]  adapters 
)
Discover adapters and start flows.

Definition at line 266 of file __init__.py.

◆ async_migrate_entries()

None homeassistant.components.bluetooth.async_migrate_entries ( HomeAssistant  hass,
dict[str, AdapterDetails]  adapters,
str   default_adapter 
)
Migrate config entries to support multiple.

Definition at line 247 of file __init__.py.

◆ async_setup()

bool homeassistant.components.bluetooth.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the bluetooth integration.

Definition at line 199 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.bluetooth.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up a config entry for a bluetooth scanner.

Definition at line 313 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.bluetooth.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 352 of file __init__.py.

◆ async_update_device()

None homeassistant.components.bluetooth.async_update_device ( HomeAssistant  hass,
ConfigEntry  entry,
str  adapter,
AdapterDetails   details 
)
Update device registry entry.

The physical adapter can change from hci0/hci1 on reboot
or if the user moves around the usb sticks so we need to
update the device with the new location so they can
figure out where the adapter is.

Definition at line 292 of file __init__.py.

◆ async_update_listener()

None homeassistant.components.bluetooth.async_update_listener ( HomeAssistant  hass,
ConfigEntry  entry 
)
Handle options update.

Definition at line 347 of file __init__.py.

Variable Documentation

◆ __all__

list homeassistant.components.bluetooth.__all__
private

Definition at line 94 of file __init__.py.

◆ _LOGGER

homeassistant.components.bluetooth._LOGGER = logging.getLogger(__name__)
private

Definition at line 128 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.bluetooth.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 130 of file __init__.py.