Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hue.const Namespace Reference

Variables

string ATTR_DYNAMIC = "dynamic"
 
string ATTR_GROUP_NAME = "group_name"
 
string ATTR_HUE_EVENT = "hue_event"
 
string ATTR_SCENE_NAME = "scene_name"
 
string ATTR_TRANSITION = "transition"
 
string CONF_ALLOW_HUE_GROUPS = "allow_hue_groups"
 
string CONF_ALLOW_UNREACHABLE = "allow_unreachable"
 
string CONF_IGNORE_AVAILABILITY = "ignore_availability"
 
string CONF_SUBTYPE = "subtype"
 
bool DEFAULT_ALLOW_HUE_GROUPS = False
 
bool DEFAULT_ALLOW_UNREACHABLE = False
 
tuple DEFAULT_BUTTON_EVENT_TYPES
 
tuple DEFAULT_ROTARY_EVENT_SUBTYPES
 
tuple DEFAULT_ROTARY_EVENT_TYPES = (RelativeRotaryAction.START, RelativeRotaryAction.REPEAT)
 
dictionary DEVICE_SPECIFIC_EVENT_TYPES
 
string DOMAIN = "hue"
 
string GROUP_TYPE_ENTERTAINMENT = "Entertainment"
 
string GROUP_TYPE_LIGHT_GROUP = "LightGroup"
 
string GROUP_TYPE_LIGHT_SOURCE = "LightSource"
 
string GROUP_TYPE_LUMINAIRE = "Luminaire"
 
string GROUP_TYPE_ROOM = "Room"
 
string GROUP_TYPE_ZONE = "Zone"
 
float REQUEST_REFRESH_DELAY = 0.3
 
string SERVICE_HUE_ACTIVATE_SCENE = "hue_activate_scene"
 

Detailed Description

Constants for the Hue component.

Variable Documentation

◆ ATTR_DYNAMIC

string homeassistant.components.hue.const.ATTR_DYNAMIC = "dynamic"

Definition at line 20 of file const.py.

◆ ATTR_GROUP_NAME

string homeassistant.components.hue.const.ATTR_GROUP_NAME = "group_name"

Definition at line 17 of file const.py.

◆ ATTR_HUE_EVENT

string homeassistant.components.hue.const.ATTR_HUE_EVENT = "hue_event"

Definition at line 15 of file const.py.

◆ ATTR_SCENE_NAME

string homeassistant.components.hue.const.ATTR_SCENE_NAME = "scene_name"

Definition at line 18 of file const.py.

◆ ATTR_TRANSITION

string homeassistant.components.hue.const.ATTR_TRANSITION = "transition"

Definition at line 19 of file const.py.

◆ CONF_ALLOW_HUE_GROUPS

string homeassistant.components.hue.const.CONF_ALLOW_HUE_GROUPS = "allow_hue_groups"

Definition at line 32 of file const.py.

◆ CONF_ALLOW_UNREACHABLE

string homeassistant.components.hue.const.CONF_ALLOW_UNREACHABLE = "allow_unreachable"

Definition at line 35 of file const.py.

◆ CONF_IGNORE_AVAILABILITY

string homeassistant.components.hue.const.CONF_IGNORE_AVAILABILITY = "ignore_availability"

Definition at line 11 of file const.py.

◆ CONF_SUBTYPE

string homeassistant.components.hue.const.CONF_SUBTYPE = "subtype"

Definition at line 13 of file const.py.

◆ DEFAULT_ALLOW_HUE_GROUPS

bool homeassistant.components.hue.const.DEFAULT_ALLOW_HUE_GROUPS = False

Definition at line 33 of file const.py.

◆ DEFAULT_ALLOW_UNREACHABLE

bool homeassistant.components.hue.const.DEFAULT_ALLOW_UNREACHABLE = False

Definition at line 36 of file const.py.

◆ DEFAULT_BUTTON_EVENT_TYPES

tuple homeassistant.components.hue.const.DEFAULT_BUTTON_EVENT_TYPES
Initial value:
1 = (
2  # I have never ever seen the `DOUBLE_SHORT_RELEASE` event so leave it out here
3  ButtonEvent.INITIAL_PRESS,
4  ButtonEvent.REPEAT,
5  ButtonEvent.SHORT_RELEASE,
6  ButtonEvent.LONG_PRESS,
7  ButtonEvent.LONG_RELEASE,
8 )

Definition at line 45 of file const.py.

◆ DEFAULT_ROTARY_EVENT_SUBTYPES

tuple homeassistant.components.hue.const.DEFAULT_ROTARY_EVENT_SUBTYPES
Initial value:
1 = (
2  RelativeRotaryDirection.CLOCK_WISE,
3  RelativeRotaryDirection.COUNTER_CLOCK_WISE,
4 )

Definition at line 55 of file const.py.

◆ DEFAULT_ROTARY_EVENT_TYPES

tuple homeassistant.components.hue.const.DEFAULT_ROTARY_EVENT_TYPES = (RelativeRotaryAction.START, RelativeRotaryAction.REPEAT)

Definition at line 54 of file const.py.

◆ DEVICE_SPECIFIC_EVENT_TYPES

dictionary homeassistant.components.hue.const.DEVICE_SPECIFIC_EVENT_TYPES
Initial value:
1 = {
2  # device specific overrides of specific supported button events
3  "Hue tap switch": (ButtonEvent.INITIAL_PRESS,),
4 }

Definition at line 60 of file const.py.

◆ DOMAIN

string homeassistant.components.hue.const.DOMAIN = "hue"

Definition at line 9 of file const.py.

◆ GROUP_TYPE_ENTERTAINMENT

string homeassistant.components.hue.const.GROUP_TYPE_ENTERTAINMENT = "Entertainment"

Definition at line 30 of file const.py.

◆ GROUP_TYPE_LIGHT_GROUP

string homeassistant.components.hue.const.GROUP_TYPE_LIGHT_GROUP = "LightGroup"

Definition at line 25 of file const.py.

◆ GROUP_TYPE_LIGHT_SOURCE

string homeassistant.components.hue.const.GROUP_TYPE_LIGHT_SOURCE = "LightSource"

Definition at line 28 of file const.py.

◆ GROUP_TYPE_LUMINAIRE

string homeassistant.components.hue.const.GROUP_TYPE_LUMINAIRE = "Luminaire"

Definition at line 27 of file const.py.

◆ GROUP_TYPE_ROOM

string homeassistant.components.hue.const.GROUP_TYPE_ROOM = "Room"

Definition at line 26 of file const.py.

◆ GROUP_TYPE_ZONE

string homeassistant.components.hue.const.GROUP_TYPE_ZONE = "Zone"

Definition at line 29 of file const.py.

◆ REQUEST_REFRESH_DELAY

float homeassistant.components.hue.const.REQUEST_REFRESH_DELAY = 0.3

Definition at line 40 of file const.py.

◆ SERVICE_HUE_ACTIVATE_SCENE

string homeassistant.components.hue.const.SERVICE_HUE_ACTIVATE_SCENE = "hue_activate_scene"

Definition at line 16 of file const.py.