homeassistant.helpers.entity.ToggleEntity Class Reference

Inheritance diagram for homeassistant.helpers.entity.ToggleEntity:

Collaboration diagram for homeassistant.helpers.entity.ToggleEntity:

Public Member Functions
None	async_toggle (self, **Any kwargs)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
bool|None	is_on (self)
Literal["on", "off"]|None	state (self)
None	toggle (self, **Any kwargs)
None	turn_off (self, **Any kwargs)
None	turn_on (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)
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, 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)

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

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

An abstract class for entities that can be turned on and off.

Definition at line 1675 of file entity.py.

Member Function Documentation

async_toggle()

None homeassistant.helpers.entity.ToggleEntity.async_toggle	(		self,
		**Any	kwargs
	)

Toggle the entity.

This method should typically not be implemented by integrations, it's enough to
implement async_turn_on + async_turn_off or turn_on + turn_off.

Reimplemented in homeassistant.components.xiaomi_miio.switch.XiaomiGatewaySwitch, homeassistant.components.smarttub.switch.SmartTubPump, homeassistant.components.refoss.switch.RefossSwitch, homeassistant.components.qbittorrent.switch.QBittorrentSwitch, homeassistant.components.pyload.switch.PyLoadSwitchEntity, homeassistant.components.progettihwsw.switch.ProgettihwswSwitch, and homeassistant.components.kmtronic.switch.KMtronicSwitch.

Definition at line 1721 of file entity.py.

async_turn_off()

None homeassistant.helpers.entity.ToggleEntity.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the entity off.

