homeassistant.components.doorbird.device.ConfiguredDoorBird Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, DoorBird device, str|None name, str|None custom_url, str token, dict[str, str] event_entity_ids)
None	async_register_events (self)
str|None	custom_url (self)
DoorBird	device (self)
dict[str, str|None]	get_event_data (self, str event)
str|None	name (self)
str	slug (self)
str	token (self)
None	update_events (self, list[str] events)

Public Attributes
	door_station_events
	event_descriptions
	events

Private Member Functions
DoorbirdEventConfig	_async_get_event_config (self, dict[str, dict[str, Any]] http_fav)
dict[str, dict[str, Any]]	_async_get_http_favorites (self)
bool	_async_register_event (self, str hass_url, str event, dict[str, dict[str, Any]] http_fav)
dict[str, Any]	_async_register_events (self)
None	_configure_unconfigured_favorites (self, DoorbirdEventConfig event_config)
str	_get_event_name (self, str event)

Private Attributes
	_custom_url
	_device
	_event_entity_ids
	_hass
	_name
	_token

Detailed Description

Attach additional information to pass along with configured device.

Definition at line 53 of file device.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.doorbird.device.ConfiguredDoorBird.__init__	(		self,
		HomeAssistant	hass,
		DoorBird	device,
		str | None	name,
		str | None	custom_url,
		str	token,
		dict[str, str]	event_entity_ids
	)

Initialize configured device.

Definition at line 56 of file device.py.

Member Function Documentation

_async_get_event_config()

DoorbirdEventConfig homeassistant.components.doorbird.device.ConfiguredDoorBird._async_get_event_config (   self, dict[str, dict[str, Any]]   http_fav  )

private

Get events and unconfigured favorites from http favorites.

Definition at line 170 of file device.py.

_async_get_http_favorites()

dict[str, dict[str, Any]] homeassistant.components.doorbird.device.ConfiguredDoorBird._async_get_http_favorites (   self )

private

Get the HTTP favorites from the device.

Definition at line 214 of file device.py.

_async_register_event()

bool homeassistant.components.doorbird.device.ConfiguredDoorBird._async_register_event (   self, str  hass_url, str  event, dict[str, dict[str, Any]]   http_fav  )

private

Register an event.

Returns True if the event was registered, False if
the event was already registered or registration failed.

Definition at line 218 of file device.py.

_async_register_events()

dict[str, Any] homeassistant.components.doorbird.device.ConfiguredDoorBird._async_register_events (   self )

private

Register events on device.

Definition at line 147 of file device.py.

_configure_unconfigured_favorites()

None homeassistant.components.doorbird.device.ConfiguredDoorBird._configure_unconfigured_favorites (   self, DoorbirdEventConfig   event_config  )

private

Configure unconfigured favorites.

Definition at line 118 of file device.py.

_get_event_name()

str homeassistant.components.doorbird.device.ConfiguredDoorBird._get_event_name (   self, str  event  )

private

Definition at line 211 of file device.py.

async_register_events()

None homeassistant.components.doorbird.device.ConfiguredDoorBird.async_register_events

(

self

)

Register events on device.

Definition at line 105 of file device.py.

custom_url()

str | None homeassistant.components.doorbird.device.ConfiguredDoorBird.custom_url

(

self

)

Get custom url for device.

Definition at line 96 of file device.py.

device()

DoorBird homeassistant.components.doorbird.device.ConfiguredDoorBird.device

(

self

)

Get the configured device.

Definition at line 91 of file device.py.

get_event_data()

dict[str, str | None] homeassistant.components.doorbird.device.ConfiguredDoorBird.get_event_data	(		self,
		str	event
	)

Get data to pass along with HA event.

Definition at line 246 of file device.py.

name()

str | None homeassistant.components.doorbird.device.ConfiguredDoorBird.name

(

self

)

Get custom device name.

Definition at line 86 of file device.py.

slug()

str homeassistant.components.doorbird.device.ConfiguredDoorBird.slug

(

self

)

Get device slug.

Definition at line 207 of file device.py.

token()

str homeassistant.components.doorbird.device.ConfiguredDoorBird.token

(

self

)

Get token for device.

Definition at line 101 of file device.py.

update_events()

None homeassistant.components.doorbird.device.ConfiguredDoorBird.update_events	(		self,
		list[str]	events
	)

Update the doorbird events.

Definition at line 78 of file device.py.

Member Data Documentation

_custom_url

homeassistant.components.doorbird.device.ConfiguredDoorBird._custom_url

private

Definition at line 69 of file device.py.

_device

homeassistant.components.doorbird.device.ConfiguredDoorBird._device

private

Definition at line 68 of file device.py.

_event_entity_ids

homeassistant.components.doorbird.device.ConfiguredDoorBird._event_entity_ids

private

Definition at line 71 of file device.py.

_hass

homeassistant.components.doorbird.device.ConfiguredDoorBird._hass

private

Definition at line 66 of file device.py.

_name

homeassistant.components.doorbird.device.ConfiguredDoorBird._name

private

Definition at line 67 of file device.py.

_token

homeassistant.components.doorbird.device.ConfiguredDoorBird._token

private

Definition at line 70 of file device.py.

door_station_events

homeassistant.components.doorbird.device.ConfiguredDoorBird.door_station_events

Definition at line 81 of file device.py.

event_descriptions

homeassistant.components.doorbird.device.ConfiguredDoorBird.event_descriptions

Definition at line 116 of file device.py.

events

homeassistant.components.doorbird.device.ConfiguredDoorBird.events

Definition at line 80 of file device.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/doorbird/device.py