You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,13 @@ By comparing gateway-to-WAN tests against local-machine-to-WAN tests, you can be
13
13
- Runs gateway-based Ping tests to measure the quality of the direct ISP connection.
14
14
- Optionally runs a gateway-based Speed Test.
15
15
- Runs local Ping tests from the machine executing the script to both the gateway and the internet.
16
-
- Runs local Speed Tests using the **official Ookla Speedtest CLI** for accurate, reliable results.
16
+
- Runs local Speed Tests using the **official Ookla Speedtest CLI** for accurate, reliable results:
17
+
- Download & Upload Bandwidth
18
+
- Ping, Jitter, and Packet Loss
19
+
- Bufferbloat (latency under load) with calculated delta vs. idle latency
17
20
- Runs in headless mode, so no browser window is required.
18
21
- Schedules tests to run at a configurable interval.
22
+
- Provides color-coded console output, highlighting anomalous results (e.g., high latency, packet loss) for at-a-glance diagnosis.
19
23
- Appends combined results to a single, local CSV log file, creating headers if the file is new or empty.
20
24
- Captures detailed Wi-Fi metrics on macOS (signal, noise, channel, etc.) - see the [Advanced Configuration](#advanced-configuration) section for details.
21
25
- All configuration is organized in the `config.py` file.
@@ -51,6 +55,7 @@ All configuration has been moved to the **`config.py`** file for easy editing.
51
55
-`LOG_FILE`: The name of the CSV file for storing results.
52
56
-`RUN_INTERVAL_MINUTES`: How often the script should run.
53
57
-`HEADLESS_MODE`: Set to `True` to run the browser invisibly in the background.
58
+
-`ENABLE_DEBUG_LOGGING`: Set to `True` to include verbose debug logs in the console and log output.
54
59
55
60
56
61
### Gateway Test Configuration
@@ -67,6 +72,16 @@ All configuration has been moved to the **`config.py`** file for easy editing.
67
72
-`RUN_LOCAL_SPEED_TEST`: Set to `True` to run a speed test from your computer using the Ookla CLI.
68
73
-`RUN_LOCAL_GATEWAY_PING_TEST`: Set to `True` to run a ping test from your computer to the gateway.
69
74
75
+
### Anomaly Highlighting & Thresholds
76
+
The console can color-highlight anomalous results to make issues obvious at a glance. You can toggle highlighting and configure thresholds in `config.py`:
77
+
78
+
- Enable/disable highlighting.
79
+
- Thresholds for packet loss, latency, and jitter.
80
+
- Thresholds for download/upload speeds.
81
+
- Bufferbloat detection: compares latency under load to idle latency using a configurable delta.
82
+
83
+
Adjust these settings to match your network expectations and noise tolerance.
84
+
70
85
### Important: Handling the Device Access Code
71
86
The gateway speed test requires your gateway's **Device Access Code** to log in. To store this securely, the script uses an environment variable.
0 commit comments