Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.cover.CoverEntity Class Reference

Inherits homeassistant.helpers.entity.Entity, cached_properties, and CACHED_PROPERTIES_WITH_ATTR_.

Inherited by homeassistant.components.abode.cover.AbodeCover, homeassistant.components.acmeda.cover.AcmedaCover, homeassistant.components.ads.cover.AdsCover, homeassistant.components.advantage_air.cover.AdvantageAirThingCover, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.bond.cover.BondCover, homeassistant.components.bosch_shc.cover.ShutterControlCover, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.chacon_dio.cover.ChaconDioCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.devolo_home_control.cover.DevoloCoverDeviceEntity, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.fibaro.cover.FibaroCover, homeassistant.components.freedompro.cover.Device, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.garadget.cover.GaradgetCover, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homematic.cover.HMCover, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipCoverSlats, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverSlats, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.isy994.cover.ISYCoverProgramEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.lutron.cover.LutronCover, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.matter.cover.MatterCover, homeassistant.components.microbees.cover.MBCover, homeassistant.components.modbus.cover.ModbusCover, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.motionblinds_ble.cover.MotionblindsBLECoverEntity, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.netatmo.cover.NetatmoCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.rflink.cover.RflinkCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.scsgate.cover.SCSGateCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.soma.cover.SomaShade, homeassistant.components.soma.cover.SomaTilt, homeassistant.components.somfy_mylink.cover.SomfyShade, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.supla.cover.SuplaDoorEntity, homeassistant.components.switch_as_x.cover.CoverSwitch, homeassistant.components.switchbee.cover.SwitchBeeCoverEntity, homeassistant.components.switchbee.cover.SwitchBeeSomfyEntity, homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switcher_kis.cover.SwitcherBaseCoverEntity, homeassistant.components.tailwind.cover.TailwindDoorCoverEntity, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.tellduslive.cover.TelldusLiveCover, homeassistant.components.tellstick.cover.TellstickCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tesla_fleet.cover.TeslaFleetChargePortEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetFrontTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetRearTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetSunroofEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetWindowEntity, homeassistant.components.teslemetry.cover.TeslemetryChargePortEntity, homeassistant.components.teslemetry.cover.TeslemetryFrontTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryRearTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetrySunroofEntity, homeassistant.components.teslemetry.cover.TeslemetryWindowEntity, homeassistant.components.tessie.cover.TessieChargePortEntity, homeassistant.components.tessie.cover.TessieFrontTrunkEntity, homeassistant.components.tessie.cover.TessieRearTrunkEntity, homeassistant.components.tessie.cover.TessieSunroofEntity, homeassistant.components.tessie.cover.TessieWindowEntity, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.tuya.cover.TuyaCoverEntity, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.vera.cover.VeraCover, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.xiaomi_aqara.cover.XiaomiGenericCover, homeassistant.components.yolink.cover.YoLinkCoverEntity, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zwave_js.cover.CoverTiltMixin, homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, and homeassistant.components.zwave_me.cover.ZWaveMeCover.

Collaboration diagram for homeassistant.components.cover.CoverEntity:
[legend]

Public Member Functions

None async_close_cover (self, **Any kwargs)
 
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_open_cover_tilt (self, **Any kwargs)
 
None async_set_cover_position (self, **Any kwargs)
 