Reimplemented in homeassistant.components.zwave_js.siren.ZwaveSirenEntity, homeassistant.components.zwave_js.light.ZwaveColorOnOffLight, homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.zwave_js.fan.ZwaveThermostatFan, homeassistant.components.zwave_js.fan.ZwaveFan, homeassistant.components.zha.switch.Switch, homeassistant.components.zha.siren.ZHASiren, homeassistant.components.zha.light.Light, homeassistant.components.zha.fan.ZhaFan, homeassistant.components.zerproc.light.ZerprocLight, homeassistant.components.yolink.switch.YoLinkSwitchEntity, homeassistant.components.yolink.siren.YoLinkSirenEntity, homeassistant.components.yolink.light.YoLinkDimmerEntity, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yardian.switch.YardianSwitch, homeassistant.components.yamaha_musiccast.switch.SwitchCapability, homeassistant.components.yale_smart_alarm.switch.YaleAutolockSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiAirConditioningCompanionSwitch, homeassistant.components.xiaomi_miio.switch.ChuangMiPlugSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGatewaySwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGenericCoordinatedSwitch, homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsEyecareLampAmbientLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier, homeassistant.components.xiaomi_miio.fan.XiaomiGenericDevice, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.wyoming.switch.WyomingSatelliteMuteSwitch, homeassistant.components.wmspro.light.WebControlProLight, homeassistant.components.wled.switch.WLEDReverseSwitch, homeassistant.components.wled.switch.WLEDSyncReceiveSwitch, homeassistant.components.wled.switch.WLEDSyncSendSwitch, homeassistant.components.wled.switch.WLEDNightlightSwitch, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wiz.entity.WizToggleEntity, homeassistant.components.wilight.switch.WiLightValvePauseSwitch, homeassistant.components.wilight.switch.WiLightValveSwitch, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.wilight.light.WiLightLightDimmer, homeassistant.components.wilight.light.WiLightLightOnOff, homeassistant.components.wilight.fan.WiLightFan, homeassistant.components.wallbox.switch.WallboxSwitch, homeassistant.components.volvooncall.switch.VolvoSwitch, homeassistant.components.voip.switch.VoIPCallAllowedSwitch, homeassistant.components.versasense.switch.VActuator, homeassistant.components.verisure.switch.VerisureSmartplug, homeassistant.components.velux.light.VeluxLight, homeassistant.components.velbus.switch.VelbusSwitch, homeassistant.components.velbus.light.VelbusButtonLight, homeassistant.components.velbus.light.VelbusLight, homeassistant.components.vallox.switch.ValloxSwitchEntity, homeassistant.components.vallox.fan.ValloxFanEntity, homeassistant.components.v2c.switch.V2CSwitchEntity, homeassistant.components.uptimerobot.switch.UptimeRobotSwitch, homeassistant.components.upb.light.UpbLight, homeassistant.components.unifiprotect.switch.ProtectPrivacyModeSwitch, homeassistant.components.unifiprotect.light.ProtectLight, homeassistant.components.unifi.switch.UnifiSwitchEntity, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.transmission.switch.TransmissionSwitch, homeassistant.components.tradfri.switch.TradfriSwitch, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.tradfri.fan.TradfriAirPurifierFan, homeassistant.components.tractive.switch.TractiveSwitch, homeassistant.components.tplink_omada.switch.OmadaDevicePortSwitchEntity, homeassistant.components.tplink.siren.TPLinkSirenEntity, homeassistant.components.tplink.light.TPLinkLightEntity, homeassistant.components.tplink.fan.TPLinkFanEntity, homeassistant.components.toon.switch.ToonHolidayModeSwitch, homeassistant.components.toon.switch.ToonProgramSwitch, homeassistant.components.tessie.switch.TessieStormModeSwitchEntity, homeassistant.components.tessie.switch.TessieChargeFromGridSwitchEntity, homeassistant.components.tessie.switch.TessieSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryStormModeSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryChargeFromGridSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryVehicleSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetStormModeSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetChargeFromGridSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetVehicleSwitchEntity, homeassistant.components.template.switch.SwitchTemplate, homeassistant.components.template.light.LightTemplate, homeassistant.components.template.fan.TemplateFan, homeassistant.components.technove.switch.TechnoVESwitchEntity, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.tasmota.fan.TasmotaFan, homeassistant.components.synology_dsm.switch.SynoDSMSurveillanceHomeModeToggle, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.switcher_kis.switch.SwitcherBaseSwitchEntity, homeassistant.components.switcher_kis.light.SwitcherBaseLightEntity, homeassistant.components.switchbot_cloud.switch.SwitchBotCloudSwitch, homeassistant.components.switchbot.light.SwitchbotLightEntity, homeassistant.components.switchbot.entity.SwitchbotSwitchedEntity, homeassistant.components.switchbee.light.SwitchBeeLightEntity, homeassistant.components.switch_as_x.entity.BaseToggleEntity, homeassistant.components.switch.light.LightSwitch, homeassistant.components.steamist.switch.SteamistSwitchEntity, homeassistant.components.starlink.switch.StarlinkSwitchEntity, homeassistant.components.snooz.fan.SnoozFan, homeassistant.components.snmp.switch.SnmpSwitch, homeassistant.components.smlight.switch.SmSwitch, homeassistant.components.smarty.switch.SmartySwitch, homeassistant.components.smarttub.switch.SmartTubPump, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.smartthings.switch.SmartThingsSwitch, homeassistant.components.smartthings.light.SmartThingsLight, homeassistant.components.smartthings.fan.SmartThingsFan, homeassistant.components.sleepiq.switch.SleepNumberPrivateSwitch, homeassistant.components.sleepiq.light.SleepIQLightEntity, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.switch.RpcScriptSwitch, homeassistant.components.shelly.switch.RpcVirtualSwitch, homeassistant.components.shelly.switch.RpcRelaySwitch, homeassistant.components.shelly.switch.BlockRelaySwitch, homeassistant.components.shelly.switch.BlockSleepingMotionSwitch, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.sensibo.switch.SensiboDeviceSwitch, homeassistant.components.script.ScriptEntity, homeassistant.components.schlage.switch.SchlageSwitch, homeassistant.components.satel_integra.switch.SatelIntegraSwitch, homeassistant.components.samsungtv.remote.SamsungTVRemote, homeassistant.components.roku.remote.RokuRemote, homeassistant.components.roborock.switch.RoborockSwitch, homeassistant.components.rituals_perfume_genie.switch.RitualsSwitchEntity, homeassistant.components.risco.switch.RiscoLocalSwitch, homeassistant.components.risco.switch.RiscoCloudSwitch, homeassistant.components.ring.switch.RingSwitch, homeassistant.components.ring.siren.RingSiren, homeassistant.components.ring.light.RingLight, homeassistant.components.ridwell.switch.RidwellSwitch, homeassistant.components.rfxtrx.switch.RfxtrxSwitch, homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic, homeassistant.components.rflink.light.ToggleRflinkLight, homeassistant.components.rest.switch.RestSwitch, homeassistant.components.reolink.switch.ReolinkChimeSwitchEntity, homeassistant.components.reolink.switch.ReolinkNVRSwitchEntity, homeassistant.components.reolink.switch.ReolinkSwitchEntity, homeassistant.components.reolink.siren.ReolinkSirenEntity, homeassistant.components.reolink.light.ReolinkHostLightEntity, homeassistant.components.reolink.light.ReolinkLightEntity, homeassistant.components.renson.switch.RensonBreezeSwitch, homeassistant.components.renson.fan.RensonFan, homeassistant.components.refoss.switch.RefossSwitch, homeassistant.components.recswitch.switch.RecSwitchSwitch, homeassistant.components.rainmachine.switch.RainMachineZoneEnabled, homeassistant.components.rainmachine.switch.RainMachineRestrictionSwitch, homeassistant.components.rainmachine.switch.RainMachineProgramEnabled, homeassistant.components.rainmachine.switch.RainMachineActivitySwitch, homeassistant.components.radiotherm.switch.RadioThermHoldSwitch, homeassistant.components.rabbitair.fan.RabbitAirFanEntity, homeassistant.components.qbittorrent.switch.QBittorrentSwitch, homeassistant.components.pyload.switch.PyLoadSwitchEntity, homeassistant.components.progettihwsw.switch.ProgettihwswSwitch, homeassistant.components.powerwall.switch.PowerwallOffGridEnabledEntity, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.plugwise.switch.PlugwiseSwitchEntity, homeassistant.components.pi_hole.switch.PiHoleSwitch, homeassistant.components.philips_js.switch.PhilipsTVAmbilightHueSwitch, homeassistant.components.philips_js.switch.PhilipsTVScreenSwitch, homeassistant.components.philips_js.remote.PhilipsTVRemote, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.overkiz.switch.OverkizSwitch, homeassistant.components.overkiz.siren.OverkizSiren, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.opentherm_gw.switch.OpenThermSwitch, homeassistant.components.onvif.switch.ONVIFSwitch, homeassistant.components.nzbget.switch.NZBGetDownloadSwitch, homeassistant.components.nissan_leaf.switch.LeafClimateSwitch, homeassistant.components.nice_go.switch.NiceGOSwitchEntity, homeassistant.components.nice_go.light.NiceGOLightEntity, homeassistant.components.nibe_heatpump.switch.Switch, homeassistant.components.nextdns.switch.NextDnsSwitch, homeassistant.components.nexia.switch.NexiaEmergencyHeatSwitch, homeassistant.components.nexia.switch.NexiaHoldSwitch, homeassistant.components.netgear.switch.NetgearAllowBlock, homeassistant.components.netatmo.switch.NetatmoSwitch, homeassistant.components.netatmo.light.NetatmoLight, homeassistant.components.netatmo.light.NetatmoCameraLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.myuplink.switch.MyUplinkDevicePointSwitch, homeassistant.components.mystrom.switch.MyStromSwitch, homeassistant.components.mystrom.light.MyStromLight, homeassistant.components.mysensors.switch.MySensorsSwitch, homeassistant.components.mysensors.remote.MySensorsRemote, homeassistant.components.mysensors.light.MySensorsLight, homeassistant.components.mqtt.switch.MqttSwitch, homeassistant.components.mqtt.siren.MqttSiren, homeassistant.components.mqtt.light.schema_template.MqttLightTemplate, homeassistant.components.mqtt.light.schema_json.MqttLightJson, homeassistant.components.mqtt.light.schema_basic.MqttLight, homeassistant.components.mqtt.humidifier.MqttHumidifier, homeassistant.components.mqtt.fan.MqttFan, homeassistant.components.motioneye.switch.MotionEyeSwitch, homeassistant.components.modern_forms.switch.ModernFormsAdaptiveLearningSwitch, homeassistant.components.modern_forms.switch.ModernFormsAwaySwitch, homeassistant.components.modern_forms.light.ModernFormsLightEntity, homeassistant.components.modern_forms.fan.ModernFormsFanEntity, homeassistant.components.modbus.entity.BaseSwitch, homeassistant.components.microbees.switch.MBSwitch, homeassistant.components.microbees.light.MBLight, homeassistant.components.melnor.switch.MelnorZoneSwitch, homeassistant.components.matter.switch.MatterSwitch, homeassistant.components.matter.light.MatterLight, homeassistant.components.matter.fan.MatterFan, homeassistant.components.madvr.remote.MadvrRemote, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lutron_caseta.fan.LutronCasetaFan, homeassistant.components.lookin.light.LookinLightEntity, homeassistant.components.livisi.switch.LivisiSwitch, homeassistant.components.litterrobot.switch.RobotSwitchEntity, homeassistant.components.litejet.switch.LiteJetSwitch, homeassistant.components.litejet.light.LiteJetLight, homeassistant.components.linear_garage_door.light.LinearLightEntity, homeassistant.components.lightwave.switch.LWRFSwitch, homeassistant.components.lightwave.light.LWRFLight, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lg_thinq.switch.ThinQSwitchEntity, homeassistant.components.lg_thinq.fan.ThinQFanEntity, homeassistant.components.lektrico.switch.LektricoSwitch, homeassistant.components.led_ble.light.LEDBLEEntity, homeassistant.components.lcn.light.LcnRelayLight, homeassistant.components.lcn.light.LcnOutputLight, homeassistant.components.lametric.switch.LaMetricSwitchEntity, homeassistant.components.lamarzocco.switch.LaMarzoccoAutoOnOffSwitchEntity, homeassistant.components.kulersky.light.KulerskyLight, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.konnected.switch.KonnectedSwitch, homeassistant.components.knx.light._KnxLight, homeassistant.components.knx.fan.KNXFan, homeassistant.components.kmtronic.switch.KMtronicSwitch, homeassistant.components.keymitt_ble.switch.MicroBotBinarySwitch, homeassistant.components.kaleidescape.remote.KaleidescapeRemote, homeassistant.components.jvc_projector.remote.JvcProjectorRemote, homeassistant.components.juicenet.switch.JuiceNetChargeNowSwitch, homeassistant.components.isy994.switch.ISYEnableSwitchEntity, homeassistant.components.isy994.switch.ISYSwitchProgramEntity, homeassistant.components.isy994.switch.ISYSwitchEntity, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.isy994.fan.ISYFanProgramEntity, homeassistant.components.isy994.fan.ISYFanEntity, homeassistant.components.iotty.switch.IottyLightSwitch, homeassistant.components.intellifire.light.IntellifireLight, homeassistant.components.intellifire.fan.IntellifireFan, homeassistant.components.insteon.switch.InsteonSwitchEntity, homeassistant.components.insteon.light.InsteonDimmerEntity, homeassistant.components.insteon.fan.InsteonFanEntity, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.ihc.switch.IHCSwitch, homeassistant.components.ihc.light.IhcLight, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.husqvarna_automower.switch.WorkAreaSwitchEntity, homeassistant.components.husqvarna_automower.switch.StayOutZoneSwitchEntity, homeassistant.components.husqvarna_automower.switch.AutomowerScheduleSwitchEntity, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.switch.HueResourceEnabledEntity, homeassistant.components.honeywell.switch.HoneywellSwitch, homeassistant.components.homewizard.switch.HomeWizardSwitchEntity, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.switch.HomematicipMultiSwitch, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.light.HomematicipMultiDimmer, homeassistant.components.homematicip_cloud.light.HomematicipLight, homeassistant.components.homekit_controller.switch.DeclarativeCharacteristicSwitch, homeassistant.components.homekit_controller.switch.HomeKitValve, homeassistant.components.homekit_controller.switch.HomeKitFaucet, homeassistant.components.homekit_controller.switch.HomeKitSwitch, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.homekit_controller.fan.BaseHomeKitFan, homeassistant.components.home_connect.switch.HomeConnectPowerSwitch, homeassistant.components.home_connect.switch.HomeConnectProgramSwitch, homeassistant.components.home_connect.light.HomeConnectLight, homeassistant.components.hlk_sw16.switch.SW16Switch, homeassistant.components.hive.switch.HiveSwitch, homeassistant.components.hive.light.HiveDeviceLight, homeassistant.components.harmony.remote.HarmonyRemote, homeassistant.components.habitica.switch.HabiticaSwitch, homeassistant.components.guardian.switch.ValveControllerSwitch, homeassistant.components.group.switch.SwitchGroup, homeassistant.components.group.light.LightGroup, homeassistant.components.group.fan.FanGroup, homeassistant.components.gree.switch.GreeSwitch, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.goalzero.switch.GoalZeroSwitch, homeassistant.components.geniushub.switch.GeniusSwitch, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gardena_bluetooth.switch.GardenaBluetoothValveSwitch, homeassistant.components.fully_kiosk.switch.FullySwitchEntity, homeassistant.components.fritzbox.switch.FritzboxSwitch, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.fritz.switch.FritzBoxProfileSwitch, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.fritz.switch.FritzBoxBaseCoordinatorSwitch, homeassistant.components.freedompro.switch.Device, homeassistant.components.freedompro.light.Device, homeassistant.components.freedompro.fan.FreedomproFan, homeassistant.components.freebox.switch.FreeboxSwitch, homeassistant.components.foscam.switch.FoscamSleepSwitch, homeassistant.components.flux_led.switch.FluxMusicSwitch, homeassistant.components.flux_led.switch.FluxRemoteAccessSwitch, homeassistant.components.flo.switch.FloSwitch, homeassistant.components.flipr.switch.FliprHubSwitch, homeassistant.components.flexit_bacnet.switch.FlexitSwitch, homeassistant.components.fjaraskupan.light.Light, homeassistant.components.fjaraskupan.fan.Fan, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.ezviz.switch.EzvizSwitch, homeassistant.components.ezviz.siren.EzvizSirenEntity, homeassistant.components.ezviz.light.EzvizLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.everlights.light.EverLightsLight, homeassistant.components.esphome.switch.EsphomeSwitch, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.esphome.fan.EsphomeFan, homeassistant.components.eq3btsmart.switch.Eq3SwitchEntity, homeassistant.components.envisalink.switch.EnvisalinkSwitch, homeassistant.components.enphase_envoy.switch.EnvoyStorageSettingsSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyDryContactSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyEnpowerSwitchEntity, homeassistant.components.elmax.switch.ElmaxSwitch, homeassistant.components.elkm1.switch.ElkThermostatEMHeat, homeassistant.components.elkm1.switch.ElkOutput, homeassistant.components.elkm1.light.ElkLight, homeassistant.components.elgato.switch.ElgatoSwitchEntity, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.ecovacs.switch.EcovacsSwitchEntity, homeassistant.components.ecoforest.switch.EcoforestSwitchEntity, homeassistant.components.ecobee.switch.EcobeeVentilator20MinSwitch, homeassistant.components.dynalite.switch.DynaliteSwitch, homeassistant.components.dynalite.light.DynaliteLight, homeassistant.components.duotecno.switch.DuotecnoSwitch, homeassistant.components.duotecno.light.DuotecnoLight, homeassistant.components.drop_connect.switch.DROPSwitch, homeassistant.components.directv.remote.DIRECTVRemote, homeassistant.components.demo.siren.DemoSiren, homeassistant.components.demo.light.DemoLight, homeassistant.components.demo.humidifier.DemoHumidifier, homeassistant.components.demo.fan.AsyncDemoPercentageFan, homeassistant.components.deconz.siren.DeconzSiren, homeassistant.components.deconz.fan.DeconzFan, homeassistant.components.deako.light.DeakoLightEntity, homeassistant.components.daikin.switch.DaikinToggleSwitch, homeassistant.components.daikin.switch.DaikinStreamerSwitch, homeassistant.components.daikin.switch.DaikinZoneSwitch, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.control4.light.Control4Light, homeassistant.components.command_line.switch.CommandSwitch, homeassistant.components.comelit.switch.ComelitSwitchEntity, homeassistant.components.comelit.light.ComelitLightEntity, homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, homeassistant.components.chacon_dio.switch.ChaconDioSwitch, homeassistant.components.cambridge_audio.switch.CambridgeAudioSwitch, homeassistant.components.broadlink.switch.BroadlinkSwitch, homeassistant.components.broadlink.remote.BroadlinkRemote, homeassistant.components.broadlink.light.BroadlinkLight, homeassistant.components.braviatv.remote.BraviaTVRemote, homeassistant.components.bond.switch.BondSwitch, homeassistant.components.bond.light.BondFireplace, homeassistant.components.bond.light.BondUpLight, homeassistant.components.bond.light.BondDownLight, homeassistant.components.bond.light.BondLight, homeassistant.components.bond.fan.BondFan, homeassistant.components.bmw_connected_drive.switch.BMWSwitch, homeassistant.components.blink.switch.BlinkSwitch, homeassistant.components.blebox.switch.BleBoxSwitchEntity, homeassistant.components.blebox.light.BleBoxLightEntity, homeassistant.components.balboa.light.BalboaLightEntity, homeassistant.components.balboa.fan.BalboaPumpFanEntity, homeassistant.components.baf.switch.BAFSwitch, homeassistant.components.baf.light.BAFLight, homeassistant.components.baf.fan.BAFFan, homeassistant.components.axis.switch.AxisSwitch, homeassistant.components.axis.light.AxisLight, homeassistant.components.automation.AutomationEntity, homeassistant.components.aten_pe.switch.AtenSwitch, homeassistant.components.apsystems.switch.ApSystemsInverterSwitch, homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity, homeassistant.components.apple_tv.remote.AppleTVRemote, homeassistant.components.androidtv_remote.remote.AndroidTVRemoteEntity, homeassistant.components.androidtv.remote.AndroidTVRemote, homeassistant.components.android_ip_webcam.switch.IPWebcamSettingSwitch, homeassistant.components.amcrest.switch.AmcrestSwitch, homeassistant.components.airzone_cloud.switch.AirzoneZoneSwitch, homeassistant.components.airzone.switch.AirzoneZoneSwitch, homeassistant.components.airgradient.switch.AirGradientSwitch, homeassistant.components.advantage_air.switch.AdvantageAirMyFan, homeassistant.components.advantage_air.switch.AdvantageAirFreshAir, homeassistant.components.advantage_air.light.AdvantageAirLight, and homeassistant.components.adguard.switch.AdGuardHomeSwitch.

