homeassistant.components.homekit Namespace Reference

Namespaces
	accessories
	aidmanager
	config_flow
	const
	diagnostics
	iidmanager
	logbook
	models
	type_cameras
	type_covers
	type_fans
	type_humidifiers
	type_lights
	type_locks
	type_media_players
	type_remotes
	type_security_systems
	type_sensors
	type_switches
	type_thermostats
	type_triggers
	util

Classes
class	HomeKit
class	HomeKitPairingQRView

Functions
list[HomeKit]	_async_all_homekit_instances (HomeAssistant hass)
tuple[dict[str, ConfigEntry], dict[int, ConfigEntry]]	_async_get_imported_entries_indices (list[ConfigEntry] current_entries)
None	_async_import_options_from_data_if_missing (HomeAssistant hass, HomeKitConfigEntry entry)
None	_async_register_events_and_services (HomeAssistant hass)
bool	_async_update_config_entry_from_yaml (HomeAssistant hass, dict[str, ConfigEntry] entries_by_name, dict[int, ConfigEntry] entries_by_port, ConfigType conf)
None	_async_update_listener (HomeAssistant hass, HomeKitConfigEntry entry)
list[dict[str, Any]]	_has_all_unique_names_and_ports (list[dict[str, Any]] bridges)
None	async_remove_entry (HomeAssistant hass, HomeKitConfigEntry entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, HomeKitConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, HomeKitConfigEntry entry)

Variables
	_DEFAULT_BIND
	_HAS_IPV6
	_HOMEKIT_CONFIG_UPDATE_TIME
	_LOGGER
	BATTERY_CHARGING_SENSOR
	BATTERY_SENSOR
	BRIDGE_SCHEMA
	CONFIG_SCHEMA
	DOORBELL_EVENT_SENSOR
	extra = vol.ALLOW_EXTRA,
	HUMIDITY_SENSOR
	MAX_DEVICES
	MOTION_EVENT_SENSOR
	MOTION_SENSOR
	PORT_CLEANUP_CHECK_INTERVAL_SECS
	RESET_ACCESSORY_SERVICE_SCHEMA
	STATUS_READY
	STATUS_RUNNING
	STATUS_STOPPED
	STATUS_WAIT
	UNPAIR_SERVICE_SCHEMA

Detailed Description

Support for Apple HomeKit.

Function Documentation

_async_all_homekit_instances()

list[HomeKit] homeassistant.components.homekit._async_all_homekit_instances ( HomeAssistant  hass )

private

All active HomeKit instances.

Definition at line 223 of file __init__.py.

_async_get_imported_entries_indices()

tuple[dict[str, ConfigEntry], dict[int, ConfigEntry]] homeassistant.components.homekit._async_get_imported_entries_indices ( list[ConfigEntry]  current_entries )

private

Return a dicts of the entries by name and port.

Definition at line 233 of file __init__.py.

_async_import_options_from_data_if_missing()

None homeassistant.components.homekit._async_import_options_from_data_if_missing ( HomeAssistant  hass, HomeKitConfigEntry   entry  )

private

Definition at line 427 of file __init__.py.

_async_register_events_and_services()

None homeassistant.components.homekit._async_register_events_and_services ( HomeAssistant  hass )

private

Register events and services for HomeKit.

Definition at line 444 of file __init__.py.

_async_update_config_entry_from_yaml()

bool homeassistant.components.homekit._async_update_config_entry_from_yaml ( HomeAssistant  hass, dict[str, ConfigEntry]  entries_by_name, dict[int, ConfigEntry]  entries_by_port, ConfigType  conf  )

private

Update a config entry with the latest yaml.

Returns True if a matching config entry was found

Returns False if there is no matching config entry

Definition at line 289 of file __init__.py.

_async_update_listener()

None homeassistant.components.homekit._async_update_listener ( HomeAssistant  hass, HomeKitConfigEntry   entry  )

private

Handle options update.

Definition at line 387 of file __init__.py.

_has_all_unique_names_and_ports()

