Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.homekit_controller.utils Namespace Reference

Functions

Controller async_get_controller (HomeAssistant hass)
 
str folded_name (str name)
 
IidTuple|None unique_id_to_iids (str unique_id)
 

Variables

 IidTuple
 

Detailed Description

Helper functions for the homekit_controller component.

Function Documentation

◆ async_get_controller()

Controller homeassistant.components.homekit_controller.utils.async_get_controller ( HomeAssistant  hass)
Get or create an aiohomekit Controller instance.

Definition at line 47 of file utils.py.

◆ folded_name()

str homeassistant.components.homekit_controller.utils.folded_name ( str  name)
Return a name that is used for matching a similar string.

Definition at line 42 of file utils.py.

◆ unique_id_to_iids()

IidTuple | None homeassistant.components.homekit_controller.utils.unique_id_to_iids ( str  unique_id)
Convert a unique_id to a tuple of accessory id, service iid and characteristic iid.

Depending on the field in the accessory map that is referenced, some of these may be None.

Returns None if this unique_id doesn't follow the homekit_controller scheme and is invalid.

Definition at line 18 of file utils.py.

Variable Documentation

◆ IidTuple

homeassistant.components.homekit_controller.utils.IidTuple

Definition at line 15 of file utils.py.