homeassistant.components.otbr.util Namespace Reference

Classes
class	GetBorderAgentIdNotSupported
class	OTBRData

Functions
Callable[Concatenate[OTBRData, _P], Coroutine[Any, Any, _R]]	_R (Callable[Concatenate[OTBRData, _P], Coroutine[Any, Any, _R]] func)
None	_warn_on_channel_collision (HomeAssistant hass, OTBRData otbrdata, bytes dataset_tlvs)
None	_warn_on_default_network_settings (HomeAssistant hass, OTBRData otbrdata, bytes dataset_tlvs)
str	compose_default_network_name (int pan_id)
int	generate_random_pan_id ()
int|None	get_allowed_channel (HomeAssistant hass, str otbr_url)
None	update_issues (HomeAssistant hass, OTBRData otbrdata, bytes dataset_tlvs)
None	update_unique_id (HomeAssistant hass, OTBRConfigEntry|None entry, bytes border_agent_id)

Variables
	_LOGGER = logging.getLogger(__name__)
tuple	INFO_URL_SKY_CONNECT
string	INFO_URL_YELLOW = "https://yellow.home-assistant.io/multiprotocol-channel-missmatch"
tuple	INSECURE_NETWORK_KEYS
tuple	INSECURE_PASSPHRASES

Detailed Description

Utility functions for the Open Thread Border Router integration.

Function Documentation

_R()

Callable[Concatenate[OTBRData, _P], Coroutine[Any, Any, _R]] homeassistant.components.otbr.util._R ( Callable[Concatenate[OTBRData, _P], Coroutine[Any, Any, _R]]  func )

private

Handle OTBR errors.

Definition at line 70 of file util.py.

_warn_on_channel_collision()

None homeassistant.components.otbr.util._warn_on_channel_collision ( HomeAssistant  hass, OTBRData  otbrdata, bytes   dataset_tlvs  )

private

Warn user if OTBR and ZHA attempt to use different channels.

Definition at line 179 of file util.py.

_warn_on_default_network_settings()

None homeassistant.components.otbr.util._warn_on_default_network_settings ( HomeAssistant  hass, OTBRData  otbrdata, bytes   dataset_tlvs  )

private

Warn user if insecure default network settings are used.

Definition at line 225 of file util.py.

compose_default_network_name()

str homeassistant.components.otbr.util.compose_default_network_name

(

int

pan_id

)

Generate a default network name.

Definition at line 59 of file util.py.

generate_random_pan_id()

int homeassistant.components.otbr.util.generate_random_pan_id

(

)

Generate a random PAN ID.

Definition at line 64 of file util.py.

get_allowed_channel()

int | None homeassistant.components.otbr.util.get_allowed_channel	(	HomeAssistant	hass,
		str	otbr_url
	)

Return the allowed channel, or None if there's no restriction.

Definition at line 167 of file util.py.

update_issues()

None homeassistant.components.otbr.util.update_issues	(	HomeAssistant	hass,
		OTBRData	otbrdata,
		bytes	dataset_tlvs
	)

Raise or clear repair issues related to network settings.

Definition at line 268 of file util.py.

update_unique_id()

None homeassistant.components.otbr.util.update_unique_id	(	HomeAssistant	hass,
		OTBRConfigEntry | None	entry,
		bytes	border_agent_id
	)

Update the config entry's unique_id if not matching.

Definition at line 276 of file util.py.

Variable Documentation

_LOGGER

homeassistant.components.otbr.util._LOGGER = logging.getLogger(__name__)

private

Definition at line 35 of file util.py.

INFO_URL_SKY_CONNECT

tuple homeassistant.components.otbr.util.INFO_URL_SKY_CONNECT

Initial value:

=  (
    "https://skyconnect.home-assistant.io/multiprotocol-channel-missmatch"
)

Definition at line 37 of file util.py.

INFO_URL_YELLOW

string homeassistant.components.otbr.util.INFO_URL_YELLOW = "https://yellow.home-assistant.io/multiprotocol-channel-missmatch"

Definition at line 40 of file util.py.

INSECURE_NETWORK_KEYS

tuple homeassistant.components.otbr.util.INSECURE_NETWORK_KEYS

Initial value:

=  (
    # Thread web UI default
    bytes.fromhex("00112233445566778899AABBCCDDEEFF"),
)

Definition at line 42 of file util.py.

INSECURE_PASSPHRASES

tuple homeassistant.components.otbr.util.INSECURE_PASSPHRASES

Initial value:

=  (
    # Thread web UI default
    "j01Nme",
    # Thread documentation default
    "J01NME",
)

Definition at line 47 of file util.py.