Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic Class Reference
Inheritance diagram for homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic:
[legend]
Collaboration diagram for homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic:
[legend]

Public Member Functions

None __init__ (self, rfxtrxmod.RFXtrxDevice device, DeviceTuple device_id, float|None off_delay=None, rfxtrxmod.RFXtrxEvent|None event=None)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.rfxtrx.entity.RfxtrxCommandEntity
None __init__ (self, rfxtrxmod.RFXtrxDevice device, DeviceTuple device_id, rfxtrxmod.RFXtrxEvent|None event=None)
 
- Public Member Functions inherited from homeassistant.components.rfxtrx.entity.RfxtrxEntity
None async_added_to_hass (self)
 
dict[str, str]|None extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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_device_update (self, bool warning=True)
 
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_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (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 Member Functions inherited from homeassistant.components.siren.SirenEntity
list[int|str]|dict[int, str]|None available_tones (self)
 
dict[str, Any]|None capability_attributes (self)
 
SirenEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin
None async_will_remove_from_hass (self)
 

Private Member Functions

None _apply_event (self, rfxtrxmod.SensorEvent event)
 
None _handle_event (self, rfxtrxmod.RFXtrxEvent event, DeviceTuple device_id)
 

Private Attributes

 _off_delay
 
 _off_value
 
 _on_value
 

Static Private Attributes

 _attr_supported_features = SirenEntityFeature.TURN_ON | SirenEntityFeature.TURN_OFF
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.siren.SirenEntity
 SirenEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin
 None
 

Detailed Description

Representation of a security device.

Definition at line 184 of file siren.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic.__init__ (   self,
rfxtrxmod.RFXtrxDevice  device,
DeviceTuple  device_id,
float | None   off_delay = None,
rfxtrxmod.RFXtrxEvent | None   event = None 
)
Initialize the entity.

Definition at line 190 of file siren.py.

Member Function Documentation

◆ _apply_event()

None homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._apply_event (   self,
rfxtrxmod.SensorEvent  event 
)
private
Apply a received event.

Definition at line 226 of file siren.py.

◆ _handle_event()

None homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._handle_event (   self,
rfxtrxmod.RFXtrxEvent  event,
DeviceTuple   device_id 
)
private
Check if event applies to me and update.

Reimplemented from homeassistant.components.rfxtrx.entity.RfxtrxEntity.

Definition at line 239 of file siren.py.

◆ async_turn_off()

None homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic.async_turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 218 of file siren.py.

◆ async_turn_on()

None homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic.async_turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 208 of file siren.py.

◆ is_on()

bool homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 204 of file siren.py.

Member Data Documentation

◆ _attr_supported_features

homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._attr_supported_features = SirenEntityFeature.TURN_ON | SirenEntityFeature.TURN_OFF
staticprivate

Definition at line 187 of file siren.py.

◆ _off_delay

homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._off_delay
private

Definition at line 201 of file siren.py.

◆ _off_value

homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._off_value
private

Definition at line 200 of file siren.py.

◆ _on_value

homeassistant.components.rfxtrx.siren.RfxtrxSecurityPanic._on_value
private

Definition at line 199 of file siren.py.


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