Compare commits
6 Commits
4e2dec2441
...
fix-snmp-e
Author | SHA1 | Date | |
---|---|---|---|
5b670c4708
|
|||
85a14f4fa0
|
|||
e4e79a34a9
|
|||
ffd86281ef
|
|||
e45c3c1f18
|
|||
7199432169
|
191
README.md
191
README.md
@@ -156,21 +156,136 @@ python snmp2mqtt.py -c config.yaml
|
|||||||
|
|
||||||
## Intégration Home Assistant
|
## Intégration Home Assistant
|
||||||
|
|
||||||
|
### MQTT Discovery (Découverte automatique)
|
||||||
|
|
||||||
|
Le script implémente le protocole **MQTT Discovery** de Home Assistant pour une intégration transparente et automatique. Aucune configuration manuelle n'est nécessaire dans Home Assistant.
|
||||||
|
|
||||||
|
#### Fonctionnement de l'autodécouverte
|
||||||
|
|
||||||
|
1. **Au démarrage** : Publication des configurations de découverte
|
||||||
|
2. **Pendant l'exécution** : Mise à jour continue des états des capteurs
|
||||||
|
3. **Surveillance** : Gestion des statuts de disponibilité (online/offline)
|
||||||
|
|
||||||
### Topics MQTT générés
|
### Topics MQTT générés
|
||||||
|
|
||||||
Le script génère automatiquement les topics MQTT suivants :
|
#### Topics de découverte (Discovery)
|
||||||
|
Chaque capteur génère un topic de configuration individuel :
|
||||||
|
```
|
||||||
|
homeassistant/{platform}/{node_id}/{object_id}/config
|
||||||
|
```
|
||||||
|
|
||||||
- **Configuration** : `homeassistant/device/{device_id}/config`
|
**Exemples** :
|
||||||
- **État** : `SNMP/{device_name}/state`
|
```bash
|
||||||
|
# Capteur de trafic réseau
|
||||||
|
homeassistant/sensor/mikrotik_hex/mikrotik_hex_starlink_in/config
|
||||||
|
|
||||||
### Découverte automatique
|
# Statut de connectivité
|
||||||
|
homeassistant/binary_sensor/mikrotik_hex/mikrotik_hex_starlink_status/config
|
||||||
|
```
|
||||||
|
|
||||||
Les équipements et capteurs sont automatiquement découverts dans Home Assistant via MQTT Discovery. Chaque équipement apparaîtra avec :
|
#### Topics de données
|
||||||
|
- **État** : `SNMP/{device_name}/state` - Données JSON des capteurs
|
||||||
|
- **Disponibilité** : `SNMP/{device_name}/availability` - Statut online/offline
|
||||||
|
|
||||||
- Un identifiant unique basé sur le nom et l'IP
|
### Configuration automatique des capteurs
|
||||||
- Des capteurs groupés par équipement
|
|
||||||
- Des icônes et unités appropriées selon la classe d'équipement
|
Chaque capteur est configuré avec :
|
||||||
- Des modèles de valeurs JSON pour extraire les données
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "mikrotik_hex starlink_in",
|
||||||
|
"unique_id": "mikrotik_hex_192_168_10_2_starlink_in",
|
||||||
|
"state_topic": "SNMP/mikrotik_hex/state",
|
||||||
|
"value_template": "{{ value_json.starlink_in }}",
|
||||||
|
"device_class": "data_size",
|
||||||
|
"unit_of_measurement": "bit",
|
||||||
|
"icon": "mdi:network",
|
||||||
|
"device": {
|
||||||
|
"identifiers": ["snmp2mqtt_mikrotik_hex_192_168_10_2"],
|
||||||
|
"name": "mikrotik_hex",
|
||||||
|
"model": "SNMP Device",
|
||||||
|
"manufacturer": "Network Equipment"
|
||||||
|
},
|
||||||
|
"availability": {
|
||||||
|
"topic": "SNMP/mikrotik_hex/availability",
|
||||||
|
"payload_available": "online",
|
||||||
|
"payload_not_available": "offline"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Découverte automatique dans Home Assistant
|
||||||
|
|
||||||
|
#### Regroupement par équipement
|
||||||
|
Tous les capteurs d'un même équipement sont automatiquement regroupés sous une seule carte d'équipement :
|
||||||
|
|
||||||
|
- **Identifiant unique** basé sur `device_name` + `ip`
|
||||||
|
- **Nom d'affichage** basé sur le nom de l'équipement
|
||||||
|
- **Métadonnées** : modèle, fabricant, version du logiciel
|
||||||
|
|
||||||
|
#### Types de capteurs supportés
|
||||||
|
|
||||||
|
| Type HA | Platform | Description | Icône |
|
||||||
|
|---------|----------|-------------|-------|
|
||||||
|
| `sensor` | `sensor` | Valeurs numériques (trafic, CPU, etc.) | Selon device_class |
|
||||||
|
| `binary_sensor` | `binary_sensor` | États binaires (online/offline, actif/inactif) | mdi:network-outline |
|
||||||
|
|
||||||
|
#### Classes d'équipements et icônes
|
||||||
|
|
||||||
|
| Device Class | Utilisation | Icône Auto | Unité Suggérée |
|
||||||
|
|--------------|-------------|------------|----------------|
|
||||||
|
| `data_size` | Trafic réseau, volumes de données | mdi:network | bit, byte, MB, GB |
|
||||||
|
| `connectivity` | Statut des interfaces, connexions | mdi:network-outline | - |
|
||||||
|
| `power_factor` | Pourcentages (CPU, mémoire) | mdi:gauge | % |
|
||||||
|
| `temperature` | Températures d'équipements | mdi:thermometer | °C, °F |
|
||||||
|
| `signal_strength` | Qualité des signaux | mdi:signal | dBm, % |
|
||||||
|
|
||||||
|
### Surveillance de disponibilité
|
||||||
|
|
||||||
|
#### Statuts de disponibilité
|
||||||
|
- **Online** : Équipement accessible et données mises à jour
|
||||||
|
- **Offline** : Équipement inaccessible ou erreurs SNMP
|
||||||
|
|
||||||
|
#### Mécanisme de heartbeat
|
||||||
|
- Mise à jour du statut à chaque cycle de surveillance
|
||||||
|
- Marquage offline automatique en cas d'erreur
|
||||||
|
- Statut offline lors de l'arrêt du script
|
||||||
|
|
||||||
|
### Persistance et redémarrages
|
||||||
|
|
||||||
|
#### Configuration Discovery retenue
|
||||||
|
- **Flag retain=true** sur les topics de configuration
|
||||||
|
- **Redécouverte automatique** après redémarrage de Home Assistant
|
||||||
|
- **Pas de perte de configuration** lors des redémarrages
|
||||||
|
|
||||||
|
#### Données d'état temps réel
|
||||||
|
- **Flag retain=false** sur les données d'état
|
||||||
|
- **Données fraîches uniquement** après redémarrage
|
||||||
|
- **Historique préservé** par Home Assistant
|
||||||
|
|
||||||
|
### Intégration dans l'interface Home Assistant
|
||||||
|
|
||||||
|
Après démarrage du script, vous verrez automatiquement :
|
||||||
|
|
||||||
|
1. **Page Équipements** : Nouveaux équipements SNMP avec leurs capteurs
|
||||||
|
2. **États et Historiques** : Données temps réel et graphiques
|
||||||
|
3. **Cartes automatiques** : Ajout facile aux tableaux de bord
|
||||||
|
4. **Notifications** : Alertes sur les changements d'état
|
||||||
|
5. **Automations** : Utilisation des capteurs dans les règles
|
||||||
|
|
||||||
|
### Exemple d'équipement découvert
|
||||||
|
|
||||||
|
```
|
||||||
|
📱 mikrotik_hex (SNMP Device)
|
||||||
|
├── 📊 mikrotik_hex starlink_in (123.45 MB)
|
||||||
|
├── 📊 mikrotik_hex starlink_out (67.89 MB)
|
||||||
|
├── 🔌 mikrotik_hex starlink_status (Online)
|
||||||
|
├── 📊 mikrotik_hex lan_bridge_in (234.56 MB)
|
||||||
|
├── 📊 mikrotik_hex lan_bridge_out (78.90 MB)
|
||||||
|
└── 🔌 mikrotik_hex lan_bridge_status (Online)
|
||||||
|
|
||||||
|
Statut: Online | Dernière mise à jour: il y a 2 secondes
|
||||||
|
```
|
||||||
|
|
||||||
## Exemple de configuration complète
|
## Exemple de configuration complète
|
||||||
|
|
||||||
@@ -263,7 +378,63 @@ ping 192.168.10.202
|
|||||||
|
|
||||||
## Support multi-équipements
|
## Support multi-équipements
|
||||||
|
|
||||||
**Note** : Le support complet multi-équipements nécessite une implémentation avec threading/multiprocessing. Actuellement, le script traite le premier équipement de la liste et affiche un avertissement pour les autres.
|
Le script supporte nativement la surveillance simultanée de plusieurs équipements grâce à une architecture **multi-threading** :
|
||||||
|
|
||||||
|
### Fonctionnement
|
||||||
|
|
||||||
|
- **Thread indépendant** pour chaque équipement configuré
|
||||||
|
- **Surveillance parallèle** : tous les équipements sont surveillés simultanément
|
||||||
|
- **Isolation des erreurs** : la défaillance d'un équipement n'affecte pas les autres
|
||||||
|
- **Clients MQTT séparés** : chaque thread utilise son propre client MQTT
|
||||||
|
- **Arrêt gracieux** : tous les threads s'arrêtent proprement sur signal
|
||||||
|
|
||||||
|
### Avantages
|
||||||
|
|
||||||
|
- ⚡ **Performance optimale** : pas de blocage entre équipements
|
||||||
|
- 🔄 **Traitement parallèle** : requêtes SNMP simultanées
|
||||||
|
- 🛡️ **Robustesse** : isolation des défaillances
|
||||||
|
- 📊 **Scalabilité** : facilement extensible à des dizaines d'équipements
|
||||||
|
- 🔧 **Maintenance** : logs clairement identifiés par équipement
|
||||||
|
|
||||||
|
### Configuration multi-équipements
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
devices:
|
||||||
|
routeur_principal:
|
||||||
|
ip: "192.168.10.1"
|
||||||
|
snmp_community: "public"
|
||||||
|
oids:
|
||||||
|
# ... configuration OID ...
|
||||||
|
|
||||||
|
switch_bureau:
|
||||||
|
ip: "192.168.10.5"
|
||||||
|
snmp_community: "public"
|
||||||
|
oids:
|
||||||
|
# ... configuration OID ...
|
||||||
|
|
||||||
|
point_acces_wifi:
|
||||||
|
ip: "192.168.10.10"
|
||||||
|
snmp_community: "private"
|
||||||
|
oids:
|
||||||
|
# ... configuration OID ...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Logs multi-threading
|
||||||
|
|
||||||
|
Chaque thread est clairement identifié dans les logs :
|
||||||
|
|
||||||
|
```
|
||||||
|
(INFO) [Device-routeur_principal] Starting monitoring thread
|
||||||
|
(INFO) [Device-switch_bureau] MQTT client connected
|
||||||
|
(DEBUG) [Device-point_acces_wifi] Published state to SNMP/point_acces_wifi/state
|
||||||
|
```
|
||||||
|
|
||||||
|
### Gestion des ressources
|
||||||
|
|
||||||
|
- **Clients MQTT uniques** : ID client basé sur le nom de l'équipement
|
||||||
|
- **Topics séparés** : chaque équipement a ses propres topics MQTT
|
||||||
|
- **Discovery HA indépendante** : configuration Home Assistant par équipement
|
||||||
|
- **Disponibilité individuelle** : statut online/offline par équipement
|
||||||
|
|
||||||
## Logs et debugging
|
## Logs et debugging
|
||||||
|
|
||||||
|
@@ -2,7 +2,8 @@
|
|||||||
# Install with: pip install -r requirements.txt
|
# Install with: pip install -r requirements.txt
|
||||||
|
|
||||||
# SNMP library for asynchronous SNMP operations
|
# SNMP library for asynchronous SNMP operations
|
||||||
pysnmp>=6.0.0
|
# Note: pysnmp 7.x uses a new API structure (no more Slim class)
|
||||||
|
pysnmp>=7.0.0
|
||||||
|
|
||||||
# MQTT client library for connecting to MQTT brokers
|
# MQTT client library for connecting to MQTT brokers
|
||||||
paho-mqtt>=1.6.0
|
paho-mqtt>=1.6.0
|
||||||
|
43
snmp2mqtt.py
43
snmp2mqtt.py
@@ -1,7 +1,9 @@
|
|||||||
#!/bin/env python3
|
#!/bin/env python3
|
||||||
import asyncio
|
import asyncio
|
||||||
from pysnmp.hlapi.asyncio.slim import Slim
|
from pysnmp.hlapi.asyncio import (
|
||||||
from pysnmp.smi.rfc1902 import ObjectIdentity, ObjectType
|
get_cmd, CommunityData, UdpTransportTarget, ContextData,
|
||||||
|
SnmpEngine, ObjectIdentity, ObjectType
|
||||||
|
)
|
||||||
import logging
|
import logging
|
||||||
import random
|
import random
|
||||||
from paho.mqtt import client as mqtt_client
|
from paho.mqtt import client as mqtt_client
|
||||||
@@ -204,25 +206,34 @@ def publish(topic, client, data, retain, qos):
|
|||||||
|
|
||||||
|
|
||||||
async def get_snmp(req):
|
async def get_snmp(req):
|
||||||
|
"""Asynchronously retrieve SNMP data from device using new pysnmp API"""
|
||||||
data = {}
|
data = {}
|
||||||
|
|
||||||
|
# Create SNMP engine and transport target
|
||||||
|
snmpEngine = SnmpEngine()
|
||||||
|
authData = CommunityData(req["snmp_community"])
|
||||||
|
transportTarget = await UdpTransportTarget.create((req["ip"], 161))
|
||||||
|
contextData = ContextData()
|
||||||
|
|
||||||
for oid in req["oids"]:
|
for oid in req["oids"]:
|
||||||
with Slim(1) as slim:
|
try:
|
||||||
errorIndication, errorStatus, errorIndex, varBinds = await slim.get(
|
# Perform async SNMP GET operation
|
||||||
req["snmp_community"],
|
errorIndication, errorStatus, errorIndex, varBinds = await get_cmd(
|
||||||
req["ip"],
|
snmpEngine,
|
||||||
161,
|
authData,
|
||||||
ObjectType(ObjectIdentity(oid["oid"])),
|
transportTarget,
|
||||||
|
contextData,
|
||||||
|
ObjectType(ObjectIdentity(oid["oid"]))
|
||||||
)
|
)
|
||||||
|
|
||||||
if errorIndication:
|
if errorIndication:
|
||||||
logging.error(errorIndication)
|
logging.error(f"{req['device_name']} SNMP error indication: {errorIndication}")
|
||||||
|
continue
|
||||||
elif errorStatus:
|
elif errorStatus:
|
||||||
logging.error(
|
logging.error(
|
||||||
"{} at {}".format(
|
f"{req['device_name']} SNMP error status: {errorStatus.prettyPrint()} at {errorIndex and varBinds[int(errorIndex) - 1][0] or '?'}"
|
||||||
errorStatus.prettyPrint(),
|
|
||||||
errorIndex and varBinds[int(errorIndex) - 1][0] or "?",
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
continue
|
||||||
else:
|
else:
|
||||||
for varBind in varBinds:
|
for varBind in varBinds:
|
||||||
logging.debug(f"{req['device_name']} {oid['name']} => {oid['type'](varBind[1])}")
|
logging.debug(f"{req['device_name']} {oid['name']} => {oid['type'](varBind[1])}")
|
||||||
@@ -233,7 +244,11 @@ async def get_snmp(req):
|
|||||||
data.update({oid["name"]: "OFF"})
|
data.update({oid["name"]: "OFF"})
|
||||||
else:
|
else:
|
||||||
data.update({oid["name"]: oid["type"](varBind[1])})
|
data.update({oid["name"]: oid["type"](varBind[1])})
|
||||||
logging.debug(f"JSON : {json.dumps(data)}")
|
except Exception as e:
|
||||||
|
logging.error(f"{req['device_name']} Exception getting OID {oid['oid']}: {e}")
|
||||||
|
continue
|
||||||
|
|
||||||
|
logging.debug(f"{req['device_name']} JSON : {json.dumps(data)}")
|
||||||
return data
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user