Update README with binary sensor documentation and badge example

This commit is contained in:
2025-12-15 12:10:32 +11:00
parent 5ba5532e60
commit a77568d84a

View File

@@ -47,6 +47,14 @@ For each server (243 and 244), the following sensors are created:
- Unit: °C - Unit: °C
- Update interval: 30 seconds - Update interval: 30 seconds
### Binary Sensors (Status Monitoring)
- **Server 243 Status** (`binary_sensor.server_243_status`)
- Monitors online/offline state of Server 243
- Uses ping to check availability
- Update interval: 60 seconds
- Perfect for adding a status badge to your dashboard
### Requirements ### Requirements
- OpenHardwareMonitor must be running on both servers with web server enabled - OpenHardwareMonitor must be running on both servers with web server enabled
@@ -77,12 +85,18 @@ To add additional sensors, you can follow the same template pattern and navigate
- Verify OpenHardwareMonitor detects your GPU - Verify OpenHardwareMonitor detects your GPU
- Check if the GPU sensor name matches the template pattern - Check if the GPU sensor name matches the template pattern
**Status sensor not working:**
- Ensure ICMP (ping) is allowed through any firewalls
- Check Home Assistant logs for ping binary_sensor errors
### Example Dashboard Card ### Example Dashboard Card
```yaml ```yaml
type: entities type: entities
title: Server Hardware Monitoring title: Server Hardware Monitoring
entities: entities:
- entity: binary_sensor.server_243_status
name: Server 243 Status
- entity: sensor.server_243_cpu_temperature - entity: sensor.server_243_cpu_temperature
name: Server 243 CPU Temp name: Server 243 CPU Temp
- entity: sensor.server_243_cpu_load - entity: sensor.server_243_cpu_load
@@ -101,6 +115,14 @@ entities:
name: Server 244 GPU Temp name: Server 244 GPU Temp
``` ```
### Example Badge Card for Status
```yaml
type: badge
entity: binary_sensor.server_243_status
name: Server 243
```
## License ## License
This configuration is provided as-is for personal use. This configuration is provided as-is for personal use.