Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.flux_led.discovery Namespace Reference

Functions

FluxLEDDiscovery async_build_cached_discovery (ConfigEntry entry)
 
None async_clear_discovery_cache (HomeAssistant hass, str host)
 
FluxLEDDiscovery|None async_discover_device (HomeAssistant hass, str host)
 
list[FluxLEDDiscovery] async_discover_devices (HomeAssistant hass, int timeout, str|None address=None)
 
FluxLEDDiscovery|None async_get_discovery (HomeAssistant hass, str host)
 
str async_name_from_discovery (FluxLEDDiscovery device, int|None model_num=None)
 
None async_populate_data_from_discovery (Mapping[str, Any] current_data, dict[str, Any] data_updates, FluxLEDDiscovery device)
 
None async_trigger_discovery (HomeAssistant hass, list[FluxLEDDiscovery] discovered_devices)
 
bool async_update_entry_from_discovery (HomeAssistant hass, config_entries.ConfigEntry entry, FluxLEDDiscovery device, int|None model_num, bool allow_update_mac)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 Final
 

Detailed Description

The Flux LED/MagicLight integration discovery.

Function Documentation

◆ async_build_cached_discovery()

FluxLEDDiscovery homeassistant.components.flux_led.discovery.async_build_cached_discovery ( ConfigEntry  entry)
When discovery is unavailable, load it from the config entry.

Definition at line 66 of file discovery.py.

◆ async_clear_discovery_cache()

None homeassistant.components.flux_led.discovery.async_clear_discovery_cache ( HomeAssistant  hass,
str  host 
)
Clear the host from the discovery cache.

Definition at line 164 of file discovery.py.

◆ async_discover_device()

FluxLEDDiscovery | None homeassistant.components.flux_led.discovery.async_discover_device ( HomeAssistant  hass,
str   host 
)
Direct discovery at a single ip instead of broadcast.

Definition at line 211 of file discovery.py.

◆ async_discover_devices()

list[FluxLEDDiscovery] homeassistant.components.flux_led.discovery.async_discover_devices ( HomeAssistant  hass,
int  timeout,
str | None   address = None 
)
Discover flux led devices.

Definition at line 173 of file discovery.py.

◆ async_get_discovery()

FluxLEDDiscovery | None homeassistant.components.flux_led.discovery.async_get_discovery ( HomeAssistant  hass,
str  host 
)
Check if a device was already discovered via a broadcast discovery.

Definition at line 154 of file discovery.py.

◆ async_name_from_discovery()

str homeassistant.components.flux_led.discovery.async_name_from_discovery ( FluxLEDDiscovery  device,
int | None   model_num = None 
)
Convert a flux_led discovery to a human readable name.

Definition at line 85 of file discovery.py.

◆ async_populate_data_from_discovery()

None homeassistant.components.flux_led.discovery.async_populate_data_from_discovery ( Mapping[str, Any]  current_data,
dict[str, Any]  data_updates,
FluxLEDDiscovery  device 
)
Copy discovery data into config entry data.

Definition at line 100 of file discovery.py.

◆ async_trigger_discovery()

None homeassistant.components.flux_led.discovery.async_trigger_discovery ( HomeAssistant  hass,
list[FluxLEDDiscovery]  discovered_devices 
)
Trigger config flows for discovered devices.

Definition at line 224 of file discovery.py.

◆ async_update_entry_from_discovery()

bool homeassistant.components.flux_led.discovery.async_update_entry_from_discovery ( HomeAssistant  hass,
config_entries.ConfigEntry  entry,
FluxLEDDiscovery  device,
int | None  model_num,
bool  allow_update_mac 
)
Update a config entry from a flux_led discovery.

Definition at line 117 of file discovery.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.flux_led.discovery._LOGGER = logging.getLogger(__name__)
private

Definition at line 49 of file discovery.py.

◆ Final

homeassistant.components.flux_led.discovery.Final

Definition at line 52 of file discovery.py.