Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.select.SelectEntity Class Reference

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

Inherited by homeassistant.components.ads.select.AdsSelect, homeassistant.components.advantage_air.select.AdvantageAirMyZone, homeassistant.components.airgradient.select.AirGradientSelect, homeassistant.components.airzone.select.AirzoneBaseSelect, homeassistant.components.airzone_cloud.select.AirzoneBaseSelect, homeassistant.components.aprilaire.select.AprilaireSelectEntity, homeassistant.components.assist_pipeline.select.AssistPipelineSelect, homeassistant.components.assist_pipeline.select.VadSensitivitySelect, homeassistant.components.balboa.select.BalboaTempRangeSelectEntity, homeassistant.components.bmw_connected_drive.select.BMWSelect, homeassistant.components.broadlink.select.BroadlinkDayOfWeek, homeassistant.components.cambridge_audio.select.CambridgeAudioSelect, homeassistant.components.demo.select.DemoSelect, homeassistant.components.drop_connect.select.DROPSelect, homeassistant.components.ecovacs.select.EcovacsSelectEntity, homeassistant.components.electric_kiwi.select.ElectricKiwiSelectHOPEntity, homeassistant.components.enphase_envoy.select.EnvoyRelaySelectEntity, homeassistant.components.enphase_envoy.select.EnvoyStorageSettingsSelectEntity, homeassistant.components.esphome.select.EsphomeAssistSatelliteWakeWordSelect, homeassistant.components.esphome.select.EsphomeSelect, homeassistant.components.ezviz.select.EzvizSelect, homeassistant.components.flipr.select.FliprHubSelect, homeassistant.components.flux_led.select.FluxConfigAtStartSelect, homeassistant.components.flux_led.select.FluxConfigSelect, homeassistant.components.flux_led.select.FluxPowerStateSelect, homeassistant.components.goodwe.select.InverterOperationModeEntity, homeassistant.components.harmony.select.HarmonyActivitySelect, homeassistant.components.home_connect.select.HomeConnectProgramSelectEntity, homeassistant.components.homekit_controller.select.BaseHomeKitSelect, homeassistant.components.huawei_lte.select.HuaweiLteSelectEntity, homeassistant.components.hunterdouglas_powerview.select.PowerViewSelect, homeassistant.components.husqvarna_automower.select.AutomowerSelectEntity, homeassistant.components.input_select.InputSelect, homeassistant.components.isy994.select.ISYAuxControlIndexSelectEntity, homeassistant.components.isy994.select.ISYBacklightSelectEntity, homeassistant.components.isy994.select.ISYRampRateSelectEntity, homeassistant.components.jvc_projector.select.JvcProjectorSelectEntity, homeassistant.components.knx.select.KNXSelect, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.lamarzocco.select.LaMarzoccoSelectEntity, homeassistant.components.lametric.select.LaMetricSelectEntity, homeassistant.components.lektrico.select.LektricoSelect, homeassistant.components.lg_thinq.select.ThinQSelectEntity, homeassistant.components.lifx.select.LIFXInfraredBrightnessSelectEntity, homeassistant.components.lifx.select.LIFXThemeSelectEntity, homeassistant.components.litterrobot.select.LitterRobotSelectEntity, homeassistant.components.matter.select.MatterSelectEntity, homeassistant.components.motionblinds_ble.select.SpeedSelect, homeassistant.components.motionmount.select.MotionMountPresets, homeassistant.components.mqtt.select.MqttSelect, homeassistant.components.myuplink.select.MyUplinkSelect, homeassistant.components.netatmo.select.NetatmoScheduleSelect, homeassistant.components.nibe_heatpump.select.Select, homeassistant.components.nobo_hub.select.NoboGlobalSelector, homeassistant.components.nobo_hub.select.NoboProfileSelector, homeassistant.components.opentherm_gw.select.OpenThermSelect, homeassistant.components.overkiz.select.OverkizSelect, homeassistant.components.plugwise.select.PlugwiseSelectEntity, homeassistant.components.rainmachine.select.FreezeProtectionTemperatureSelect, homeassistant.components.renault.select.RenaultSelectEntity, homeassistant.components.reolink.select.ReolinkChimeSelectEntity, homeassistant.components.reolink.select.ReolinkSelectEntity, homeassistant.components.rituals_perfume_genie.select.RitualsSelectEntity, homeassistant.components.roborock.select.RoborockCurrentMapSelectEntity, homeassistant.components.roborock.select.RoborockSelectEntity, homeassistant.components.roku.select.RokuSelectEntity, homeassistant.components.schlage.select.SchlageSelect, homeassistant.components.sensibo.select.SensiboSelect, homeassistant.components.shelly.select.RpcSelect, homeassistant.components.sleepiq.select.SleepIQFootWarmingTempSelectEntity, homeassistant.components.sleepiq.select.SleepIQSelectEntity, homeassistant.components.template.select.TemplateSelect, homeassistant.components.template.select.TriggerSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetExportRuleSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetOperationSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetSeatHeaterSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetWheelHeaterSelectEntity, homeassistant.components.teslemetry.select.TeslemetryExportRuleSelectEntity, homeassistant.components.teslemetry.select.TeslemetryOperationSelectEntity, homeassistant.components.teslemetry.select.TeslemetrySeatHeaterSelectEntity, homeassistant.components.teslemetry.select.TeslemetryWheelHeaterSelectEntity, homeassistant.components.tessie.select.TessieExportRuleSelectEntity, homeassistant.components.tessie.select.TessieOperationSelectEntity, homeassistant.components.tessie.select.TessieSeatCoolerSelectEntity, homeassistant.components.tessie.select.TessieSeatHeaterSelectEntity, homeassistant.components.tolo.select.ToloSelectEntity, homeassistant.components.tplink.select.TPLinkSelectEntity, homeassistant.components.tuya.select.TuyaSelectEntity, homeassistant.components.unifiprotect.select.ProtectSelects, homeassistant.components.utility_meter.select.TariffSelect, homeassistant.components.velbus.select.VelbusSelect, homeassistant.components.wled.select.WLEDLiveOverrideSelect, homeassistant.components.wled.select.WLEDPaletteSelect, homeassistant.components.wled.select.WLEDPlaylistSelect, homeassistant.components.wled.select.WLEDPresetSelect, homeassistant.components.wyoming.select.WyomingSatelliteNoiseSuppressionLevelSelect, homeassistant.components.xiaomi_miio.select.XiaomiSelector, homeassistant.components.yale_smart_alarm.select.YaleLockVolumeSelect, homeassistant.components.yamaha_musiccast.select.SelectableCapability, and homeassistant.components.zha.select.ZHAEnumSelectEntity.

