Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.bluetooth.passive_update_processor Namespace Reference

Classes

class  PassiveBluetoothDataProcessor
 
class  PassiveBluetoothDataUpdate
 
class  PassiveBluetoothEntityKey
 
class  PassiveBluetoothProcessorCoordinator
 
class  PassiveBluetoothProcessorData
 
class  PassiveBluetoothProcessorEntity
 
class  RestoredPassiveBluetoothDataUpdate
 

Functions

None __init__ (self, _PassiveBluetoothDataProcessorT processor, PassiveBluetoothEntityKey entity_key, EntityDescription description, Any context=None)
 
None _handle_processor_update (self, PassiveBluetoothDataUpdate[_PassiveBluetoothDataProcessorT]|None new_data)
 
None async_added_to_hass (self)
 
CALLBACK_TYPE async_register_coordinator_for_restore (HomeAssistant hass, PassiveBluetoothProcessorCoordinator[Any] coordinator)
 
None async_setup (HomeAssistant hass)
 
bool available (self)
 
EntityDescription deserialize_entity_description (type[EntityDescription] descriptions_class, dict[str, Any] data)
 
dict[str, Any] serialize_entity_description (EntityDescription description)
 

Variables

 _attr_device_info
 
bool _attr_has_entity_name = True
 
 _attr_name
 
bool _attr_should_poll = False
 
 _attr_unique_id
 
 cached_fields = cache(dataclasses.fields)
 
 entity_description
 
 entity_key
 
string PASSIVE_UPDATE_PROCESSOR = "passive_update_processor"
 
 processor
 
 processor_context
 
string STORAGE_KEY = "bluetooth.passive_update_processor"
 
 STORAGE_SAVE_INTERVAL = timedelta(minutes=15)
 
int STORAGE_VERSION = 1
 

Detailed Description

Passive update processors for the Bluetooth integration.

Function Documentation

◆ __init__()

None homeassistant.components.bluetooth.passive_update_processor.__init__ (   self,
_PassiveBluetoothDataProcessorT  processor,
PassiveBluetoothEntityKey  entity_key,
EntityDescription  description,
Any   context = None 
)
Create the entity with a PassiveBluetoothDataProcessor.

Definition at line 609 of file passive_update_processor.py.

◆ _handle_processor_update()

None homeassistant.components.bluetooth.passive_update_processor._handle_processor_update (   self,
PassiveBluetoothDataUpdate[_PassiveBluetoothDataProcessorT] | None  new_data 
)
private
Handle updated data from the processor.

Definition at line 661 of file passive_update_processor.py.

◆ async_added_to_hass()

None homeassistant.components.bluetooth.passive_update_processor.async_added_to_hass (   self)
When entity is added to hass.

Definition at line 651 of file passive_update_processor.py.

◆ async_register_coordinator_for_restore()

CALLBACK_TYPE homeassistant.components.bluetooth.passive_update_processor.async_register_coordinator_for_restore ( HomeAssistant  hass,
PassiveBluetoothProcessorCoordinator[Any]   coordinator 
)
Register a coordinator to have its processors data restored.

Definition at line 220 of file passive_update_processor.py.

◆ async_setup()

None homeassistant.components.bluetooth.passive_update_processor.async_setup ( HomeAssistant  hass)
Set up the passive update processor coordinators.

Definition at line 238 of file passive_update_processor.py.

◆ available()

bool homeassistant.components.bluetooth.passive_update_processor.available (   self)
Return if entity is available.

Definition at line 647 of file passive_update_processor.py.

◆ deserialize_entity_description()

EntityDescription homeassistant.components.bluetooth.passive_update_processor.deserialize_entity_description ( type[EntityDescription descriptions_class,
dict[str, Any]   data 
)
Deserialize an entity description.

Definition at line 93 of file passive_update_processor.py.

◆ serialize_entity_description()

dict[str, Any] homeassistant.components.bluetooth.passive_update_processor.serialize_entity_description ( EntityDescription  description)
Serialize an entity description.

Definition at line 115 of file passive_update_processor.py.

Variable Documentation

◆ _attr_device_info

homeassistant.components.bluetooth.passive_update_processor._attr_device_info
private

Definition at line 630 of file passive_update_processor.py.

◆ _attr_has_entity_name

bool homeassistant.components.bluetooth.passive_update_processor._attr_has_entity_name = True
private
A class for entities using PassiveBluetoothDataProcessor.

Definition at line 606 of file passive_update_processor.py.

◆ _attr_name

homeassistant.components.bluetooth.passive_update_processor._attr_name
private

Definition at line 644 of file passive_update_processor.py.

◆ _attr_should_poll

bool homeassistant.components.bluetooth.passive_update_processor._attr_should_poll = False
private

Definition at line 607 of file passive_update_processor.py.

◆ _attr_unique_id

homeassistant.components.bluetooth.passive_update_processor._attr_unique_id
private

Definition at line 633 of file passive_update_processor.py.

◆ cached_fields

homeassistant.components.bluetooth.passive_update_processor.cached_fields = cache(dataclasses.fields)

Definition at line 90 of file passive_update_processor.py.

◆ entity_description

homeassistant.components.bluetooth.passive_update_processor.entity_description

Definition at line 617 of file passive_update_processor.py.

◆ entity_key

homeassistant.components.bluetooth.passive_update_processor.entity_key

Definition at line 618 of file passive_update_processor.py.

◆ PASSIVE_UPDATE_PROCESSOR

string homeassistant.components.bluetooth.passive_update_processor.PASSIVE_UPDATE_PROCESSOR = "passive_update_processor"

Definition at line 44 of file passive_update_processor.py.

◆ processor

homeassistant.components.bluetooth.passive_update_processor.processor

Definition at line 619 of file passive_update_processor.py.

◆ processor_context

homeassistant.components.bluetooth.passive_update_processor.processor_context

Definition at line 620 of file passive_update_processor.py.

◆ STORAGE_KEY

string homeassistant.components.bluetooth.passive_update_processor.STORAGE_KEY = "bluetooth.passive_update_processor"

Definition at line 41 of file passive_update_processor.py.

◆ STORAGE_SAVE_INTERVAL

homeassistant.components.bluetooth.passive_update_processor.STORAGE_SAVE_INTERVAL = timedelta(minutes=15)

Definition at line 43 of file passive_update_processor.py.

◆ STORAGE_VERSION

int homeassistant.components.bluetooth.passive_update_processor.STORAGE_VERSION = 1

Definition at line 42 of file passive_update_processor.py.