Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.significant_change.SignificantlyChangedChecker Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ExtraCheckTypeFunc|None extra_significant_check=None)
 
bool async_is_significant_change (self, State new_state, *Any|None extra_arg=None)
 

Public Attributes

 extra_significant_check
 
 hass
 

Detailed Description

Class to keep track of entities to see if they have significantly changed.

Will always compare the entity to the last entity that was considered significant.

Definition at line 178 of file significant_change.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.significant_change.SignificantlyChangedChecker.__init__ (   self,
HomeAssistant  hass,
ExtraCheckTypeFunc | None   extra_significant_check = None 
)
Class to keep track of entities to see if they have significantly changed.

Will always compare the entity to the last entity that was considered significant.
Test if an entity has significantly changed.

Definition at line 184 of file significant_change.py.

Member Function Documentation

◆ async_is_significant_change()

bool homeassistant.helpers.significant_change.SignificantlyChangedChecker.async_is_significant_change (   self,
State  new_state,
*Any | None   extra_arg = None 
)
Return if this was a significant change.

Extra kwargs are passed to the extra significant checker.

Definition at line 195 of file significant_change.py.

Member Data Documentation

◆ extra_significant_check

homeassistant.helpers.significant_change.SignificantlyChangedChecker.extra_significant_check

Definition at line 192 of file significant_change.py.

◆ hass

homeassistant.helpers.significant_change.SignificantlyChangedChecker.hass

Definition at line 190 of file significant_change.py.


The documentation for this class was generated from the following file: