homeassistant.components.zha.api Namespace Reference

Functions
ConfigEntry	_get_config_entry (HomeAssistant hass)
None	async_change_channel (HomeAssistant hass, int|Literal["auto"] new_channel)
NetworkBackup	async_get_active_network_settings (HomeAssistant hass)
NetworkBackup|None	async_get_last_network_settings (HomeAssistant hass, ConfigEntry|None config_entry=None)
NetworkBackup|None	async_get_network_settings (HomeAssistant hass, ConfigEntry|None config_entry=None)
str	async_get_radio_path (HomeAssistant hass, ConfigEntry|None config_entry=None)
RadioType	async_get_radio_type (HomeAssistant hass, ConfigEntry|None config_entry=None)

Detailed Description

API for Zigbee Home Automation.

Function Documentation

_get_config_entry()

ConfigEntry homeassistant.components.zha.api._get_config_entry ( HomeAssistant  hass )

private

Find the singleton ZHA config entry, if one exists.

Definition at line 22 of file api.py.

async_change_channel()

None homeassistant.components.zha.api.async_change_channel	(	HomeAssistant	hass,
		int | Literal["auto"]	new_channel
	)

Migrate the ZHA network to a new channel.

Definition at line 99 of file api.py.

async_get_active_network_settings()

NetworkBackup homeassistant.components.zha.api.async_get_active_network_settings

(

HomeAssistant

hass

)

Get the network settings for the currently active ZHA network.

Definition at line 40 of file api.py.

async_get_last_network_settings()

NetworkBackup | None homeassistant.components.zha.api.async_get_last_network_settings	(	HomeAssistant	hass,
		ConfigEntry | None	config_entry = None
	)

Get the network settings for the last-active ZHA network.

Definition at line 50 of file api.py.

async_get_network_settings()

NetworkBackup | None homeassistant.components.zha.api.async_get_network_settings	(	HomeAssistant	hass,
		ConfigEntry | None	config_entry = None
	)

Get ZHA network settings, preferring the active settings if ZHA is running.

Definition at line 68 of file api.py.

async_get_radio_path()

str homeassistant.components.zha.api.async_get_radio_path	(	HomeAssistant	hass,
		ConfigEntry | None	config_entry = None
	)

Get ZHA radio path.

Definition at line 89 of file api.py.

async_get_radio_type()

RadioType homeassistant.components.zha.api.async_get_radio_type	(	HomeAssistant	hass,
		ConfigEntry | None	config_entry = None
	)

Get ZHA radio type.

Definition at line 79 of file api.py.