homeassistant.components.hyperion Namespace Reference

Namespaces
	camera
	config_flow
	const
	light
	sensor
	switch

Functions
None	_async_entry_updated (HomeAssistant hass, ConfigEntry config_entry)
client.HyperionClient|None	async_create_connect_hyperion_client (*Any args, **Any kwargs)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry config_entry)
client.HyperionClient	create_hyperion_client (*Any args, **Any kwargs)
str	get_hyperion_device_id (str server_id, int instance)
str	get_hyperion_unique_id (str server_id, int instance, str name)
None	listen_for_instance_updates (HomeAssistant hass, ConfigEntry config_entry, Callable add_func, Callable remove_func)
tuple[str, int, str]|None	split_hyperion_unique_id (str unique_id)

Variables
	_LOGGER = logging.getLogger(__name__)
list	PLATFORMS = [Platform.CAMERA, Platform.LIGHT, Platform.SENSOR, Platform.SWITCH]

Detailed Description

The Hyperion component.

Function Documentation

_async_entry_updated()

None homeassistant.components.hyperion._async_entry_updated ( HomeAssistant  hass, ConfigEntry  config_entry  )

private

Handle entry updates.

Definition at line 280 of file __init__.py.

async_create_connect_hyperion_client()

client.HyperionClient | None homeassistant.components.hyperion.async_create_connect_hyperion_client	(	*Any	args,
		**Any	kwargs
	)

Create and connect a Hyperion Client.

Definition at line 95 of file __init__.py.

async_setup_entry()

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

Set up Hyperion from a config entry.

Definition at line 132 of file __init__.py.

async_unload_entry()

bool homeassistant.components.hyperion.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Unload a config entry.

Definition at line 285 of file __init__.py.

create_hyperion_client()

client.HyperionClient homeassistant.components.hyperion.create_hyperion_client	(	*Any	args,
		**Any	kwargs
	)

Create a Hyperion Client.

Definition at line 87 of file __init__.py.

get_hyperion_device_id()

str homeassistant.components.hyperion.get_hyperion_device_id	(	str	server_id,
		int	instance
	)

Get an id for a Hyperion device/instance.

Definition at line 71 of file __init__.py.

get_hyperion_unique_id()

str homeassistant.components.hyperion.get_hyperion_unique_id	(	str	server_id,
		int	instance,
		str	name
	)

Get a unique_id for a Hyperion instance.

Definition at line 66 of file __init__.py.

listen_for_instance_updates()

None homeassistant.components.hyperion.listen_for_instance_updates	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		Callable	add_func,
		Callable	remove_func
	)

Listen for instance additions/removals.

Definition at line 108 of file __init__.py.

split_hyperion_unique_id()

tuple[str, int, str] | None homeassistant.components.hyperion.split_hyperion_unique_id

(

str

unique_id

)

Split a unique_id into a (server_id, instance, type) tuple.

Definition at line 76 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 38 of file __init__.py.

PLATFORMS

list homeassistant.components.hyperion.PLATFORMS = [Platform.CAMERA, Platform.LIGHT, Platform.SENSOR, Platform.SWITCH]

Definition at line 36 of file __init__.py.