homeassistant.components.ring Namespace Reference

Namespaces
	binary_sensor
	button
	camera
	config_flow
	const
	coordinator
	diagnostics
	entity
	event
	light
	number
	sensor
	siren
	switch

Classes
class	RingData

Functions
bool	async_migrate_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
bool	async_setup_entry (HomeAssistant hass, RingConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
str	get_auth_user_agent ()

Variables
	_LOGGER = logging.getLogger(__name__)
	RingConfigEntry

Detailed Description

Support for Ring Doorbell/Chimes.

Function Documentation

async_migrate_entry()

bool homeassistant.components.ring.async_migrate_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Migrate old config entry.

Definition at line 106 of file __init__.py.

async_remove_config_entry_device()

bool homeassistant.components.ring.async_remove_config_entry_device	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		dr.DeviceEntry	device_entry
	)

Remove a config entry from a device.

Definition at line 99 of file __init__.py.

async_setup_entry()

bool homeassistant.components.ring.async_setup_entry	(	HomeAssistant	hass,
		RingConfigEntry	entry
	)

Set up a config entry.

Definition at line 46 of file __init__.py.

async_unload_entry()

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

Unload Ring entry.

Definition at line 94 of file __init__.py.

get_auth_user_agent()

str homeassistant.components.ring.get_auth_user_agent

(

)

Return user-agent for Auth instantiation.

user_agent will be the display name in the ring.com authorised devices.

Definition at line 38 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 22 of file __init__.py.

RingConfigEntry

homeassistant.components.ring.RingConfigEntry

Definition at line 35 of file __init__.py.