Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity Class Reference
Inheritance diagram for homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity:
[legend]
Collaboration diagram for homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity:
[legend]

Public Member Functions

None __init__ (self, SwitchbotDataUpdateCoordinator coordinator)
 
None async_added_to_hass (self)
 
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover_tilt (self, **Any kwargs)
 
None async_set_cover_tilt_position (self, **Any kwargs)
 
None async_stop_cover_tilt (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.switchbot.entity.SwitchbotEntity
None async_update (self)
 
Mapping[Any, Any] extra_state_attributes (self)
 
dict[str, Any] parsed_data (self)
 
- Public Member Functions inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, BLEDevice ble_device, switchbot.SwitchbotDevice device, str base_unique_id, str device_name, bool connectable, SwitchbotModel model)
 
bool async_wait_ready (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *str address, BluetoothScanningMode mode, Callable[[BluetoothServiceInfoBleak, float|None], bool] needs_poll_method, Callable[[BluetoothServiceInfoBleak], Coroutine[Any, Any, _T],]|None poll_method=None, Debouncer[Coroutine[Any, Any, None]]|None poll_debouncer=None, bool connectable=True)
 
bool needs_poll (self, BluetoothServiceInfoBleak service_info)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.passive_update_coordinator.PassiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, str address, BluetoothScanningMode mode, bool connectable=False)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
Generator[Any] async_contexts (self)
 
None async_update_listeners (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
CALLBACK_TYPE async_start (self)
 
float last_seen (self)
 
str name (self)
 
- Public Member Functions inherited from homeassistant.components.cover.CoverEntity
None async_close_cover (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_set_cover_position (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
None async_toggle (self, **Any kwargs)
 
None async_toggle_tilt (self, **Any kwargs)
 
None close_cover (self, **Any kwargs)
 
None close_cover_tilt (self, **Any kwargs)
 
int|None current_cover_position (self)
 
int|None current_cover_tilt_position (self)
 
CoverDeviceClass|None device_class (self)
 
bool|None is_closed (self)
 
bool|None is_closing (self)
 
bool|None is_opening (self)
 
None open_cover (self, **Any kwargs)
 
None open_cover_tilt (self, **Any kwargs)
 
None set_cover_position (self, **Any kwargs)
 
None set_cover_tilt_position (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop_cover (self, **Any kwargs)
 
None stop_cover_tilt (self, **Any kwargs)
 
CoverEntityFeature supported_features (self)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (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_device_update (self, bool warning=True)
 
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)
 
bool available (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)
 
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 Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Static Public Attributes

int CLOSED_DOWN_THRESHOLD = 20
 
int CLOSED_UP_THRESHOLD = 80
 
- Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _handle_coordinator_update (self)
 

Private Attributes

 _attr_current_cover_tilt_position
 
 _attr_is_closed
 
 _attr_is_closing
 
 _attr_is_opening
 
 _last_run_success
 

Static Private Attributes

 _attr_device_class = CoverDeviceClass.BLIND
 
 _attr_name = None
 
tuple _attr_supported_features
 
string _attr_translation_key = "cover"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
 base_unique_id
 
 ble_device
 
 device
 
 device_name
 
 model
 
- Public Attributes inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
 data
 
 last_poll_successful
 
- Public Attributes inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
 address
 
 connectable
 
 hass
 
 logger
 
 mode
 
- Public Attributes inherited from homeassistant.components.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a Switchbot.

Definition at line 125 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.__init__ (   self,
SwitchbotDataUpdateCoordinator  coordinator 
)
Initialize the Switchbot.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 141 of file cover.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 192 of file cover.py.

◆ async_added_to_hass()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.async_added_to_hass (   self)
Run when entity about to be added.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 146 of file cover.py.

◆ async_close_cover_tilt()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.async_close_cover_tilt (   self,
**Any  kwargs 
)
Close the tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 169 of file cover.py.

◆ async_open_cover_tilt()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.async_open_cover_tilt (   self,
**Any  kwargs 
)
Open the tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 162 of file cover.py.

◆ async_set_cover_tilt_position()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.async_set_cover_tilt_position (   self,
**Any  kwargs 
)
Move the cover tilt to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 183 of file cover.py.

◆ async_stop_cover_tilt()

None homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.async_stop_cover_tilt (   self,
**Any  kwargs 
)
Stop the moving of this device.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 176 of file cover.py.

Member Data Documentation

◆ _attr_current_cover_tilt_position

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_current_cover_tilt_position
private

Definition at line 153 of file cover.py.

◆ _attr_device_class

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_device_class = CoverDeviceClass.BLIND
staticprivate

Definition at line 129 of file cover.py.

◆ _attr_is_closed

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_is_closed
private

Definition at line 144 of file cover.py.

◆ _attr_is_closing

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_is_closing
private

Definition at line 200 of file cover.py.

◆ _attr_is_opening

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_is_opening
private

Definition at line 199 of file cover.py.

◆ _attr_name

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_name = None
staticprivate

Definition at line 136 of file cover.py.

◆ _attr_supported_features

tuple homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_supported_features
staticprivate
Initial value:
= (
CoverEntityFeature.OPEN_TILT
| CoverEntityFeature.CLOSE_TILT
| CoverEntityFeature.STOP_TILT
| CoverEntityFeature.SET_TILT_POSITION
)

Definition at line 130 of file cover.py.

◆ _attr_translation_key

string homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._attr_translation_key = "cover"
staticprivate

Definition at line 137 of file cover.py.

◆ _last_run_success

homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity._last_run_success
private

Definition at line 156 of file cover.py.

◆ CLOSED_DOWN_THRESHOLD

int homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.CLOSED_DOWN_THRESHOLD = 20
static

Definition at line 139 of file cover.py.

◆ CLOSED_UP_THRESHOLD

int homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity.CLOSED_UP_THRESHOLD = 80
static

Definition at line 138 of file cover.py.


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