homeassistant.components.homekit_controller.config_flow Namespace Reference

Classes
class	HomekitControllerFlowHandler
class	InsecureSetupCode

Functions
str	ensure_pin_format (str pin, Any allow_insecure_setup_codes=None)
str	formatted_category (Categories category)
str	normalize_hkid (str hkid)

Variables
	_LOGGER = logging.getLogger(__name__)
string	BLE_DEFAULT_NAME = "Bluetooth device"
string	HOMEKIT_BRIDGE_DOMAIN = "homekit"
string	HOMEKIT_DIR = ".homekit"
list	HOMEKIT_IGNORE
dictionary	INSECURE_CODES
string	PAIRING_FILE = "pairing.json"
	PIN_FORMAT = re.compile(r"^(\d{3})-{0,1}(\d{2})-{0,1}(\d{3})$")

Detailed Description

Config flow to configure homekit_controller.

Function Documentation

ensure_pin_format()

str homeassistant.components.homekit_controller.config_flow.ensure_pin_format	(	str	pin,
		Any	allow_insecure_setup_codes = None
	)

Ensure a pin code is correctly formatted.

Ensures a pin code is in the format 111-11-111.
Handles codes with and without dashes.

If incorrect code is entered, an exception is raised.

Definition at line 84 of file config_flow.py.

formatted_category()

str homeassistant.components.homekit_controller.config_flow.formatted_category

(

Categories

category

)

Return a human readable category name.

Definition at line 79 of file config_flow.py.

normalize_hkid()

str homeassistant.components.homekit_controller.config_flow.normalize_hkid

(

str

hkid

)

Normalize a hkid so that it is safe to compare with other normalized hkids.

Definition at line 74 of file config_flow.py.

Variable Documentation

_LOGGER

homeassistant.components.homekit_controller.config_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 53 of file config_flow.py.

BLE_DEFAULT_NAME

string homeassistant.components.homekit_controller.config_flow.BLE_DEFAULT_NAME = "Bluetooth device"

Definition at line 56 of file config_flow.py.

HOMEKIT_BRIDGE_DOMAIN

string homeassistant.components.homekit_controller.config_flow.HOMEKIT_BRIDGE_DOMAIN = "homekit"

Definition at line 38 of file config_flow.py.

HOMEKIT_DIR

string homeassistant.components.homekit_controller.config_flow.HOMEKIT_DIR = ".homekit"

Definition at line 37 of file config_flow.py.

HOMEKIT_IGNORE

list homeassistant.components.homekit_controller.config_flow.HOMEKIT_IGNORE

Initial value:

=  [
    # eufy Indoor Cam 2K and 2K Pan & Tilt
    # https://github.com/home-assistant/core/issues/42307
    "T8400",
    "T8410",
    # Hive Hub - vendor does not give user a pairing code
    "HHKBridge1,1",
]

Definition at line 40 of file config_flow.py.

INSECURE_CODES

dictionary homeassistant.components.homekit_controller.config_flow.INSECURE_CODES

Initial value:

=  {
    "00000000",
    "11111111",
    "22222222",
    "33333333",
    "44444444",
    "55555555",
    "66666666",
    "77777777",
    "88888888",
    "99999999",
    "12345678",
    "87654321",
}

Definition at line 58 of file config_flow.py.

PAIRING_FILE

string homeassistant.components.homekit_controller.config_flow.PAIRING_FILE = "pairing.json"

Definition at line 49 of file config_flow.py.

PIN_FORMAT

homeassistant.components.homekit_controller.config_flow.PIN_FORMAT = re.compile(r"^(\d{3})-{0,1}(\d{2})-{0,1}(\d{3})$")

Definition at line 51 of file config_flow.py.