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

Public Member Functions

None __init__ (self, HomeAssistant hass, pyflic.FlicClient client, str address, int timeout, list[str]|None ignored_click_types)
 
- 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)
 
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)
 

Private Member Functions

def _connection_status_changed (self, channel, connection_status, disconnect_reason)
 
pyflic.ButtonConnectionChannel _create_channel (self)
 
def _on_click (self, channel, click_type, was_queued, time_diff)
 
def _on_up_down (self, channel, click_type, was_queued, time_diff)
 
def _queued_event_check (self, click_type, time_diff)
 

Private Attributes

 _address
 
 _attr_extra_state_attributes
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _channel
 
 _hass
 
 _hass_click_types
 
 _ignored_click_types
 
 _timeout
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- 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 inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a flic button.

Definition at line 140 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.flic.binary_sensor.FlicButton.__init__ (   self,
HomeAssistant  hass,
pyflic.FlicClient  client,
str  address,
int  timeout,
list[str] | None  ignored_click_types 
)
Initialize the flic button.

Definition at line 145 of file binary_sensor.py.

Member Function Documentation

◆ _connection_status_changed()

def homeassistant.components.flic.binary_sensor.FlicButton._connection_status_changed (   self,
  channel,
  connection_status,
  disconnect_reason 
)
private
Remove device, if button disconnects.

Definition at line 243 of file binary_sensor.py.

◆ _create_channel()

pyflic.ButtonConnectionChannel homeassistant.components.flic.binary_sensor.FlicButton._create_channel (   self)
private
Create a new connection channel to the button.

Definition at line 173 of file binary_sensor.py.

◆ _on_click()

def homeassistant.components.flic.binary_sensor.FlicButton._on_click (   self,
  channel,
  click_type,
  was_queued,
  time_diff 
)
private
Fire click event, if event was not queued.

Definition at line 222 of file binary_sensor.py.

◆ _on_up_down()

def homeassistant.components.flic.binary_sensor.FlicButton._on_up_down (   self,
  channel,
  click_type,
  was_queued,
  time_diff 
)
private
Update device state, if event was not queued.

Definition at line 214 of file binary_sensor.py.

◆ _queued_event_check()

def homeassistant.components.flic.binary_sensor.FlicButton._queued_event_check (   self,
  click_type,
  time_diff 
)
private
Generate a log message and returns true if timeout exceeded.

Definition at line 194 of file binary_sensor.py.

Member Data Documentation

◆ _address

homeassistant.components.flic.binary_sensor.FlicButton._address
private

Definition at line 159 of file binary_sensor.py.

◆ _attr_extra_state_attributes

homeassistant.components.flic.binary_sensor.FlicButton._attr_extra_state_attributes
private

Definition at line 155 of file binary_sensor.py.

◆ _attr_is_on

homeassistant.components.flic.binary_sensor.FlicButton._attr_is_on
private

Definition at line 161 of file binary_sensor.py.

◆ _attr_name

homeassistant.components.flic.binary_sensor.FlicButton._attr_name
private

Definition at line 156 of file binary_sensor.py.

◆ _attr_should_poll

bool homeassistant.components.flic.binary_sensor.FlicButton._attr_should_poll = False
staticprivate

Definition at line 143 of file binary_sensor.py.

◆ _attr_unique_id

homeassistant.components.flic.binary_sensor.FlicButton._attr_unique_id
private

Definition at line 157 of file binary_sensor.py.

◆ _channel

homeassistant.components.flic.binary_sensor.FlicButton._channel
private

Definition at line 170 of file binary_sensor.py.

◆ _hass

homeassistant.components.flic.binary_sensor.FlicButton._hass
private

Definition at line 158 of file binary_sensor.py.

◆ _hass_click_types

homeassistant.components.flic.binary_sensor.FlicButton._hass_click_types
private

Definition at line 163 of file binary_sensor.py.

◆ _ignored_click_types

homeassistant.components.flic.binary_sensor.FlicButton._ignored_click_types
private

Definition at line 162 of file binary_sensor.py.

◆ _timeout

homeassistant.components.flic.binary_sensor.FlicButton._timeout
private

Definition at line 160 of file binary_sensor.py.


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