Collaboration diagram for homeassistant.components.select.SelectEntity:
[legend]

Public Member Functions

None async_first (self)
 
None async_handle_select_option (self, str option)
 
None async_last (self)
 
None async_next (self, bool cycle)
 
None async_previous (self, bool cycle)
 
None async_select_option (self, str option)
 
dict[str, Any] capability_attributes (self)
 
str|None current_option (self)
 
list[stroptions (self)
 
None select_option (self, str option)
 
str|None state (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_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)
 
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)
 
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 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)
 

Static Public Attributes

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

Private Member Functions

None _async_offset_index (self, int offset, bool cycle)
 
None _async_select_index (self, int idx)
 
None _valid_option_or_raise (self, str option)
 

Static Private Attributes

 _entity_component_unrecorded_attributes = frozenset({ATTR_OPTIONS})
 

Additional Inherited Members

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

Detailed Description

Representation of a Select entity.

Definition at line 124 of file __init__.py.

Member Function Documentation

◆ _async_offset_index()

None homeassistant.components.select.SelectEntity._async_offset_index (   self,
int  offset,
bool  cycle 
)
private
Offset current index.

Definition at line 231 of file __init__.py.

◆ _async_select_index()

None homeassistant.components.select.SelectEntity._async_select_index (   self,
int  idx 
)
private
Select new option by index.

Definition at line 250 of file __init__.py.

◆ _valid_option_or_raise()

None homeassistant.components.select.SelectEntity._valid_option_or_raise (   self,
str  option 
)
private
Raise ServiceValidationError on invalid option.

Definition at line 169 of file __init__.py.

◆ async_first()

None homeassistant.components.select.SelectEntity.async_first (   self)
Select first option.

