Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.freebox.router.FreeboxRouter Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry, Freepybox api, Mapping[str, Any] freebox_config)
 
Call call (self)
 
None close (self)
 
DeviceInfo device_info (self)
 
Home home (self)
 
None reboot (self)
 
dict[str, Any] sensors (self)
 
str signal_device_new (self)
 
str signal_device_update (self)
 
str signal_home_device_new (self)
 
str signal_home_device_update (self)
 
str signal_sensor_update (self)
 
None update_all (self, datetime|None now=None)
 
None update_device_trackers (self)
 
None update_home_devices (self)
 
None update_sensors (self)
 
Wifi wifi (self)
 

Public Attributes

 call_list
 
 hass
 
 home_granted
 
 supports_hosts
 
 supports_raid
 

Private Member Functions

None _update_disks_sensors (self)
 
None _update_raids_sensors (self)
 

Private Attributes

 _attrs
 
 _host
 
 _port
 

Detailed Description

Representation of a Freebox router.

Definition at line 95 of file router.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.freebox.router.FreeboxRouter.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry,
Freepybox  api,
Mapping[str, Any]  freebox_config 
)
Initialize a Freebox router.

Definition at line 98 of file router.py.

Member Function Documentation

◆ _update_disks_sensors()

None homeassistant.components.freebox.router.FreeboxRouter._update_disks_sensors (   self)
private
Update Freebox disks.

Definition at line 205 of file router.py.

◆ _update_raids_sensors()

None homeassistant.components.freebox.router.FreeboxRouter._update_raids_sensors (   self)
private
Update Freebox raids.

Definition at line 218 of file router.py.

◆ call()

Call homeassistant.components.freebox.router.FreeboxRouter.call (   self)
Return the call.

Definition at line 313 of file router.py.

◆ close()

None homeassistant.components.freebox.router.FreeboxRouter.close (   self)
Close the connection.

Definition at line 265 of file router.py.

◆ device_info()

DeviceInfo homeassistant.components.freebox.router.FreeboxRouter.device_info (   self)
Return the device information.

Definition at line 271 of file router.py.

◆ home()

Home homeassistant.components.freebox.router.FreeboxRouter.home (   self)
Return the home.

Definition at line 323 of file router.py.

◆ reboot()

None homeassistant.components.freebox.router.FreeboxRouter.reboot (   self)
Reboot the Freebox.

Definition at line 261 of file router.py.

◆ sensors()

dict[str, Any] homeassistant.components.freebox.router.FreeboxRouter.sensors (   self)
Return sensors.

Definition at line 308 of file router.py.

◆ signal_device_new()

str homeassistant.components.freebox.router.FreeboxRouter.signal_device_new (   self)
Event specific per Freebox entry to signal new device.

Definition at line 283 of file router.py.

◆ signal_device_update()

str homeassistant.components.freebox.router.FreeboxRouter.signal_device_update (   self)
Event specific per Freebox entry to signal updates in devices.

Definition at line 293 of file router.py.

◆ signal_home_device_new()

str homeassistant.components.freebox.router.FreeboxRouter.signal_home_device_new (   self)
Event specific per Freebox entry to signal new home device.

Definition at line 288 of file router.py.

◆ signal_home_device_update()

str homeassistant.components.freebox.router.FreeboxRouter.signal_home_device_update (   self)
Event specific per Freebox entry to signal update in home devices.

Definition at line 303 of file router.py.

◆ signal_sensor_update()

str homeassistant.components.freebox.router.FreeboxRouter.signal_sensor_update (   self)
Event specific per Freebox entry to signal updates in sensors.

Definition at line 298 of file router.py.

◆ update_all()

None homeassistant.components.freebox.router.FreeboxRouter.update_all (   self,
datetime | None   now = None 
)
Update all Freebox platforms.

Definition at line 128 of file router.py.

◆ update_device_trackers()

None homeassistant.components.freebox.router.FreeboxRouter.update_device_trackers (   self)
Update Freebox devices.

Definition at line 134 of file router.py.

◆ update_home_devices()

None homeassistant.components.freebox.router.FreeboxRouter.update_home_devices (   self)
Update Home devices (alarm, light, sensor, switch, remote ...).

Definition at line 237 of file router.py.

◆ update_sensors()

None homeassistant.components.freebox.router.FreeboxRouter.update_sensors (   self)
Update Freebox sensors.

Definition at line 171 of file router.py.

◆ wifi()

Wifi homeassistant.components.freebox.router.FreeboxRouter.wifi (   self)
Return the wifi.

Definition at line 318 of file router.py.

Member Data Documentation

◆ _attrs

homeassistant.components.freebox.router.FreeboxRouter._attrs
private

Definition at line 187 of file router.py.

◆ _host

homeassistant.components.freebox.router.FreeboxRouter._host
private

Definition at line 107 of file router.py.

◆ _port

homeassistant.components.freebox.router.FreeboxRouter._port
private

Definition at line 108 of file router.py.

◆ call_list

homeassistant.components.freebox.router.FreeboxRouter.call_list

Definition at line 198 of file router.py.

◆ hass

homeassistant.components.freebox.router.FreeboxRouter.hass

Definition at line 106 of file router.py.

◆ home_granted

homeassistant.components.freebox.router.FreeboxRouter.home_granted

Definition at line 124 of file router.py.

◆ supports_hosts

homeassistant.components.freebox.router.FreeboxRouter.supports_hosts

Definition at line 116 of file router.py.

◆ supports_raid

homeassistant.components.freebox.router.FreeboxRouter.supports_raid

Definition at line 119 of file router.py.


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