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

Public Member Functions

def __init__ (self, smappee_base, service_location, name, actuator_id, actuator_type, actuator_serialnumber, actuator_state_option=None)
 
None async_update (self)
 
bool available (self)
 
def is_on (self)
 
def name (self)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
def unique_id (self)
 
- 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)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
- 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)
 
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)
 

Private Attributes

 _actuator_id
 
 _actuator_name
 
 _actuator_serialnumber
 
 _actuator_state_option
 
 _actuator_type
 
 _attr_device_info
 
 _connection_state
 
 _service_location
 
 _smappee_base
 
 _state
 

Static Private Attributes

string _attr_icon = "mdi:toggle-switch"
 

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.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Smappee Comport Plug.

Definition at line 55 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.smappee.switch.SmappeeActuator.__init__ (   self,
  smappee_base,
  service_location,
  name,
  actuator_id,
  actuator_type,
  actuator_serialnumber,
  actuator_state_option = None 
)
Initialize a new Smappee Comfort Plug.

Definition at line 60 of file switch.py.

Member Function Documentation

◆ async_update()

None homeassistant.components.smappee.switch.SmappeeActuator.async_update (   self)
Get the latest data from Smappee and update the state.

Definition at line 164 of file switch.py.

◆ available()

bool homeassistant.components.smappee.switch.SmappeeActuator.available (   self)
Return True if entity is available. Unavailable for COMFORT_PLUGS.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 138 of file switch.py.

◆ is_on()

def homeassistant.components.smappee.switch.SmappeeActuator.is_on (   self)
Return true if switch is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 106 of file switch.py.

◆ name()

def homeassistant.components.smappee.switch.SmappeeActuator.name (   self)
Return the name of the switch.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 91 of file switch.py.

◆ turn_off()

None homeassistant.components.smappee.switch.SmappeeActuator.turn_off (   self,
**Any  kwargs 
)
Turn off Comport Plug.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 126 of file switch.py.

◆ turn_on()

None homeassistant.components.smappee.switch.SmappeeActuator.turn_on (   self,
**Any  kwargs 
)
Turn on Comport Plug.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 117 of file switch.py.

◆ unique_id()

def homeassistant.components.smappee.switch.SmappeeActuator.unique_id (   self)
Return the unique ID for this switch.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 146 of file switch.py.

Member Data Documentation

◆ _actuator_id

homeassistant.components.smappee.switch.SmappeeActuator._actuator_id
private

Definition at line 74 of file switch.py.

◆ _actuator_name

homeassistant.components.smappee.switch.SmappeeActuator._actuator_name
private

Definition at line 73 of file switch.py.

◆ _actuator_serialnumber

homeassistant.components.smappee.switch.SmappeeActuator._actuator_serialnumber
private

Definition at line 76 of file switch.py.

◆ _actuator_state_option

homeassistant.components.smappee.switch.SmappeeActuator._actuator_state_option
private

Definition at line 77 of file switch.py.

◆ _actuator_type

homeassistant.components.smappee.switch.SmappeeActuator._actuator_type
private

Definition at line 75 of file switch.py.

◆ _attr_device_info

homeassistant.components.smappee.switch.SmappeeActuator._attr_device_info
private

Definition at line 82 of file switch.py.

◆ _attr_icon

string homeassistant.components.smappee.switch.SmappeeActuator._attr_icon = "mdi:toggle-switch"
staticprivate

Definition at line 58 of file switch.py.

◆ _connection_state

homeassistant.components.smappee.switch.SmappeeActuator._connection_state
private

Definition at line 79 of file switch.py.

◆ _service_location

homeassistant.components.smappee.switch.SmappeeActuator._service_location
private

Definition at line 72 of file switch.py.

◆ _smappee_base

homeassistant.components.smappee.switch.SmappeeActuator._smappee_base
private

Definition at line 71 of file switch.py.

◆ _state

homeassistant.components.smappee.switch.SmappeeActuator._state
private

Definition at line 78 of file switch.py.


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