Files
lan_checker/README.md
Antoine Van Elstraete b0d571ae26 Add French docstrings and README
- Docstrings for all modules, classes and methods
- README.md with installation and usage instructions
- Update CLAUDE.md with dns.py

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-26 18:25:20 +01:00

48 lines
1.1 KiB
Markdown

# LAN Checker
Surveillance réseau avec reporting MQTT pour Home Assistant.
Vérifie périodiquement l'état de services et équipements réseau (ping, HTTP, DNS, SNMP), puis publie les résultats via MQTT. Les entités sont créées automatiquement dans Home Assistant grâce au protocole MQTT Discovery.
## Installation
```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
## Configuration
```bash
cp config.yaml.example config.yaml
# Éditer config.yaml avec vos équipements
```
## Usage
```bash
python lan_checker.py
python lan_checker.py -c /chemin/vers/config.yaml
```
## Types de checks
| Type | Description |
|------|-------------|
| `ping` | Vérifie la disponibilité via ICMP |
| `http` | Vérifie un service web (code HTTP) |
| `dns` | Vérifie un serveur DNS (ping + requête) |
| `snmp` | Vérifie un équipement via SNMP (+ température optionnelle) |
## Entités Home Assistant
Pour chaque équipement configuré :
- **binary_sensor** : état online/offline
- **sensor** : latence (ms)
- **sensor** : température (SNMP uniquement, si `temperature_oid` configuré)
## Licence
MIT