Definition at line 1709 of file entity.py.

async_turn_on()

None homeassistant.helpers.entity.ToggleEntity.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the entity on.

Reimplemented in homeassistant.components.zwave_js.siren.ZwaveSirenEntity, homeassistant.components.zwave_js.light.ZwaveColorOnOffLight, homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.zha.switch.Switch, homeassistant.components.zha.siren.ZHASiren, homeassistant.components.zha.light.Light, homeassistant.components.zerproc.light.ZerprocLight, homeassistant.components.yolink.switch.YoLinkSwitchEntity, homeassistant.components.yolink.siren.YoLinkSirenEntity, homeassistant.components.yolink.light.YoLinkDimmerEntity, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yardian.switch.YardianSwitch, homeassistant.components.yamaha_musiccast.switch.SwitchCapability, homeassistant.components.yale_smart_alarm.switch.YaleAutolockSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiAirConditioningCompanionSwitch, homeassistant.components.xiaomi_miio.switch.ChuangMiPlugSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGatewaySwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGenericCoordinatedSwitch, homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsMoonlightLamp, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsEyecareLampAmbientLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.wyoming.switch.WyomingSatelliteMuteSwitch, homeassistant.components.wmspro.light.WebControlProDimmer, homeassistant.components.wmspro.light.WebControlProLight, homeassistant.components.wled.switch.WLEDReverseSwitch, homeassistant.components.wled.switch.WLEDSyncReceiveSwitch, homeassistant.components.wled.switch.WLEDSyncSendSwitch, homeassistant.components.wled.switch.WLEDNightlightSwitch, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wiz.switch.WizSocketEntity, homeassistant.components.wiz.light.WizBulbEntity, homeassistant.components.wilight.switch.WiLightValvePauseSwitch, homeassistant.components.wilight.switch.WiLightValveSwitch, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.wilight.light.WiLightLightDimmer, homeassistant.components.wilight.light.WiLightLightOnOff, homeassistant.components.wallbox.switch.WallboxSwitch, homeassistant.components.volvooncall.switch.VolvoSwitch, homeassistant.components.voip.switch.VoIPCallAllowedSwitch, homeassistant.components.versasense.switch.VActuator, homeassistant.components.verisure.switch.VerisureSmartplug, homeassistant.components.velux.light.VeluxLight, homeassistant.components.velbus.switch.VelbusSwitch, homeassistant.components.velbus.light.VelbusButtonLight, homeassistant.components.velbus.light.VelbusLight, homeassistant.components.vallox.switch.ValloxSwitchEntity, homeassistant.components.v2c.switch.V2CSwitchEntity, homeassistant.components.uptimerobot.switch.UptimeRobotSwitch, homeassistant.components.upb.light.UpbLight, homeassistant.components.unifiprotect.switch.ProtectPrivacyModeSwitch, homeassistant.components.unifiprotect.light.ProtectLight, homeassistant.components.unifi.switch.UnifiSwitchEntity, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.transmission.switch.TransmissionSwitch, homeassistant.components.tradfri.switch.TradfriSwitch, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.tractive.switch.TractiveSwitch, homeassistant.components.tplink_omada.switch.OmadaDevicePortSwitchEntity, homeassistant.components.tplink.switch.TPLinkSwitch, homeassistant.components.tplink.siren.TPLinkSirenEntity, homeassistant.components.tplink.light.TPLinkLightEffectEntity, homeassistant.components.tplink.light.TPLinkLightEntity, homeassistant.components.toon.switch.ToonHolidayModeSwitch, homeassistant.components.toon.switch.ToonProgramSwitch, homeassistant.components.tessie.switch.TessieStormModeSwitchEntity, homeassistant.components.tessie.switch.TessieChargeFromGridSwitchEntity, homeassistant.components.tessie.switch.TessieSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryStormModeSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryChargeFromGridSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryVehicleSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetStormModeSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetChargeFromGridSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetVehicleSwitchEntity, homeassistant.components.template.switch.SwitchTemplate, homeassistant.components.template.light.LightTemplate, homeassistant.components.technove.switch.TechnoVESwitchEntity, homeassistant.components.tasmota.switch.TasmotaSwitch, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.synology_dsm.switch.SynoDSMSurveillanceHomeModeToggle, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.switcher_kis.switch.SwitcherBaseSwitchEntity, homeassistant.components.switcher_kis.light.SwitcherBaseLightEntity, homeassistant.components.switchbot_cloud.switch.SwitchBotCloudSwitch, homeassistant.components.switchbot.light.SwitchbotLightEntity, homeassistant.components.switchbot.entity.SwitchbotSwitchedEntity, homeassistant.components.switchbee.light.SwitchBeeLightEntity, homeassistant.components.switch_as_x.entity.BaseToggleEntity, homeassistant.components.switch.light.LightSwitch, homeassistant.components.supla.switch.SuplaSwitchEntity, homeassistant.components.steamist.switch.SteamistSwitchEntity, homeassistant.components.starlink.switch.StarlinkSwitchEntity, homeassistant.components.snmp.switch.SnmpSwitch, homeassistant.components.smlight.switch.SmSwitch, homeassistant.components.smarty.switch.SmartySwitch, homeassistant.components.smarttub.switch.SmartTubPump, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.smartthings.light.SmartThingsLight, homeassistant.components.sleepiq.switch.SleepNumberPrivateSwitch, homeassistant.components.sleepiq.light.SleepIQLightEntity, homeassistant.components.skybell.switch.SkybellSwitch, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.switch.RpcScriptSwitch, homeassistant.components.shelly.switch.RpcVirtualSwitch, homeassistant.components.shelly.switch.RpcRelaySwitch, homeassistant.components.shelly.switch.BlockRelaySwitch, homeassistant.components.shelly.switch.BlockSleepingMotionSwitch, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.sensibo.switch.SensiboDeviceSwitch, homeassistant.components.script.ScriptEntity, homeassistant.components.schlage.switch.SchlageSwitch, homeassistant.components.satel_integra.switch.SatelIntegraSwitch, homeassistant.components.samsungtv.remote.SamsungTVRemote, homeassistant.components.roku.remote.RokuRemote, homeassistant.components.roborock.switch.RoborockSwitch, homeassistant.components.rituals_perfume_genie.switch.RitualsSwitchEntity, homeassistant.components.risco.switch.RiscoLocalSwitch, homeassistant.components.risco.switch.RiscoCloudSwitch, homeassistant.components.ring.switch.RingSwitch, homeassistant.components.ring.siren.RingSiren, homeassistant.components.ring.light.RingLight, homeassistant.components.ridwell.switch.RidwellSwitch, homeassistant.components.rfxtrx.switch.RfxtrxSwitch, homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic, homeassistant.components.rfxtrx.siren.RfxtrxChime, homeassistant.components.rflink.light.ToggleRflinkLight, homeassistant.components.rflink.light.HybridRflinkLight, homeassistant.components.rflink.light.DimmableRflinkLight, homeassistant.components.rest.switch.RestSwitch, homeassistant.components.reolink.switch.ReolinkChimeSwitchEntity, homeassistant.components.reolink.switch.ReolinkNVRSwitchEntity, homeassistant.components.reolink.switch.ReolinkSwitchEntity, homeassistant.components.reolink.siren.ReolinkSirenEntity, homeassistant.components.reolink.light.ReolinkHostLightEntity, homeassistant.components.reolink.light.ReolinkLightEntity, homeassistant.components.renson.switch.RensonBreezeSwitch, homeassistant.components.refoss.switch.RefossSwitch, homeassistant.components.recswitch.switch.RecSwitchSwitch, homeassistant.components.rainmachine.switch.RainMachineZoneEnabled, homeassistant.components.rainmachine.switch.RainMachineRestrictionSwitch, homeassistant.components.rainmachine.switch.RainMachineProgramEnabled, homeassistant.components.rainmachine.switch.RainMachineActivitySwitch, homeassistant.components.radiotherm.switch.RadioThermHoldSwitch, homeassistant.components.qbittorrent.switch.QBittorrentSwitch, homeassistant.components.pyload.switch.PyLoadSwitchEntity, homeassistant.components.progettihwsw.switch.ProgettihwswSwitch, homeassistant.components.powerwall.switch.PowerwallOffGridEnabledEntity, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.plugwise.switch.PlugwiseSwitchEntity, homeassistant.components.pi_hole.switch.PiHoleSwitch, homeassistant.components.philips_js.switch.PhilipsTVAmbilightHueSwitch, homeassistant.components.philips_js.switch.PhilipsTVScreenSwitch, homeassistant.components.philips_js.remote.PhilipsTVRemote, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.overkiz.switch.OverkizSwitch, homeassistant.components.overkiz.siren.OverkizSiren, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.opentherm_gw.switch.OpenThermSwitch, homeassistant.components.onvif.switch.ONVIFSwitch, homeassistant.components.nzbget.switch.NZBGetDownloadSwitch, homeassistant.components.nissan_leaf.switch.LeafClimateSwitch, homeassistant.components.nice_go.switch.NiceGOSwitchEntity, homeassistant.components.nice_go.light.NiceGOLightEntity, homeassistant.components.nibe_heatpump.switch.Switch, homeassistant.components.nextdns.switch.NextDnsSwitch, homeassistant.components.nexia.switch.NexiaEmergencyHeatSwitch, homeassistant.components.nexia.switch.NexiaHoldSwitch, homeassistant.components.netgear.switch.NetgearAllowBlock, homeassistant.components.netatmo.switch.NetatmoSwitch, homeassistant.components.netatmo.light.NetatmoLight, homeassistant.components.netatmo.light.NetatmoCameraLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.myuplink.switch.MyUplinkDevicePointSwitch, homeassistant.components.mystrom.switch.MyStromSwitch, homeassistant.components.mystrom.light.MyStromLight, homeassistant.components.mysensors.switch.MySensorsSwitch, homeassistant.components.mysensors.remote.MySensorsRemote, homeassistant.components.mysensors.light.MySensorsLightRGBW, homeassistant.components.mysensors.light.MySensorsLightRGB, homeassistant.components.mysensors.light.MySensorsLightDimmer, homeassistant.components.mqtt.switch.MqttSwitch, homeassistant.components.mqtt.siren.MqttSiren, homeassistant.components.mqtt.light.schema_template.MqttLightTemplate, homeassistant.components.mqtt.light.schema_json.MqttLightJson, homeassistant.components.mqtt.light.schema_basic.MqttLight, homeassistant.components.mqtt.humidifier.MqttHumidifier, homeassistant.components.motioneye.switch.MotionEyeSwitch, homeassistant.components.modern_forms.switch.ModernFormsAdaptiveLearningSwitch, homeassistant.components.modern_forms.switch.ModernFormsAwaySwitch, homeassistant.components.modern_forms.light.ModernFormsLightEntity, homeassistant.components.modbus.switch.ModbusSwitch, homeassistant.components.modbus.light.ModbusLight, homeassistant.components.microbees.switch.MBSwitch, homeassistant.components.microbees.light.MBLight, homeassistant.components.melnor.switch.MelnorZoneSwitch, homeassistant.components.matter.switch.MatterSwitch, homeassistant.components.matter.light.MatterLight, homeassistant.components.madvr.remote.MadvrRemote, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lookin.light.LookinLightEntity, homeassistant.components.livisi.switch.LivisiSwitch, homeassistant.components.litterrobot.switch.RobotSwitchEntity, homeassistant.components.litejet.switch.LiteJetSwitch, homeassistant.components.litejet.light.LiteJetLight, homeassistant.components.linear_garage_door.light.LinearLightEntity, homeassistant.components.lightwave.switch.LWRFSwitch, homeassistant.components.lightwave.light.LWRFLight, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lg_thinq.switch.ThinQSwitchEntity, homeassistant.components.lektrico.switch.LektricoSwitch, homeassistant.components.led_ble.light.LEDBLEEntity, homeassistant.components.lcn.light.LcnRelayLight, homeassistant.components.lcn.light.LcnOutputLight, homeassistant.components.lametric.switch.LaMetricSwitchEntity, homeassistant.components.lamarzocco.switch.LaMarzoccoAutoOnOffSwitchEntity, homeassistant.components.lamarzocco.switch.LaMarzoccoSwitchEntity, homeassistant.components.kulersky.light.KulerskyLight, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.konnected.switch.KonnectedSwitch, homeassistant.components.knx.light._KnxLight, homeassistant.components.kmtronic.switch.KMtronicSwitch, homeassistant.components.keymitt_ble.switch.MicroBotBinarySwitch, homeassistant.components.kaleidescape.remote.KaleidescapeRemote, homeassistant.components.jvc_projector.remote.JvcProjectorRemote, homeassistant.components.juicenet.switch.JuiceNetChargeNowSwitch, homeassistant.components.isy994.switch.ISYEnableSwitchEntity, homeassistant.components.isy994.switch.ISYSwitchProgramEntity, homeassistant.components.isy994.switch.ISYSwitchEntity, homeassistant.components.iotty.switch.IottyLightSwitch, homeassistant.components.intellifire.switch.IntellifireSwitch, homeassistant.components.intellifire.light.IntellifireLight, homeassistant.components.insteon.switch.InsteonSwitchEntity, homeassistant.components.insteon.light.InsteonDimmerEntity, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.ihc.switch.IHCSwitch, homeassistant.components.ihc.light.IhcLight, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hydrawise.switch.HydrawiseSwitch, homeassistant.components.husqvarna_automower.switch.WorkAreaSwitchEntity, homeassistant.components.husqvarna_automower.switch.StayOutZoneSwitchEntity, homeassistant.components.husqvarna_automower.switch.AutomowerScheduleSwitchEntity, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.switch.HueResourceEnabledEntity, homeassistant.components.honeywell.switch.HoneywellSwitch, homeassistant.components.homewizard.switch.HomeWizardSwitchEntity, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.switch.HomematicipMultiSwitch, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.light.HomematicipMultiDimmer, homeassistant.components.homematicip_cloud.light.HomematicipLight, homeassistant.components.homekit_controller.switch.DeclarativeCharacteristicSwitch, homeassistant.components.homekit_controller.switch.HomeKitValve, homeassistant.components.homekit_controller.switch.HomeKitFaucet, homeassistant.components.homekit_controller.switch.HomeKitSwitch, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.home_connect.switch.HomeConnectPowerSwitch, homeassistant.components.home_connect.switch.HomeConnectProgramSwitch, homeassistant.components.home_connect.switch.HomeConnectSwitch, homeassistant.components.home_connect.light.HomeConnectLight, homeassistant.components.hlk_sw16.switch.SW16Switch, homeassistant.components.hive.switch.HiveSwitch, homeassistant.components.hive.light.HiveDeviceLight, homeassistant.components.harmony.remote.HarmonyRemote, homeassistant.components.habitica.switch.HabiticaSwitch, homeassistant.components.guardian.switch.ValveControllerSwitch, homeassistant.components.group.switch.SwitchGroup, homeassistant.components.group.light.LightGroup, homeassistant.components.gree.switch.GreeSwitch, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.goalzero.switch.GoalZeroSwitch, homeassistant.components.geniushub.switch.GeniusSwitch, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gardena_bluetooth.switch.GardenaBluetoothValveSwitch, homeassistant.components.fully_kiosk.switch.FullySwitchEntity, homeassistant.components.fritzbox.switch.FritzboxSwitch, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.fritz.switch.FritzBoxProfileSwitch, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.fritz.switch.FritzBoxBaseCoordinatorSwitch, homeassistant.components.freedompro.switch.Device, homeassistant.components.freedompro.light.Device, homeassistant.components.freebox.switch.FreeboxSwitch, homeassistant.components.foscam.switch.FoscamSleepSwitch, homeassistant.components.flux_led.switch.FluxMusicSwitch, homeassistant.components.flux_led.switch.FluxRemoteAccessSwitch, homeassistant.components.flo.switch.FloSwitch, homeassistant.components.flipr.switch.FliprHubSwitch, homeassistant.components.flexit_bacnet.switch.FlexitSwitch, homeassistant.components.fjaraskupan.light.Light, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.ezviz.switch.EzvizSwitch, homeassistant.components.ezviz.siren.EzvizSirenEntity, homeassistant.components.ezviz.light.EzvizLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.everlights.light.EverLightsLight, homeassistant.components.esphome.switch.EsphomeSwitch, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.eq3btsmart.switch.Eq3SwitchEntity, homeassistant.components.envisalink.switch.EnvisalinkSwitch, homeassistant.components.enphase_envoy.switch.EnvoyStorageSettingsSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyDryContactSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyEnpowerSwitchEntity, homeassistant.components.elmax.switch.ElmaxSwitch, homeassistant.components.elkm1.switch.ElkThermostatEMHeat, homeassistant.components.elkm1.switch.ElkOutput, homeassistant.components.elkm1.light.ElkLight, homeassistant.components.elgato.switch.ElgatoSwitchEntity, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.ecovacs.switch.EcovacsSwitchEntity, homeassistant.components.ecoforest.switch.EcoforestSwitchEntity, homeassistant.components.ecobee.switch.EcobeeVentilator20MinSwitch, homeassistant.components.dynalite.switch.DynaliteSwitch, homeassistant.components.dynalite.light.DynaliteLight, homeassistant.components.duotecno.switch.DuotecnoSwitch, homeassistant.components.duotecno.light.DuotecnoLight, homeassistant.components.drop_connect.switch.DROPSwitch, homeassistant.components.directv.remote.DIRECTVRemote, homeassistant.components.demo.siren.DemoSiren, homeassistant.components.demo.light.DemoLight, homeassistant.components.demo.humidifier.DemoHumidifier, homeassistant.components.deconz.siren.DeconzSiren, homeassistant.components.deako.light.DeakoLightEntity, homeassistant.components.daikin.switch.DaikinToggleSwitch, homeassistant.components.daikin.switch.DaikinStreamerSwitch, homeassistant.components.daikin.switch.DaikinZoneSwitch, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.control4.light.Control4Light, homeassistant.components.command_line.switch.CommandSwitch, homeassistant.components.comelit.switch.ComelitSwitchEntity, homeassistant.components.comelit.light.ComelitLightEntity, homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, homeassistant.components.chacon_dio.switch.ChaconDioSwitch, homeassistant.components.cambridge_audio.switch.CambridgeAudioSwitch, homeassistant.components.broadlink.switch.BroadlinkSwitch, homeassistant.components.broadlink.remote.BroadlinkRemote, homeassistant.components.broadlink.light.BroadlinkLight, homeassistant.components.braviatv.remote.BraviaTVRemote, homeassistant.components.bond.switch.BondSwitch, homeassistant.components.bond.light.BondFireplace, homeassistant.components.bond.light.BondUpLight, homeassistant.components.bond.light.BondDownLight, homeassistant.components.bond.light.BondLight, homeassistant.components.bmw_connected_drive.switch.BMWSwitch, homeassistant.components.blink.switch.BlinkSwitch, homeassistant.components.blebox.switch.BleBoxSwitchEntity, homeassistant.components.blebox.light.BleBoxLightEntity, homeassistant.components.balboa.light.BalboaLightEntity, homeassistant.components.baf.switch.BAFSwitch, homeassistant.components.baf.light.BAFStandaloneLight, homeassistant.components.baf.light.BAFLight, homeassistant.components.axis.switch.AxisSwitch, homeassistant.components.axis.light.AxisLight, homeassistant.components.automation.AutomationEntity, homeassistant.components.aten_pe.switch.AtenSwitch, homeassistant.components.apsystems.switch.ApSystemsInverterSwitch, homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity, homeassistant.components.apple_tv.remote.AppleTVRemote, homeassistant.components.androidtv_remote.remote.AndroidTVRemoteEntity, homeassistant.components.androidtv.remote.AndroidTVRemote, homeassistant.components.android_ip_webcam.switch.IPWebcamSettingSwitch, homeassistant.components.amcrest.switch.AmcrestSwitch, homeassistant.components.airzone_cloud.switch.AirzoneZoneSwitch, homeassistant.components.airzone.switch.AirzoneZoneSwitch, homeassistant.components.airgradient.switch.AirGradientSwitch, homeassistant.components.advantage_air.switch.AdvantageAirMyFan, homeassistant.components.advantage_air.switch.AdvantageAirFreshAir, homeassistant.components.advantage_air.light.AdvantageAirThingLightDimmable, homeassistant.components.advantage_air.light.AdvantageAirLightDimmable, homeassistant.components.advantage_air.light.AdvantageAirLight, and homeassistant.components.adguard.switch.AdGuardHomeSwitch.

