Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.homematic.entity.HMHub Class Reference
Inheritance diagram for homeassistant.components.homematic.entity.HMHub:
[legend]
Collaboration diagram for homeassistant.components.homematic.entity.HMHub:
[legend]

Public Member Functions

def __init__ (self, hass, homematic, name)
 
def extra_state_attributes (self)
 
def hm_set_variable (self, name, value)
 
def icon (self)
 
def name (self)
 
def state (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Public Attributes

 entity_id
 
 hass
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _update_hub (self, now)
 
def _update_variables (self, now)
 

Private Attributes

 _homematic
 
 _name
 
 _state
 
 _variables
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

The HomeMatic hub. (CCU2/HomeGear).

Definition at line 210 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.homematic.entity.HMHub.__init__ (   self,
  hass,
  homematic,
  name 
)
Initialize HomeMatic hub.

Definition at line 215 of file entity.py.

Member Function Documentation

◆ _update_hub()

def homeassistant.components.homematic.entity.HMHub._update_hub (   self,
  now 
)
private
Retrieve latest state.

Definition at line 251 of file entity.py.

◆ _update_variables()

def homeassistant.components.homematic.entity.HMHub._update_variables (   self,
  now 
)
private
Retrieve all variable data and update hmvariable states.

Definition at line 261 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.homematic.entity.HMHub.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file entity.py.

◆ hm_set_variable()

def homeassistant.components.homematic.entity.HMHub.hm_set_variable (   self,
  name,
  value 
)
Set variable value on CCU/Homegear.

Definition at line 278 of file entity.py.

◆ icon()

def homeassistant.components.homematic.entity.HMHub.icon (   self)
Return the icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 247 of file entity.py.

◆ name()

def homeassistant.components.homematic.entity.HMHub.name (   self)
Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 232 of file entity.py.

◆ state()

def homeassistant.components.homematic.entity.HMHub.state (   self)
Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 237 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.homematic.entity.HMHub._attr_should_poll = False
staticprivate
The HomeMatic hub. (CCU2/HomeGear).

Definition at line 213 of file entity.py.

◆ _homematic

homeassistant.components.homematic.entity.HMHub._homematic
private

Definition at line 219 of file entity.py.

◆ _name

homeassistant.components.homematic.entity.HMHub._name
private

Definition at line 221 of file entity.py.

◆ _state

homeassistant.components.homematic.entity.HMHub._state
private

Definition at line 222 of file entity.py.

◆ _variables

homeassistant.components.homematic.entity.HMHub._variables
private

Definition at line 220 of file entity.py.

◆ entity_id

homeassistant.components.homematic.entity.HMHub.entity_id

Definition at line 218 of file entity.py.

◆ hass

homeassistant.components.homematic.entity.HMHub.hass

Definition at line 217 of file entity.py.


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