homeassistant.components.thread.diagnostics Namespace Reference

Classes
class	Neighbour
class	Network
class	Route
class	Router

Functions
dict[str, Neighbour]	_get_neighbours (NDB ndb)
tuple[dict[str, dict[str, Route]], dict[str, set[str]]]	_get_possible_thread_routes (NDB ndb)
def	_get_routes_and_neighbors ()
dict[str, Any]	async_get_config_entry_diagnostics (HomeAssistant hass, ConfigEntry entry)

Detailed Description

Diagnostics support for Thread networks.

When triaging Matter and HomeKit issues you often need to check for problems with the Thread network.

This report helps spot and rule out:

* Is the users border router visible at all?
* Is the border router actually announcing any routes? The user could have a network boundary like
  VLANs or WiFi isolation that is blocking the RA packets.
* Alternatively, if user isn't on HAOS they could have accept_ra_rt_info_max_plen set incorrectly.
* Are there any bogus routes that could be interfering. If routes don't expire they can build up.
  When you have 10 routes and only 2 border routers something has gone wrong.

This does not do any connectivity checks. So user could have all their border routers visible, but
some of their thread accessories can't be pinged, but it's still a thread problem.

Function Documentation

_get_neighbours()

dict[str, Neighbour] homeassistant.components.thread.diagnostics._get_neighbours ( NDB  ndb )

private

Definition at line 104 of file diagnostics.py.

_get_possible_thread_routes()

tuple[dict[str, dict[str, Route]], dict[str, set[str]]] homeassistant.components.thread.diagnostics._get_possible_thread_routes ( NDB  ndb )

private

Definition at line 72 of file diagnostics.py.

_get_routes_and_neighbors()

def homeassistant.components.thread.diagnostics._get_routes_and_neighbors ( )

private

Get the routes and neighbours from pyroute2.

Definition at line 117 of file diagnostics.py.

async_get_config_entry_diagnostics()

dict[str, Any] homeassistant.components.thread.diagnostics.async_get_config_entry_diagnostics	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Return diagnostics for all known thread networks.

Definition at line 131 of file diagnostics.py.