Definition at line 1701 of file entity.py.

is_on()

bool | None homeassistant.helpers.entity.ToggleEntity.is_on

(

self

)

Return True if entity is on.

Reimplemented in homeassistant.components.zwave_me.switch.ZWaveMeSwitch, homeassistant.components.zwave_me.siren.ZWaveMeSiren, homeassistant.components.zwave_me.light.ZWaveMeRGB, homeassistant.components.zwave_js.siren.ZwaveSirenEntity, homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.zwave_js.fan.ZwaveThermostatFan, homeassistant.components.zwave_js.fan.ZwaveFan, homeassistant.components.zoneminder.switch.ZMSwitchMonitors, homeassistant.components.zha.switch.Switch, homeassistant.components.zha.siren.ZHASiren, homeassistant.components.zha.light.Light, homeassistant.components.yeelight.light.YeelightNightLightMode, homeassistant.components.yeelight.light.YeelightWithNightLight, homeassistant.components.yeelight.light.YeelightColorLightWithNightlightSwitch, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yardian.switch.YardianSwitch, homeassistant.components.yamaha_musiccast.switch.SwitchCapability, homeassistant.components.xs1.switch.XS1SwitchEntity, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGatewaySwitch, homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier, homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier, homeassistant.components.xiaomi_miio.fan.XiaomiGenericDevice, homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch, homeassistant.components.xiaomi_aqara.light.XiaomiGatewayLight, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.x10.light.X10Light, homeassistant.components.wmspro.light.WebControlProLight, homeassistant.components.wled.switch.WLEDReverseSwitch, homeassistant.components.wled.switch.WLEDSyncReceiveSwitch, homeassistant.components.wled.switch.WLEDSyncSendSwitch, homeassistant.components.wled.switch.WLEDNightlightSwitch, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wirelesstag.switch.WirelessTagSwitch, homeassistant.components.wilight.switch.WiLightValvePauseSwitch, homeassistant.components.wilight.switch.WiLightValveSwitch, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.wilight.light.WiLightLightDimmer, homeassistant.components.wilight.light.WiLightLightOnOff, homeassistant.components.wilight.fan.WiLightFan, homeassistant.components.wemo.light.WemoLight, homeassistant.components.wallbox.switch.WallboxSwitch, homeassistant.components.wake_on_lan.switch.WolSwitch, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.volvooncall.switch.VolvoSwitch, homeassistant.components.vicare.fan.ViCareFan, homeassistant.components.vesync.entity.VeSyncDevice, homeassistant.components.versasense.switch.VActuator, homeassistant.components.verisure.switch.VerisureSmartplug, homeassistant.components.velux.light.VeluxLight, homeassistant.components.velbus.switch.VelbusSwitch, homeassistant.components.velbus.light.VelbusButtonLight, homeassistant.components.velbus.light.VelbusLight, homeassistant.components.vallox.switch.ValloxSwitchEntity, homeassistant.components.vallox.fan.ValloxFanEntity, homeassistant.components.v2c.switch.V2CSwitchEntity, homeassistant.components.uptimerobot.switch.UptimeRobotSwitch, homeassistant.components.upb.light.UpbLight, homeassistant.components.tuya.switch.TuyaSwitchEntity, homeassistant.components.tuya.siren.TuyaSirenEntity, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tuya.humidifier.TuyaHumidifierEntity, homeassistant.components.tuya.fan.TuyaFanEntity, homeassistant.components.transmission.switch.TransmissionSwitch, homeassistant.components.tradfri.switch.TradfriSwitch, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.tradfri.fan.TradfriAirPurifierFan, homeassistant.components.toon.switch.ToonSwitch, homeassistant.components.tolo.switch.ToloSwitchEntity, homeassistant.components.tolo.light.ToloLight, homeassistant.components.tolo.fan.ToloFan, homeassistant.components.thinkingcleaner.switch.ThinkingCleanerSwitch, homeassistant.components.tessie.switch.TessieChargeSwitchEntity, homeassistant.components.tessie.switch.TessieSwitchEntity, homeassistant.components.template.switch.SwitchTemplate, homeassistant.components.template.light.LightTemplate, homeassistant.components.template.fan.TemplateFan, homeassistant.components.tellduslive.switch.TelldusLiveSwitch, homeassistant.components.tellduslive.light.TelldusLiveLight, homeassistant.components.technove.switch.TechnoVESwitchEntity, homeassistant.components.synology_dsm.switch.SynoDSMSurveillanceHomeModeToggle, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.switcher_kis.switch.SwitcherBaseSwitchEntity, homeassistant.components.switcher_kis.light.SwitcherBaseLightEntity, homeassistant.components.switchbot.switch.SwitchBotSwitch, homeassistant.components.switchbot.humidifier.SwitchBotHumidifier, homeassistant.components.switch_as_x.fan.FanSwitch, homeassistant.components.steamist.switch.SteamistSwitchEntity, homeassistant.components.starlink.switch.StarlinkSwitchEntity, homeassistant.components.starline.switch.StarlineSwitch, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.switch.SonosSwitchEntity, homeassistant.components.snooz.fan.SnoozFan, homeassistant.components.snmp.switch.SnmpSwitch, homeassistant.components.smlight.switch.SmSwitch, homeassistant.components.smarty.switch.SmartySwitch, homeassistant.components.smarty.fan.SmartyFan, homeassistant.components.smarttub.switch.SmartTubPump, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.smartthings.light.SmartThingsLight, homeassistant.components.smartthings.fan.SmartThingsFan, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.switch.RpcScriptSwitch, homeassistant.components.shelly.switch.RpcVirtualSwitch, homeassistant.components.shelly.switch.RpcRelaySwitch, homeassistant.components.shelly.switch.BlockRelaySwitch, homeassistant.components.shelly.switch.BlockSleepingMotionSwitch, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.sensibo.switch.SensiboDeviceSwitch, homeassistant.components.scsgate.switch.SCSGateSwitch, homeassistant.components.scsgate.light.SCSGateLight, homeassistant.components.script.ScriptEntity, homeassistant.components.schlage.switch.SchlageSwitch, homeassistant.components.satel_integra.switch.SatelIntegraSwitch, homeassistant.components.roku.remote.RokuRemote, homeassistant.components.roborock.switch.RoborockSwitch, homeassistant.components.risco.switch.RiscoLocalSwitch, homeassistant.components.risco.switch.RiscoCloudSwitch, homeassistant.components.ridwell.switch.RidwellSwitch, homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic, homeassistant.components.rfxtrx.siren.RfxtrxChime, homeassistant.components.reolink.switch.ReolinkChimeSwitchEntity, homeassistant.components.reolink.switch.ReolinkNVRSwitchEntity, homeassistant.components.reolink.switch.ReolinkSwitchEntity, homeassistant.components.reolink.light.ReolinkHostLightEntity, homeassistant.components.reolink.light.ReolinkLightEntity, homeassistant.components.remote_rpi_gpio.switch.RemoteRPiGPIOSwitch, homeassistant.components.refoss.switch.RefossSwitch, homeassistant.components.recswitch.switch.RecSwitchSwitch, homeassistant.components.raspyrfm.switch.RaspyRFMSwitch, homeassistant.components.raincloud.switch.RainCloudSwitch, homeassistant.components.rainbird.switch.RainBirdSwitch, homeassistant.components.qbittorrent.switch.QBittorrentSwitch, homeassistant.components.pyload.switch.PyLoadSwitchEntity, homeassistant.components.pulseaudio_loopback.switch.PALoopbackSwitch, homeassistant.components.progettihwsw.switch.ProgettihwswSwitch, homeassistant.components.powerwall.switch.PowerwallOffGridEnabledEntity, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.plugwise.switch.PlugwiseSwitchEntity, homeassistant.components.pi_hole.switch.PiHoleSwitch, homeassistant.components.philips_js.switch.PhilipsTVAmbilightHueSwitch, homeassistant.components.philips_js.switch.PhilipsTVScreenSwitch, homeassistant.components.philips_js.remote.PhilipsTVRemote, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.pencom.switch.PencomRelay, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.overkiz.switch.OverkizSwitch, homeassistant.components.overkiz.siren.OverkizSiren, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.orvibo.switch.S20Switch, homeassistant.components.opple.light.OppleLight, homeassistant.components.onewire.switch.OneWireSwitch, homeassistant.components.omnilogic.switch.OmniLogicSwitch, homeassistant.components.nzbget.switch.NZBGetDownloadSwitch, homeassistant.components.nissan_leaf.switch.LeafClimateSwitch, homeassistant.components.nice_go.switch.NiceGOSwitchEntity, homeassistant.components.nice_go.light.NiceGOLightEntity, homeassistant.components.nexia.switch.NexiaEmergencyHeatSwitch, homeassistant.components.nexia.switch.NexiaHoldSwitch, homeassistant.components.netio.switch.NetioSwitch, homeassistant.components.neato.switch.NeatoConnectedSwitch, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.myuplink.switch.MyUplinkDevicePointSwitch, homeassistant.components.mysensors.switch.MySensorsSwitch, homeassistant.components.mysensors.remote.MySensorsRemote, homeassistant.components.mysensors.light.MySensorsLight, homeassistant.components.mqtt.fan.MqttFan, homeassistant.components.motioneye.switch.MotionEyeSwitch, homeassistant.components.modern_forms.switch.ModernFormsAdaptiveLearningSwitch, homeassistant.components.modern_forms.switch.ModernFormsAwaySwitch, homeassistant.components.modern_forms.light.ModernFormsLightEntity, homeassistant.components.modern_forms.fan.ModernFormsFanEntity, homeassistant.components.modbus.fan.ModbusFan, homeassistant.components.microbees.switch.MBSwitch, homeassistant.components.microbees.light.MBLight, homeassistant.components.mfi.switch.MfiSwitch, homeassistant.components.melnor.switch.MelnorZoneSwitch, homeassistant.components.madvr.remote.MadvrRemote, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lutron_caseta.fan.LutronCasetaFan, homeassistant.components.lupusec.switch.LupusecSwitch, homeassistant.components.litterrobot.switch.RobotSwitchEntity, homeassistant.components.linear_garage_door.light.LinearLightEntity, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lektrico.switch.LektricoSwitch, homeassistant.components.lametric.switch.LaMetricSwitchEntity, homeassistant.components.lamarzocco.switch.LaMarzoccoAutoOnOffSwitchEntity, homeassistant.components.kulersky.light.KulerskyLight, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.knx.light._KnxLight, homeassistant.components.kmtronic.switch.KMtronicSwitch, homeassistant.components.keymitt_ble.switch.MicroBotBinarySwitch, homeassistant.components.kankun.switch.KankunSwitch, homeassistant.components.kaleidescape.remote.KaleidescapeRemote, homeassistant.components.jvc_projector.remote.JvcProjectorRemote, homeassistant.components.juicenet.switch.JuiceNetChargeNowSwitch, homeassistant.components.jellyfin.remote.JellyfinRemote, homeassistant.components.itach.remote.ITachIP2IRRemote, homeassistant.components.isy994.switch.ISYEnableSwitchEntity, homeassistant.components.isy994.switch.ISYSwitchProgramEntity, homeassistant.components.isy994.switch.ISYSwitchEntity, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.isy994.fan.ISYFanProgramEntity, homeassistant.components.isy994.fan.ISYFanEntity, homeassistant.components.iotty.switch.IottyLightSwitch, homeassistant.components.intellifire.light.IntellifireLight, homeassistant.components.intellifire.fan.IntellifireFan, homeassistant.components.insteon.switch.InsteonSwitchEntity, homeassistant.components.insteon.light.InsteonDimmerEntity, homeassistant.components.ihc.light.IhcLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.husqvarna_automower.switch.WorkAreaSwitchEntity, homeassistant.components.husqvarna_automower.switch.StayOutZoneSwitchEntity, homeassistant.components.husqvarna_automower.switch.AutomowerScheduleSwitchEntity, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.hue.switch.HueResourceEnabledEntity, homeassistant.components.huawei_lte.switch.HuaweiLteWifiGuestNetworkSwitch, homeassistant.components.huawei_lte.switch.HuaweiLteMobileDataSwitch, homeassistant.components.honeywell.switch.HoneywellSwitch, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.homewizard.switch.HomeWizardSwitchEntity, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.switch.HomematicipMultiSwitch, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.light.HomematicipMultiDimmer, homeassistant.components.homematicip_cloud.light.HomematicipLight, homeassistant.components.homematic.switch.HMSwitch, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.switch.DeclarativeCharacteristicSwitch, homeassistant.components.homekit_controller.switch.HomeKitValve, homeassistant.components.homekit_controller.switch.HomeKitFaucet, homeassistant.components.homekit_controller.switch.HomeKitSwitch, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.homekit_controller.fan.BaseHomeKitFan, homeassistant.components.hlk_sw16.switch.SW16Switch, homeassistant.components.hikvisioncam.switch.HikvisionMotionSwitch, homeassistant.components.harmony.remote.HarmonyRemote, homeassistant.components.habitica.switch.HabiticaSwitch, homeassistant.components.guardian.switch.ValveControllerSwitch, homeassistant.components.group.fan.FanGroup, homeassistant.components.greenwave.light.GreenwaveLight, homeassistant.components.gree.switch.GreeSwitch, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.goalzero.switch.GoalZeroSwitch, homeassistant.components.geniushub.switch.GeniusSwitch, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gc100.switch.GC100Switch, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fritzbox.switch.FritzboxSwitch, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.fritz.switch.FritzBoxProfileSwitch, homeassistant.components.fritz.switch.FritzBoxDeflectionSwitch, homeassistant.components.freedompro.fan.FreedomproFan, homeassistant.components.foscam.switch.FoscamSleepSwitch, homeassistant.components.flux_led.switch.FluxMusicSwitch, homeassistant.components.flux_led.switch.FluxRemoteAccessSwitch, homeassistant.components.flipr.switch.FliprHubSwitch, homeassistant.components.flexit_bacnet.switch.FlexitSwitch, homeassistant.components.fjaraskupan.light.Light, homeassistant.components.fjaraskupan.fan.Fan, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.fan.FanEntity, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.everlights.light.EverLightsLight, homeassistant.components.eufy.switch.EufyHomeSwitch, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.esphome.switch.EsphomeSwitch, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.esphome.fan.EsphomeFan, homeassistant.components.eq3btsmart.switch.Eq3SwitchEntity, homeassistant.components.envisalink.switch.EnvisalinkSwitch, homeassistant.components.enphase_envoy.switch.EnvoyStorageSettingsSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyDryContactSwitchEntity, homeassistant.components.enphase_envoy.switch.EnvoyEnpowerSwitchEntity, homeassistant.components.elv.switch.SmartPlugSwitch, homeassistant.components.elmax.switch.ElmaxSwitch, homeassistant.components.elkm1.switch.ElkThermostatEMHeat, homeassistant.components.elkm1.switch.ElkOutput, homeassistant.components.elkm1.light.ElkLight, homeassistant.components.elgato.switch.ElgatoSwitchEntity, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.edimax.switch.SmartPlugSwitch, homeassistant.components.econet.switch.EcoNetSwitchAuxHeatOnly, homeassistant.components.ecoforest.switch.EcoforestSwitchEntity, homeassistant.components.ecobee.switch.EcobeeSwitchAuxHeatOnly, homeassistant.components.ecobee.humidifier.EcobeeHumidifier, homeassistant.components.dynalite.switch.DynaliteSwitch, homeassistant.components.dynalite.light.DynaliteLight, homeassistant.components.duotecno.switch.DuotecnoSwitch, homeassistant.components.duotecno.light.DuotecnoLight, homeassistant.components.drop_connect.switch.DROPSwitch, homeassistant.components.dlink.switch.SmartPlugSwitch, homeassistant.components.digital_ocean.switch.DigitalOceanSwitch, homeassistant.components.devolo_home_control.siren.DevoloSirenDeviceEntity, homeassistant.components.devolo_home_control.light.DevoloLightDeviceEntity, homeassistant.components.demo.light.DemoLight, homeassistant.components.deluge.switch.DelugeSwitch, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.deconz.siren.DeconzSiren, homeassistant.components.deconz.fan.DeconzFan, homeassistant.components.danfoss_air.switch.DanfossAir, homeassistant.components.daikin.switch.DaikinToggleSwitch, homeassistant.components.daikin.switch.DaikinStreamerSwitch, homeassistant.components.daikin.switch.DaikinZoneSwitch, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.control4.light.Control4Light, homeassistant.components.comelit.switch.ComelitSwitchEntity, homeassistant.components.comelit.light.ComelitLightEntity, homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, homeassistant.components.cambridge_audio.switch.CambridgeAudioSwitch, homeassistant.components.braviatv.remote.BraviaTVRemote, homeassistant.components.bosch_shc.switch.SHCRoutingSwitch, homeassistant.components.bosch_shc.switch.SHCSwitch, homeassistant.components.bmw_connected_drive.switch.BMWSwitch, homeassistant.components.blink.switch.BlinkSwitch, homeassistant.components.blebox.switch.BleBoxSwitchEntity, homeassistant.components.blebox.light.BleBoxLightEntity, homeassistant.components.balboa.light.BalboaLightEntity, homeassistant.components.balboa.fan.BalboaPumpFanEntity, homeassistant.components.automation.AutomationEntity, homeassistant.components.aqualogic.switch.AquaLogicSwitch, homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity, homeassistant.components.apple_tv.remote.AppleTVRemote, homeassistant.components.android_ip_webcam.switch.IPWebcamSettingSwitch, homeassistant.components.airgradient.switch.AirGradientSwitch, homeassistant.components.advantage_air.switch.AdvantageAirMyFan, homeassistant.components.advantage_air.switch.AdvantageAirFreshAir, homeassistant.components.advantage_air.light.AdvantageAirLight, homeassistant.components.ads.light.AdsLight, homeassistant.components.abode.switch.AbodeAutomationSwitch, homeassistant.components.abode.switch.AbodeSwitch, and homeassistant.components.abode.light.AbodeLight.

