Skip to content

Commit b1cf56d

Browse files
itsDNNSclaude
andcommitted
Reposition README as user-facing troubleshooting tool
Shift focus from HA/MQTT integration to cable internet diagnostics: add "Why DOCSight" section, restructure features by user priority, rename "Created Sensors" to "Home Assistant Integration" (optional), and update requirements. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent efb81c0 commit b1cf56d

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,23 @@
1111
</p>
1212

1313
<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.
1515
</p>
1616

1717
![Dashboard Dark Mode](docs/screenshots/dashboard-dark.png)
1818

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+
1923
## Table of Contents
2024

25+
- [Why DOCSight](#why-docsight)
2126
- [Features](#features)
2227
- [Quick Start](#quick-start)
2328
- [Configuration](#configuration)
2429
- [Screenshots](#screenshots)
25-
- [Created Sensors](#created-sensors)
30+
- [Home Assistant Integration](#home-assistant-integration)
2631
- [Reference Values](#reference-values)
2732
- [Requirements](#requirements)
2833
- [Roadmap](#roadmap)
@@ -31,18 +36,22 @@
3136

3237
## Features
3338

39+
**Monitoring & Diagnostics**
3440
- **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)
3741
- **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
4143
- **LLM Export**: Generate structured reports for AI analysis (ChatGPT, Claude, Gemini, etc.)
42-
- **MQTT Auto-Discovery**: Zero-config integration with Home Assistant
4344
- **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
4549
- **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
4655

4756
## Quick Start
4857

@@ -105,7 +114,9 @@ Copy `.env.example` to `.env` and edit:
105114
</details>
106115

107116
<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.
109120

110121
### Per-Channel (~37 DS + 4 US)
111122

@@ -141,8 +152,9 @@ Copy `.env.example` to `.env` and edit:
141152

142153
## Requirements
143154

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
146158

147159
## Roadmap
148160

0 commit comments

Comments
 (0)