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

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyRpcAttributeEntity
None __init__ (self, ShellyRpcCoordinator coordinator, str key, str attribute, RpcEntityDescription description)
 
StateType attribute_value (self)
 
bool available (self)
 
Any sub_status (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyRpcEntity
None __init__ (self, ShellyRpcCoordinator coordinator, str key)
 
None async_added_to_hass (self)
 
Any call_rpc (self, str method, Any params)
 
dict status (self)
 
- 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.ShellyRpcCoordinator
None __init__ (self, HomeAssistant hass, ShellyConfigEntry entry, RpcDevice device)
 
None async_device_online (self, str source)
 
None async_setup (self, list[Platform]|None pending_platforms=None)
 
CALLBACK_TYPE async_subscribe_events (self, Callable[[dict[str, Any]], None] event_callback)
 
CALLBACK_TYPE async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
 
CALLBACK_TYPE async_subscribe_ota_events (self, Callable[[dict[str, Any]], None] ota_event_callback)
 
None shutdown (self)
 
bool update_sleep_period (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)
 
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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 
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 Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.shelly.entity.ShellyRpcAttributeEntity
 attribute
 
 entity_description
 
 option_map
 
 reversed_option_map
 
- Public Attributes inherited from homeassistant.components.shelly.entity.ShellyRpcEntity
 key
 
- Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyRpcCoordinator
 connected
 
 entry
 
 last_update_success
 
 update_interval
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Entity that controls a virtual boolean component on RPC based Shelly devices.

Definition at line 328 of file switch.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.shelly.switch.RpcVirtualSwitch.async_turn_off (   self,
**Any  kwargs 
)
Turn off relay.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 343 of file switch.py.

◆ async_turn_on()

None homeassistant.components.shelly.switch.RpcVirtualSwitch.async_turn_on (   self,
**Any  kwargs 
)
Turn on relay.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 339 of file switch.py.

◆ is_on()

bool homeassistant.components.shelly.switch.RpcVirtualSwitch.is_on (   self)
If switch is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 335 of file switch.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.shelly.switch.RpcVirtualSwitch._attr_has_entity_name = True
staticprivate

Definition at line 332 of file switch.py.


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