Home Assistant Unofficial Reference 2024.12.1
event.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.helpers.event._KeyedEventData
 
class  homeassistant.helpers.event._KeyedEventTracker
 
class  homeassistant.helpers.event._TrackPointUTCTime
 
class  homeassistant.helpers.event._TrackStateChangeFiltered
 
class  homeassistant.helpers.event._TrackTimeInterval
 
class  homeassistant.helpers.event._TrackUTCTimeChange
 
class  homeassistant.helpers.event.SunListener
 
class  homeassistant.helpers.event.TrackStates
 
class  homeassistant.helpers.event.TrackTemplate
 
class  homeassistant.helpers.event.TrackTemplateResult
 
class  homeassistant.helpers.event.TrackTemplateResultInfo
 

Namespaces

 homeassistant.helpers.event
 

Functions

bool homeassistant.helpers.event._async_device_registry_updated_filter (HomeAssistant hass, dict[str, list[HassJob[[Event[EventDeviceRegistryUpdatedData]], Any]]] callbacks, EventDeviceRegistryUpdatedData event_data)
 
None homeassistant.helpers.event._async_dispatch_device_id_event (HomeAssistant hass, dict[str, list[HassJob[[Event[EventDeviceRegistryUpdatedData]], Any]]] callbacks, Event[EventDeviceRegistryUpdatedData] event)
 
None homeassistant.helpers.event._async_dispatch_domain_event (HomeAssistant hass, dict[str, list[HassJob[[Event[EventStateChangedData]], Any]]] callbacks, Event[EventStateChangedData] event)
 
None homeassistant.helpers.event._async_dispatch_entity_id_event (HomeAssistant hass, dict[str, list[HassJob[[Event[_StateEventDataT]], Any]]] callbacks, Event[_StateEventDataT] event)
 
None homeassistant.helpers.event._async_dispatch_entity_id_event_soon (HomeAssistant hass, dict[str, list[HassJob[[Event[_StateEventDataT]], Any]]] callbacks, Event[_StateEventDataT] event)
 
None homeassistant.helpers.event._async_dispatch_old_entity_id_or_entity_id_event (HomeAssistant hass, dict[str, list[HassJob[[Event[EventEntityRegistryUpdatedData]], Any]]] callbacks, Event[EventEntityRegistryUpdatedData] event)
 
bool homeassistant.helpers.event._async_domain_added_filter (HomeAssistant hass, dict[str, list[HassJob[[Event[EventStateChangedData]], Any]]] callbacks, EventStateChangedData event_data)
 
bool homeassistant.helpers.event._async_domain_removed_filter (HomeAssistant hass, dict[str, list[HassJob[[Event[EventStateChangedData]], Any]]] callbacks, EventStateChangedData event_data)
 
bool homeassistant.helpers.event._async_entity_registry_updated_filter (HomeAssistant hass, dict[str, list[HassJob[[Event[EventEntityRegistryUpdatedData]], Any]]] callbacks, EventEntityRegistryUpdatedData event_data)
 
bool homeassistant.helpers.event._async_state_filter (HomeAssistant hass, dict[str, list[HassJob[[Event[_StateEventDataT]], Any]]] callbacks, _StateEventDataT event_data)
 
list[str] homeassistant.helpers.event._async_string_to_lower_list (str|Iterable[str] instr)
 
CALLBACK_TYPE homeassistant.helpers.event._async_track_event (_KeyedEventTracker[_TypedDictT] tracker, HomeAssistant hass, str|Iterable[str] keys, Callable[[Event[_TypedDictT]], None] action, HassJobType|None job_type)
 
CALLBACK_TYPE homeassistant.helpers.event._async_track_state_added_domain (HomeAssistant hass, str|Iterable[str] domains, Callable[[Event[EventStateChangedData]], Any] action, HassJobType|None job_type)
 
CALLBACK_TYPE homeassistant.helpers.event._async_track_state_change_event (HomeAssistant hass, str|Iterable[str] entity_ids, Callable[[Event[EventStateChangedData]], Any] action, HassJobType|None job_type)
 
