homeassistant.components.canary Namespace Reference

Namespaces
	alarm_control_panel
	camera
	config_flow
	const
	coordinator
	model
	sensor

Functions
None	_async_update_listener (HomeAssistant hass, ConfigEntry entry)
Api	_get_canary_api_instance (ConfigEntry entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
	camera_config
	canary_api = await hass.async_add_executor_job(_get_canary_api_instance, entry)
	coordinator = CanaryDataUpdateCoordinator(hass, api=canary_api)
	entry
	extra
	ffmpeg_arguments = DEFAULT_FFMPEG_ARGUMENTS
	Final
dictionary	options
	seconds
	undo_listener = entry.add_update_listener(_async_update_listener)
	unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

Detailed Description

Support for Canary devices.

Function Documentation

_async_update_listener()

None homeassistant.components.canary._async_update_listener ( HomeAssistant  hass, ConfigEntry  entry  )

private

Definition at line 136 of file __init__.py.

_get_canary_api_instance()

Api homeassistant.components.canary._get_canary_api_instance ( ConfigEntry  entry )

private

Handle options update.

Initialize a new instance of CanaryApi.

Definition at line 141 of file __init__.py.

async_setup()

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

Definition at line 60 of file __init__.py.

async_setup_entry()

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

Definition at line 93 of file __init__.py.

async_unload_entry()

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

Definition at line 125 of file __init__.py.

Variable Documentation

camera_config

homeassistant.components.canary.camera_config

Initial value:

=  next(
            (item for item in config[CAMERA_DOMAIN] if item["platform"] == DOMAIN),
            None,
        )

Definition at line 69 of file __init__.py.

canary_api

homeassistant.components.canary.canary_api = await hass.async_add_executor_job(_get_canary_api_instance, entry)

Definition at line 105 of file __init__.py.

coordinator

homeassistant.components.canary.coordinator = CanaryDataUpdateCoordinator(hass, api=canary_api)

Definition at line 110 of file __init__.py.

entry

homeassistant.components.canary.entry

Definition at line 102 of file __init__.py.

extra

homeassistant.components.canary.extra

Definition at line 50 of file __init__.py.

ffmpeg_arguments

homeassistant.components.canary.ffmpeg_arguments = DEFAULT_FFMPEG_ARGUMENTS

Set up the Canary integration.

Definition at line 67 of file __init__.py.

Final

homeassistant.components.canary.Final

Definition at line 31 of file __init__.py.

options

homeassistant.components.canary.options

Initial value:

=  {
            CONF_FFMPEG_ARGUMENTS: entry.data.get(
                CONF_FFMPEG_ARGUMENTS, DEFAULT_FFMPEG_ARGUMENTS
            ),
            CONF_TIMEOUT: entry.data.get(CONF_TIMEOUT, DEFAULT_TIMEOUT),
        }

Set up Canary from a config entry.

Definition at line 96 of file __init__.py.

seconds

homeassistant.components.canary.seconds

Definition at line 33 of file __init__.py.

undo_listener

homeassistant.components.canary.undo_listener = entry.add_update_listener(_async_update_listener)

Definition at line 113 of file __init__.py.

unload_ok

homeassistant.components.canary.unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

Unload a config entry.

Definition at line 127 of file __init__.py.