Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ring.binary_sensor.RingBinarySensor Class Reference
Inheritance diagram for homeassistant.components.ring.binary_sensor.RingBinarySensor:
[legend]
Collaboration diagram for homeassistant.components.ring.binary_sensor.RingBinarySensor:
[legend]

Public Member Functions

None __init__ (self, RingDeviceT device, RingListenCoordinator coordinator, RingBinarySensorEntityDescription[RingDeviceT] description)
 
None async_update (self)
 
bool available (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.ring.entity.RingBaseEntity
None __init__ (self, RingDeviceT device, _RingCoordinatorT coordinator)
 
- Public Member Functions inherited from homeassistant.components.ring.coordinator.RingListenCoordinator
None __init__ (self, HomeAssistant hass, Ring ring_api, dict[str, Any]|None listen_credentials, Callable[[dict[str, Any]], None] listen_credentials_updater)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_shutdown (self)
 
None index_alerts (self)
 
- Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Public Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.ring.coordinator.RingListenCoordinator
 alerts
 
 config_entry
 
 event_listener
 
 hass
 
 logger
 
 start_timeout
 
- Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 entity_category
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _async_cancel_event (self, Any _now)
 
None _async_handle_event (self, RingEvent alert)
 
RingEvent|None _get_coordinator_alert (self)
 
None _handle_coordinator_update (self)
 

Private Attributes

 _active_alert
 
 _attr_is_on
 
 _attr_unique_id
 
 _cancel_callback
 

Detailed Description

A binary sensor implementation for Ring device.

Definition at line 88 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ring.binary_sensor.RingBinarySensor.__init__ (   self,
RingDeviceT  device,
RingListenCoordinator  coordinator,
RingBinarySensorEntityDescription[RingDeviceT]  description 
)
Initialize a binary sensor for Ring device.

Definition at line 96 of file binary_sensor.py.

Member Function Documentation

◆ _async_cancel_event()

None homeassistant.components.ring.binary_sensor.RingBinarySensor._async_cancel_event (   self,
Any  _now 
)
private
Clear the event.

Definition at line 125 of file binary_sensor.py.

◆ _async_handle_event()

None homeassistant.components.ring.binary_sensor.RingBinarySensor._async_handle_event (   self,
RingEvent  alert 
)
private
Handle the event.

Definition at line 114 of file binary_sensor.py.

◆ _get_coordinator_alert()

RingEvent | None homeassistant.components.ring.binary_sensor.RingBinarySensor._get_coordinator_alert (   self)
private

Definition at line 132 of file binary_sensor.py.

◆ _handle_coordinator_update()

None homeassistant.components.ring.binary_sensor.RingBinarySensor._handle_coordinator_update (   self)
private

Definition at line 138 of file binary_sensor.py.

◆ async_update()

None homeassistant.components.ring.binary_sensor.RingBinarySensor.async_update (   self)
All updates are passive.

Definition at line 148 of file binary_sensor.py.

◆ available()

bool homeassistant.components.ring.binary_sensor.RingBinarySensor.available (   self)
Return if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 144 of file binary_sensor.py.

◆ extra_state_attributes()

Mapping[str, Any] | None homeassistant.components.ring.binary_sensor.RingBinarySensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 152 of file binary_sensor.py.

Member Data Documentation

◆ _active_alert

homeassistant.components.ring.binary_sensor.RingBinarySensor._active_alert
private

Definition at line 117 of file binary_sensor.py.

◆ _attr_is_on

homeassistant.components.ring.binary_sensor.RingBinarySensor._attr_is_on
private

Definition at line 109 of file binary_sensor.py.

◆ _attr_unique_id

homeassistant.components.ring.binary_sensor.RingBinarySensor._attr_unique_id
private

Definition at line 108 of file binary_sensor.py.

◆ _cancel_callback

homeassistant.components.ring.binary_sensor.RingBinarySensor._cancel_callback
private

Definition at line 122 of file binary_sensor.py.

◆ entity_description

homeassistant.components.ring.binary_sensor.RingBinarySensor.entity_description

Definition at line 107 of file binary_sensor.py.

◆ None

homeassistant.components.ring.binary_sensor.RingBinarySensor.None
static

Definition at line 93 of file binary_sensor.py.


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