ryan/systant
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CLAUDE.md documentation for network throughput

Browse Source 
Update documentation to reflect network throughput implementation:
- Network sensors now show real-time RX/TX throughput in MB/s
- Changed from cumulative byte counters to bandwidth monitoring
- Updated sensor descriptions and features list

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
ryan
2025-08-08 21:12:57 -07:00
co-authored by Claude
parent 9dd21023ef
commit bc7ac0c854
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+3 -3
View File
@@ -190,7 +190,7 @@ mosquitto_sub -t "systant/+/responses"
### Phase 3: Home Assistant Integration (Completed) ### Phase 3: Home Assistant Integration (Completed)
- ✅ **MQTT Auto-Discovery**: `server/lib/systant/ha_discovery.ex` - Publishes HA discovery configurations for automatic device registration - ✅ **MQTT Auto-Discovery**: `server/lib/systant/ha_discovery.ex` - Publishes HA discovery configurations for automatic device registration
- ✅ **Device Registration**: Creates unified "Systant {hostname}" device in Home Assistant with comprehensive sensor suite - ✅ **Device Registration**: Creates unified "Systant {hostname}" device in Home Assistant with comprehensive sensor suite
- ✅ **Sensor Auto-Discovery**: CPU load averages, memory usage, system uptime, temperatures, GPU metrics, disk usage, network stats - ✅ **Sensor Auto-Discovery**: CPU load averages, memory usage, system uptime, temperatures, GPU metrics, disk usage, network throughput
- ✅ **Configuration Integration**: TOML-based enable/disable with `homeassistant.discovery_enabled` setting - ✅ **Configuration Integration**: TOML-based enable/disable with `homeassistant.discovery_enabled` setting
- ✅ **Value Templates**: Proper JSON path extraction for nested metrics data with error handling - ✅ **Value Templates**: Proper JSON path extraction for nested metrics data with error handling
- ✅ **Real-time Updates**: Seamless integration with existing MQTT stats publishing - no additional topics needed - ✅ **Real-time Updates**: Seamless integration with existing MQTT stats publishing - no additional topics needed
@@ -198,7 +198,7 @@ mosquitto_sub -t "systant/+/responses"
#### Home Assistant Integration Features #### Home Assistant Integration Features
- **Automatic Discovery**: No custom integration required - uses standard MQTT discovery protocol - **Automatic Discovery**: No custom integration required - uses standard MQTT discovery protocol
- **Device Grouping**: All sensors grouped under single "Systant {hostname}" device for clean organization - **Device Grouping**: All sensors grouped under single "Systant {hostname}" device for clean organization
- **Comprehensive Metrics**: CPU, memory, disk, GPU (NVIDIA/AMD), network, temperature, and system sensors - **Comprehensive Metrics**: CPU, memory, disk, GPU (NVIDIA/AMD), network throughput, temperature, and system sensors
- **Configuration Control**: Enable/disable discovery via `systant.toml` configuration - **Configuration Control**: Enable/disable discovery via `systant.toml` configuration
- **Template Flexibility**: Advanced Jinja2 templates handle optional/missing data gracefully - **Template Flexibility**: Advanced Jinja2 templates handle optional/missing data gracefully
- **Topic Structure**: Discovery on `homeassistant/#`, stats remain on `systant/{hostname}/stats` - **Topic Structure**: Discovery on `homeassistant/#`, stats remain on `systant/{hostname}/stats`
@@ -214,7 +214,7 @@ mosquitto_sub -t "systant/+/responses"
- **Memory**: Usage percentage, used/total in GB - **Memory**: Usage percentage, used/total in GB
- **Disk**: Root and home filesystem usage percentages - **Disk**: Root and home filesystem usage percentages
- **GPU**: NVIDIA/AMD utilization, temperature, memory usage - **GPU**: NVIDIA/AMD utilization, temperature, memory usage
- **Network**: RX/TX bytes for primary interface - **Network**: RX/TX throughput in MB/s for primary interface (real-time bandwidth monitoring)
- **System**: Uptime in hours, kernel version, online status - **System**: Uptime in hours, kernel version, online status
### Future Plans ### Future Plans