Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.deconz.hub.hub.DeconzHub Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry config_entry, DeconzSession api)
 
None async_connection_status_callback (self, bool available)
 
bool async_reset (self)
 
None async_update_device_registry (self)
 
str bridgeid (self)
 
None load_ignored_devices (self)
 
bool master (self)
 
None options_updated (self, DeconzConfig previous_config)
 
None register_platform_add_device_callback (self, Callable[[EventType, str], None] add_device_callback, APIHandler|GroupedAPIHandler deconz_device_interface, bool always_ignore_clip_sensors=False)
 
None shutdown (self, Event event)
 

Static Public Member Functions

None async_config_entry_updated (HomeAssistant hass, ConfigEntry config_entry)
 
DeconzHub get_hub (HomeAssistant hass, ConfigEntry config_entry)
 

Public Attributes

 api
 
 available
 
 config
 
 config_entry
 
 deconz_ids
 
 hass
 
 ignore_state_updates
 
 signal_reachable
 

Detailed Description

Manages a single deCONZ gateway.

Definition at line 66 of file hub.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.deconz.hub.hub.DeconzHub.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  config_entry,
DeconzSession   api 
)
Initialize the system.

Definition at line 69 of file hub.py.

Member Function Documentation

◆ async_config_entry_updated()

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

This is a static method because a class method (bound method),
cannot be used with weak references.
Causes for this is either discovery updating host address or
config entry options changing.

Definition at line 210 of file hub.py.

◆ async_connection_status_callback()

None homeassistant.components.deconz.hub.hub.DeconzHub.async_connection_status_callback (   self,
bool  available 
)
Handle signals of gateway connection status.

Definition at line 174 of file hub.py.

◆ async_reset()

bool homeassistant.components.deconz.hub.hub.DeconzHub.async_reset (   self)
Reset this gateway to default state.

Definition at line 290 of file hub.py.

◆ async_update_device_registry()

None homeassistant.components.deconz.hub.hub.DeconzHub.async_update_device_registry (   self)
Update device registry.

Definition at line 180 of file hub.py.

◆ bridgeid()

str homeassistant.components.deconz.hub.hub.DeconzHub.bridgeid (   self)
Return the unique identifier of the gateway.

Definition at line 104 of file hub.py.

◆ get_hub()

DeconzHub homeassistant.components.deconz.hub.hub.DeconzHub.get_hub ( HomeAssistant  hass,
ConfigEntry  config_entry 
)
static
Return hub with a matching config entry ID.

Definition at line 99 of file hub.py.

◆ load_ignored_devices()

None homeassistant.components.deconz.hub.hub.DeconzHub.load_ignored_devices (   self)
Load previously ignored devices.

Definition at line 165 of file hub.py.

◆ master()

bool homeassistant.components.deconz.hub.hub.DeconzHub.master (   self)
Gateway which is used with deCONZ services without defining id.

Definition at line 109 of file hub.py.

◆ options_updated()

None homeassistant.components.deconz.hub.hub.DeconzHub.options_updated (   self,
DeconzConfig  previous_config 
)
Manage entities affected by config entry options.

Definition at line 235 of file hub.py.

◆ register_platform_add_device_callback()

None homeassistant.components.deconz.hub.hub.DeconzHub.register_platform_add_device_callback (   self,
Callable[[EventType, str], None]  add_device_callback,
APIHandler | GroupedAPIHandler  deconz_device_interface,
bool   always_ignore_clip_sensors = False 
)
Wrap add_device_callback to check allow_new_devices option.

Definition at line 114 of file hub.py.

◆ shutdown()

None homeassistant.components.deconz.hub.hub.DeconzHub.shutdown (   self,
Event  event 
)
Wrap the call to deconz.close.

Used as an argument to EventBus.async_listen_once.

Definition at line 283 of file hub.py.

Member Data Documentation

◆ api

homeassistant.components.deconz.hub.hub.DeconzHub.api

Definition at line 76 of file hub.py.

◆ available

homeassistant.components.deconz.hub.hub.DeconzHub.available

Definition at line 80 of file hub.py.

◆ config

homeassistant.components.deconz.hub.hub.DeconzHub.config

Definition at line 74 of file hub.py.

◆ config_entry

homeassistant.components.deconz.hub.hub.DeconzHub.config_entry

Definition at line 75 of file hub.py.

◆ deconz_ids

homeassistant.components.deconz.hub.hub.DeconzHub.deconz_ids

Definition at line 299 of file hub.py.

◆ hass

homeassistant.components.deconz.hub.hub.DeconzHub.hass

Definition at line 73 of file hub.py.

◆ ignore_state_updates

homeassistant.components.deconz.hub.hub.DeconzHub.ignore_state_updates

Definition at line 81 of file hub.py.

◆ signal_reachable

homeassistant.components.deconz.hub.hub.DeconzHub.signal_reachable

Definition at line 83 of file hub.py.


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