list[dict[str, Any]] homeassistant.components.homekit._has_all_unique_names_and_ports ( list[dict[str, Any]]  bridges )

private

Validate that each homekit bridge configured has a unique name.

Definition at line 173 of file __init__.py.

async_remove_entry()

None homeassistant.components.homekit.async_remove_entry	(	HomeAssistant	hass,
		HomeKitConfigEntry	entry
	)

Remove a config entry.

Definition at line 419 of file __init__.py.

async_setup()

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

Set up the HomeKit from yaml.

Definition at line 250 of file __init__.py.

async_setup_entry()

bool homeassistant.components.homekit.async_setup_entry	(	HomeAssistant	hass,
		HomeKitConfigEntry	entry
	)

Set up HomeKit from a config entry.

Definition at line 321 of file __init__.py.

async_unload_entry()

bool homeassistant.components.homekit.async_unload_entry	(	HomeAssistant	hass,
		HomeKitConfigEntry	entry
	)

Unload a config entry.

Definition at line 396 of file __init__.py.

Variable Documentation

_DEFAULT_BIND

homeassistant.components.homekit._DEFAULT_BIND

private

Definition at line 159 of file __init__.py.

_HAS_IPV6

homeassistant.components.homekit._HAS_IPV6

private

Definition at line 158 of file __init__.py.

_HOMEKIT_CONFIG_UPDATE_TIME

homeassistant.components.homekit._HOMEKIT_CONFIG_UPDATE_TIME

private

Definition at line 155 of file __init__.py.

_LOGGER

homeassistant.components.homekit._LOGGER

private

Definition at line 143 of file __init__.py.

BATTERY_CHARGING_SENSOR

homeassistant.components.homekit.BATTERY_CHARGING_SENSOR

Definition at line 162 of file __init__.py.

BATTERY_SENSOR

homeassistant.components.homekit.BATTERY_SENSOR

Definition at line 166 of file __init__.py.

BRIDGE_SCHEMA

homeassistant.components.homekit.BRIDGE_SCHEMA

Definition at line 184 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.homekit.CONFIG_SCHEMA

Definition at line 206 of file __init__.py.

DOORBELL_EVENT_SENSOR

homeassistant.components.homekit.DOORBELL_EVENT_SENSOR

Definition at line 169 of file __init__.py.

extra

homeassistant.components.homekit.extra = vol.ALLOW_EXTRA,

Definition at line 202 of file __init__.py.

HUMIDITY_SENSOR

homeassistant.components.homekit.HUMIDITY_SENSOR

Definition at line 170 of file __init__.py.

MAX_DEVICES

homeassistant.components.homekit.MAX_DEVICES

Definition at line 145 of file __init__.py.

MOTION_EVENT_SENSOR

homeassistant.components.homekit.MOTION_EVENT_SENSOR

Definition at line 167 of file __init__.py.

MOTION_SENSOR

homeassistant.components.homekit.MOTION_SENSOR

Definition at line 168 of file __init__.py.

PORT_CLEANUP_CHECK_INTERVAL_SECS

homeassistant.components.homekit.PORT_CLEANUP_CHECK_INTERVAL_SECS

Definition at line 153 of file __init__.py.

RESET_ACCESSORY_SERVICE_SCHEMA

homeassistant.components.homekit.RESET_ACCESSORY_SERVICE_SCHEMA

Definition at line 212 of file __init__.py.

STATUS_READY

homeassistant.components.homekit.STATUS_READY

Definition at line 148 of file __init__.py.

STATUS_RUNNING

homeassistant.components.homekit.STATUS_RUNNING

Definition at line 149 of file __init__.py.

STATUS_STOPPED

homeassistant.components.homekit.STATUS_STOPPED

Definition at line 150 of file __init__.py.

STATUS_WAIT

homeassistant.components.homekit.STATUS_WAIT

Definition at line 151 of file __init__.py.

UNPAIR_SERVICE_SCHEMA

homeassistant.components.homekit.UNPAIR_SERVICE_SCHEMA

Definition at line 217 of file __init__.py.