homeassistant.components.system_health Namespace Reference

Classes
class	SystemHealthProtocol
class	SystemHealthRegistration

Functions
Any	_format_value (Any val)
None	_register_system_health_platform (HomeAssistant hass, str integration_domain, SystemHealthProtocol platform)
str|dict[str, str]	async_check_can_reach_url (HomeAssistant hass, str url, str|None more_info=None)
None	async_register_info (HomeAssistant hass, str domain, Callable[[HomeAssistant], Awaitable[dict]] info_callback)
bool	async_setup (HomeAssistant hass, ConfigType config)
dict[str, Any]	get_integration_info (HomeAssistant hass, SystemHealthRegistration registration)
None	handle_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
string	DOMAIN = "system_health"
int	INFO_CALLBACK_TIMEOUT = 5

Detailed Description

Support for System health .

Function Documentation

_format_value()

Any homeassistant.components.system_health._format_value ( Any  val )

private

Format a system health value.

Definition at line 105 of file __init__.py.

_register_system_health_platform()

None homeassistant.components.system_health._register_system_health_platform ( HomeAssistant  hass, str  integration_domain, SystemHealthProtocol   platform  )

private

Register a system health platform.

Definition at line 75 of file __init__.py.

async_check_can_reach_url()

str | dict[str, str] homeassistant.components.system_health.async_check_can_reach_url	(	HomeAssistant	hass,
		str	url,
		str | None	more_info = None
	)

Test if the url can be reached.

Definition at line 231 of file __init__.py.

async_register_info()

None homeassistant.components.system_health.async_register_info	(	HomeAssistant	hass,
		str	domain,
		Callable[[HomeAssistant], Awaitable[dict]]	info_callback
	)

Register an info callback.

Deprecated.

Definition at line 45 of file __init__.py.

async_setup()

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

Set up the System Health component.

Definition at line 62 of file __init__.py.

get_integration_info()

dict[str, Any] homeassistant.components.system_health.get_integration_info	(	HomeAssistant	hass,
		SystemHealthRegistration	registration
	)

Get integration system health.

Definition at line 82 of file __init__.py.

handle_info()

None homeassistant.components.system_health.handle_info	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle an info request via a subscription.

Definition at line 114 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 25 of file __init__.py.

CONFIG_SCHEMA

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

Definition at line 31 of file __init__.py.

DOMAIN

string homeassistant.components.system_health.DOMAIN = "system_health"

Definition at line 27 of file __init__.py.

INFO_CALLBACK_TIMEOUT

int homeassistant.components.system_health.INFO_CALLBACK_TIMEOUT = 5

Definition at line 29 of file __init__.py.