homeassistant.components.diagnostics Namespace Reference

Namespaces
	const
	util

Classes
class	DiagnosticsData
class	DiagnosticsPlatformData
class	DiagnosticsProtocol
class	DownloadDiagnosticsView

Functions
web.Response	_async_get_json_file_response (HomeAssistant hass, Mapping[str, Any] data, str filename, str domain, str d_id, str|None sub_id=None)
None	_register_diagnostics_platform (HomeAssistant hass, str integration_domain, DiagnosticsProtocol platform)
Manifest	async_format_manifest (Manifest manifest)
bool	async_setup (HomeAssistant hass, ConfigType config)
None	handle_get (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
None	handle_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)

Variables
list	__all__ = ["REDACTED", "async_redact_data"]
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Detailed Description

The Diagnostics integration.

Function Documentation

_async_get_json_file_response()

web.Response homeassistant.components.diagnostics._async_get_json_file_response ( HomeAssistant  hass, Mapping[str, Any]  data, str  filename, str  domain, str  d_id, str | None   sub_id = None  )

private

Return JSON file from dictionary.

Definition at line 185 of file __init__.py.

_register_diagnostics_platform()

None homeassistant.components.diagnostics._register_diagnostics_platform ( HomeAssistant  hass, str  integration_domain, DiagnosticsProtocol   platform  )

private

Register a diagnostics platform.

Definition at line 103 of file __init__.py.

async_format_manifest()

Manifest homeassistant.components.diagnostics.async_format_manifest

(

Manifest

manifest

)

Format manifest for diagnostics.

Remove the @ from codeowners so that
when users download the diagnostics and paste
the codeowners into the repository, it will
not notify the users in the codeowners file.

Definition at line 169 of file __init__.py.

async_setup()

bool homeassistant.components.diagnostics.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Diagnostics from a config entry.

Definition at line 73 of file __init__.py.

handle_get()

None homeassistant.components.diagnostics.handle_get	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

List all diagnostic handlers for a domain.

Definition at line 143 of file __init__.py.

handle_info()

None homeassistant.components.diagnostics.handle_info	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

List all possible diagnostic handlers.

Definition at line 117 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.diagnostics.__all__ = ["REDACTED", "async_redact_data"]

private

Definition at line 41 of file __init__.py.

_LOGGER

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

private

Definition at line 43 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.diagnostics.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 46 of file __init__.py.