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

Public Member Functions

None __init__ (self, GatewayId gateway_id, BaseAsyncGateway gateway, int node_id, int child_id, int value_type)
 
None async_added_to_hass (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
DevId dev_id (self)
 
dict[str, Any] extra_state_attributes (self)
 
str name (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.mysensors.entity.MySensorNodeEntity
None __init__ (self, GatewayId gateway_id, BaseAsyncGateway gateway, int node_id)
 
None async_update_callback (self)
 
DeviceInfo device_info (self)
 
str node_name (self)
 
str sketch_name (self)
 
str sketch_version (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_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (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)
 
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 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

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

Private Member Functions

None _async_update (self)
 
None _async_update_callback (self)
 
ChildSensor _child (self)
 

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 MySensors entity.

Definition at line 149 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mysensors.entity.MySensorsChildEntity.__init__ (   self,
GatewayId  gateway_id,
BaseAsyncGateway  gateway,
int  node_id,
int  child_id,
int  value_type 
)
Set up the MySensors child entity.

Definition at line 154 of file entity.py.

Member Function Documentation

◆ _async_update()

None homeassistant.components.mysensors.entity.MySensorsChildEntity._async_update (   self)
private

◆ _async_update_callback()

None homeassistant.components.mysensors.entity.MySensorsChildEntity._async_update_callback (   self)
private
Update the entity.

Reimplemented from homeassistant.components.mysensors.entity.MySensorNodeEntity.

Definition at line 257 of file entity.py.

◆ _child()

ChildSensor homeassistant.components.mysensors.entity.MySensorsChildEntity._child (   self)
private

Definition at line 179 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.mysensors.entity.MySensorsChildEntity.async_added_to_hass (   self)
Register update callback.

Reimplemented from homeassistant.components.mysensors.entity.MySensorNodeEntity.

Definition at line 262 of file entity.py.

◆ async_will_remove_from_hass()

None homeassistant.components.mysensors.entity.MySensorsChildEntity.async_will_remove_from_hass (   self)
Remove this entity from home assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 196 of file entity.py.

◆ available()

bool homeassistant.components.mysensors.entity.MySensorsChildEntity.available (   self)
Return true if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 207 of file entity.py.

◆ dev_id()

DevId homeassistant.components.mysensors.entity.MySensorsChildEntity.dev_id (   self)
Return the DevId of this device.

It is used to route incoming MySensors messages to the correct device/entity.

Definition at line 171 of file entity.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.mysensors.entity.MySensorsChildEntity.extra_state_attributes (   self)
Return entity and device specific state attributes.

Reimplemented from homeassistant.components.mysensors.entity.MySensorNodeEntity.

Definition at line 212 of file entity.py.

◆ name()

str homeassistant.components.mysensors.entity.MySensorsChildEntity.name (   self)
Return the name of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 188 of file entity.py.

◆ unique_id()

str homeassistant.components.mysensors.entity.MySensorsChildEntity.unique_id (   self)
Return a unique ID for use in home assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 183 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.mysensors.entity.MySensorsChildEntity._attr_should_poll = False
staticprivate

Definition at line 152 of file entity.py.

◆ child_type

homeassistant.components.mysensors.entity.MySensorsChildEntity.child_type

Definition at line 167 of file entity.py.


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