Internet Connection Health Dashboard in Home Assistant

#!/usr/bin/env bash

# Requirements: sudo apt install mtr bc jq -y
TOKEN="YOUR_HA_TOKEN"


# --- CONFIGURATION ---
TARGET="redirector.googlevideo.com"
PORT=443
CYCLES=5
INTERVAL=1
TIMEOUT=2
CHECK_WINDOW=3      # Only look at the last 3 visible hops
LOSS_THRESHOLD=25   # Alert if loss in window > 25%
LATENCY_THRESHOLD=150
SD_THRESHOLD=100

export LC_NUMERIC=C

HA_URL="YOUR_HA_URL" # Ensure port is correct for your setup

# --- SCRIPT START ---
timestamp() {
    date -u +"%Y-%m-%dT%H:%M:%SZ"
}

# Run mtr with wide report to ensure columns don't truncate
mtr_output=$(mtr --report --report-cycles="$CYCLES" --tcp --port="$PORT" --no-dns --report-wide --timeout=$TIMEOUT --interval="$INTERVAL" "$TARGET" 2>&1)

if [[ $? -ne 0 ]]; then
    echo "Error running mtr: $mtr_output" >&2
    exit 1
fi

max_loss=0
worst_hop=""
worst_avg_latency=0
hops_json="["

# 1. Parse full MTR report into JSON including StDev
while IFS= read -r line; do
    # This regex captures Hop, Host, Loss, Sent, Avg, and StDev
    if [[ "$line" =~ ^[[:space:]]*([0-9]+)\.\|--[[:space:]]+([^[:space:]]+)[[:space:]]+([0-9.]+)%[[:space:]]+([0-9]+)[[:space:]]+[0-9.]+[[:space:]]+([0-9.]+)[[:space:]]+[0-9.]+[[:space:]]+([0-9.]+)[[:space:]]+([0-9.]+) ]]; then
        hop_num="${BASH_REMATCH[1]}"
        host="${BASH_REMATCH[2]}"
        loss="${BASH_REMATCH[3]}"
        sent="${BASH_REMATCH[4]}"
        avg="${BASH_REMATCH[5]}"
        worst="${BASH_REMATCH[6]}"
        stdev="${BASH_REMATCH[7]}"

        # Append to JSON string
        hops_json+=$(printf '{"hop":%d,"host":"%s","loss_percent":%.1f,"sent":%d,"avg_ms":%.1f,"worst_ms":%.1f,"stdev":%.1f},' \
            "$hop_num" "$host" "$loss" "$sent" "$avg" "$worst" "$stdev")

        # Track absolute worsts for internal debugging
        if (( $(echo "$loss > $max_loss" | bc -l) )); then
            max_loss="$loss"
            worst_hop="$hop_num ($host)"
            worst_avg_latency=$(printf "%.1f" "$avg")
        fi
    fi
done <<< "$mtr_output"

# Remove trailing comma and close array
hops_json="${hops_json%,}]"

# --- 2. Extract specific Window for On/Off Logic ---
recent_hops=$(echo "$mtr_output" | grep "|--" | grep -v "???" | tail -n "$CHECK_WINDOW")

# Extract Window Loss
window_max_loss=$(echo "$recent_hops" | tr -d '%' | awk '{print $3}' | sort -rn | head -n 1)
# Extract Window Latency (Avg)
window_max_lat=$(echo "$recent_hops" | awk '{print $6}' | sort -rn | head -n 1)
# Extract Window Jitter (StDev)
window_max_sd=$(echo "$recent_hops" | awk '{print $9}' | sort -rn | head -n 1)

# SAFETY: If any value is not a valid number, force it to 0
[[ ! "$window_max_loss" =~ ^[0-9.]+$ ]] && window_max_loss=0
[[ ! "$window_max_lat" =~ ^[0-9.]+$ ]] && window_max_lat=0
[[ ! "$window_max_sd" =~ ^[0-9.]+$ ]] && window_max_sd=0

# --- 3. Final Status Determination ---

# Check if BOTH thresholds are exceeded at the same time

if (( $(echo "$window_max_lat > $LATENCY_THRESHOLD" | bc -l) )) && (( $(echo "$window_max_loss > $LOSS_THRESHOLD" | bc -l) )); then
    status="on"
    friendly="Network Crisis: High Latency (${window_max_lat}ms) AND High Loss (${window_max_loss}%) detected."

# Optional: Keep individual checks as warnings or turn status "off" for them
elif (( $(echo "$window_max_sd > $SD_THRESHOLD" | bc -l) )); then
    status="on"
    friendly="High Jitter: ${window_max_sd}ms at destination."

else
    status="off"
    friendly="Stable: ${window_max_lat}ms (SD: ${window_max_sd}ms)"
fi


# 4. Create the data payload
# We pass the windowed (cleaned) metrics to HA's main attributes
api_payload=$(jq -n \
  --arg state "$status" \
  --arg ts "$(timestamp)" \
  --arg tar "$TARGET" \
  --argjson port "$PORT" \
  --arg friend "$friendly" \
  --argjson loss "$window_max_loss" \
  --arg worst "$worst_hop" \
  --argjson lat "$window_max_lat" \
  --argjson sd "$window_max_sd" \
  --argjson hops "$hops_json" \
  '{
    state: $state,
    attributes: {
      timestamp: $ts,
      target: $tar,
      port: $port,
      status: $state,
      friendly: $friend,
      window_loss: $loss,
      worst_hop: $worst,
      window_latency_avg: $lat,
      window_jitter_sd: $sd,
      hops: $hops
    }
  }')

# 5. Push to Home Assistant
curl -X POST \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d "$api_payload" \
     "$HA_URL/api/states/sensor.mtr_availability"