homeassistant.components.network Namespace Reference

Namespaces
	const
	models
	network
	util
	websocket

Functions
list[Adapter]	async_get_adapters (HomeAssistant hass)
list[str]	async_get_announce_addresses (HomeAssistant hass)
list[IPv4Address|IPv6Address]	async_get_enabled_source_ips (HomeAssistant hass)
set[IPv4Address]	async_get_ipv4_broadcast_addresses (HomeAssistant hass)
str	async_get_source_ip (HomeAssistant hass, str|UndefinedType target_ip=UNDEFINED)
bool	async_only_default_interface_enabled (list[Adapter] adapters)
bool	async_setup (HomeAssistant hass, ConfigType config)

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

Detailed Description

The Network Configuration integration.

Function Documentation

async_get_adapters()

list[Adapter] homeassistant.components.network.async_get_adapters

(

HomeAssistant

hass

)

Get the network adapter configuration.

Definition at line 31 of file __init__.py.

async_get_announce_addresses()

list[str] homeassistant.components.network.async_get_announce_addresses

(

HomeAssistant

hass

)

Return a list of IP addresses to announce/use via zeroconf/ssdp/etc.

The default ip address is always returned first if available.

Definition at line 123 of file __init__.py.

async_get_enabled_source_ips()

list[IPv4Address | IPv6Address] homeassistant.components.network.async_get_enabled_source_ips

(

HomeAssistant

hass

)

Build the list of enabled source ips.

Definition at line 73 of file __init__.py.

async_get_ipv4_broadcast_addresses()

set[IPv4Address] homeassistant.components.network.async_get_ipv4_broadcast_addresses

(

HomeAssistant

hass

)

Return a set of broadcast addresses.

Definition at line 104 of file __init__.py.

async_get_source_ip()

str homeassistant.components.network.async_get_source_ip	(	HomeAssistant	hass,
		str | UndefinedType	target_ip = UNDEFINED
	)

Get the source ip for a target ip.

Definition at line 38 of file __init__.py.

async_only_default_interface_enabled()

bool homeassistant.components.network.async_only_default_interface_enabled

(

list[Adapter]

adapters

)

Check to see if any non-default adapter is enabled.

Definition at line 96 of file __init__.py.

async_setup()

bool homeassistant.components.network.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up network for Home Assistant.

Definition at line 147 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 25 of file __init__.py.

CONFIG_SCHEMA

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

Definition at line 27 of file __init__.py.