Definition at line 1693 of file entity.py.

state()

Literal["on", "off"] | None homeassistant.helpers.entity.ToggleEntity.state

(

self

)

Return the state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 1686 of file entity.py.

toggle()

None homeassistant.helpers.entity.ToggleEntity.toggle	(		self,
		**Any	kwargs
	)

Toggle the entity.

This method will never be called by Home Assistant and should not be implemented
by integrations.

Definition at line 1714 of file entity.py.

turn_off()

None homeassistant.helpers.entity.ToggleEntity.turn_off	(		self,
		**Any	kwargs
	)

Turn the entity off.

Reimplemented in homeassistant.components.zwave_me.switch.ZWaveMeSwitch, homeassistant.components.zwave_me.siren.ZWaveMeSiren, homeassistant.components.zwave_me.light.ZWaveMeRGB, homeassistant.components.zwave_me.fan.ZWaveMeFan, homeassistant.components.zoneminder.switch.ZMSwitchMonitors, homeassistant.components.zengge.light.ZenggeLight, homeassistant.components.yeelightsunflower.light.SunflowerBulb, homeassistant.components.xs1.switch.XS1SwitchEntity, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch, homeassistant.components.xiaomi_aqara.light.XiaomiGatewayLight, homeassistant.components.x10.light.X10Light, homeassistant.components.wirelesstag.switch.WirelessTagSwitch, homeassistant.components.wemo.switch.WemoSwitch, homeassistant.components.wemo.light.WemoDimmer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.wemo.fan.WemoHumidifier, homeassistant.components.wake_on_lan.switch.WolSwitch, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.vesync.entity.VeSyncDevice, homeassistant.components.vera.switch.VeraSwitch, homeassistant.components.vera.light.VeraLight, homeassistant.components.upcloud.switch.UpCloudSwitch, homeassistant.components.unifiled.light.UnifiLedLight, homeassistant.components.tuya.switch.TuyaSwitchEntity, homeassistant.components.tuya.siren.TuyaSirenEntity, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tuya.fan.TuyaFanEntity, homeassistant.components.tolo.switch.ToloSwitchEntity, homeassistant.components.tolo.light.ToloLight, homeassistant.components.tolo.fan.ToloFan, homeassistant.components.tikteck.light.TikteckLight, homeassistant.components.thinkingcleaner.switch.ThinkingCleanerSwitch, homeassistant.components.telnet.switch.TelnetSwitch, homeassistant.components.tellduslive.switch.TelldusLiveSwitch, homeassistant.components.tellduslive.light.TelldusLiveLight, homeassistant.components.starline.switch.StarlineSwitch, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.switch.SonosSwitchEntity, homeassistant.components.smarty.fan.SmartyFan, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.scsgate.switch.SCSGateSwitch, homeassistant.components.scsgate.light.SCSGateLight, homeassistant.components.remote_rpi_gpio.switch.RemoteRPiGPIOSwitch, homeassistant.components.raincloud.switch.RainCloudSwitch, homeassistant.components.rachio.switch.RachioValve, homeassistant.components.rachio.switch.RachioSchedule, homeassistant.components.rachio.switch.RachioZone, homeassistant.components.rachio.switch.RachioRainDelay, homeassistant.components.rachio.switch.RachioStandbySwitch, homeassistant.components.pulseaudio_loopback.switch.PALoopbackSwitch, homeassistant.components.pencom.switch.PencomRelay, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.orvibo.switch.S20Switch, homeassistant.components.opple.light.OppleLight, homeassistant.components.onewire.switch.OneWireSwitch, homeassistant.components.numato.switch.NumatoGpioSwitch, homeassistant.components.niko_home_control.light.NikoHomeControlLight, homeassistant.components.netio.switch.NetioSwitch, homeassistant.components.neato.switch.NeatoConnectedSwitch, homeassistant.components.mochad.switch.MochadSwitch, homeassistant.components.mochad.light.MochadLight, homeassistant.components.mfi.switch.MfiSwitch, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lutron.switch.LutronLed, homeassistant.components.lutron.switch.LutronSwitch, homeassistant.components.lutron.light.LutronLight, homeassistant.components.lutron.fan.LutronFan, homeassistant.components.lupusec.switch.LupusecSwitch, homeassistant.components.linode.switch.LinodeSwitch, homeassistant.components.kitchen_sink.switch.DemoSwitch, homeassistant.components.kankun.switch.KankunSwitch, homeassistant.components.itach.remote.ITachIP2IRRemote, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.huawei_lte.switch.HuaweiLteBaseSwitch, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.homematic.switch.HMSwitch, homeassistant.components.homematic.light.HMLight, homeassistant.components.hikvisioncam.switch.HikvisionMotionSwitch, homeassistant.components.greenwave.light.GreenwaveLight, homeassistant.components.gc100.switch.GC100Switch, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fibaro.switch.FibaroSwitch, homeassistant.components.fibaro.light.FibaroLight, homeassistant.components.eufy.switch.EufyHomeSwitch, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.enocean.switch.EnOceanSwitch, homeassistant.components.enocean.light.EnOceanLight, homeassistant.components.energenie_power_sockets.switch.EGPowerStripSocket, homeassistant.components.elv.switch.SmartPlugSwitch, homeassistant.components.edimax.switch.SmartPlugSwitch, homeassistant.components.econet.switch.EcoNetSwitchAuxHeatOnly, homeassistant.components.ecobee.switch.EcobeeSwitchAuxHeatOnly, homeassistant.components.ecoal_boiler.switch.EcoalSwitch, homeassistant.components.dlink.switch.SmartPlugSwitch, homeassistant.components.digital_ocean.switch.DigitalOceanSwitch, homeassistant.components.devolo_home_control.switch.DevoloSwitch, homeassistant.components.devolo_home_control.siren.DevoloSirenDeviceEntity, homeassistant.components.devolo_home_control.light.DevoloLightDeviceEntity, homeassistant.components.demo.switch.DemoSwitch, homeassistant.components.demo.remote.DemoRemote, homeassistant.components.demo.fan.DemoPercentageFan, homeassistant.components.deluge.switch.DelugeSwitch, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.decora.light.DecoraLight, homeassistant.components.danfoss_air.switch.DanfossAir, homeassistant.components.comfoconnect.fan.ComfoConnectFan, homeassistant.components.bosch_shc.switch.SHCRoutingSwitch, homeassistant.components.bosch_shc.switch.SHCSwitch, homeassistant.components.blinksticklight.light.BlinkStickLight, homeassistant.components.avion.light.AvionLight, homeassistant.components.avea.light.AveaLight, homeassistant.components.arest.switch.ArestSwitchPin, homeassistant.components.arest.switch.ArestSwitchFunction, homeassistant.components.aqualogic.switch.AquaLogicSwitch, homeassistant.components.anel_pwrctrl.switch.PwrCtrlSwitch, homeassistant.components.ads.light.AdsLight, homeassistant.components.acer_projector.switch.AcerSwitch, homeassistant.components.abode.switch.AbodeAutomationSwitch, homeassistant.components.abode.switch.AbodeSwitch, and homeassistant.components.abode.light.AbodeLight.

