Module Expr Str Import alias ImportFrom alias ImportFrom alias alias alias alias alias alias alias alias alias alias alias alias alias ImportFrom alias ImportFrom alias alias Assign NameStore Call NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call AttributeLoad BoolOpOr NameLoad NameLoad attr If CompareIs NameLoad NameLoad body If CompareIs NameLoad NameLoad body Raise Call NameLoad Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Return Call NameLoad Call AttributeLoad NameLoad attr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad NameLoad attr Str Num decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareIsNot Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad Str attr AttributeLoad NameLoad attr Call NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Pass decorator_list Assign NameStore NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str If CompareIs AttributeLoad NameLoad attr NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad If CompareIs AttributeLoad NameLoad attr NameLoad body Raise Call NameLoad Call AttributeLoad Str attr AttributeLoad NameLoad attr If NameLoad body Expr Call AttributeLoad NameLoad attr Assign NameStore IfExp CompareIs AttributeLoad NameLoad attr NameLoad NameLoad Call NameLoad AttributeLoad NameLoad attr Assign NameStore BoolOpOr AttributeLoad NameLoad attr Dict Assign NameStore AttributeLoad NameLoad attr If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad If UnaryOpNot AttributeLoad NameLoad attr body Assign NameStore NameLoad Assign NameStore Dict Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Dict If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad If CompareIn Call AttributeLoad NameLoad attr NameLoad TupleLoad NameLoad NameLoad body Assign TupleStore NameStore SubscriptStore NameLoad Index NameLoad Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad SubscriptLoad NameLoad Index NameLoad Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults body Expr Str If CompareIn NameLoad NameLoad body Return Assign NameStore Call NameLoad NameLoad NameLoad If UnaryOpNot NameLoad body Return TryExcept body Assign SubscriptStore NameLoad Index NameLoad Call NameLoad NameLoad handlers ExceptHandler type TupleLoad NameLoad NameLoad body Pass decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return BoolOpAnd Call NameLoad NameLoad NameLoad CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str For TupleStore NameStore NameStore Call NameLoad NameLoad NameLoad body If CompareIs NameLoad NameLoad body Expr Call AttributeLoad SubscriptLoad NameLoad Index Call AttributeLoad NameLoad attr attr NameLoad NameLoad orelse Assign SubscriptStore SubscriptLoad NameLoad Index Call AttributeLoad NameLoad attr Index NameLoad NameLoad decorator_list NameLoad decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Expr Str Return IfExp AttributeLoad NameLoad attr NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults kwarg body Expr Str Pass decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str Pass decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad orelse Expr Call AttributeLoad NameLoad attr NameLoad decorator_list decorator_list
N/A N/A An abstract class for entities. N/A re collections defaultdict homeassistant.const ATTR_ASSUMED_STATE ATTR_FRIENDLY_NAME ATTR_HIDDEN ATTR_ICON ATTR_UNIT_OF_MEASUREMENT DEVICE_DEFAULT_NAME STATE_OFF STATE_ON STATE_UNAVAILABLE STATE_UNKNOWN TEMP_CELSIUS TEMP_FAHRENHEIT ATTR_ENTITY_PICTURE homeassistant.exceptions NoEntitySpecifiedError homeassistant.util ensure_unique_string slugify N/A _OVERWRITE N/A defaultdict dict N/A ENTITY_ID_PATTERN N/A N/A re compile ^(\w+)\.(\w+)$ generate_entity_id N/A N/A entity_id_format name current_ids hass N/A None None N/A N/A Generate a unique entity ID based on given entity IDs or used IDs. N/A name N/A N/A N/A name DEVICE_DEFAULT_NAME lower N/A N/A current_ids None N/A N/A N/A hass None N/A N/A N/A RuntimeError Missing required parameter currentids or hass N/A current_ids N/A N/A N/A hass states entity_ids N/A N/A ensure_unique_string N/A N/A entity_id_format format N/A slugify name current_ids N/A split_entity_id N/A N/A entity_id N/A N/A N/A Split a state entity_id into domain, object_id. N/A N/A N/A entity_id split . 1 N/A valid_entity_id N/A N/A entity_id N/A N/A N/A Test if an entity ID is a valid format. N/A N/A N/A N/A ENTITY_ID_PATTERN match entity_id None N/A Entity N/A object N/A N/A An abstract class for Home Assistant entities. should_poll N/A N/A self N/A N/A N/A Return True if entity has to be polled for state.

        False if entity pushes its state to HA.
         N/A True N/A property unique_id N/A N/A self N/A N/A N/A Return an unique ID. N/A N/A N/A {}.{} format N/A self __class__ N/A id self N/A property name N/A N/A self N/A N/A N/A Return the name of the entity. N/A None N/A property state N/A N/A self N/A N/A N/A Return the state of the entity. N/A STATE_UNKNOWN N/A property state_attributes N/A N/A self N/A N/A N/A Return the state attributes.

        Implemented by component base class.
         N/A None N/A property device_state_attributes N/A N/A self N/A N/A N/A Return device specific state attributes.

        Implemented by platform classes.
         N/A None N/A property unit_of_measurement N/A N/A self N/A N/A N/A Return the unit of measurement of this entity, if any. N/A None N/A property icon N/A N/A self N/A N/A N/A Return the icon to use in the frontend, if any. N/A None N/A property entity_picture N/A N/A self N/A N/A N/A Return the entity picture to use in the frontend, if any. N/A None N/A property hidden N/A N/A self N/A N/A N/A Return True if the entity should be hidden from UIs. N/A False N/A property available N/A N/A self N/A N/A N/A Return True if entity is available. N/A True N/A property assumed_state N/A N/A self N/A N/A N/A Return True if unable to access real state of the entity. N/A False N/A property update N/A N/A self N/A N/A N/A Retrieve latest state. N/A N/A N/A entity_id None N/A hass None update_ha_state N/A N/A self force_refresh N/A False N/A N/A Update Home Assistant with current state of entity.

        If force_refresh == True will update entity before setting state.
         N/A N/A N/A self hass None N/A N/A N/A RuntimeError N/A N/A Attribute hass is None for {} format self N/A N/A N/A self entity_id None N/A N/A N/A NoEntitySpecifiedError N/A N/A No entity id specified for entity {} format N/A self name N/A force_refresh N/A N/A N/A N/A self update N/A state N/A N/A N/A self state None STATE_UNKNOWN N/A str N/A self state N/A attr N/A N/A self state_attributes N/A N/A device_attr N/A self device_state_attributes N/A N/A device_attr None N/A N/A N/A N/A attr update device_attr N/A N/A N/A self _attr_setter unit_of_measurement str ATTR_UNIT_OF_MEASUREMENT attr N/A N/A N/A self available N/A N/A state STATE_UNAVAILABLE N/A attr N/A N/A N/A N/A self _attr_setter name str ATTR_FRIENDLY_NAME attr N/A N/A N/A self _attr_setter icon str ATTR_ICON attr N/A N/A N/A self _attr_setter entity_picture str ATTR_ENTITY_PICTURE attr N/A N/A N/A self _attr_setter hidden bool ATTR_HIDDEN attr N/A N/A N/A self _attr_setter assumed_state bool ATTR_ASSUMED_STATE attr N/A N/A N/A attr update N/A N/A _OVERWRITE get N/A self entity_id N/A N/A N/A N/A N/A attr get ATTR_HIDDEN True N/A N/A N/A N/A attr pop ATTR_HIDDEN N/A N/A N/A N/A attr get ATTR_UNIT_OF_MEASUREMENT N/A TEMP_CELSIUS TEMP_FAHRENHEIT N/A N/A N/A state N/A attr N/A ATTR_UNIT_OF_MEASUREMENT N/A N/A N/A N/A self hass config temperature state N/A attr N/A ATTR_UNIT_OF_MEASUREMENT N/A state N/A str state N/A N/A N/A N/A N/A self hass states set N/A self entity_id state attr N/A _attr_setter N/A N/A self name typ attr attrs N/A N/A N/A Helper method to populate attributes based on properties. N/A N/A attr attrs N/A N/A N/A value N/A getattr self name N/A N/A value N/A N/A N/A N/A N/A N/A attrs N/A attr N/A typ value N/A N/A N/A N/A TypeError ValueError N/A N/A N/A __eq__ N/A N/A self other N/A N/A N/A Return the comparison. N/A N/A N/A isinstance other Entity N/A N/A other unique_id N/A self unique_id N/A __repr__ N/A N/A self N/A N/A N/A Return the representation. N/A N/A N/A <Entity {}: {}> format N/A self name N/A self state N/A overwrite_attribute N/A N/A entity_id attrs vals N/A N/A N/A Overwrite any attribute of an entity.

        This function should receive a list of attributes and a
        list of values. Set attribute to None to remove any overwritten
        value in place.
         N/A N/A attr val N/A zip attrs vals N/A N/A N/A val None N/A N/A N/A N/A N/A _OVERWRITE N/A N/A N/A entity_id lower pop attr None N/A N/A N/A N/A _OVERWRITE N/A N/A N/A entity_id lower N/A attr val N/A staticmethod N/A ToggleEntity N/A Entity N/A N/A An abstract class for entities that can be turned on and off. state N/A N/A self N/A N/A N/A Return the state. N/A N/A N/A self is_on STATE_ON STATE_OFF N/A property is_on N/A N/A self N/A N/A N/A Return True if entity is on. N/A False N/A property turn_on N/A N/A self N/A kwargs N/A N/A Turn the entity on. N/A N/A turn_off N/A N/A self N/A kwargs N/A N/A Turn the entity off. N/A N/A toggle N/A N/A self N/A kwargs N/A N/A Toggle the entity off. N/A N/A self is_on N/A N/A N/A N/A self turn_off kwargs N/A N/A N/A N/A self turn_on kwargs N/A N/A