homeassistant.components.matter Namespace Reference

Namespaces
	adapter
	addon
	api
	binary_sensor
	button
	climate
	config_flow
	const
	cover
	diagnostics
	discovery
	entity
	event
	fan
	helpers
	light
	lock
	models
	number
	select
	sensor
	switch
	update
	util
	vacuum
	valve

Functions
None	_async_ensure_addon_running (HomeAssistant hass, ConfigEntry entry)
None	_client_listen (HomeAssistant hass, ConfigEntry entry, MatterClient matter_client, asyncio.Event init_ready)
AddonManager	_get_addon_manager (HomeAssistant hass)
None	_remove_via_devices (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
bool	async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
None	async_remove_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
MatterDeviceInfo|None	get_matter_device_info (HomeAssistant hass, str device_id)

Variables
int	CONNECT_TIMEOUT = 10
int	LISTEN_READY_TIMEOUT = 30

Detailed Description

The Matter integration.

Function Documentation

_async_ensure_addon_running()

None homeassistant.components.matter._async_ensure_addon_running ( HomeAssistant  hass, ConfigEntry  entry  )

private

Ensure that Matter Server add-on is installed and running.

Definition at line 281 of file __init__.py.

_client_listen()

None homeassistant.components.matter._client_listen ( HomeAssistant  hass, ConfigEntry  entry, MatterClient  matter_client, asyncio.Event  init_ready  )

private

Listen with the client.

Definition at line 168 of file __init__.py.

_get_addon_manager()

AddonManager homeassistant.components.matter._get_addon_manager ( HomeAssistant  hass )

private

Ensure that Matter Server add-on is updated and running.

May only be used as part of async_setup_entry above.

Definition at line 304 of file __init__.py.

_remove_via_devices()

None homeassistant.components.matter._remove_via_devices ( HomeAssistant  hass, ConfigEntry  config_entry, dr.DeviceEntry   device_entry  )

private

Remove all via devices associated with a device.

Definition at line 238 of file __init__.py.

async_remove_config_entry_device()

bool homeassistant.components.matter.async_remove_config_entry_device	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		dr.DeviceEntry	device_entry
	)

Remove a config entry from a device.

Definition at line 251 of file __init__.py.

async_remove_entry()

None homeassistant.components.matter.async_remove_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Config entry is being removed.

Definition at line 215 of file __init__.py.

async_setup_entry()

bool homeassistant.components.matter.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up Matter from a config entry.

Definition at line 67 of file __init__.py.

async_unload_entry()

bool homeassistant.components.matter.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 192 of file __init__.py.

get_matter_device_info()

MatterDeviceInfo | None homeassistant.components.matter.get_matter_device_info	(	HomeAssistant	hass,
		str	device_id
	)

Return Matter device info or None if device does not exist.

Definition at line 50 of file __init__.py.

Variable Documentation

CONNECT_TIMEOUT

int homeassistant.components.matter.CONNECT_TIMEOUT = 10

Definition at line 44 of file __init__.py.

LISTEN_READY_TIMEOUT

int homeassistant.components.matter.LISTEN_READY_TIMEOUT = 30

Definition at line 45 of file __init__.py.