homeassistant.components.guardian Namespace Reference

Namespaces
	binary_sensor
	button
	config_flow
	const
	coordinator
	diagnostics
	entity
	sensor
	switch
	util
	valve

Classes
class	GuardianData
class	PairedSensorManager

Functions
str	async_get_entry_id_for_service_call (HomeAssistant hass, ServiceCall call)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
string	DATA_PAIRED_SENSOR_MANAGER = "paired_sensor_manager"
list	PLATFORMS
	SERVICE_BASE_SCHEMA
string	SERVICE_NAME_PAIR_SENSOR = "pair_sensor"
string	SERVICE_NAME_UNPAIR_SENSOR = "unpair_sensor"
string	SERVICE_NAME_UPGRADE_FIRMWARE = "upgrade_firmware"
	SERVICE_PAIR_UNPAIR_SENSOR_SCHEMA
	SERVICE_UPGRADE_FIRMWARE_SCHEMA
tuple	SERVICES

Detailed Description

The Elexa Guardian integration.

Function Documentation

async_get_entry_id_for_service_call()

str homeassistant.components.guardian.async_get_entry_id_for_service_call	(	HomeAssistant	hass,
		ServiceCall	call
	)

Get the entry ID related to a service call (by device ID).

Definition at line 97 of file __init__.py.

async_setup_entry()

bool homeassistant.components.guardian.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up Elexa Guardian from a config entry.

Definition at line 114 of file __init__.py.

async_unload_entry()

bool homeassistant.components.guardian.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 244 of file __init__.py.

Variable Documentation

DATA_PAIRED_SENSOR_MANAGER

string homeassistant.components.guardian.DATA_PAIRED_SENSOR_MANAGER = "paired_sensor_manager"

Definition at line 43 of file __init__.py.

PLATFORMS

list homeassistant.components.guardian.PLATFORMS

Initial value:

=  [
    Platform.BINARY_SENSOR,
    Platform.BUTTON,
    Platform.SENSOR,
    Platform.SWITCH,
    Platform.VALVE,
]

Definition at line 77 of file __init__.py.

SERVICE_BASE_SCHEMA

homeassistant.components.guardian.SERVICE_BASE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_DEVICE_ID): cv.string,
    }
)

Definition at line 55 of file __init__.py.

SERVICE_NAME_PAIR_SENSOR

string homeassistant.components.guardian.SERVICE_NAME_PAIR_SENSOR = "pair_sensor"

Definition at line 45 of file __init__.py.

SERVICE_NAME_UNPAIR_SENSOR

string homeassistant.components.guardian.SERVICE_NAME_UNPAIR_SENSOR = "unpair_sensor"

Definition at line 46 of file __init__.py.

SERVICE_NAME_UPGRADE_FIRMWARE

string homeassistant.components.guardian.SERVICE_NAME_UPGRADE_FIRMWARE = "upgrade_firmware"

Definition at line 47 of file __init__.py.

SERVICE_PAIR_UNPAIR_SENSOR_SCHEMA

homeassistant.components.guardian.SERVICE_PAIR_UNPAIR_SENSOR_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_DEVICE_ID): cv.string,
        vol.Required(CONF_UID): cv.string,
    }
)

Definition at line 61 of file __init__.py.

SERVICE_UPGRADE_FIRMWARE_SCHEMA

homeassistant.components.guardian.SERVICE_UPGRADE_FIRMWARE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_DEVICE_ID): cv.string,
        vol.Optional(CONF_URL): cv.url,
        vol.Optional(CONF_PORT): cv.port,
        vol.Optional(CONF_FILENAME): cv.string,
    },
)

Definition at line 68 of file __init__.py.

SERVICES

tuple homeassistant.components.guardian.SERVICES

Initial value:

=  (
    SERVICE_NAME_PAIR_SENSOR,
    SERVICE_NAME_UNPAIR_SENSOR,
    SERVICE_NAME_UPGRADE_FIRMWARE,
)

Definition at line 49 of file __init__.py.