tuple[set[str], set[str]] homeassistant.helpers.event._entities_domains_from_render_infos (Iterable[RenderInfo] render_infos)
 
bool homeassistant.helpers.event._event_triggers_rerender (Event[EventStateChangedData] event, RenderInfo info)
 
Callable[Concatenate[HomeAssistant, _P], CALLBACK_TYPE] homeassistant.helpers.event._P (Callable[Concatenate[HomeAssistant, _P], Any] async_factory)
 
float|None homeassistant.helpers.event._rate_limit_for_event (Event[EventStateChangedData] event, RenderInfo info, TrackTemplate track_template_)
 
None homeassistant.helpers.event._remove_empty_listener ()
 
None homeassistant.helpers.event._remove_listener (HomeAssistant hass, _KeyedEventTracker[_TypedDictT] tracker, Iterable[str] keys, HassJob[[Event[_TypedDictT]], Any] job, dict[str, list[HassJob[[Event[_TypedDictT]], Any]]] callbacks)
 
bool homeassistant.helpers.event._render_infos_needs_all_listener (Iterable[RenderInfo] render_infos)
 
TrackStates homeassistant.helpers.event._render_infos_to_track_states (Iterable[RenderInfo] render_infos)
 
None homeassistant.helpers.event._run_async_call_action (HomeAssistant hass, HassJob[[datetime], Coroutine[Any, Any, None]|None] job)
 
RenderInfo homeassistant.helpers.event._suppress_domain_all_in_render_info (RenderInfo render_info)
 
CALLBACK_TYPE homeassistant.helpers.event.async_call_at (HomeAssistant hass, HassJob[[datetime], Coroutine[Any, Any, None]|None]|Callable[[datetime], Coroutine[Any, Any, None]|None] action, float loop_time)
 
