Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.subscription.EntitySubscription Class Reference

Public Member Functions

None resubscribe_if_necessary (self, HomeAssistant hass, EntitySubscription|None other)
 
None subscribe (self)
 

Public Attributes

 should_subscribe
 
 unsubscribe_callback
 

Static Public Attributes

 int
 
 str
 

Private Member Functions

bool _should_resubscribe (self, EntitySubscription|None other)
 

Detailed Description

Class to hold data about an active entity topic subscription.

Definition at line 19 of file subscription.py.

Member Function Documentation

◆ _should_resubscribe()

bool homeassistant.components.mqtt.subscription.EntitySubscription._should_resubscribe (   self,
EntitySubscription | None  other 
)
private
Check if we should re-subscribe to the topic using the old state.

Definition at line 70 of file subscription.py.

◆ resubscribe_if_necessary()

None homeassistant.components.mqtt.subscription.EntitySubscription.resubscribe_if_necessary (   self,
HomeAssistant  hass,
EntitySubscription | None   other 
)
Re-subscribe to the new topic if necessary.

Definition at line 32 of file subscription.py.

◆ subscribe()

None homeassistant.components.mqtt.subscription.EntitySubscription.subscribe (   self)
Subscribe to a topic.

Definition at line 57 of file subscription.py.

Member Data Documentation

◆ int

homeassistant.components.mqtt.subscription.EntitySubscription.int
static
Class to hold data about an active entity topic subscription.

Definition at line 27 of file subscription.py.

◆ should_subscribe

homeassistant.components.mqtt.subscription.EntitySubscription.should_subscribe

Definition at line 54 of file subscription.py.

◆ str

homeassistant.components.mqtt.subscription.EntitySubscription.str
static

Definition at line 28 of file subscription.py.

◆ unsubscribe_callback

homeassistant.components.mqtt.subscription.EntitySubscription.unsubscribe_callback

Definition at line 39 of file subscription.py.


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