selfish / home-assistant-netgear-router-enhanced-integration

Adds sensors and actions Integration for select Netgear routers

Enhanced Netgear Integration for Home Assistant

Home Assistant Integration which adds sensors and actions for select Netgear routers to Home Assistant With HACS or Custom Component.

based on previous work by roblandry.

Router model support:

These are router which were tested and are known to work, add yours!

• XR500 (port 80)

For models which use port 80, see Setup below.

---

Features:

Switches:

Friendly Name	Entity	States
Access Control
Traffic Meter		on/off
Parental Control
QOS
2.4g Guest WiFi	switch.ng_enhanced_2g_guest_wifi	on/off
5g Guest WiFi
Run Speed Test	(switch will always toggle to off)
Reboot Router	switch.ng_enhanced_reboot	auto-toggles to off

Sensors:

The supported sensors are:

Firmware, App Firmware, Device Config, Access Control Status, Traffic Meter, Traffic Meter Enabled, Traffic Meter Opt, LAN Config, WAN Info, Parental Control Enabled, All MAC Addresses, DNS Masq, Info, Supported Features, Speed Test Result, QOS Enabled, Bandwidth Control, 2G Guest Wifi, 5G Guest Wifi, WPA Security Key, 5G WPA Security Key, 2G Info, 5G Info, Channel, 2G Guest Wifi Info, 5G Guest Wifi Info, Smart Connect

---

Setup

Note that you will need to restart Home Assistant after installion, whichever method is used.

Option 1 - HACS (recommended!):

1. In HACS, go to Integrations, and then click the orange '+' button in the lower right corner to add an integration.
2. Search for "Hubitat" and install it.

Option 2 - Manual:

1. Create a directory named netgear_enhanced under custom_components.
2. Copy the files from to the netgear_enhanced folder in this repository.

Configurations:

• Use the following examples in your configuration file (typically configuration.yaml). Note that you may need to merge switch and sensor keys with existing ones.
• Make sure to modify the parameters to fit your needs. It's recommended to use secrets for all sensitive info.
• After making changes there may be some delay before entities are updated due to the router changing configuration.
• Different routers use different ports for authentication. If you know your router port is different from 5000, specify that, otherwise, ususally 5000 or 80 will work.
• Each configuration key is either required, or is not required because it uses a default value, which is mentioned below

Default values:

Config Value	Explanation	Required? (Default)
username	Router access username	Yes
password	Router access password	Yes
host	Router access URL/IP	No (Default: 192.168.1.1)
port	Router access port. This is typically 5000 or 80.	No (Default: 5000)
ssl	Should the integration access the router using SSL? (true/false)	No (Default: false)
prefix	Entities created by the integration will use this as a prefix for their id	No (Default: ng_enhanced)
scan_interval	Interval between updates polling from the router	No (Default: 5 minutes)
resources	List of resources to use in Home Assistant. See examples below for full lists of available resources	Yes

Actions / Switches:

# Configuration.yaml:
switch:
  - platform: netgear_enhanced
    host: !secret my_secret_ip
    username: !secret my_secret_netgear_user
    password: !secret my_secret_netgear_pass
    resources:
      - 'access_control'
      - 'traffic_meter'
      - 'parental_control'
      - 'qos'
      - '2g_guest_wifi'
      - '5g_guest_wifi'
      - 'run_speed_test'
      - 'reboot'

Sensors:

# Configuration.yaml:
sensor:
  - platform: netgear_enhanced
    host: !secret my_secret_ip
    username: !secret my_secret_netgear_user
    password: !secret my_secret_netgear_pass
    resources:
      - firmware
      - check_app_fw
      - get_device_config_info
      - access_control_on
      - traffic_meter
      - traffic_meter_on
      - traffic_meter_options
      - get_lan_config_info
      - get_wan_ip_info
      - parental_control_on
      - mac_address
      - dns_masq
      - info
      - supported_features
      - speed_test_result
      - qos_enabled
      - bw_control
      - 2g_guest_wifi_on
      - 5g_guest_wifi_on
      - 2g_wpa_key
      - 5g_wpa_key
      - 2g_wifi_info
      - 5g_wifi_info
      - get_channel
      - 2g_guest_wifi_info
      - 5g_guest_wifi_info
      - get_smart_conn