|
11 | 11 | </p> |
12 | 12 |
|
13 | 13 | <p align="center"> |
14 | | - Docker container that monitors DOCSIS channel health on cable modems and publishes per-channel sensor data to Home Assistant via MQTT Auto-Discovery. |
| 14 | + Self-hosted cable internet monitoring and diagnostics. Track DOCSIS signal levels, detect problems, and get actionable health assessments — right in your browser. |
15 | 15 | </p> |
16 | 16 |
|
17 | 17 |  |
18 | 18 |
|
| 19 | +## Why DOCSight |
| 20 | + |
| 21 | +Cable internet dropping out, buffering, or slower than it should be? Your ISP says "everything looks fine"? DOCSight reads the DOCSIS signal levels directly from your modem and tells you whether the problem is on your end or your provider's. It gives you real data — power levels, signal-to-noise ratios, error counts — that you can show a technician or use to hold your ISP accountable. |
| 22 | + |
19 | 23 | ## Table of Contents |
20 | 24 |
|
| 25 | +- [Why DOCSight](#why-docsight) |
21 | 26 | - [Features](#features) |
22 | 27 | - [Quick Start](#quick-start) |
23 | 28 | - [Configuration](#configuration) |
24 | 29 | - [Screenshots](#screenshots) |
25 | | -- [Created Sensors](#created-sensors) |
| 30 | +- [Home Assistant Integration](#home-assistant-integration) |
26 | 31 | - [Reference Values](#reference-values) |
27 | 32 | - [Requirements](#requirements) |
28 | 33 | - [Roadmap](#roadmap) |
|
31 | 36 |
|
32 | 37 | ## Features |
33 | 38 |
|
| 39 | +**Monitoring & Diagnostics** |
34 | 40 | - **Web Dashboard**: Real-time channel data with health assessment, trend charts, and calendar navigation |
35 | | -- **Per-Channel Sensors**: Every downstream/upstream DOCSIS channel becomes its own Home Assistant sensor with full attributes |
36 | | -- **Summary Sensors**: Aggregated metrics (power min/max/avg, SNR, error counts, overall health) |
37 | 41 | - **Health Assessment**: Automatic traffic-light evaluation with actionable recommendations |
38 | | -- **Setup Wizard**: Browser-based configuration - no .env file needed |
39 | | -- **Settings Page**: Change all settings at runtime, test connections, toggle themes |
40 | | -- **Internationalization**: English, German, French, and Spanish UI |
| 42 | +- **Trend Charts**: Track signal quality over days, weeks, or months to spot recurring issues |
41 | 43 | - **LLM Export**: Generate structured reports for AI analysis (ChatGPT, Claude, Gemini, etc.) |
42 | | -- **MQTT Auto-Discovery**: Zero-config integration with Home Assistant |
43 | 44 | - **ThinkBroadband BQM**: Daily fetch and archive of broadband quality graphs with gallery view |
44 | | -- **Optional Authentication**: Password-protected web UI with scrypt hashing |
| 45 | + |
| 46 | +**Ease of Use** |
| 47 | +- **Setup Wizard**: Browser-based configuration — no .env file needed |
| 48 | +- **4 Languages**: English, German, French, and Spanish UI |
45 | 49 | - **Light/Dark Mode**: Persistent theme toggle |
| 50 | +- **Optional Authentication**: Password-protected web UI with scrypt hashing |
| 51 | + |
| 52 | +**Smart Home Integration** (optional) |
| 53 | +- **MQTT Auto-Discovery**: Zero-config integration with Home Assistant |
| 54 | +- **Per-Channel + Summary Sensors**: Every DOCSIS channel and aggregated metrics as HA entities |
46 | 55 |
|
47 | 56 | ## Quick Start |
48 | 57 |
|
@@ -105,7 +114,9 @@ Copy `.env.example` to `.env` and edit: |
105 | 114 | </details> |
106 | 115 |
|
107 | 116 | <details> |
108 | | -<summary><h2>Created Sensors</h2></summary> |
| 117 | +<summary><h2>Home Assistant Integration</h2></summary> |
| 118 | + |
| 119 | +DOCSight can optionally publish all channel data to Home Assistant via MQTT Auto-Discovery. This is not required to use DOCSight. |
109 | 120 |
|
110 | 121 | ### Per-Channel (~37 DS + 4 US) |
111 | 122 |
|
@@ -141,8 +152,9 @@ Copy `.env.example` to `.env` and edit: |
141 | 152 |
|
142 | 153 | ## Requirements |
143 | 154 |
|
144 | | -- DOCSIS cable modem or router (tested with AVM FRITZ!Box 6690 Cable) |
145 | | -- MQTT broker (e.g., Mosquitto) - optional, for Home Assistant integration |
| 155 | +- Docker (or any OCI-compatible container runtime) |
| 156 | +- A DOCSIS cable modem or router with web interface (tested with AVM FRITZ!Box 6690 Cable) |
| 157 | +- MQTT broker (optional) — only needed for Home Assistant integration |
146 | 158 |
|
147 | 159 | ## Roadmap |
148 | 160 |
|
|
0 commit comments