Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ihc.manual_setup Namespace Reference

Functions

None get_manual_configuration (HomeAssistant hass, ConfigType config, ConfigType controller_conf, str controller_id)
 
def validate_name (config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 BINARY_SENSOR_SCHEMA
 
 DEVICE_SCHEMA
 
 IHC_SCHEMA
 
 LIGHT_SCHEMA
 
 SENSOR_SCHEMA
 
 SWITCH_SCHEMA
 

Detailed Description

Handle manual setup of ihc resources as entities in Home Assistant.

Function Documentation

◆ get_manual_configuration()

None homeassistant.components.ihc.manual_setup.get_manual_configuration ( HomeAssistant  hass,
ConfigType  config,
ConfigType  controller_conf,
str  controller_id 
)
Get manual configuration for IHC devices.

Definition at line 110 of file manual_setup.py.

◆ validate_name()

def homeassistant.components.ihc.manual_setup.validate_name (   config)
Validate the device name.

Definition at line 42 of file manual_setup.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.ihc.manual_setup._LOGGER = logging.getLogger(__name__)
private

Definition at line 39 of file manual_setup.py.

◆ BINARY_SENSOR_SCHEMA

homeassistant.components.ihc.manual_setup.BINARY_SENSOR_SCHEMA
Initial value:
1 = DEVICE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_INVERTING, default=False): cv.boolean,
4  vol.Optional(CONF_TYPE): DEVICE_CLASSES_SCHEMA,
5  }
6 )

Definition at line 68 of file manual_setup.py.

◆ DEVICE_SCHEMA

homeassistant.components.ihc.manual_setup.DEVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_ID): cv.positive_int,
4  vol.Optional(CONF_NAME): cv.string,
5  vol.Optional(CONF_NOTE): cv.string,
6  vol.Optional(CONF_POSITION): cv.string,
7  }
8 )

Definition at line 52 of file manual_setup.py.

◆ IHC_SCHEMA

homeassistant.components.ihc.manual_setup.IHC_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_PASSWORD): cv.string,
4  vol.Required(CONF_URL): cv.string,
5  vol.Required(CONF_USERNAME): cv.string,
6  vol.Optional(CONF_AUTOSETUP, default=True): cv.boolean,
7  vol.Optional(CONF_BINARY_SENSOR, default=[]): vol.All(
8  cv.ensure_list, [vol.All(BINARY_SENSOR_SCHEMA, validate_name)]
9  ),
10  vol.Optional(CONF_INFO, default=True): cv.boolean,
11  vol.Optional(CONF_LIGHT, default=[]): vol.All(
12  cv.ensure_list, [vol.All(LIGHT_SCHEMA, validate_name)]
13  ),
14  vol.Optional(CONF_SENSOR, default=[]): vol.All(
15  cv.ensure_list, [vol.All(SENSOR_SCHEMA, validate_name)]
16  ),
17  vol.Optional(CONF_SWITCH, default=[]): vol.All(
18  cv.ensure_list, [vol.All(SWITCH_SCHEMA, validate_name)]
19  ),
20  }
21 )

Definition at line 87 of file manual_setup.py.

◆ LIGHT_SCHEMA

homeassistant.components.ihc.manual_setup.LIGHT_SCHEMA
Initial value:
1 = DEVICE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_DIMMABLE, default=False): cv.boolean,
4  vol.Optional(CONF_OFF_ID, default=0): cv.positive_int,
5  vol.Optional(CONF_ON_ID, default=0): cv.positive_int,
6  }
7 )

Definition at line 75 of file manual_setup.py.

◆ SENSOR_SCHEMA

homeassistant.components.ihc.manual_setup.SENSOR_SCHEMA
Initial value:
1 = DEVICE_SCHEMA.extend(
2  {vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string}
3 )

Definition at line 83 of file manual_setup.py.

◆ SWITCH_SCHEMA

homeassistant.components.ihc.manual_setup.SWITCH_SCHEMA
Initial value:
1 = DEVICE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_OFF_ID, default=0): cv.positive_int,
4  vol.Optional(CONF_ON_ID, default=0): cv.positive_int,
5  }
6 )

Definition at line 61 of file manual_setup.py.