Definition at line 199 of file __init__.py.

◆ async_handle_select_option()

None homeassistant.components.select.SelectEntity.async_handle_select_option (   self,
str  option 
)
Service call wrapper to set a new value.

Definition at line 185 of file __init__.py.

◆ async_last()

None homeassistant.components.select.SelectEntity.async_last (   self)
Select last option.

Definition at line 204 of file __init__.py.

◆ async_next()

None homeassistant.components.select.SelectEntity.async_next (   self,
bool  cycle 
)
Select next option.

If there is no current option, first item is the next.

Definition at line 209 of file __init__.py.

◆ async_previous()

None homeassistant.components.select.SelectEntity.async_previous (   self,
bool  cycle 
)
Select previous option.

If there is no current option, last item is the previous.

Definition at line 220 of file __init__.py.

◆ async_select_option()

None homeassistant.components.select.SelectEntity.async_select_option (   self,
str  option 
)
Change the selected option.

Reimplemented in homeassistant.components.zha.select.ZHAEnumSelectEntity, homeassistant.components.yamaha_musiccast.select.SelectableCapability, homeassistant.components.yale_smart_alarm.select.YaleLockVolumeSelect, homeassistant.components.xiaomi_miio.select.XiaomiGenericSelector, homeassistant.components.wyoming.select.WyomingSatelliteVadSensitivitySelect, homeassistant.components.wyoming.select.WyomingSatelliteNoiseSuppressionLevelSelect, homeassistant.components.wyoming.select.WyomingSatellitePipelineSelect, homeassistant.components.wled.select.WLEDPaletteSelect, homeassistant.components.wled.select.WLEDPlaylistSelect, homeassistant.components.wled.select.WLEDPresetSelect, homeassistant.components.wled.select.WLEDLiveOverrideSelect, homeassistant.components.velbus.select.VelbusSelect, homeassistant.components.utility_meter.select.TariffSelect, homeassistant.components.unifiprotect.select.ProtectSelects, homeassistant.components.tplink.select.TPLinkSelectEntity, homeassistant.components.tessie.select.TessieExportRuleSelectEntity, homeassistant.components.tessie.select.TessieOperationSelectEntity, homeassistant.components.tessie.select.TessieSeatCoolerSelectEntity, homeassistant.components.tessie.select.TessieSeatHeaterSelectEntity, homeassistant.components.teslemetry.select.TeslemetryExportRuleSelectEntity, homeassistant.components.teslemetry.select.TeslemetryOperationSelectEntity, homeassistant.components.teslemetry.select.TeslemetryWheelHeaterSelectEntity, homeassistant.components.teslemetry.select.TeslemetrySeatHeaterSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetExportRuleSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetOperationSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetWheelHeaterSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetSeatHeaterSelectEntity, homeassistant.components.template.select.TriggerSelectEntity, homeassistant.components.template.select.TemplateSelect, homeassistant.components.sleepiq.select.SleepIQFootWarmingTempSelectEntity, homeassistant.components.sleepiq.select.SleepIQSelectEntity, homeassistant.components.shelly.select.RpcSelect, homeassistant.components.sensibo.select.SensiboSelect, homeassistant.components.roku.select.RokuSelectEntity, homeassistant.components.roborock.select.RoborockCurrentMapSelectEntity, homeassistant.components.roborock.select.RoborockSelectEntity, homeassistant.components.rituals_perfume_genie.select.RitualsSelectEntity, homeassistant.components.reolink.select.ReolinkChimeSelectEntity, homeassistant.components.reolink.select.ReolinkSelectEntity, homeassistant.components.renault.select.RenaultSelectEntity, homeassistant.components.rainmachine.select.FreezeProtectionTemperatureSelect, homeassistant.components.plugwise.select.PlugwiseSelectEntity, homeassistant.components.overkiz.select.OverkizSelect, homeassistant.components.opentherm_gw.select.OpenThermSelect, homeassistant.components.nobo_hub.select.NoboProfileSelector, homeassistant.components.nobo_hub.select.NoboGlobalSelector, homeassistant.components.nibe_heatpump.select.Select, homeassistant.components.netatmo.select.NetatmoScheduleSelect, homeassistant.components.myuplink.select.MyUplinkSelect, homeassistant.components.mqtt.select.MqttSelect, homeassistant.components.motionmount.select.MotionMountPresets, homeassistant.components.motionblinds_ble.select.SpeedSelect, homeassistant.components.matter.select.MatterModeSelectEntity, homeassistant.components.matter.select.MatterSelectEntity, homeassistant.components.litterrobot.select.LitterRobotSelectEntity, homeassistant.components.lifx.select.LIFXThemeSelectEntity, homeassistant.components.lifx.select.LIFXInfraredBrightnessSelectEntity, homeassistant.components.lg_thinq.select.ThinQSelectEntity, homeassistant.components.lektrico.select.LektricoSelect, homeassistant.components.lametric.select.LaMetricSelectEntity, homeassistant.components.lamarzocco.select.LaMarzoccoSelectEntity, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.knx.select.KNXSelect, homeassistant.components.jvc_projector.select.JvcProjectorSelectEntity, homeassistant.components.isy994.select.ISYBacklightSelectEntity, homeassistant.components.isy994.select.ISYAuxControlIndexSelectEntity, homeassistant.components.isy994.select.ISYRampRateSelectEntity, homeassistant.components.input_select.InputSelect, homeassistant.components.husqvarna_automower.select.AutomowerSelectEntity, homeassistant.components.hunterdouglas_powerview.select.PowerViewSelect, homeassistant.components.homekit_controller.select.EcobeeModeSelect, homeassistant.components.homekit_controller.select.HomeKitSelect, homeassistant.components.home_connect.select.HomeConnectProgramSelectEntity, homeassistant.components.harmony.select.HarmonyActivitySelect, homeassistant.components.goodwe.select.InverterOperationModeEntity, homeassistant.components.flux_led.select.FluxWhiteChannelSelect, homeassistant.components.flux_led.select.FluxRemoteConfigSelect, homeassistant.components.flux_led.select.FluxOperatingModesSelect, homeassistant.components.flux_led.select.FluxWiringsSelect, homeassistant.components.flux_led.select.FluxICTypeSelect, homeassistant.components.flux_led.select.FluxPowerStateSelect, homeassistant.components.flipr.select.FliprHubSelect, homeassistant.components.esphome.select.EsphomeAssistSatelliteWakeWordSelect, homeassistant.components.esphome.select.EsphomeSelect, homeassistant.components.enphase_envoy.select.EnvoyStorageSettingsSelectEntity, homeassistant.components.enphase_envoy.select.EnvoyRelaySelectEntity, homeassistant.components.electric_kiwi.select.ElectricKiwiSelectHOPEntity, homeassistant.components.ecovacs.select.EcovacsSelectEntity, homeassistant.components.drop_connect.select.DROPSelect, homeassistant.components.demo.select.DemoSelect, homeassistant.components.cambridge_audio.select.CambridgeAudioSelect, homeassistant.components.broadlink.select.BroadlinkDayOfWeek, homeassistant.components.bmw_connected_drive.select.BMWSelect, homeassistant.components.balboa.select.BalboaTempRangeSelectEntity, homeassistant.components.assist_pipeline.select.VadSensitivitySelect, homeassistant.components.assist_pipeline.select.AssistPipelineSelect, homeassistant.components.aprilaire.select.AprilaireSelectEntity, homeassistant.components.airzone_cloud.select.AirzoneZoneSelect, homeassistant.components.airzone.select.AirzoneZoneSelect, homeassistant.components.airgradient.select.AirGradientSelect, and homeassistant.components.advantage_air.select.AdvantageAirMyZone.

