Home Assistant Unofficial Reference 2024.12.1
Functions | Variables
homeassistant.components.network.util Namespace Reference

Functions

bool _adapter_has_external_address (Adapter adapter)
 
bool _has_external_address (str ip_str)
 
Adapter _ifaddr_adapter_to_ha (ifaddr.Adapter adapter, IPv4Address|IPv6Address|None next_hop_address)
 
bool _ip_address_is_external (IPv4Address|IPv6Address ip_addr)
 
IPv4ConfiguredAddress _ip_v4_from_adapter (ifaddr.IP ip_config)
 
IPv6ConfiguredAddress _ip_v6_from_adapter (ifaddr.IP ip_config)
 
None _reset_enabled_adapters (list[Adapter] adapters)
 
str|None async_get_source_ip (str target_ip)
 
list[Adapter] async_load_adapters ()
 
bool enable_adapters (list[Adapter] adapters, list[str] enabled_interfaces)
 
None enable_auto_detected_adapters (list[Adapter] adapters)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

Network helper class for the network integration.

Function Documentation

◆ _adapter_has_external_address()

bool homeassistant.components.network.util._adapter_has_external_address ( Adapter  adapter)
private 
Adapter has a non-loopback and non-link-local address.

Definition at line 61 of file util.py.

◆ _has_external_address()

bool homeassistant.components.network.util._has_external_address ( str  ip_str)
private

Definition at line 70 of file util.py.

◆ _ifaddr_adapter_to_ha()

Adapter homeassistant.components.network.util._ifaddr_adapter_to_ha ( ifaddr.Adapter  adapter,
IPv4Address | IPv6Address | None   next_hop_address 
)
private 
Convert an ifaddr adapter to ha.

Definition at line 87 of file util.py.

◆ _ip_address_is_external()

bool homeassistant.components.network.util._ip_address_is_external ( IPv4Address | IPv6Address  ip_addr)
private

Definition at line 74 of file util.py.

◆ _ip_v4_from_adapter()

IPv4ConfiguredAddress homeassistant.components.network.util._ip_v4_from_adapter ( ifaddr.IP  ip_config)
private

Definition at line 131 of file util.py.

◆ _ip_v6_from_adapter()

IPv6ConfiguredAddress homeassistant.components.network.util._ip_v6_from_adapter ( ifaddr.IP  ip_config)
private

Definition at line 121 of file util.py.

◆ _reset_enabled_adapters()

None homeassistant.components.network.util._reset_enabled_adapters ( list[Adapter]  adapters)
private

Definition at line 82 of file util.py.

◆ async_get_source_ip()

str | None homeassistant.components.network.util.async_get_source_ip ( str  target_ip) 
Return the source ip that will reach target_ip.

Definition at line 140 of file util.py.

◆ async_load_adapters()

list[Adapter] homeassistant.components.network.util.async_load_adapters ( ) 
Load adapters.

Definition at line 20 of file util.py.

◆ enable_adapters()

bool homeassistant.components.network.util.enable_adapters ( list[Adapter]  adapters,
list[str]  enabled_interfaces 
) 
Enable configured adapters.

Definition at line 38 of file util.py.

◆ enable_auto_detected_adapters()

None homeassistant.components.network.util.enable_auto_detected_adapters ( list[Adapter]  adapters) 
Enable auto detected adapters.

Definition at line 54 of file util.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.network.util._LOGGER = logging.getLogger(__name__)
private

Definition at line 17 of file util.py.