Definition at line 1705 of file entity.py.

turn_on()

None homeassistant.helpers.entity.ToggleEntity.turn_on	(		self,
		**Any	kwargs
	)

Turn the entity on.

Reimplemented in homeassistant.components.zwave_me.switch.ZWaveMeSwitch, homeassistant.components.zwave_me.siren.ZWaveMeSiren, homeassistant.components.zwave_me.light.ZWaveMeRGB, homeassistant.components.zoneminder.switch.ZMSwitchMonitors, homeassistant.components.zengge.light.ZenggeLight, homeassistant.components.yeelightsunflower.light.SunflowerBulb, homeassistant.components.xs1.switch.XS1SwitchEntity, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch, homeassistant.components.x10.light.X10Light, homeassistant.components.wirelesstag.switch.WirelessTagSwitch, homeassistant.components.wemo.switch.WemoSwitch, homeassistant.components.wemo.light.WemoDimmer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.wake_on_lan.switch.WolSwitch, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.vesync.switch.VeSyncBaseSwitch, homeassistant.components.vesync.light.VeSyncBaseLight, homeassistant.components.vera.switch.VeraSwitch, homeassistant.components.vera.light.VeraLight, homeassistant.components.upcloud.switch.UpCloudSwitch, homeassistant.components.unifiled.light.UnifiLedLight, homeassistant.components.tuya.switch.TuyaSwitchEntity, homeassistant.components.tuya.siren.TuyaSirenEntity, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tolo.switch.ToloSwitchEntity, homeassistant.components.tolo.light.ToloLight, homeassistant.components.tikteck.light.TikteckLight, homeassistant.components.thinkingcleaner.switch.ThinkingCleanerSwitch, homeassistant.components.telnet.switch.TelnetSwitch, homeassistant.components.tellduslive.switch.TelldusLiveSwitch, homeassistant.components.tellduslive.light.TelldusLiveLight, homeassistant.components.starline.switch.StarlineSwitch, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.switch.SonosSwitchEntity, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.scsgate.switch.SCSGateSwitch, homeassistant.components.scsgate.light.SCSGateLight, homeassistant.components.remote_rpi_gpio.switch.RemoteRPiGPIOSwitch, homeassistant.components.raincloud.switch.RainCloudSwitch, homeassistant.components.rachio.switch.RachioValve, homeassistant.components.rachio.switch.RachioSchedule, homeassistant.components.rachio.switch.RachioZone, homeassistant.components.rachio.switch.RachioRainDelay, homeassistant.components.rachio.switch.RachioStandbySwitch, homeassistant.components.pulseaudio_loopback.switch.PALoopbackSwitch, homeassistant.components.pilight.light.PilightLight, homeassistant.components.pencom.switch.PencomRelay, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.orvibo.switch.S20Switch, homeassistant.components.opple.light.OppleLight, homeassistant.components.onewire.switch.OneWireSwitch, homeassistant.components.numato.switch.NumatoGpioSwitch, homeassistant.components.niko_home_control.light.NikoHomeControlLight, homeassistant.components.netio.switch.NetioSwitch, homeassistant.components.neato.switch.NeatoConnectedSwitch, homeassistant.components.mochad.switch.MochadSwitch, homeassistant.components.mochad.light.MochadLight, homeassistant.components.mfi.switch.MfiSwitch, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lutron.switch.LutronLed, homeassistant.components.lutron.switch.LutronSwitch, homeassistant.components.lutron.light.LutronLight, homeassistant.components.lupusec.switch.LupusecSwitch, homeassistant.components.linode.switch.LinodeSwitch, homeassistant.components.kitchen_sink.switch.DemoSwitch, homeassistant.components.kankun.switch.KankunSwitch, homeassistant.components.itach.remote.ITachIP2IRRemote, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.huawei_lte.switch.HuaweiLteBaseSwitch, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.homematic.switch.HMSwitch, homeassistant.components.homematic.light.HMLight, homeassistant.components.hikvisioncam.switch.HikvisionMotionSwitch, homeassistant.components.greenwave.light.GreenwaveLight, homeassistant.components.gc100.switch.GC100Switch, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fibaro.switch.FibaroSwitch, homeassistant.components.fibaro.light.FibaroLight, homeassistant.components.eufy.switch.EufyHomeSwitch, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.enocean.switch.EnOceanSwitch, homeassistant.components.enocean.light.EnOceanLight, homeassistant.components.energenie_power_sockets.switch.EGPowerStripSocket, homeassistant.components.elv.switch.SmartPlugSwitch, homeassistant.components.edimax.switch.SmartPlugSwitch, homeassistant.components.econet.switch.EcoNetSwitchAuxHeatOnly, homeassistant.components.ecobee.switch.EcobeeSwitchAuxHeatOnly, homeassistant.components.ecoal_boiler.switch.EcoalSwitch, homeassistant.components.dlink.switch.SmartPlugSwitch, homeassistant.components.digital_ocean.switch.DigitalOceanSwitch, homeassistant.components.devolo_home_control.switch.DevoloSwitch, homeassistant.components.devolo_home_control.siren.DevoloSirenDeviceEntity, homeassistant.components.devolo_home_control.light.DevoloLightDeviceEntity, homeassistant.components.demo.switch.DemoSwitch, homeassistant.components.demo.remote.DemoRemote, homeassistant.components.deluge.switch.DelugeSwitch, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.decora.light.DecoraLight, homeassistant.components.danfoss_air.switch.DanfossAir, homeassistant.components.bosch_shc.switch.SHCRoutingSwitch, homeassistant.components.bosch_shc.switch.SHCSwitch, homeassistant.components.blinksticklight.light.BlinkStickLight, homeassistant.components.avion.light.AvionLight, homeassistant.components.avea.light.AveaLight, homeassistant.components.arest.switch.ArestSwitchPin, homeassistant.components.arest.switch.ArestSwitchFunction, homeassistant.components.aqualogic.switch.AquaLogicSwitch, homeassistant.components.anel_pwrctrl.switch.PwrCtrlSwitch, homeassistant.components.ads.light.AdsLight, homeassistant.components.acer_projector.switch.AcerSwitch, homeassistant.components.abode.switch.AbodeAutomationSwitch, homeassistant.components.abode.switch.AbodeSwitch, and homeassistant.components.abode.light.AbodeLight.

Definition at line 1697 of file entity.py.

Member Data Documentation

None

homeassistant.helpers.entity.ToggleEntity.None

static

Definition at line 1681 of file entity.py.

---

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

• core/homeassistant/helpers/entity.py