Definition at line 194 of file __init__.py.

◆ capability_attributes()

dict[str, Any] homeassistant.components.select.SelectEntity.capability_attributes (   self)
Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 135 of file __init__.py.

◆ current_option()

str | None homeassistant.components.select.SelectEntity.current_option (   self)
Return the selected entity option to represent the entity state.

Reimplemented in homeassistant.components.zha.select.ZHAEnumSelectEntity, homeassistant.components.yamaha_musiccast.select.SelectableCapability, homeassistant.components.xiaomi_miio.select.XiaomiGenericSelector, homeassistant.components.wled.select.WLEDPaletteSelect, homeassistant.components.wled.select.WLEDPlaylistSelect, homeassistant.components.wled.select.WLEDPresetSelect, homeassistant.components.wled.select.WLEDLiveOverrideSelect, homeassistant.components.velbus.select.VelbusSelect, homeassistant.components.utility_meter.select.TariffSelect, homeassistant.components.tuya.select.TuyaSelectEntity, homeassistant.components.tolo.select.ToloSelectEntity, homeassistant.components.tessie.select.TessieSeatCoolerSelectEntity, homeassistant.components.tessie.select.TessieSeatHeaterSelectEntity, homeassistant.components.template.select.TriggerSelectEntity, homeassistant.components.shelly.select.RpcSelect, homeassistant.components.sensibo.select.SensiboSelect, homeassistant.components.schlage.select.SchlageSelect, homeassistant.components.roku.select.RokuSelectEntity, homeassistant.components.roborock.select.RoborockCurrentMapSelectEntity, homeassistant.components.roborock.select.RoborockSelectEntity, homeassistant.components.rituals_perfume_genie.select.RitualsSelectEntity, homeassistant.components.reolink.select.ReolinkChimeSelectEntity, homeassistant.components.reolink.select.ReolinkSelectEntity, homeassistant.components.renault.select.RenaultSelectEntity, homeassistant.components.plugwise.select.PlugwiseSelectEntity, homeassistant.components.overkiz.select.OverkizSelect, homeassistant.components.myuplink.select.MyUplinkSelect, homeassistant.components.motionmount.select.MotionMountPresets, homeassistant.components.litterrobot.select.LitterRobotSelectEntity, homeassistant.components.lektrico.select.LektricoSelect, homeassistant.components.lametric.select.LaMetricSelectEntity, homeassistant.components.lamarzocco.select.LaMarzoccoSelectEntity, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.jvc_projector.select.JvcProjectorSelectEntity, homeassistant.components.isy994.select.ISYAuxControlIndexSelectEntity, homeassistant.components.isy994.select.ISYRampRateSelectEntity, homeassistant.components.husqvarna_automower.select.AutomowerSelectEntity, homeassistant.components.hunterdouglas_powerview.select.PowerViewSelect, homeassistant.components.huawei_lte.select.HuaweiLteSelectEntity, homeassistant.components.homekit_controller.select.EcobeeModeSelect, homeassistant.components.homekit_controller.select.HomeKitSelect, homeassistant.components.harmony.select.HarmonyActivitySelect, homeassistant.components.flux_led.select.FluxWhiteChannelSelect, homeassistant.components.flux_led.select.FluxRemoteConfigSelect, homeassistant.components.flux_led.select.FluxOperatingModesSelect, homeassistant.components.flux_led.select.FluxWiringsSelect, homeassistant.components.flux_led.select.FluxICTypeSelect, homeassistant.components.flipr.select.FliprHubSelect, homeassistant.components.ezviz.select.EzvizSelect, homeassistant.components.esphome.select.EsphomeSelect, homeassistant.components.enphase_envoy.select.EnvoyStorageSettingsSelectEntity, homeassistant.components.enphase_envoy.select.EnvoyRelaySelectEntity, homeassistant.components.electric_kiwi.select.ElectricKiwiSelectHOPEntity, homeassistant.components.drop_connect.select.DROPSelect, homeassistant.components.cambridge_audio.select.CambridgeAudioSelect, homeassistant.components.balboa.select.BalboaTempRangeSelectEntity, homeassistant.components.aprilaire.select.AprilaireSelectEntity, homeassistant.components.airgradient.select.AirGradientSelect, and homeassistant.components.advantage_air.select.AdvantageAirMyZone.

Definition at line 163 of file __init__.py.

◆ options()

◆ select_option()

◆ state()

str | None homeassistant.components.select.SelectEntity.state (   self)
Return the entity state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 143 of file __init__.py.

Member Data Documentation

◆ _entity_component_unrecorded_attributes

homeassistant.components.select.SelectEntity._entity_component_unrecorded_attributes = frozenset({ATTR_OPTIONS})
staticprivate

Definition at line 127 of file __init__.py.

◆ None

homeassistant.components.select.SelectEntity.None
static

Definition at line 132 of file __init__.py.


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