Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.insteon.schemas Namespace Reference

Functions

def _find_likely_port (ports)
 
def build_device_override_schema (address=vol.UNDEFINED, cat=vol.UNDEFINED, subcat=vol.UNDEFINED, firmware=vol.UNDEFINED)
 
def build_hub_schema (hub_version, host=vol.UNDEFINED, port=vol.UNDEFINED, username=vol.UNDEFINED, password=vol.UNDEFINED)
 
def build_plm_manual_schema (device=vol.UNDEFINED)
 
def build_plm_schema (dict[str, str] ports, device=vol.UNDEFINED)
 
def build_x10_schema (housecode=vol.UNDEFINED, unitcode=vol.UNDEFINED, platform=vol.UNDEFINED, dim_steps=22)
 

Variables

 ADD_ALL_LINK_SCHEMA
 
 ADD_DEFAULT_LINKS_SCHEMA = vol.Schema({vol.Required(CONF_ENTITY_ID): cv.entity_id})
 
 DEL_ALL_LINK_SCHEMA
 
 LOAD_ALDB_SCHEMA
 
 PRINT_ALDB_SCHEMA = vol.Schema({vol.Required(CONF_ENTITY_ID): cv.entity_id})
 
 TRIGGER_SCENE_SCHEMA
 
 X10_HOUSECODE_SCHEMA = vol.Schema({vol.Required(SRV_HOUSECODE): vol.In(HOUSECODES)})
 

Detailed Description

Schemas used by insteon component.

Function Documentation

◆ _find_likely_port()

def homeassistant.components.insteon.schemas._find_likely_port (   ports)
private
Return the most likely USB port for a PLM.

Definition at line 112 of file schemas.py.

◆ build_device_override_schema()

def homeassistant.components.insteon.schemas.build_device_override_schema (   address = vol.UNDEFINED,
  cat = vol.UNDEFINED,
  subcat = vol.UNDEFINED,
  firmware = vol.UNDEFINED 
)
Build the device override schema for config flow.

Definition at line 75 of file schemas.py.

◆ build_hub_schema()

def homeassistant.components.insteon.schemas.build_hub_schema (   hub_version,
  host = vol.UNDEFINED,
  port = vol.UNDEFINED,
  username = vol.UNDEFINED,
  password = vol.UNDEFINED 
)
Build the Hub schema for config flow.

Definition at line 134 of file schemas.py.

◆ build_plm_manual_schema()

def homeassistant.components.insteon.schemas.build_plm_manual_schema (   device = vol.UNDEFINED)
Build the manual PLM schema for config flow.

Definition at line 129 of file schemas.py.

◆ build_plm_schema()

def homeassistant.components.insteon.schemas.build_plm_schema ( dict[str, str]  ports,
  device = vol.UNDEFINED 
)
Build the PLM schema for config flow.

Definition at line 122 of file schemas.py.

◆ build_x10_schema()

def homeassistant.components.insteon.schemas.build_x10_schema (   housecode = vol.UNDEFINED,
  unitcode = vol.UNDEFINED,
  platform = vol.UNDEFINED,
  dim_steps = 22 
)
Build the X10 schema for config flow.

Definition at line 91 of file schemas.py.

Variable Documentation

◆ ADD_ALL_LINK_SCHEMA

homeassistant.components.insteon.schemas.ADD_ALL_LINK_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(SRV_ALL_LINK_GROUP): vol.Range(min=0, max=255),
4  vol.Required(SRV_ALL_LINK_MODE): vol.In([SRV_CONTROLLER, SRV_RESPONDER]),
5  }
6 )

Definition at line 40 of file schemas.py.

◆ ADD_DEFAULT_LINKS_SCHEMA

homeassistant.components.insteon.schemas.ADD_DEFAULT_LINKS_SCHEMA = vol.Schema({vol.Required(CONF_ENTITY_ID): cv.entity_id})

Definition at line 72 of file schemas.py.

◆ DEL_ALL_LINK_SCHEMA

homeassistant.components.insteon.schemas.DEL_ALL_LINK_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(SRV_ALL_LINK_GROUP): vol.Range(min=0, max=255)}
3 )

Definition at line 48 of file schemas.py.

◆ LOAD_ALDB_SCHEMA

homeassistant.components.insteon.schemas.LOAD_ALDB_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_ENTITY_ID): vol.Any(cv.entity_id, ENTITY_MATCH_ALL),
4  vol.Optional(SRV_LOAD_DB_RELOAD, default=False): cv.boolean,
5  }
6 )

Definition at line 53 of file schemas.py.

◆ PRINT_ALDB_SCHEMA

homeassistant.components.insteon.schemas.PRINT_ALDB_SCHEMA = vol.Schema({vol.Required(CONF_ENTITY_ID): cv.entity_id})

Definition at line 61 of file schemas.py.

◆ TRIGGER_SCENE_SCHEMA

homeassistant.components.insteon.schemas.TRIGGER_SCENE_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(SRV_ALL_LINK_GROUP): vol.Range(min=0, max=255)}
3 )

Definition at line 67 of file schemas.py.

◆ X10_HOUSECODE_SCHEMA

homeassistant.components.insteon.schemas.X10_HOUSECODE_SCHEMA = vol.Schema({vol.Required(SRV_HOUSECODE): vol.In(HOUSECODES)})

Definition at line 64 of file schemas.py.