homeassistant.components.starline.lock.StarlineLock Class Reference

Inheritance diagram for homeassistant.components.starline.lock.StarlineLock:

Collaboration diagram for homeassistant.components.starline.lock.StarlineLock:

Public Member Functions
None	__init__ (self, StarlineAccount account, StarlineDevice device)
bool	available (self)
dict[str, bool]	extra_state_attributes (self)
bool|None	is_locked (self)
None	lock (self, **Any kwargs)
None	unlock (self, **Any kwargs)
Public Member Functions inherited from homeassistant.components.starline.entity.StarlineEntity
None	__init__ (self, StarlineAccount account, StarlineDevice device, str key)
def	async_added_to_hass (self)
def	async_will_remove_from_hass (self)
def	update (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_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_write_ha_state (self)
str|None	attribution (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)
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, str]	translation_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.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_lock (self, **Any kwargs)
None	async_open (self, **Any kwargs)
None	async_registry_entry_updated (self)
None	async_unlock (self, **Any kwargs)
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_locking (self)
bool|None	is_open (self)
bool|None	is_opening (self)
bool|None	is_unlocking (self)
None	open (self, **Any kwargs)
str|None	state (self)
dict[str, StateType]	state_attributes (self)
LockEntityFeature	supported_features (self)

Static Private Attributes
string	_attr_translation_key = "security"

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.components.lock.LockEntity
	LockEntityFeature
	None
	str

Detailed Description

Representation of a StarLine lock.

Definition at line 31 of file lock.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.starline.lock.StarlineLock.__init__	(		self,
		StarlineAccount	account,
		StarlineDevice	device
	)

Initialize the lock.

Definition at line 36 of file lock.py.

Member Function Documentation

available()

bool homeassistant.components.starline.lock.StarlineLock.available

(

self

)

Return True if entity is available.

Reimplemented from homeassistant.components.starline.entity.StarlineEntity.

Definition at line 41 of file lock.py.

extra_state_attributes()

dict[str, bool] homeassistant.components.starline.lock.StarlineLock.extra_state_attributes

(

self

)

Return the state attributes of the lock.

Possible dictionary keys:
add_h - Additional sensor alarm status (high level)
add_l - Additional channel alarm status (low level)
door - Doors alarm status
hbrake - Hand brake alarm status
hijack - Hijack mode status
hood - Hood alarm status
ign - Ignition alarm status
pbrake - Brake pedal alarm status
shock_h - Shock sensor alarm status (high level)
shock_l - Shock sensor alarm status (low level)
tilt - Tilt sensor alarm status
trunk - Trunk alarm status
Documentation: https://developer.starline.ru/#api-Device-DeviceState

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 46 of file lock.py.

is_locked()

bool | None homeassistant.components.starline.lock.StarlineLock.is_locked

(

self

)

Return true if lock is locked.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 67 of file lock.py.

lock()

None homeassistant.components.starline.lock.StarlineLock.lock	(		self,
		**Any	kwargs
	)

Lock the car.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 71 of file lock.py.

unlock()

None homeassistant.components.starline.lock.StarlineLock.unlock	(		self,
		**Any	kwargs
	)

Unlock the car.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 75 of file lock.py.

Member Data Documentation

_attr_translation_key

string homeassistant.components.starline.lock.StarlineLock._attr_translation_key = "security"

staticprivate

Definition at line 34 of file lock.py.

---

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

• core/homeassistant/components/starline/lock.py