Classes
class	EntityFilterDict

class	HomeKitConfigFlow

class	OptionsFlowHandler

Functions
EntityFilterDict	_async_build_entities_filter (list[str] domains, list[str] entities)

list[str]	_async_cameras_from_entities (list[str] entities)

str	_async_domain_names (HomeAssistant hass, list[str] domains)

set[str]	_async_entity_ids_with_accessory_mode (HomeAssistant hass)

list[str]	_async_get_entity_ids_for_accessory_mode (HomeAssistant hass, Iterable[str] include_domains)

list[str]	_async_get_matching_entities (HomeAssistant hass, list[str]\|None domains=None, bool include_entity_category=False, bool include_hidden=False)

dict[str, str]	_async_get_supported_devices (HomeAssistant hass)

dict[str, str]	_async_name_to_type_map (HomeAssistant hass)

set[str]	_domains_set_from_entities (Iterable[str] entity_ids)

bool	_exclude_by_entity_registry (er.EntityRegistry ent_reg, str entity_id, bool include_entity_category, bool include_hidden)

EntityFilterDict	_make_entity_filter (list[str]\|None include_domains=None, list[str]\|None include_entities=None, list[str]\|None exclude_domains=None, list[str]\|None exclude_entities=None)

Variables
string	CAMERA_ENTITY_PREFIX = f"{CAMERA_DOMAIN}."

string	CONF_CAMERA_AUDIO = "camera_audio"

string	CONF_CAMERA_COPY = "camera_copy"

string	CONF_INCLUDE_EXCLUDE_MODE = "include_exclude_mode"

list	DEFAULT_DOMAINS

dictionary	DOMAINS_NEED_ACCESSORY_MODE

	Final

list	INCLUDE_EXCLUDE_MODES = [MODE_EXCLUDE, MODE_INCLUDE]

string	MODE_EXCLUDE = "exclude"

string	MODE_INCLUDE = "include"

dictionary	NEVER_BRIDGED_DOMAINS = {CAMERA_DOMAIN}

list	SUPPORTED_DOMAINS

Detailed Description

Config flow for HomeKit integration.

Function Documentation

◆ _async_build_entities_filter()

EntityFilterDict homeassistant.components.homekit.config_flow._async_build_entities_filter	(	list[str]	domains,
		list[str]	entities
	)

private

Build an entities filter from domains and entities.

Definition at line 168 of file config_flow.py.

◆ _async_cameras_from_entities()

list[str] homeassistant.components.homekit.config_flow._async_cameras_from_entities ( list[str] entities )

private

Definition at line 182 of file config_flow.py.

◆ _async_domain_names()

str homeassistant.components.homekit.config_flow._async_domain_names	(	HomeAssistant	hass,
		list[str]	domains
	)

private

Build a list of integration names from domains.

Definition at line 159 of file config_flow.py.

◆ _async_entity_ids_with_accessory_mode()

set[str] homeassistant.components.homekit.config_flow._async_entity_ids_with_accessory_mode ( HomeAssistant hass )

private

Return a set of entity ids that have config entries in accessory mode.

Definition at line 749 of file config_flow.py.

◆ _async_get_entity_ids_for_accessory_mode()

list[str] homeassistant.components.homekit.config_flow._async_get_entity_ids_for_accessory_mode	(	HomeAssistant	hass,
		Iterable[str]	include_domains
	)

private

Build a list of entities that should be paired in accessory mode.

Definition at line 730 of file config_flow.py.

◆ _async_get_matching_entities()

list[str] homeassistant.components.homekit.config_flow._async_get_matching_entities	(	HomeAssistant	hass,
		list[str] \| None	domains = `None`,
		bool	include_entity_category = `False`,
		bool	include_hidden = `False`
	)

private

Fetch all entities or entities in the given domains.

Definition at line 704 of file config_flow.py.

◆ _async_get_supported_devices()

dict[str, str] homeassistant.components.homekit.config_flow._async_get_supported_devices ( HomeAssistant hass )

private

Return all supported devices.

Definition at line 675 of file config_flow.py.

◆ _async_name_to_type_map()

dict[str, str] homeassistant.components.homekit.config_flow._async_name_to_type_map ( HomeAssistant hass )

private

Create a mapping of types of devices/entities HomeKit can support.

Definition at line 190 of file config_flow.py.

◆ _domains_set_from_entities()

set[str] homeassistant.components.homekit.config_flow._domains_set_from_entities ( Iterable[str] entity_ids )

private

Build a set of domains for the given entity ids.

Definition at line 724 of file config_flow.py.

◆ _exclude_by_entity_registry()

bool homeassistant.components.homekit.config_flow._exclude_by_entity_registry	(	er.EntityRegistry	ent_reg,
		str	entity_id,
		bool	include_entity_category,
		bool	include_hidden
	)

private

Filter out hidden entities and ones with entity category (unless specified).

Definition at line 688 of file config_flow.py.