CALLBACK_TYPE homeassistant.helpers.event.async_call_later (HomeAssistant hass, float|timedelta delay, HassJob[[datetime], Coroutine[Any, Any, None]|None]|Callable[[datetime], Coroutine[Any, Any, None]|None] action)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_device_registry_updated_event (HomeAssistant hass, str|Iterable[str] device_ids, Callable[[Event[EventDeviceRegistryUpdatedData]], Any] action, HassJobType|None job_type=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_entity_registry_updated_event (HomeAssistant hass, str|Iterable[str] entity_ids, Callable[[Event[EventEntityRegistryUpdatedData]], Any] action, HassJobType|None job_type=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_point_in_time (HomeAssistant hass, HassJob[[datetime], Coroutine[Any, Any, None]|None]|Callable[[datetime], Coroutine[Any, Any, None]|None] action, datetime point_in_time)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_point_in_utc_time (HomeAssistant hass, HassJob[[datetime], Coroutine[Any, Any, None]|None]|Callable[[datetime], Coroutine[Any, Any, None]|None] action, datetime point_in_time)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_same_state (HomeAssistant hass, timedelta period, Callable[[], Coroutine[Any, Any, None]|None] action, Callable[[str, State|None, State|None], bool] async_check_same_func, str|Iterable[str] entity_ids=MATCH_ALL)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_state_added_domain (HomeAssistant hass, str|Iterable[str] domains, Callable[[Event[EventStateChangedData]], Any] action, HassJobType|None job_type=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_state_change (HomeAssistant hass, str|Iterable[str] entity_ids, Callable[[str, State|None, State|None], Coroutine[Any, Any, None]|None] action, str|Iterable[str]|None from_state=None, str|Iterable[str]|None to_state=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_state_change_event (HomeAssistant hass, str|Iterable[str] entity_ids, Callable[[Event[EventStateChangedData]], Any] action, HassJobType|None job_type=None)
 
_TrackStateChangeFiltered homeassistant.helpers.event.async_track_state_change_filtered (HomeAssistant hass, TrackStates track_states, Callable[[Event[EventStateChangedData]], Any] action)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_state_removed_domain (HomeAssistant hass, str|Iterable[str] domains, Callable[[Event[EventStateChangedData]], Any] action, HassJobType|None job_type=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_state_report_event (HomeAssistant hass, str|Iterable[str] entity_ids, Callable[[Event[EventStateReportedData]], Any] action, HassJobType|None job_type=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_sunrise (HomeAssistant hass, Callable[[], None] action, timedelta|None offset=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_sunset (HomeAssistant hass, Callable[[], None] action, timedelta|None offset=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_template (HomeAssistant hass, Template template, Callable[[str, State|None, State|None], Coroutine[Any, Any, None]|None] action, TemplateVarsType|None variables=None)
 
TrackTemplateResultInfo homeassistant.helpers.event.async_track_template_result (HomeAssistant hass, Sequence[TrackTemplate] track_templates, TrackTemplateResultListener action, bool strict=False, Callable[[int, str], None]|None log_fn=None, bool has_super_template=False)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_time_change (HomeAssistant hass, Callable[[datetime], Coroutine[Any, Any, None]|None] action, Any|None hour=None, Any|None minute=None, Any|None second=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_time_interval (HomeAssistant hass, Callable[[datetime], Coroutine[Any, Any, None]|None] action, timedelta interval, *str|None name=None, bool|None cancel_on_shutdown=None)
 
CALLBACK_TYPE homeassistant.helpers.event.async_track_utc_time_change (HomeAssistant hass, Callable[[datetime], Coroutine[Any, Any, None]|None] action, Any|None hour=None, Any|None minute=None, Any|None second=None, bool local=False)
 
Callable[[str|None], bool] homeassistant.helpers.event.process_state_match (str|Iterable[str]|None parameter, bool invert=False)
 

Variables

 homeassistant.helpers.event._ALL_LISTENER
 
 homeassistant.helpers.event._DOMAINS_LISTENER
 
 homeassistant.helpers.event._ENTITIES_LISTENER
 
 homeassistant.helpers.event._KEYED_TRACK_DEVICE_REGISTRY_UPDATED
 
 homeassistant.helpers.event._KEYED_TRACK_ENTITY_REGISTRY_UPDATED
 
 homeassistant.helpers.event._KEYED_TRACK_STATE_ADDED_DOMAIN
 
 homeassistant.helpers.event._KEYED_TRACK_STATE_CHANGE
 
 homeassistant.helpers.event._KEYED_TRACK_STATE_REMOVED_DOMAIN
 
 homeassistant.helpers.event._KEYED_TRACK_STATE_REPORT
 
 homeassistant.helpers.event._LOGGER
 
 homeassistant.helpers.event._StateEventDataT
 
 homeassistant.helpers.event._TypedDictT
 
 homeassistant.helpers.event.bound
 
 homeassistant.helpers.event.call_later
 
None homeassistant.helpers.event.dispatcher_callable = _async_dispatch_entity_id_event_soon,
 
 homeassistant.helpers.event.event_type = EVENT_STATE_CHANGED,
 
bool homeassistant.helpers.event.filter_callable = _async_state_filter,
 
 homeassistant.helpers.event.key = _TRACK_STATE_CHANGE_DATA,
 
 homeassistant.helpers.event.RANDOM_MICROSECOND_MAX
 
 homeassistant.helpers.event.RANDOM_MICROSECOND_MIN
 
 homeassistant.helpers.event.time_tracker_timestamp
 
 homeassistant.helpers.event.time_tracker_utcnow
 
 homeassistant.helpers.event.track_point_in_time
 
 homeassistant.helpers.event.track_point_in_utc_time
 
 homeassistant.helpers.event.track_same_state
 
 homeassistant.helpers.event.track_state_change
 
 homeassistant.helpers.event.track_sunrise
 
 homeassistant.helpers.event.track_sunset
 
 homeassistant.helpers.event.track_template
 
 homeassistant.helpers.event.track_time_change
 
 homeassistant.helpers.event.track_time_interval
 
 homeassistant.helpers.event.track_utc_time_change
 
 homeassistant.helpers.event.TrackTemplateResultListener