ckw-ha-gs108e

HomeAssistant Netgear Switch Integration

What it does

Grabs statistical network data from supported Netgear Switches

How it works

1. Detecting Switch Model/Product in login.cgi
2. Connects to the Switch and asks for a cookie (http://IP_OF_SWITCH/login.cgi)
3. HTTP-Request send to the Switch twice (http://IP_OF_SWITCH/portStatistics.cgi) and compared with previous data ("in response time")

Which entities

• overall Switch statistics as attributes
  • Diagnostic Sensor: switch_ip - IP of the Switch
  • Diagnostic Sensor: response_time_s - Response time of two requests send to the Switch to calculate the traffic speed
  • ...
• statistics for each Port (8 Ports for GS108Ev3) as attributes
  • port_{port}_receiving - receiving traffic on {port} in MB/s
  • port_{port}_total_received - total received traffic on {port} in MB
  • port_{port}_total_transferred - total transferred traffic on {port} in MB
  • ...
• status for each port
  • Binary Sensor: port_{port}_status - port cable connected/disconnected
  • Sensor: port_{port}_connection_speed - port transmission speed (100M/1000M)

List of port sensors

List of aggregated sensors

Supported and tested Netgear Models/Products and firmwares

Supported firmware languages: GR (German), EN (English)

How to integrate in your HomeAssistant

1. Goto HACS > Integrations
2. Click on the right corner on the vertical dots and select "Custom Repositories"
3. Add "https://github.com/ckarrie/ckw-ha-gs108e" as Integration

After adding the integration go to Add Integration and select Netgear GS108e Integration.

Lovelance examples

Example with ha-sankey-chart

Example with mini-graph-card

type: custom:mini-graph-card
entities:
  - entity: sensor.gs108ev3_192_168_178_8_port_1_io
    show_points: false
    name: QNAP
  - entity: sensor.gs108ev3_192_168_178_8_port_2_io
    show_points: false
    name: P2
  - entity: sensor.gs108ev3_192_168_178_8_port_3_io
    show_points: false
    name: rpi4-001
  - entity: sensor.gs108ev3_192_168_178_8_port_4_io
    show_points: false
    name: Telefon
  - entity: sensor.gs108ev3_192_168_178_8_port_5_io
    show_points: false
    name: Unraid
  - entity: sensor.gs108ev3_192_168_178_8_port_6_io
    show_points: false
    name: Drucker
  - entity: sensor.gs108ev3_192_168_178_8_port_7_io
    show_points: false
    name: Beelink (HA)
  - entity: sensor.gs108ev3_192_168_178_8_port_8_io
    show_points: false
    name: HomeOffice und WLAN
hours_to_show: 0.1
points_per_hour: 1000
name: 192.168.178.8 - GS108Ev3 Büro
line_width: 1
animate: true

ToDo

• move integrated gs108e module into a seperate Python library (get rid of gs108e wording)
• add GS308x support
  • PoE ports status
  • turn on/off PoE ports

API Level

create a python venv with requests and lxml

python3 -m venv test-netgear
cd test-netgear
source bin/activate
pip install lxml requests

Using this VENV go to your local source folder

Example calls

cd ~/workspace/src/ckw-ha-gs108e/custom_components/ckw_hass_gs108e
python3

ip = '192.168.178.68'
p = 'fyce4gKZemkqjDY'
import gs108e
sw = gs108e.NetgearSwitchConnector(ip, p)
sw.autodetect_model()
sw.get_login_cookie()

data = sw.get_switch_infos()
print(sw.switch_model.MODEL_NAME)
print(data["port_1_sum_rx_mbytes"])
print(data)