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

Public Member Functions

None __init__ (self, HomeAssistant hass, FreeboxRouter router, dict[str, Any] node, dict[str, Any]|None sub_node=None)
 
None async_update_signal (self)
 
- Public Member Functions inherited from homeassistant.components.freebox.entity.FreeboxHomeEntity
None async_added_to_hass (self)
 
None async_will_remove_from_hass (self)
 
int|None get_command_id (self, nodes, str ep_type, str name)
 
Any|None get_home_endpoint_value (self, Any command_id)
 
def get_value (self, str ep_type, str name)
 
None remove_signal_update (self, Callable[[], None] dispatcher)
 
bool set_home_endpoint_value (self, int|None command_id, bool|None value=None)
 
- 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_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

bool|None _edit_state (self, bool|None state)
 

Private Attributes

 _attr_is_on
 
 _command_id
 
 _sensor_name
 

Static Private Attributes

string _sensor_name = "trigger"
 

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 a Freebox binary sensor.

Definition at line 69 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor.__init__ (   self,
HomeAssistant  hass,
FreeboxRouter  router,
dict[str, Any]  node,
dict[str, Any] | None   sub_node = None 
)
Initialize a Freebox binary sensor.

Reimplemented from homeassistant.components.freebox.entity.FreeboxHomeEntity.

Definition at line 74 of file binary_sensor.py.

Member Function Documentation

◆ _edit_state()

bool | None homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor._edit_state (   self,
bool | None  state 
)
private
Edit state depending on sensor name.

Definition at line 95 of file binary_sensor.py.

◆ async_update_signal()

None homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor.async_update_signal (   self)
Update name & state.

Reimplemented from homeassistant.components.freebox.entity.FreeboxHomeEntity.

Definition at line 88 of file binary_sensor.py.

Member Data Documentation

◆ _attr_is_on

homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor._attr_is_on
private

Definition at line 86 of file binary_sensor.py.

◆ _command_id

homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor._command_id
private

Definition at line 83 of file binary_sensor.py.

◆ _sensor_name [1/2]

string homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor._sensor_name = "trigger"
staticprivate

Definition at line 72 of file binary_sensor.py.

◆ _sensor_name [2/2]

homeassistant.components.freebox.binary_sensor.FreeboxHomeBinarySensor._sensor_name
private

Definition at line 99 of file binary_sensor.py.


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