Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.shelly.entity Namespace Reference

Classes

class  BlockEntityDescription
 
class  RestEntityDescription
 
class  RpcEntityDescription
 
class  ShellyBlockAttributeEntity
 
class  ShellyBlockEntity
 
class  ShellyRestAttributeEntity
 
class  ShellyRpcAttributeEntity
 
class  ShellyRpcEntity
 
class  ShellySleepingBlockAttributeEntity
 
class  ShellySleepingRpcAttributeEntity
 

Functions

None async_restore_block_attribute_entities (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, ShellyBlockCoordinator coordinator, Mapping[tuple[str, str], BlockEntityDescription] sensors, Callable sensor_class)
 
None async_restore_rpc_attribute_entities (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, ShellyRpcCoordinator coordinator, Mapping[str, RpcEntityDescription] sensors, Callable sensor_class)
 
None async_setup_block_attribute_entities (HomeAssistant hass, AddEntitiesCallback async_add_entities, ShellyBlockCoordinator coordinator, Mapping[tuple[str, str], BlockEntityDescription] sensors, Callable sensor_class)
 
None async_setup_entry_attribute_entities (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, Mapping[tuple[str, str], BlockEntityDescription] sensors, Callable sensor_class)
 
None async_setup_entry_rest (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, Mapping[str, RestEntityDescription] sensors, Callable sensor_class)
 
None async_setup_entry_rpc (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, Mapping[str, RpcEntityDescription] sensors, Callable sensor_class)
 
None async_setup_rpc_attribute_entities (HomeAssistant hass, ShellyConfigEntry config_entry, AddEntitiesCallback async_add_entities, Mapping[str, RpcEntityDescription] sensors, Callable sensor_class)
 

Detailed Description

Shelly entity helper.

Function Documentation

◆ async_restore_block_attribute_entities()

None homeassistant.components.shelly.entity.async_restore_block_attribute_entities ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
ShellyBlockCoordinator  coordinator,
Mapping[tuple[str, str], BlockEntityDescription sensors,
Callable  sensor_class 
)
Restore block attributes entities.

Definition at line 101 of file entity.py.

◆ async_restore_rpc_attribute_entities()

None homeassistant.components.shelly.entity.async_restore_rpc_attribute_entities ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
ShellyRpcCoordinator  coordinator,
Mapping[str, RpcEntityDescription sensors,
Callable  sensor_class 
)
Restore block attributes entities.

Definition at line 210 of file entity.py.

◆ async_setup_block_attribute_entities()

None homeassistant.components.shelly.entity.async_setup_block_attribute_entities ( HomeAssistant  hass,
AddEntitiesCallback  async_add_entities,
ShellyBlockCoordinator  coordinator,
Mapping[tuple[str, str], BlockEntityDescription sensors,
Callable  sensor_class 
)
Set up entities for block attributes.

Definition at line 59 of file entity.py.

◆ async_setup_entry_attribute_entities()

None homeassistant.components.shelly.entity.async_setup_entry_attribute_entities ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
Mapping[tuple[str, str], BlockEntityDescription sensors,
Callable  sensor_class 
)
Set up entities for attributes.

Definition at line 33 of file entity.py.

◆ async_setup_entry_rest()

None homeassistant.components.shelly.entity.async_setup_entry_rest ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
Mapping[str, RestEntityDescription sensors,
Callable  sensor_class 
)
Set up entities for REST sensors.

Definition at line 245 of file entity.py.

◆ async_setup_entry_rpc()

None homeassistant.components.shelly.entity.async_setup_entry_rpc ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
Mapping[str, RpcEntityDescription sensors,
Callable  sensor_class 
)
Set up entities for RPC sensors.

Definition at line 136 of file entity.py.

◆ async_setup_rpc_attribute_entities()

None homeassistant.components.shelly.entity.async_setup_rpc_attribute_entities ( HomeAssistant  hass,
ShellyConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities,
Mapping[str, RpcEntityDescription sensors,
Callable  sensor_class 
)
Set up entities for RPC attributes.

Definition at line 158 of file entity.py.