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

Public Member Functions

def __init__ (self, name, device, entry, unique_id)
 
def async_set_power_price (self, int price)
 
def async_set_wifi_led_off (self)
 
def async_set_wifi_led_on (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_update (self)
 
def available (self)
 
def extra_state_attributes (self)
 
def icon (self)
 
def is_on (self)
 
- Public Member Functions inherited from homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity
DeviceInfo device_info (self)
 
def name (self)
 
def unique_id (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)
 
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)
 
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 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)
 

Private Member Functions

def _try_command (self, mask_error, func, *args, **kwargs)
 

Private Attributes

 _available
 
 _device_features
 
 _icon
 
 _skip_update
 
 _state
 
 _state_attrs
 

Additional Inherited Members

- 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

Representation of a Xiaomi Plug Generic.

Definition at line 772 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.__init__ (   self,
  name,
  device,
  entry,
  unique_id 
)

Member Function Documentation

◆ _try_command()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._try_command (   self,
  mask_error,
  func,
args,
**  kwargs 
)
private
Call a plug command handling error messages.

Definition at line 806 of file switch.py.

◆ async_set_power_price()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_set_power_price (   self,
int  price 
)
Set the power price.

Definition at line 883 of file switch.py.

◆ async_set_wifi_led_off()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_set_wifi_led_off (   self)
Turn the wifi led on.

Definition at line 874 of file switch.py.

◆ async_set_wifi_led_on()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_set_wifi_led_on (   self)
Turn the wifi led on.

Definition at line 865 of file switch.py.

◆ async_turn_off()

None homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_turn_off (   self,
**Any  kwargs 
)

◆ async_turn_on()

None homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_turn_on (   self,
**Any  kwargs 
)

◆ async_update()

None homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.async_update (   self)

◆ available()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.available (   self)
Return true when state is known.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 792 of file switch.py.

◆ extra_state_attributes()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.extra_state_attributes (   self)
Return the state attributes of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 797 of file switch.py.

◆ icon()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.icon (   self)
Return the icon to use for device if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 787 of file switch.py.

◆ is_on()

def homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch.is_on (   self)
Return true if switch is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 802 of file switch.py.

Member Data Documentation

◆ _available

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._available
private

Definition at line 780 of file switch.py.

◆ _device_features

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._device_features
private

Definition at line 783 of file switch.py.

◆ _icon

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._icon
private

Definition at line 779 of file switch.py.

◆ _skip_update

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._skip_update
private

Definition at line 784 of file switch.py.

◆ _state

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._state
private

Definition at line 781 of file switch.py.

◆ _state_attrs

homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch._state_attrs
private

Definition at line 782 of file switch.py.


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