Home Assistant Unofficial Reference 2024.12.1
Functions | Variables
homeassistant.components.dynalite.schema Namespace Reference

Functions

str num_string (str|int value)
 
dict[str, Any] validate_area (dict[str, Any] config)
 

Variables

 AREA_DATA_SCHEMA
 
 AREA_SCHEMA = vol.Schema({num_string: vol.Any(AREA_DATA_SCHEMA, None)})
 
 BRIDGE_SCHEMA
 
 CHANNEL_DATA_SCHEMA
 
 CHANNEL_SCHEMA = vol.Schema({num_string: CHANNEL_DATA_SCHEMA})
 
 PLATFORM_DEFAULTS_SCHEMA = vol.Schema({vol.Optional(CONF_FADE): vol.Coerce(float)})
 
 PRESET_DATA_SCHEMA
 
 PRESET_SCHEMA = vol.Schema({num_string: vol.Any(PRESET_DATA_SCHEMA, None)})
 
 TEMPLATE_DATA_SCHEMA = vol.Any(TEMPLATE_ROOM_SCHEMA, TEMPLATE_TIMECOVER_SCHEMA)
 
 TEMPLATE_ROOM_SCHEMA
 
 TEMPLATE_SCHEMA = vol.Schema({str: TEMPLATE_DATA_SCHEMA})
 
 TEMPLATE_TIMECOVER_SCHEMA
 

Detailed Description

Schema for config entries.

Function Documentation

◆ num_string()

str homeassistant.components.dynalite.schema.num_string ( str | int  value) 
Test if value is a string of digits, aka an integer.

Definition at line 43 of file schema.py.

◆ validate_area()

dict[str, Any] homeassistant.components.dynalite.schema.validate_area ( dict[str, Any]  config) 
Validate that template parameters are only used if area is using the relevant template.

Definition at line 94 of file schema.py.

Variable Documentation

◆ AREA_DATA_SCHEMA

homeassistant.components.dynalite.schema.AREA_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  vol.All(
3  {
4  vol.Required(CONF_NAME): cv.string,
5  vol.Optional(CONF_TEMPLATE): vol.In(DEFAULT_TEMPLATES),
6  vol.Optional(CONF_FADE): vol.Coerce(float),
7  vol.Optional(CONF_NO_DEFAULT): cv.boolean,
8  vol.Optional(CONF_CHANNEL): CHANNEL_SCHEMA,
9  vol.Optional(CONF_PRESET): PRESET_SCHEMA,
10  # the next ones can be part of the templates
11  vol.Optional(CONF_ROOM_ON): num_string,
12  vol.Optional(CONF_ROOM_OFF): num_string,
13  vol.Optional(CONF_CHANNEL_COVER): num_string,
14  vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
15  vol.Optional(CONF_OPEN_PRESET): num_string,
16  vol.Optional(CONF_CLOSE_PRESET): num_string,
17  vol.Optional(CONF_STOP_PRESET): num_string,
18  vol.Optional(CONF_DURATION): vol.Coerce(float),
19  vol.Optional(CONF_TILT_TIME): vol.Coerce(float),
20  },
21  validate_area,
22  )
23 )

Definition at line 111 of file schema.py.

◆ AREA_SCHEMA

homeassistant.components.dynalite.schema.AREA_SCHEMA = vol.Schema({num_string: vol.Any(AREA_DATA_SCHEMA, None)})

Definition at line 135 of file schema.py.

◆ BRIDGE_SCHEMA

homeassistant.components.dynalite.schema.BRIDGE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
4  vol.Required(CONF_HOST): cv.string,
5  vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
6  vol.Optional(CONF_AUTO_DISCOVER, default=False): vol.Coerce(bool),
7  vol.Optional(CONF_POLL_TIMER, default=1.0): vol.Coerce(float),
8  vol.Optional(CONF_AREA): AREA_SCHEMA,
9  vol.Optional(CONF_DEFAULT): PLATFORM_DEFAULTS_SCHEMA,
10  vol.Optional(CONF_ACTIVE, default=False): vol.Any(
11  ACTIVE_ON, ACTIVE_OFF, ACTIVE_INIT, cv.boolean
12  ),
13  vol.Optional(CONF_PRESET): PRESET_SCHEMA,
14  vol.Optional(CONF_TEMPLATE): TEMPLATE_SCHEMA,
15  }
16 )

Definition at line 140 of file schema.py.

◆ CHANNEL_DATA_SCHEMA

homeassistant.components.dynalite.schema.CHANNEL_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_NAME): cv.string,
4  vol.Optional(CONF_FADE): vol.Coerce(float),
5  vol.Optional(CONF_TYPE, default=DEFAULT_CHANNEL_TYPE): vol.Any(
6  "light", "switch"
7  ),
8  }
9 )

Definition at line 51 of file schema.py.

◆ CHANNEL_SCHEMA

homeassistant.components.dynalite.schema.CHANNEL_SCHEMA = vol.Schema({num_string: CHANNEL_DATA_SCHEMA})

Definition at line 61 of file schema.py.

◆ PLATFORM_DEFAULTS_SCHEMA

homeassistant.components.dynalite.schema.PLATFORM_DEFAULTS_SCHEMA = vol.Schema({vol.Optional(CONF_FADE): vol.Coerce(float)})

Definition at line 137 of file schema.py.

◆ PRESET_DATA_SCHEMA

homeassistant.components.dynalite.schema.PRESET_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_NAME): cv.string,
4  vol.Optional(CONF_FADE): vol.Coerce(float),
5  vol.Optional(CONF_LEVEL): vol.Coerce(float),
6  }
7 )

Definition at line 63 of file schema.py.

◆ PRESET_SCHEMA

homeassistant.components.dynalite.schema.PRESET_SCHEMA = vol.Schema({num_string: vol.Any(PRESET_DATA_SCHEMA, None)})

Definition at line 71 of file schema.py.

◆ TEMPLATE_DATA_SCHEMA

homeassistant.components.dynalite.schema.TEMPLATE_DATA_SCHEMA = vol.Any(TEMPLATE_ROOM_SCHEMA, TEMPLATE_TIMECOVER_SCHEMA)

Definition at line 89 of file schema.py.

◆ TEMPLATE_ROOM_SCHEMA

homeassistant.components.dynalite.schema.TEMPLATE_ROOM_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Optional(CONF_ROOM_ON): num_string, vol.Optional(CONF_ROOM_OFF): num_string}
3 )

Definition at line 73 of file schema.py.

◆ TEMPLATE_SCHEMA

homeassistant.components.dynalite.schema.TEMPLATE_SCHEMA = vol.Schema({str: TEMPLATE_DATA_SCHEMA})

Definition at line 91 of file schema.py.

◆ TEMPLATE_TIMECOVER_SCHEMA

homeassistant.components.dynalite.schema.TEMPLATE_TIMECOVER_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_CHANNEL_COVER): num_string,
4  vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
5  vol.Optional(CONF_OPEN_PRESET): num_string,
6  vol.Optional(CONF_CLOSE_PRESET): num_string,
7  vol.Optional(CONF_STOP_PRESET): num_string,
8  vol.Optional(CONF_DURATION): vol.Coerce(float),
9  vol.Optional(CONF_TILT_TIME): vol.Coerce(float),
10  }
11 )

Definition at line 77 of file schema.py.