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

Public Member Functions

None __init__ (self, DeviceModel fibaro_device)
 
None action (self, str cmd, *Any args)
 
None async_added_to_hass (self)
 
None call_set_color (self, int red, int green, int blue, int white)
 
None call_turn_off (self)
 
None call_turn_on (self)
 
bool current_binary_state (self)
 
None dont_know_message (self, str cmd)
 
Mapping[str, Any] extra_state_attributes (self)
 
int|None level (self)
 
int|None level2 (self)
 
None set_level (self, int level)
 
None set_level2 (self, int level)
 
None update (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_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)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (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

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

Private Member Functions

None _update_callback (self)
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_entity_registry_visible_default
 
 _attr_name
 
 _attr_unique_id
 

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

Representation of a Fibaro device entity.

Definition at line 17 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _update_callback()

None homeassistant.components.fibaro.entity.FibaroEntity._update_callback (   self)
private
Update the state.

Definition at line 39 of file entity.py.

◆ action()

None homeassistant.components.fibaro.entity.FibaroEntity.action (   self,
str  cmd,
*Any  args 
)
Perform an action on the Fibaro HC.

Definition at line 98 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.fibaro.entity.FibaroEntity.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.fibaro.event.FibaroEventEntity, and homeassistant.components.fibaro.climate.FibaroThermostat.

Definition at line 35 of file entity.py.

◆ call_set_color()

None homeassistant.components.fibaro.entity.FibaroEntity.call_set_color (   self,
int  red,
int  green,
int  blue,
int  white 
)
Set the color of Fibaro device.

Definition at line 88 of file entity.py.

◆ call_turn_off()

None homeassistant.components.fibaro.entity.FibaroEntity.call_turn_off (   self)
Turn off the Fibaro device.

Definition at line 84 of file entity.py.

◆ call_turn_on()

None homeassistant.components.fibaro.entity.FibaroEntity.call_turn_on (   self)
Turn on the Fibaro device.

Definition at line 80 of file entity.py.

◆ current_binary_state()

bool homeassistant.components.fibaro.entity.FibaroEntity.current_binary_state (   self)
Return the current binary state.

Definition at line 107 of file entity.py.

◆ dont_know_message()

None homeassistant.components.fibaro.entity.FibaroEntity.dont_know_message (   self,
str  cmd 
)
Make a warning in case we don't know how to perform an action.

Definition at line 57 of file entity.py.

◆ extra_state_attributes()

Mapping[str, Any] homeassistant.components.fibaro.entity.FibaroEntity.extra_state_attributes (   self)
Return the state attributes of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.fibaro.binary_sensor.FibaroBinarySensor.

Definition at line 112 of file entity.py.

◆ level()

int | None homeassistant.components.fibaro.entity.FibaroEntity.level (   self)
Get the level of Fibaro device.

Definition at line 44 of file entity.py.

◆ level2()

int | None homeassistant.components.fibaro.entity.FibaroEntity.level2 (   self)
Get the tilt level of Fibaro device.

Definition at line 51 of file entity.py.

◆ set_level()

None homeassistant.components.fibaro.entity.FibaroEntity.set_level (   self,
int  level 
)
Set the level of Fibaro device.

Definition at line 66 of file entity.py.

◆ set_level2()

None homeassistant.components.fibaro.entity.FibaroEntity.set_level2 (   self,
int  level 
)
Set the level2 of Fibaro device.

Definition at line 74 of file entity.py.

◆ update()

Member Data Documentation

◆ _attr_available

homeassistant.components.fibaro.entity.FibaroEntity._attr_available
private

Definition at line 126 of file entity.py.

◆ _attr_device_info

homeassistant.components.fibaro.entity.FibaroEntity._attr_device_info
private

Definition at line 30 of file entity.py.

◆ _attr_entity_registry_visible_default

homeassistant.components.fibaro.entity.FibaroEntity._attr_entity_registry_visible_default
private

Definition at line 33 of file entity.py.

◆ _attr_name

homeassistant.components.fibaro.entity.FibaroEntity._attr_name
private

Definition at line 27 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.fibaro.entity.FibaroEntity._attr_should_poll = False
staticprivate

Definition at line 20 of file entity.py.

◆ _attr_unique_id

homeassistant.components.fibaro.entity.FibaroEntity._attr_unique_id
private

Definition at line 28 of file entity.py.

◆ controller

homeassistant.components.fibaro.entity.FibaroEntity.controller

Definition at line 25 of file entity.py.

◆ fibaro_device

homeassistant.components.fibaro.entity.FibaroEntity.fibaro_device

Definition at line 24 of file entity.py.

◆ ha_id

homeassistant.components.fibaro.entity.FibaroEntity.ha_id

Definition at line 26 of file entity.py.


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