Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sia.hub.SIAHub Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
None async_create_and_fire_event (self, SIAEvent event)
 
None async_setup_hub (self)
 
None async_shutdown (self, Event|None _=None)
 
def update_accounts (self)
 

Static Public Member Functions

None async_config_entry_updated (HomeAssistant hass, ConfigEntry config_entry)
 

Public Attributes

 sia_accounts
 
 sia_client
 

Private Member Functions

None _load_options (self)
 

Detailed Description

Class for SIA Hubs.

Definition at line 34 of file hub.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.sia.hub.SIAHub.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry 
)
Create the SIAHub.

Definition at line 37 of file hub.py.

Member Function Documentation

◆ _load_options()

None homeassistant.components.sia.hub.SIAHub._load_options (   self)
private
Store attributes to avoid property call overhead since they are called frequently.

Definition at line 121 of file hub.py.

◆ async_config_entry_updated()

None homeassistant.components.sia.hub.SIAHub.async_config_entry_updated ( HomeAssistant  hass,
ConfigEntry   config_entry 
)
static
Handle signals of config entry being updated.

First, update the accounts, this will reflect any changes with ignore_timestamps.
Second, unload underlying platforms, and then setup platforms, this reflects any changes in number of zones.

Definition at line 133 of file hub.py.

◆ async_create_and_fire_event()

None homeassistant.components.sia.hub.SIAHub.async_create_and_fire_event (   self,
SIAEvent  event 
)
Create a event on HA dispatcher and then on HA's bus, with the data from the SIAEvent.

The created event is handled by default for only a small subset for each platform (there are about 320 SIA Codes defined, only 22 of those are used in the alarm_control_panel), a user can choose to build other automation or even entities on the same event for SIA codes not handled by the built-in platforms.

Definition at line 76 of file hub.py.

◆ async_setup_hub()

None homeassistant.components.sia.hub.SIAHub.async_setup_hub (   self)
Add a device to the device_registry, register shutdown listener, load reactions.

Definition at line 53 of file hub.py.

◆ async_shutdown()

None homeassistant.components.sia.hub.SIAHub.async_shutdown (   self,
Event | None   _ = None 
)
Shutdown the SIA server.

Definition at line 71 of file hub.py.

◆ update_accounts()

def homeassistant.components.sia.hub.SIAHub.update_accounts (   self)
Update the SIA_Accounts variable.

Definition at line 96 of file hub.py.

Member Data Documentation

◆ sia_accounts

homeassistant.components.sia.hub.SIAHub.sia_accounts

Definition at line 99 of file hub.py.

◆ sia_client

homeassistant.components.sia.hub.SIAHub.sia_client

Definition at line 113 of file hub.py.


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