Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.subaru.lock.SubaruLock Class Reference
Inheritance diagram for homeassistant.components.subaru.lock.SubaruLock:
[legend]
Collaboration diagram for homeassistant.components.subaru.lock.SubaruLock:
[legend]

Public Member Functions

def __init__ (self, vehicle_info, controller)
 
None async_lock (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
def async_unlock_specific_door (self, door)
 
- Public Member Functions inherited from homeassistant.components.lock.LockEntity
dict[Any, Any] add_default_code (self, dict[Any, Any] data)
 
None async_handle_lock_service (self, **Any kwargs)
 
None async_handle_open_service (self, **Any kwargs)
 
None async_handle_unlock_service (self, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_open (self, **Any kwargs)
 
None async_registry_entry_updated (self)
 
str|None changed_by (self)
 
str|None code_format (self)
 
re.Pattern[str]|None code_format_cmp (self)
 
bool|None is_jammed (self)
 
bool|None is_locked (self)
 
bool|None is_locking (self)
 
bool|None is_open (self)
 
bool|None is_opening (self)
 
bool|None is_unlocking (self)
 
None lock (self, **Any kwargs)
 
None open (self, **Any kwargs)
 
str|None state (self)
 
dict[str, StateTypestate_attributes (self)
 
LockEntityFeature supported_features (self)
 
None unlock (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_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
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)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (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)
 
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 Attributes

 car_name
 
 controller
 
 vehicle_info
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
string _attr_translation_key = "door_locks"
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.lock.LockEntity
 LockEntityFeature
 
 None
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Subaru door lock.

Note that the Subaru API currently does not support returning the status of the locks. Lock status is always unknown.

Definition at line 56 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.subaru.lock.SubaruLock.__init__ (   self,
  vehicle_info,
  controller 
)
Initialize the locks for the vehicle.

Definition at line 65 of file lock.py.

Member Function Documentation

◆ async_lock()

None homeassistant.components.subaru.lock.SubaruLock.async_lock (   self,
**Any  kwargs 
)
Send the lock command.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 74 of file lock.py.

◆ async_unlock()

None homeassistant.components.subaru.lock.SubaruLock.async_unlock (   self,
**Any  kwargs 
)
Send the unlock command.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 83 of file lock.py.

◆ async_unlock_specific_door()

def homeassistant.components.subaru.lock.SubaruLock.async_unlock_specific_door (   self,
  door 
)
Send the unlock command for a specified door.

Definition at line 93 of file lock.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.subaru.lock.SubaruLock._attr_device_info
private

Definition at line 72 of file lock.py.

◆ _attr_has_entity_name

bool homeassistant.components.subaru.lock.SubaruLock._attr_has_entity_name = True
staticprivate

Definition at line 62 of file lock.py.

◆ _attr_translation_key

string homeassistant.components.subaru.lock.SubaruLock._attr_translation_key = "door_locks"
staticprivate

Definition at line 63 of file lock.py.

◆ _attr_unique_id

homeassistant.components.subaru.lock.SubaruLock._attr_unique_id
private

Definition at line 71 of file lock.py.

◆ car_name

homeassistant.components.subaru.lock.SubaruLock.car_name

Definition at line 70 of file lock.py.

◆ controller

homeassistant.components.subaru.lock.SubaruLock.controller

Definition at line 67 of file lock.py.

◆ vehicle_info

homeassistant.components.subaru.lock.SubaruLock.vehicle_info

Definition at line 68 of file lock.py.


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