Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.fibaro.FibaroController Class Reference

Public Member Functions

None __init__ (self, Mapping[str, Any] config)
 
None connect (self)
 
None connect_with_error_handling (self)
 
None disable_state_handler (self)
 
None enable_state_handler (self)
 
list[set[tuple[str, str]]] get_all_device_identifiers (self)
 
list[DeviceModel] get_children (self, int device_id)
 
list[DeviceModel] get_children2 (self, int device_id, int endpoint_id)
 
DeviceInfo get_device_info (self, DeviceModel device)
 
str|None get_room_name (self, int room_id)
 
list[DeviceModel] get_siblings (self, DeviceModel device)
 
list[SceneModel] read_scenes (self)
 
None register (self, int device_id, Any callback)
 
None register_event (self, int device_id, Callable[[FibaroEvent], None] callback)
 

Public Attributes

 hub_model
 
 hub_name
 
 hub_serial
 
 hub_software_version
 

Private Member Functions

None _create_device_info (self, DeviceModel device, list[DeviceModel] devices)
 
None _on_state_change (self, Any state)
 
None _read_devices (self)
 

Static Private Member Functions

Platform|None _map_device_to_platform (DeviceModel device)
 

Private Attributes

 _client
 
 _device_map
 
 _import_plugins
 
 _room_map
 
 _scenes
 

Detailed Description

Initiate Fibaro Controller Class.

Definition at line 73 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fibaro.FibaroController.__init__ (   self,
Mapping[str, Any]  config 
)
Initiate Fibaro Controller Class.
Initialize the Fibaro controller.

Definition at line 76 of file __init__.py.

Member Function Documentation

◆ _create_device_info()

None homeassistant.components.fibaro.FibaroController._create_device_info (   self,
DeviceModel  device,
list[DeviceModel]   devices 
)
private
Create the device info. Unrooted entities are directly shown below the home center.

Definition at line 258 of file __init__.py.

◆ _map_device_to_platform()

Platform | None homeassistant.components.fibaro.FibaroController._map_device_to_platform ( DeviceModel  device)
staticprivate
Map device to HA device type.

Definition at line 223 of file __init__.py.

◆ _on_state_change()

None homeassistant.components.fibaro.FibaroController._on_state_change (   self,
Any  state 
)
private
Handle change report received from the HomeCenter.

Definition at line 142 of file __init__.py.

◆ _read_devices()

None homeassistant.components.fibaro.FibaroController._read_devices (   self)
private
Read and process the device list.

Definition at line 312 of file __init__.py.

◆ connect()

None homeassistant.components.fibaro.FibaroController.connect (   self)
Start the communication with the Fibaro controller.

Definition at line 103 of file __init__.py.

◆ connect_with_error_handling()

None homeassistant.components.fibaro.FibaroController.connect_with_error_handling (   self)
Translate connect errors to easily differentiate auth and connect failures.

When there is a better error handling in the used library this can be improved.

Definition at line 119 of file __init__.py.

◆ disable_state_handler()

None homeassistant.components.fibaro.FibaroController.disable_state_handler (   self)
Stop StateHandler thread used for monitoring updates.

Definition at line 138 of file __init__.py.

◆ enable_state_handler()

None homeassistant.components.fibaro.FibaroController.enable_state_handler (   self)
Start StateHandler thread for monitoring updates.

Definition at line 134 of file __init__.py.

◆ get_all_device_identifiers()

list[set[tuple[str, str]]] homeassistant.components.fibaro.FibaroController.get_all_device_identifiers (   self)
Get all identifiers of fibaro integration.

Definition at line 298 of file __init__.py.

◆ get_children()

list[DeviceModel] homeassistant.components.fibaro.FibaroController.get_children (   self,
int  device_id 
)
Get a list of child devices.

Definition at line 199 of file __init__.py.

◆ get_children2()

list[DeviceModel] homeassistant.components.fibaro.FibaroController.get_children2 (   self,
int  device_id,
int  endpoint_id 
)
Get a list of child devices for the same endpoint.

Definition at line 207 of file __init__.py.

◆ get_device_info()

DeviceInfo homeassistant.components.fibaro.FibaroController.get_device_info (   self,
DeviceModel  device 
)
Get the device info by fibaro device id.

Definition at line 290 of file __init__.py.

◆ get_room_name()

str | None homeassistant.components.fibaro.FibaroController.get_room_name (   self,
int  room_id 
)
Get the room name by room id.

Definition at line 302 of file __init__.py.

◆ get_siblings()

list[DeviceModel] homeassistant.components.fibaro.FibaroController.get_siblings (   self,
DeviceModel  device 
)
Get the siblings of a device.

Definition at line 216 of file __init__.py.

◆ read_scenes()

list[SceneModel] homeassistant.components.fibaro.FibaroController.read_scenes (   self)
Return list of scenes.

Definition at line 308 of file __init__.py.

◆ register()

None homeassistant.components.fibaro.FibaroController.register (   self,
int  device_id,
Any  callback 
)
Register device with a callback for updates.

Definition at line 184 of file __init__.py.

◆ register_event()

None homeassistant.components.fibaro.FibaroController.register_event (   self,
int  device_id,
Callable[[FibaroEvent], None]   callback 
)
Register device with a callback for central scene events.

The callback receives one parameter with the event.

Definition at line 189 of file __init__.py.

Member Data Documentation

◆ _client

homeassistant.components.fibaro.FibaroController._client
private

Definition at line 80 of file __init__.py.

◆ _device_map

homeassistant.components.fibaro.FibaroController._device_map
private

Definition at line 315 of file __init__.py.

◆ _import_plugins

homeassistant.components.fibaro.FibaroController._import_plugins
private

Definition at line 84 of file __init__.py.

◆ _room_map

homeassistant.components.fibaro.FibaroController._room_map
private

Definition at line 115 of file __init__.py.

◆ _scenes

homeassistant.components.fibaro.FibaroController._scenes
private

Definition at line 117 of file __init__.py.

◆ hub_model

homeassistant.components.fibaro.FibaroController.hub_model

Definition at line 112 of file __init__.py.

◆ hub_name

homeassistant.components.fibaro.FibaroController.hub_name

Definition at line 111 of file __init__.py.

◆ hub_serial

homeassistant.components.fibaro.FibaroController.hub_serial

Definition at line 110 of file __init__.py.

◆ hub_software_version

homeassistant.components.fibaro.FibaroController.hub_software_version

Definition at line 113 of file __init__.py.


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