Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.device_sun_light_trigger Namespace Reference

Functions

def activate_automation (hass, device_group, light_group, light_profile, disable_turn_off)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

string CONF_DEVICE_GROUP = "device_group"
 
string CONF_DISABLE_TURN_OFF = "disable_turn_off"
 
string CONF_LIGHT_GROUP = "light_group"
 
string CONF_LIGHT_PROFILE = "light_profile"
 
 CONFIG_SCHEMA
 
bool DEFAULT_DISABLE_TURN_OFF = False
 
string DEFAULT_LIGHT_PROFILE = "relax"
 
string DOMAIN = "device_sun_light_trigger"
 
 LIGHT_TRANSITION_TIME = timedelta(minutes=15)
 

Detailed Description

Support to turn on lights based on the states.

Function Documentation

◆ activate_automation()

def homeassistant.components.device_sun_light_trigger.activate_automation (   hass,
  device_group,
  light_group,
  light_profile,
  disable_turn_off 
)
Activate the automation.

Definition at line 93 of file __init__.py.

◆ async_setup()

bool homeassistant.components.device_sun_light_trigger.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the triggers to control lights based on device presence.

Definition at line 71 of file __init__.py.

Variable Documentation

◆ CONF_DEVICE_GROUP

string homeassistant.components.device_sun_light_trigger.CONF_DEVICE_GROUP = "device_group"

Definition at line 42 of file __init__.py.

◆ CONF_DISABLE_TURN_OFF

string homeassistant.components.device_sun_light_trigger.CONF_DISABLE_TURN_OFF = "disable_turn_off"

Definition at line 43 of file __init__.py.

◆ CONF_LIGHT_GROUP

string homeassistant.components.device_sun_light_trigger.CONF_LIGHT_GROUP = "light_group"

Definition at line 44 of file __init__.py.

◆ CONF_LIGHT_PROFILE

string homeassistant.components.device_sun_light_trigger.CONF_LIGHT_PROFILE = "light_profile"

Definition at line 45 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.device_sun_light_trigger.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(CONF_DEVICE_GROUP): cv.entity_id,
6  vol.Optional(
7  CONF_DISABLE_TURN_OFF, default=DEFAULT_DISABLE_TURN_OFF
8  ): cv.boolean,
9  vol.Optional(CONF_LIGHT_GROUP): cv.string,
10  vol.Optional(
11  CONF_LIGHT_PROFILE, default=DEFAULT_LIGHT_PROFILE
12  ): cv.string,
13  }
14  )
15  },
16  extra=vol.ALLOW_EXTRA,
17 )

Definition at line 52 of file __init__.py.

◆ DEFAULT_DISABLE_TURN_OFF

bool homeassistant.components.device_sun_light_trigger.DEFAULT_DISABLE_TURN_OFF = False

Definition at line 47 of file __init__.py.

◆ DEFAULT_LIGHT_PROFILE

string homeassistant.components.device_sun_light_trigger.DEFAULT_LIGHT_PROFILE = "relax"

Definition at line 48 of file __init__.py.

◆ DOMAIN

string homeassistant.components.device_sun_light_trigger.DOMAIN = "device_sun_light_trigger"

Definition at line 41 of file __init__.py.

◆ LIGHT_TRANSITION_TIME

homeassistant.components.device_sun_light_trigger.LIGHT_TRANSITION_TIME = timedelta(minutes=15)

Definition at line 50 of file __init__.py.