Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
homeassistant.components.netgear.router.NetgearRouter Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
None async_allow_block_device (self, str mac, str allow_block)
 
dict[str, Any]|None async_check_new_firmware (self)
 
list async_get_attached_devices (self)
 
dict[str, Any]|None async_get_link_status (self)
 
dict[str, Any]|None async_get_speed_test (self)
 
dict[str, Any]|None async_get_traffic_meter (self)
 
dict[str, Any]|None async_get_utilization (self)
 
None async_reboot (self)
 
bool async_setup (self)
 
bool async_update_device_trackers (self, now=None)
 
None async_update_new_firmware (self)
 
int port (self)
 
bool ssl (self)
 

Public Attributes

 api
 
 api_lock
 
 device_name
 
 entry
 
 entry_id
 
 firmware_version
 
 hardware_version
 
 hass
 
 method_version
 
 mode
 
 model
 
 serial_number
 
 track_devices
 
 unique_id
 

Private Member Functions

bool _setup (self)
 

Private Attributes

 _consider_home
 
 _info
 
 _password
 
 _username
 

Detailed Description

Representation of a Netgear router.

Definition at line 53 of file router.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.netgear.router.NetgearRouter.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry 
) 
Initialize a Netgear router.

Definition at line 56 of file router.py.

Member Function Documentation

◆ _setup()

bool homeassistant.components.netgear.router.NetgearRouter._setup (   self)
private 
Set up a Netgear router sync portion.

Definition at line 89 of file router.py.

◆ async_allow_block_device()

None homeassistant.components.netgear.router.NetgearRouter.async_allow_block_device (   self,
str  mac,
str  allow_block 
) 
Allow or block a device connected to the router.

Definition at line 236 of file router.py.

◆ async_check_new_firmware()

dict[str, Any] | None homeassistant.components.netgear.router.NetgearRouter.async_check_new_firmware (   self) 
Check for new firmware of the router.

Definition at line 253 of file router.py.

◆ async_get_attached_devices()

list homeassistant.components.netgear.router.NetgearRouter.async_get_attached_devices (   self) 
Get the devices connected to the router.

Definition at line 172 of file router.py.

◆ async_get_link_status()

dict[str, Any] | None homeassistant.components.netgear.router.NetgearRouter.async_get_link_status (   self) 
Check the ethernet link status of the router.

Definition at line 231 of file router.py.

◆ async_get_speed_test()

dict[str, Any] | None homeassistant.components.netgear.router.NetgearRouter.async_get_speed_test (   self) 
Perform a speed test and get the results from the router.

Definition at line 224 of file router.py.

◆ async_get_traffic_meter()

dict[str, Any] | None homeassistant.components.netgear.router.NetgearRouter.async_get_traffic_meter (   self) 
Get the traffic meter data of the router.

Definition at line 219 of file router.py.

◆ async_get_utilization()

dict[str, Any] | None homeassistant.components.netgear.router.NetgearRouter.async_get_utilization (   self) 
Get the system information about utilization of the router.

Definition at line 243 of file router.py.

◆ async_reboot()

None homeassistant.components.netgear.router.NetgearRouter.async_reboot (   self) 
Reboot the router.

Definition at line 248 of file router.py.

◆ async_setup()

bool homeassistant.components.netgear.router.NetgearRouter.async_setup (   self) 
Set up a Netgear router.

Definition at line 139 of file router.py.

◆ async_update_device_trackers()

bool homeassistant.components.netgear.router.NetgearRouter.async_update_device_trackers (   self,
  now = None 
) 
Update Netgear devices.

Definition at line 185 of file router.py.

◆ async_update_new_firmware()

None homeassistant.components.netgear.router.NetgearRouter.async_update_new_firmware (   self) 
Update the router to the latest firmware.

Definition at line 258 of file router.py.

◆ port()

int homeassistant.components.netgear.router.NetgearRouter.port (   self) 
Port used by the API.

Definition at line 264 of file router.py.

◆ ssl()

bool homeassistant.components.netgear.router.NetgearRouter.ssl (   self) 
SSL used by the API.

Definition at line 269 of file router.py.

Member Data Documentation

◆ _consider_home

homeassistant.components.netgear.router.NetgearRouter._consider_home
private

Definition at line 82 of file router.py.

◆ _info

homeassistant.components.netgear.router.NetgearRouter._info
private

Definition at line 69 of file router.py.

◆ _password

homeassistant.components.netgear.router.NetgearRouter._password
private

Definition at line 67 of file router.py.

◆ _username

homeassistant.components.netgear.router.NetgearRouter._username
private

Definition at line 66 of file router.py.

◆ api

homeassistant.components.netgear.router.NetgearRouter.api

Definition at line 91 of file router.py.

◆ api_lock

homeassistant.components.netgear.router.NetgearRouter.api_lock

Definition at line 85 of file router.py.

◆ device_name

homeassistant.components.netgear.router.NetgearRouter.device_name

Definition at line 72 of file router.py.

◆ entry

homeassistant.components.netgear.router.NetgearRouter.entry

Definition at line 60 of file router.py.

◆ entry_id

homeassistant.components.netgear.router.NetgearRouter.entry_id

Definition at line 61 of file router.py.

◆ firmware_version

homeassistant.components.netgear.router.NetgearRouter.firmware_version

Definition at line 73 of file router.py.

◆ hardware_version

homeassistant.components.netgear.router.NetgearRouter.hardware_version

Definition at line 74 of file router.py.

◆ hass

homeassistant.components.netgear.router.NetgearRouter.hass

Definition at line 59 of file router.py.

◆ method_version

homeassistant.components.netgear.router.NetgearRouter.method_version

Definition at line 78 of file router.py.

◆ mode

homeassistant.components.netgear.router.NetgearRouter.mode

Definition at line 71 of file router.py.

◆ model

homeassistant.components.netgear.router.NetgearRouter.model

Definition at line 70 of file router.py.

◆ serial_number

homeassistant.components.netgear.router.NetgearRouter.serial_number

Definition at line 75 of file router.py.

◆ track_devices

homeassistant.components.netgear.router.NetgearRouter.track_devices

Definition at line 77 of file router.py.

◆ unique_id

homeassistant.components.netgear.router.NetgearRouter.unique_id

Definition at line 62 of file router.py.

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