homeassistant.components.event Namespace Reference

Namespaces
	const

Classes
class	EventDeviceClass
class	EventEntity
class	EventEntityDescription
class	EventExtraStoredData

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
list	__all__
	_LOGGER = logging.getLogger(__name__)
dictionary	CACHED_PROPERTIES_WITH_ATTR_
string	ENTITY_ID_FORMAT = DOMAIN + ".{}"
	PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
	SCAN_INTERVAL = timedelta(seconds=30)

Detailed Description

Component for handling incoming events as a platform.

Function Documentation

async_setup()

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

Set up Event entities.

Definition at line 55 of file __init__.py.

async_setup_entry()

bool homeassistant.components.event.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 64 of file __init__.py.

async_unload_entry()

bool homeassistant.components.event.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 69 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.event.__all__

private

Initial value:

=  [
    "ATTR_EVENT_TYPE",
    "ATTR_EVENT_TYPES",
    "DOMAIN",
    "PLATFORM_SCHEMA_BASE",
    "PLATFORM_SCHEMA",
    "EventDeviceClass",
    "EventEntity",
    "EventEntityDescription",
]

Definition at line 41 of file __init__.py.

_LOGGER

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

private

Definition at line 25 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.event.CACHED_PROPERTIES_WITH_ATTR_

Initial value:

=  {
    "device_class",
    "event_types",
}

Definition at line 104 of file __init__.py.

ENTITY_ID_FORMAT

string homeassistant.components.event.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 27 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.event.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 28 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.event.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 29 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.event.SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 30 of file __init__.py.