homeassistant.components.siren Namespace Reference

Namespaces
	const

Classes
class	SirenEntity
class	SirenEntityDescription
class	SirenTurnOnServiceParameters

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
SirenTurnOnServiceParameters	process_turn_on_params (SirenEntity siren, SirenTurnOnServiceParameters params)

Variables
	__all__
	__dir__
	__getattr__
	_LOGGER
	CACHED_PROPERTIES_WITH_ATTR_
	check_if_deprecated_constant
	dir_with_deprecated_constants
	module_globals
	module_globals_keys
	PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE
	SCAN_INTERVAL
	seconds
	VolDictType

Detailed Description

Component to interface with various sirens/chimes.

Function Documentation

async_setup()

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

Set up siren devices.

Definition at line 108 of file __init__.py.

async_setup_entry()

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

Set up a config entry.

Definition at line 147 of file __init__.py.

async_unload_entry()

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

Unload a config entry.

Definition at line 152 of file __init__.py.

process_turn_on_params()

SirenTurnOnServiceParameters homeassistant.components.siren.process_turn_on_params	(	SirenEntity	siren,
		SirenTurnOnServiceParameters	params
	)

Process turn_on service params.

Filters out unsupported params and validates the rest.

Definition at line 66 of file __init__.py.

Variable Documentation

__all__

homeassistant.components.siren.__all__

private

Definition at line 220 of file __init__.py.

__dir__

homeassistant.components.siren.__dir__

private

Definition at line 217 of file __init__.py.

__getattr__

homeassistant.components.siren.__getattr__

private

Definition at line 216 of file __init__.py.

_LOGGER

homeassistant.components.siren._LOGGER

private

Definition at line 41 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.siren.CACHED_PROPERTIES_WITH_ATTR_

Definition at line 163 of file __init__.py.

check_if_deprecated_constant

homeassistant.components.siren.check_if_deprecated_constant

Definition at line 216 of file __init__.py.

dir_with_deprecated_constants

homeassistant.components.siren.dir_with_deprecated_constants

Definition at line 218 of file __init__.py.

module_globals

homeassistant.components.siren.module_globals

Definition at line 216 of file __init__.py.

module_globals_keys

homeassistant.components.siren.module_globals_keys

Definition at line 218 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.siren.PLATFORM_SCHEMA

Definition at line 44 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.siren.PLATFORM_SCHEMA_BASE

Definition at line 45 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.siren.SCAN_INTERVAL

Definition at line 46 of file __init__.py.

seconds

homeassistant.components.siren.seconds

Definition at line 46 of file __init__.py.

VolDictType

homeassistant.components.siren.VolDictType

Definition at line 48 of file __init__.py.