homeassistant.components.zha Namespace Reference

Namespaces
	alarm_control_panel
	api
	backup
	binary_sensor
	button
	climate
	config_flow
	const
	cover
	device_action
	device_tracker
	device_trigger
	diagnostics
	entity
	fan
	helpers
	light
	lock
	logbook
	number
	radio_manager
	repairs
	select
	sensor
	silabs_multiprotocol
	siren
	switch
	update
	websocket_api

Functions
bool	async_migrate_entry (HomeAssistant hass, ConfigEntry config_entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry config_entry)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CENTICELSIUS = "C-100"
	CONFIG_SCHEMA
	DEVICE_CONFIG_SCHEMA_ENTRY = vol.Schema({vol.Optional(CONF_TYPE): cv.string})
tuple	PLATFORMS
dictionary	ZHA_CONFIG_SCHEMA

Detailed Description

Support for Zigbee Home Automation devices.

Function Documentation

async_migrate_entry()

bool homeassistant.components.zha.async_migrate_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Migrate old entry.

Definition at line 250 of file __init__.py.

async_setup()

bool homeassistant.components.zha.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up ZHA from config.

Definition at line 109 of file __init__.py.

async_setup_entry()

bool homeassistant.components.zha.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Set up ZHA.

Will automatically load components to support devices found on the network.

Definition at line 117 of file __init__.py.

async_unload_entry()

bool homeassistant.components.zha.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Unload ZHA config entry.

Definition at line 228 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.zha._LOGGER = logging.getLogger(__name__)

private

Definition at line 106 of file __init__.py.

CENTICELSIUS

string homeassistant.components.zha.CENTICELSIUS = "C-100"

Definition at line 103 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.zha.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            vol.All(
                cv.deprecated(CONF_USB_PATH),
                cv.deprecated(CONF_BAUDRATE),
                cv.deprecated(CONF_RADIO_TYPE),
                ZHA_CONFIG_SCHEMA,
            ),
        ),
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 69 of file __init__.py.

DEVICE_CONFIG_SCHEMA_ENTRY

homeassistant.components.zha.DEVICE_CONFIG_SCHEMA_ENTRY = vol.Schema({vol.Optional(CONF_TYPE): cv.string})

Definition at line 56 of file __init__.py.

PLATFORMS

tuple homeassistant.components.zha.PLATFORMS

Initial value:

=  (
    Platform.ALARM_CONTROL_PANEL,
    Platform.BINARY_SENSOR,
    Platform.BUTTON,
    Platform.CLIMATE,
    Platform.COVER,
    Platform.DEVICE_TRACKER,
    Platform.FAN,
    Platform.LIGHT,
    Platform.LOCK,
    Platform.NUMBER,
    Platform.SELECT,
    Platform.SENSOR,
    Platform.SIREN,
    Platform.SWITCH,
    Platform.UPDATE,
)

Definition at line 83 of file __init__.py.

ZHA_CONFIG_SCHEMA

dictionary homeassistant.components.zha.ZHA_CONFIG_SCHEMA

Initial value:

=  {
    vol.Optional(CONF_BAUDRATE): cv.positive_int,
    vol.Optional(CONF_DATABASE): cv.string,
    vol.Optional(CONF_DEVICE_CONFIG, default={}): vol.Schema(
        {cv.string: DEVICE_CONFIG_SCHEMA_ENTRY}
    ),
    vol.Optional(CONF_ENABLE_QUIRKS, default=True): cv.boolean,
    vol.Optional(CONF_ZIGPY): dict,
    vol.Optional(CONF_RADIO_TYPE): cv.enum(RadioType),
    vol.Optional(CONF_USB_PATH): cv.string,
    vol.Optional(CONF_CUSTOM_QUIRKS_PATH): cv.isdir,
}

Definition at line 57 of file __init__.py.