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

Public Member Functions

def __init__ (self, client, zone_number, zone_name, zone_type, zone_rfid, zone_loop, relay_addr, relay_chan)
 
None async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.alarmdecoder.entity.AlarmDecoderEntity
def __init__ (self, client)
 
- 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_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)
 
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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 

Private Member Functions

def _fault_callback (self, zone)
 
def _rel_message_callback (self, message)
 
def _restore_callback (self, zone)
 
def _rfx_message_callback (self, message)
 

Private Attributes

 _attr_device_class
 
 _attr_extra_state_attributes
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _loop
 
 _relay_addr
 
 _relay_chan
 
 _rfid
 
 _zone_number
 
 _zone_type
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- 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
 
- 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

Representation of an AlarmDecoder binary sensor.

Definition at line 74 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor.__init__ (   self,
  client,
  zone_number,
  zone_name,
  zone_type,
  zone_rfid,
  zone_loop,
  relay_addr,
  relay_chan 
)
Initialize the binary_sensor.

Definition at line 79 of file binary_sensor.py.

Member Function Documentation

◆ _fault_callback()

def homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._fault_callback (   self,
  zone 
)
private
Update the zone's state, if needed.

Definition at line 130 of file binary_sensor.py.

◆ _rel_message_callback()

def homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._rel_message_callback (   self,
  message 
)
private
Update relay / expander state.

Definition at line 161 of file binary_sensor.py.

◆ _restore_callback()

def homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._restore_callback (   self,
  zone 
)
private
Update the zone's state, if needed.

Definition at line 136 of file binary_sensor.py.

◆ _rfx_message_callback()

def homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._rfx_message_callback (   self,
  message 
)
private
Update RF state.

Definition at line 142 of file binary_sensor.py.

◆ async_added_to_hass()

None homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 106 of file binary_sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_device_class
private

Definition at line 101 of file binary_sensor.py.

◆ _attr_extra_state_attributes

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_extra_state_attributes
private

Definition at line 102 of file binary_sensor.py.

◆ _attr_is_on

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_is_on
private

Definition at line 96 of file binary_sensor.py.

◆ _attr_name

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_name
private

Definition at line 95 of file binary_sensor.py.

◆ _attr_should_poll

bool homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_should_poll = False
staticprivate

Definition at line 77 of file binary_sensor.py.

◆ _attr_unique_id

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._attr_unique_id
private

Definition at line 92 of file binary_sensor.py.

◆ _loop

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._loop
private

Definition at line 98 of file binary_sensor.py.

◆ _relay_addr

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._relay_addr
private

Definition at line 99 of file binary_sensor.py.

◆ _relay_chan

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._relay_chan
private

Definition at line 100 of file binary_sensor.py.

◆ _rfid

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._rfid
private

Definition at line 97 of file binary_sensor.py.

◆ _zone_number

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._zone_number
private

Definition at line 93 of file binary_sensor.py.

◆ _zone_type

homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor._zone_type
private

Definition at line 94 of file binary_sensor.py.


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