Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.shelly.valve.BlockShellyValve Class Reference
Inheritance diagram for homeassistant.components.shelly.valve.BlockShellyValve:
[legend]
Collaboration diagram for homeassistant.components.shelly.valve.BlockShellyValve:
[legend]

Public Member Functions

None __init__ (self, ShellyBlockCoordinator coordinator, Block block, str attribute, BlockValveDescription description)
 
None async_close_valve (self, **Any kwargs)
 
None async_open_valve (self, **Any kwargs)
 
bool is_closing (self)
 
bool is_opening (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyBlockAttributeEntity
None __init__ (self, ShellyBlockCoordinator coordinator, Block block, str attribute, BlockEntityDescription description)
 
StateType attribute_value (self)
 
bool available (self)
 
dict[str, Any]|None extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyBlockEntity
None __init__ (self, ShellyBlockCoordinator coordinator, Block block)
 
None async_added_to_hass (self)
 
Any set_state (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
None __init__ (self, HomeAssistant hass, ShellyConfigEntry entry, BlockDevice device)
 
None async_setup (self, list[Platform]|None pending_platforms=None)
 
CALLBACK_TYPE async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
 
- 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)
 
dict[str, Any]|None capability_attributes (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)
 
str|None suggested_object_id (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 Member Functions inherited from homeassistant.components.valve.ValveEntity
None async_close_valve (self)
 
None async_handle_close_valve (self)
 
None async_handle_open_valve (self)
 
None async_open_valve (self)
 
None async_set_valve_position (self, int position)
 
None async_stop_valve (self)
 
None async_toggle (self)
 
None close_valve (self)
 
int|None current_valve_position (self)
 
ValveDeviceClass|None device_class (self)
 
bool|None is_closed (self)
 
None open_valve (self)
 
bool reports_position (self)
 
None set_valve_position (self, int position)
 
str|None state (self)
 
dict[str, Any]|None state_attributes (self)
 
None stop_valve (self)
 
ValveEntityFeature supported_features (self)
 

Public Attributes

 attribute_value
 
 control_result
 
- Public Attributes inherited from homeassistant.components.shelly.entity.ShellyBlockAttributeEntity
 attribute
 
 entity_description
 
- Public Attributes inherited from homeassistant.components.shelly.entity.ShellyBlockEntity
 block
 
- Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
 entry
 
 model
 
- 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_is_closed
 

Static Private Attributes

 _attr_device_class = ValveDeviceClass.GAS
 
 _attr_supported_features = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE
 

Additional Inherited Members

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

Detailed Description

Entity that controls a valve on block based Shelly devices.

Definition at line 75 of file valve.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.shelly.valve.BlockShellyValve.__init__ (   self,
ShellyBlockCoordinator  coordinator,
Block  block,
str  attribute,
BlockValveDescription  description 
)
Initialize block valve.

Definition at line 82 of file valve.py.

Member Function Documentation

◆ _update_callback()

None homeassistant.components.shelly.valve.BlockShellyValve._update_callback (   self)
private
When device updates, clear control result that overrides state.

Reimplemented from homeassistant.components.shelly.entity.ShellyBlockEntity.

Definition at line 121 of file valve.py.

◆ async_close_valve()

None homeassistant.components.shelly.valve.BlockShellyValve.async_close_valve (   self,
**Any  kwargs 
)
Close valve.

Definition at line 115 of file valve.py.

◆ async_open_valve()

None homeassistant.components.shelly.valve.BlockShellyValve.async_open_valve (   self,
**Any  kwargs 
)
Open valve.

Definition at line 110 of file valve.py.

◆ is_closing()

bool homeassistant.components.shelly.valve.BlockShellyValve.is_closing (   self)
Return if the valve is closing.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 95 of file valve.py.

◆ is_opening()

bool homeassistant.components.shelly.valve.BlockShellyValve.is_opening (   self)
Return if the valve is opening.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 103 of file valve.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.shelly.valve.BlockShellyValve._attr_device_class = ValveDeviceClass.GAS
staticprivate

Definition at line 79 of file valve.py.

◆ _attr_is_closed

homeassistant.components.shelly.valve.BlockShellyValve._attr_is_closed
private

Definition at line 92 of file valve.py.

◆ _attr_supported_features

homeassistant.components.shelly.valve.BlockShellyValve._attr_supported_features = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE
staticprivate

Definition at line 80 of file valve.py.

◆ attribute_value

homeassistant.components.shelly.valve.BlockShellyValve.attribute_value

Definition at line 92 of file valve.py.

◆ control_result

homeassistant.components.shelly.valve.BlockShellyValve.control_result

Definition at line 112 of file valve.py.


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