homeassistant.components.logbook Namespace Reference

Namespaces
	const
	helpers
	models
	processor
	queries
	rest_api
	websocket_api

Functions
None	_process_logbook_platform (HomeAssistant hass, str domain, Any platform)
None	async_log_entry (HomeAssistant hass, str name, str message, str|None domain=None, str|None entity_id=None, Context|None context=None)
bool	async_setup (HomeAssistant hass, ConfigType config)
None	log_entry (HomeAssistant hass, str name, str message, str|None domain=None, str|None entity_id=None, Context|None context=None)

Variables
	extra
	LOG_MESSAGE_SCHEMA

Detailed Description

Event parser and human readable log generator.

Function Documentation

_process_logbook_platform()

None homeassistant.components.logbook._process_logbook_platform ( HomeAssistant  hass, str  domain, Any  platform  )

private

Process a logbook platform.

Definition at line 150 of file __init__.py.

async_log_entry()

None homeassistant.components.logbook.async_log_entry	(	HomeAssistant	hass,
		str	name,
		str	message,
		str | None	domain = None,
		str | None	entity_id = None,
		Context | None	context = None
	)

Add an entry to the logbook.

Definition at line 80 of file __init__.py.

async_setup()

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

Logbook setup.

Definition at line 98 of file __init__.py.

log_entry()

None homeassistant.components.logbook.log_entry	(	HomeAssistant	hass,
		str	name,
		str	message,
		str | None	domain = None,
		str | None	entity_id = None,
		Context | None	context = None
	)

Add an entry to the logbook.

Definition at line 66 of file __init__.py.

Variable Documentation

extra

homeassistant.components.logbook.extra

Definition at line 51 of file __init__.py.

LOG_MESSAGE_SCHEMA

homeassistant.components.logbook.LOG_MESSAGE_SCHEMA

Definition at line 55 of file __init__.py.