◆ _make_entity_filter()

EntityFilterDict homeassistant.components.homekit.config_flow._make_entity_filter	(	list[str] \| None	include_domains = `None`,
		list[str] \| None	include_entities = `None`,
		list[str] \| None	exclude_domains = `None`,
		list[str] \| None	exclude_entities = `None`
	)

private

Create a filter dict.

Definition at line 144 of file config_flow.py.

Variable Documentation

◆ CAMERA_ENTITY_PREFIX

string homeassistant.components.homekit.config_flow.CAMERA_ENTITY_PREFIX = f"{CAMERA_DOMAIN}."

Definition at line 81 of file config_flow.py.

◆ CONF_CAMERA_AUDIO

string homeassistant.components.homekit.config_flow.CONF_CAMERA_AUDIO = "camera_audio"

Definition at line 64 of file config_flow.py.

◆ CONF_CAMERA_COPY

string homeassistant.components.homekit.config_flow.CONF_CAMERA_COPY = "camera_copy"

Definition at line 65 of file config_flow.py.

◆ CONF_INCLUDE_EXCLUDE_MODE

string homeassistant.components.homekit.config_flow.CONF_INCLUDE_EXCLUDE_MODE = "include_exclude_mode"

Definition at line 66 of file config_flow.py.

◆ DEFAULT_DOMAINS

list homeassistant.components.homekit.config_flow.DEFAULT_DOMAINS

Initial value:

 =  [
     "alarm_control_panel",
     "climate",
     CAMERA_DOMAIN,
     "cover",
     "humidifier",
     "fan",
     "light",
     "lock",
     MEDIA_PLAYER_DOMAIN,
     REMOTE_DOMAIN,
     "switch",
     "vacuum",
     "water_heater",
 ]

Definition at line 113 of file config_flow.py.

◆ DOMAINS_NEED_ACCESSORY_MODE

dictionary homeassistant.components.homekit.config_flow.DOMAINS_NEED_ACCESSORY_MODE

Initial value:

 =  {
     CAMERA_DOMAIN,
     LOCK_DOMAIN,
     MEDIA_PLAYER_DOMAIN,
     REMOTE_DOMAIN,
 }

Definition at line 73 of file config_flow.py.

◆ Final

homeassistant.components.homekit.config_flow.Final

Definition at line 129 of file config_flow.py.

◆ INCLUDE_EXCLUDE_MODES

list homeassistant.components.homekit.config_flow.INCLUDE_EXCLUDE_MODES = [MODE_EXCLUDE, MODE_INCLUDE]

Definition at line 71 of file config_flow.py.

◆ MODE_EXCLUDE

string homeassistant.components.homekit.config_flow.MODE_EXCLUDE = "exclude"

Definition at line 69 of file config_flow.py.

◆ MODE_INCLUDE

string homeassistant.components.homekit.config_flow.MODE_INCLUDE = "include"

Definition at line 68 of file config_flow.py.

◆ NEVER_BRIDGED_DOMAINS

dictionary homeassistant.components.homekit.config_flow.NEVER_BRIDGED_DOMAINS = {CAMERA_DOMAIN}

Definition at line 79 of file config_flow.py.

◆ SUPPORTED_DOMAINS

list homeassistant.components.homekit.config_flow.SUPPORTED_DOMAINS

Initial value:

 =  [
     "alarm_control_panel",
     "automation",
     "binary_sensor",
     "button",
     CAMERA_DOMAIN,
     "climate",
     "cover",
     "demo",
     "device_tracker",
     "fan",
     "humidifier",
     "input_boolean",
     "input_button",
     "input_select",
     "light",
     "lock",
     MEDIA_PLAYER_DOMAIN,
     "person",
     REMOTE_DOMAIN,
     "scene",
     "script",
     "select",
     "sensor",
     "switch",
     "vacuum",
     "water_heater",
     VALVE_DOMAIN,
 ]

Definition at line 83 of file config_flow.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _async_build_entities_filter()

◆ _async_cameras_from_entities()

◆ _async_domain_names()

◆ _async_entity_ids_with_accessory_mode()

◆ _async_get_entity_ids_for_accessory_mode()

◆ _async_get_matching_entities()

◆ _async_get_supported_devices()

◆ _async_name_to_type_map()

◆ _domains_set_from_entities()

◆ _exclude_by_entity_registry()

◆ _make_entity_filter()

Variable Documentation

◆ CAMERA_ENTITY_PREFIX

◆ CONF_CAMERA_AUDIO

◆ CONF_CAMERA_COPY

◆ CONF_INCLUDE_EXCLUDE_MODE

◆ DEFAULT_DOMAINS

◆ DOMAINS_NEED_ACCESSORY_MODE

◆ Final

◆ INCLUDE_EXCLUDE_MODES

◆ MODE_EXCLUDE

◆ MODE_INCLUDE

◆ NEVER_BRIDGED_DOMAINS

◆ SUPPORTED_DOMAINS