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

Public Member Functions

None __init__ (self, rfxtrxmod.RFXtrxDevice device, DeviceTuple device_id, BinarySensorEntityDescription entity_description, float|None off_delay=None, int|None data_bits=None, int|None cmd_on=None, int|None cmd_off=None, rfxtrxmod.RFXtrxEvent|None event=None)
 
None async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.rfxtrx.entity.RfxtrxEntity
None __init__ (self, rfxtrxmod.RFXtrxDevice device, DeviceTuple device_id, rfxtrxmod.RFXtrxEvent|None event=None)
 
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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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 Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (self)
 

Public Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 entity_category
 

Private Member Functions

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

Private Attributes

 _attr_is_on
 
 _cmd_off
 
 _cmd_on
 
 _data_bits
 
 _delay_listener
 
 _off_delay
 

Static Private Attributes

bool _attr_force_update = True
 
 _attr_name = None
 

Additional Inherited Members

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

Detailed Description

A representation of a RFXtrx binary sensor.

Since all repeated events have meaning, these types of sensors
need to have force update enabled.

Definition at line 127 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor.__init__ (   self,
rfxtrxmod.RFXtrxDevice  device,
DeviceTuple  device_id,
BinarySensorEntityDescription  entity_description,
float | None   off_delay = None,
int | None   data_bits = None,
int | None   cmd_on = None,
int | None   cmd_off = None,
rfxtrxmod.RFXtrxEvent | None   event = None 
)
Initialize the RFXtrx sensor.

Definition at line 137 of file binary_sensor.py.

Member Function Documentation

◆ _apply_event()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._apply_event (   self,
rfxtrxmod.RFXtrxEvent  event 
)
private
Apply command from rfxtrx.

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

Definition at line 193 of file binary_sensor.py.

◆ _apply_event_lighting4()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._apply_event_lighting4 (   self,
rfxtrxmod.RFXtrxEvent  event 
)
private
Apply event for a lighting 4 device.

Definition at line 169 of file binary_sensor.py.

◆ _apply_event_standard()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._apply_event_standard (   self,
rfxtrxmod.RFXtrxEvent  event 
)
private

Definition at line 182 of file binary_sensor.py.

◆ _handle_event()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._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 202 of file binary_sensor.py.

◆ async_added_to_hass()

None homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor.async_added_to_hass (   self)
Restore device state.

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

Definition at line 157 of file binary_sensor.py.

Member Data Documentation

◆ _attr_force_update

bool homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._attr_force_update = True
staticprivate

Definition at line 134 of file binary_sensor.py.

◆ _attr_is_on

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._attr_is_on
private

Definition at line 164 of file binary_sensor.py.

◆ _attr_name

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._attr_name = None
staticprivate

Definition at line 135 of file binary_sensor.py.

◆ _cmd_off

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._cmd_off
private

Definition at line 155 of file binary_sensor.py.

◆ _cmd_on

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._cmd_on
private

Definition at line 154 of file binary_sensor.py.

◆ _data_bits

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._data_bits
private

Definition at line 151 of file binary_sensor.py.

◆ _delay_listener

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._delay_listener
private

Definition at line 222 of file binary_sensor.py.

◆ _off_delay

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor._off_delay
private

Definition at line 152 of file binary_sensor.py.

◆ entity_description

homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor.entity_description

Definition at line 150 of file binary_sensor.py.


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