None async_set_cover_tilt_position (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
None async_stop_cover_tilt (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_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)
 
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 Attributes

 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
 

Static Public Attributes

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

Private Member Functions

Callable[_P, _R] _R (self, dict[str, Callable[_P, _R]] fns)
 

Static Private Attributes

 _cover_is_last_toggle_direction_open
 

Detailed Description

Base class for cover entities.

Definition at line 278 of file __init__.py.

Member Function Documentation

◆ _R()

Callable[_P, _R] homeassistant.components.cover.CoverEntity._R (   self,
dict[str, Callable[_P, _R]]   fns 
)
private

Definition at line 492 of file __init__.py.

◆ async_close_cover()

None homeassistant.components.cover.CoverEntity.async_close_cover (   self,
**Any  kwargs 
)
Close cover.

Reimplemented in homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, homeassistant.components.zwave_js.cover.ZWaveWindowCovering, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.yolink.cover.YoLinkCoverEntity, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.tessie.cover.TessieSunroofEntity, homeassistant.components.tessie.cover.TessieRearTrunkEntity, homeassistant.components.tessie.cover.TessieChargePortEntity, homeassistant.components.tessie.cover.TessieWindowEntity, homeassistant.components.teslemetry.cover.TeslemetrySunroofEntity, homeassistant.components.teslemetry.cover.TeslemetryRearTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryChargePortEntity, homeassistant.components.teslemetry.cover.TeslemetryWindowEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetSunroofEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetRearTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetChargePortEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetWindowEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.tailwind.cover.TailwindDoorCoverEntity, homeassistant.components.switcher_kis.cover.SwitcherBaseCoverEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switchbee.cover.SwitchBeeCoverEntity, homeassistant.components.switchbee.cover.SwitchBeeSomfyEntity, homeassistant.components.switch_as_x.cover.CoverSwitch, homeassistant.components.supla.cover.SuplaDoorEntity, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.somfy_mylink.cover.SomfyShade, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.overkiz.cover.vertical_cover.LowSpeedCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.netatmo.cover.NetatmoCover, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.PositionCover, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.modbus.cover.ModbusCover, homeassistant.components.microbees.cover.MBCover, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.isy994.cover.ISYCoverProgramEntity, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.freedompro.cover.Device, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.chacon_dio.cover.ChaconDioCover, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.advantage_air.cover.AdvantageAirThingCover, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 402 of file __init__.py.

◆ async_close_cover_tilt()

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

Reimplemented in homeassistant.components.zwave_js.cover.CoverTiltMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.TiltCover, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionTiltDevice, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.knx.cover.KNXCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverSlats, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.group.cover.CoverGroup, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.dynalite.cover.DynaliteCoverWithTilt, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 454 of file __init__.py.

◆ async_open_cover()

None homeassistant.components.cover.CoverEntity.async_open_cover (   self,
**Any  kwargs 
)
Open the cover.

Reimplemented in homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, homeassistant.components.zwave_js.cover.ZWaveWindowCovering, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.yolink.cover.YoLinkCoverEntity, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.tessie.cover.TessieSunroofEntity, homeassistant.components.tessie.cover.TessieRearTrunkEntity, homeassistant.components.tessie.cover.TessieFrontTrunkEntity, homeassistant.components.tessie.cover.TessieChargePortEntity, homeassistant.components.tessie.cover.TessieWindowEntity, homeassistant.components.teslemetry.cover.TeslemetrySunroofEntity, homeassistant.components.teslemetry.cover.TeslemetryRearTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryFrontTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryChargePortEntity, homeassistant.components.teslemetry.cover.TeslemetryWindowEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetSunroofEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetRearTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetFrontTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetChargePortEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetWindowEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.tailwind.cover.TailwindDoorCoverEntity, homeassistant.components.switcher_kis.cover.SwitcherBaseCoverEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switchbee.cover.SwitchBeeCoverEntity, homeassistant.components.switchbee.cover.SwitchBeeSomfyEntity, homeassistant.components.switch_as_x.cover.CoverSwitch, homeassistant.components.supla.cover.SuplaDoorEntity, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.somfy_mylink.cover.SomfyShade, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.overkiz.cover.vertical_cover.LowSpeedCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.netatmo.cover.NetatmoCover, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.PositionCover, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.modbus.cover.ModbusCover, homeassistant.components.microbees.cover.MBCover, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.isy994.cover.ISYCoverProgramEntity, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.freedompro.cover.Device, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.chacon_dio.cover.ChaconDioCover, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.advantage_air.cover.AdvantageAirThingCover, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 394 of file __init__.py.

◆ async_open_cover_tilt()

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

Reimplemented in homeassistant.components.zwave_js.cover.CoverTiltMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.TiltCover, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionTiltDevice, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.knx.cover.KNXCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverSlats, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.group.cover.CoverGroup, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.dynalite.cover.DynaliteCoverWithTilt, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 445 of file __init__.py.

◆ async_set_cover_position()

None homeassistant.components.cover.CoverEntity.async_set_cover_position (   self,
**Any  kwargs 
)
Move the cover to a specific position.

Reimplemented in homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.switcher_kis.cover.SwitcherBaseCoverEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switchbee.cover.SwitchBeeCoverEntity, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.overkiz.cover.vertical_cover.LowSpeedCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.netatmo.cover.NetatmoCover, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.PositionCover, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.knx.cover.KNXCover, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.freedompro.cover.Device, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.chacon_dio.cover.ChaconDioCover, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 429 of file __init__.py.

◆ async_set_cover_tilt_position()

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

Reimplemented in homeassistant.components.zwave_js.cover.CoverTiltMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.TiltCover, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionTiltDevice, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.knx.cover.KNXCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverSlats, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.dynalite.cover.DynaliteCoverWithTilt, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 463 of file __init__.py.

◆ async_stop_cover()

None homeassistant.components.cover.CoverEntity.async_stop_cover (   self,
**Any  kwargs 
)
Stop the cover.

Reimplemented in homeassistant.components.zwave_js.cover.ZWaveWindowCovering, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.teslemetry.cover.TeslemetrySunroofEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetSunroofEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.switcher_kis.cover.SwitcherBaseCoverEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switchbee.cover.SwitchBeeCoverEntity, homeassistant.components.switchbee.cover.SwitchBeeSomfyEntity, homeassistant.components.supla.cover.SuplaDoorEntity, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.somfy_mylink.cover.SomfyShade, homeassistant.components.slide.cover.SlideCover, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.netatmo.cover.NetatmoCover, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.mqtt.cover.MqttCover, homeassistant.components.motionblinds_ble.cover.MotionblindsBLECoverEntity, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.microbees.cover.MBCover, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.knx.cover.KNXCover, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.group.cover.CoverGroup, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.chacon_dio.cover.ChaconDioCover, homeassistant.components.bond.cover.BondCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.acmeda.cover.AcmedaCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, and homeassistant.components.comelit.cover.ComelitCoverEntity.

Definition at line 438 of file __init__.py.

◆ async_stop_cover_tilt()

◆ async_toggle()

None homeassistant.components.cover.CoverEntity.async_toggle (   self,
**Any  kwargs 
)
Toggle the entity.

Reimplemented in homeassistant.components.supla.cover.SuplaDoorEntity.

Definition at line 416 of file __init__.py.

◆ async_toggle_tilt()

None homeassistant.components.cover.CoverEntity.async_toggle_tilt (   self,
**Any  kwargs 
)
Toggle the entity.

Reimplemented in homeassistant.components.mqtt.cover.MqttCover.

Definition at line 485 of file __init__.py.

◆ close_cover()

◆ close_cover_tilt()

None homeassistant.components.cover.CoverEntity.close_cover_tilt (   self,
**Any  kwargs 
)

◆ current_cover_position()

int | None homeassistant.components.cover.CoverEntity.current_cover_position (   self)
Return current position of cover.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented in homeassistant.components.zwave_me.cover.ZWaveMeCover, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.xiaomi_aqara.cover.XiaomiGenericCover, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.vera.cover.VeraCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tuya.cover.TuyaCoverEntity, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.tessie.cover.TessieSunroofEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.soma.cover.SomaShade, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.knx.cover.KNXCover, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homematic.cover.HMGarage, homeassistant.components.homematic.cover.HMCover, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.devolo_home_control.cover.DevoloCoverDeviceEntity, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bosch_shc.cover.ShutterControlCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, homeassistant.components.ads.cover.AdsCover, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 294 of file __init__.py.

◆ current_cover_tilt_position()

int | None homeassistant.components.cover.CoverEntity.current_cover_tilt_position (   self)
Return current position of cover tilt.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented in homeassistant.components.zwave_js.cover.CoverTiltMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.tuya.cover.TuyaCoverEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.soma.cover.SomaTilt, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionTiltDevice, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.knx.cover.KNXCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverSlats, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homematic.cover.HMCover, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.dynalite.cover.DynaliteCoverWithTilt, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 302 of file __init__.py.

◆ device_class()

CoverDeviceClass | None homeassistant.components.cover.CoverEntity.device_class (   self)
Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.nice_go.cover.NiceGOCoverEntity.

Definition at line 310 of file __init__.py.

◆ is_closed()

bool | None homeassistant.components.cover.CoverEntity.is_closed (   self)
Return if the cover is closed or not.

Reimplemented in homeassistant.components.zwave_me.cover.ZWaveMeCover, homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, homeassistant.components.zwave_js.cover.CoverPositionMixin, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.xiaomi_aqara.cover.XiaomiGenericCover, homeassistant.components.wmspro.cover.WebControlProAwning, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.vera.cover.VeraCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.tuya.cover.TuyaCoverEntity, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.tessie.cover.TessieSunroofEntity, homeassistant.components.tessie.cover.TessieRearTrunkEntity, homeassistant.components.tessie.cover.TessieFrontTrunkEntity, homeassistant.components.tessie.cover.TessieChargePortEntity, homeassistant.components.tessie.cover.TessieWindowEntity, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tellstick.cover.TellstickCover, homeassistant.components.tellduslive.cover.TelldusLiveCover, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.tailwind.cover.TailwindDoorCoverEntity, homeassistant.components.supla.cover.SuplaDoorEntity, homeassistant.components.supla.cover.SuplaCoverEntity, homeassistant.components.soma.cover.SomaShade, homeassistant.components.soma.cover.SomaTilt, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.scsgate.cover.SCSGateCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.motion_blinds.cover.MotionTiltDevice, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.matter.cover.MatterCover, homeassistant.components.lutron_caseta.cover.LutronCasetaTiltOnlyBlind, homeassistant.components.lutron_caseta.cover.LutronCasetaShade, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.isy994.cover.ISYCoverProgramEntity, homeassistant.components.isy994.cover.ISYCoverEntity, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.insteon.cover.InsteonCoverEntity, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.homematicip_cloud.cover.HomematicipCoverShutterGroup, homeassistant.components.homematicip_cloud.cover.HomematicipGarageDoorModule, homeassistant.components.homematicip_cloud.cover.HomematicipMultiCoverShutter, homeassistant.components.homematicip_cloud.cover.HomematicipBlindModule, homeassistant.components.homematic.cover.HMGarage, homeassistant.components.homematic.cover.HMCover, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.garadget.cover.GaradgetCover, homeassistant.components.fritzbox.cover.FritzboxCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.devolo_home_control.cover.DevoloCoverDeviceEntity, homeassistant.components.demo.cover.DemoCover, homeassistant.components.deconz.cover.DeconzCover, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bosch_shc.cover.ShutterControlCover, homeassistant.components.blebox.cover.BleBoxCoverEntity, homeassistant.components.advantage_air.cover.AdvantageAirThingCover, homeassistant.components.advantage_air.cover.AdvantageAirZoneVent, homeassistant.components.ads.cover.AdsCover, homeassistant.components.acmeda.cover.AcmedaCover, and homeassistant.components.abode.cover.AbodeCover.

Definition at line 386 of file __init__.py.

◆ is_closing()

bool | None homeassistant.components.cover.CoverEntity.is_closing (   self)
Return if the cover is closing or not.

Reimplemented in homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bosch_shc.cover.ShutterControlCover, and homeassistant.components.blebox.cover.BleBoxCoverEntity.

Definition at line 381 of file __init__.py.

◆ is_opening()

bool | None homeassistant.components.cover.CoverEntity.is_opening (   self)
Return if the cover is opening or not.

Reimplemented in homeassistant.components.zwave_js.cover.ZwaveMotorizedBarrier, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.wilight.cover.WiLightCover, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.velbus.cover.VelbusCover, homeassistant.components.template.cover.CoverTemplate, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.smartthings.cover.SmartThingsCover, homeassistant.components.slide.cover.SlideCover, homeassistant.components.shelly.cover.RpcShellyCover, homeassistant.components.shelly.cover.BlockShellyCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.opengarage.cover.OpenGarageCover, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.mysensors.cover.MySensorsCover, homeassistant.components.linear_garage_door.cover.LinearCoverEntity, homeassistant.components.knx.cover.KNXCover, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.elmax.cover.ElmaxCover, homeassistant.components.dynalite.cover.DynaliteCover, homeassistant.components.duotecno.cover.DuotecnoCover, homeassistant.components.demo.cover.DemoCover, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bosch_shc.cover.ShutterControlCover, and homeassistant.components.blebox.cover.BleBoxCoverEntity.

Definition at line 376 of file __init__.py.

◆ open_cover()

◆ open_cover_tilt()

None homeassistant.components.cover.CoverEntity.open_cover_tilt (   self,
**Any  kwargs 
)

◆ set_cover_position()

◆ set_cover_tilt_position()

None homeassistant.components.cover.CoverEntity.set_cover_tilt_position (   self,
**Any  kwargs 
)

◆ state()

str | None homeassistant.components.cover.CoverEntity.state (   self)
Return the state of the cover.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 320 of file __init__.py.

◆ state_attributes()

dict[str, Any] homeassistant.components.cover.CoverEntity.state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 336 of file __init__.py.

◆ stop_cover()

◆ stop_cover_tilt()

None homeassistant.components.cover.CoverEntity.stop_cover_tilt (   self,
**Any  kwargs 
)
Stop the cover.

Reimplemented in homeassistant.components.soma.cover.SomaTilt, and homeassistant.components.homematic.cover.HMCover.

Definition at line 469 of file __init__.py.

◆ supported_features()

◆ toggle()

None homeassistant.components.cover.CoverEntity.toggle (   self,
**Any  kwargs 
)
Toggle the entity.

Definition at line 406 of file __init__.py.

◆ toggle_tilt()

None homeassistant.components.cover.CoverEntity.toggle_tilt (   self,
**Any  kwargs 
)
Toggle the entity.

Definition at line 478 of file __init__.py.

Member Data Documentation

◆ _cover_is_last_toggle_direction_open

homeassistant.components.cover.CoverEntity._cover_is_last_toggle_direction_open
staticprivate

Definition at line 291 of file __init__.py.

◆ current_cover_position

homeassistant.components.cover.CoverEntity.current_cover_position

Definition at line 506 of file __init__.py.

◆ current_cover_tilt_position

homeassistant.components.cover.CoverEntity.current_cover_tilt_position

Definition at line 480 of file __init__.py.

◆ None

homeassistant.components.cover.CoverEntity.None
static

Definition at line 282 of file __init__.py.


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