Compare commits
6 Commits
multithrea
...
fix-snmp-e
Author | SHA1 | Date | |
---|---|---|---|
5b670c4708
|
|||
85a14f4fa0
|
|||
e4e79a34a9
|
|||
ffd86281ef
|
|||
e45c3c1f18
|
|||
4e2dec2441
|
133
README.md
133
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
|
||||||
|
|
||||||
|
@@ -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
|
||||||
|
194
snmp2mqtt.py
194
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
|
||||||
@@ -51,40 +53,56 @@ class DeviceMonitorThread(threading.Thread):
|
|||||||
logging.info(f"Starting monitoring thread for device: {self.device_name} ({self.device_config['ip']})")
|
logging.info(f"Starting monitoring thread for device: {self.device_name} ({self.device_config['ip']})")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Setup MQTT connection and Home Assistant config
|
# Setup MQTT connection
|
||||||
ha_config = ha_create_config(self.req)
|
|
||||||
client = connect_mqtt(self.mqtt_config)
|
client = connect_mqtt(self.mqtt_config)
|
||||||
client.loop_start()
|
client.loop_start()
|
||||||
|
|
||||||
config_topic = f"homeassistant/device/{ha_config['dev']['ids']}/config"
|
state_topic = f"SNMP/{self.device_name}/state"
|
||||||
state_topic = ha_config['state_topic']
|
availability_topic = f"SNMP/{self.device_name}/availability"
|
||||||
|
|
||||||
logging.info(f"[{self.device_name}] MQTT client connected, starting monitoring loop")
|
logging.info(f"[{self.device_name}] MQTT client connected")
|
||||||
|
|
||||||
|
# Publish Home Assistant autodiscovery configuration (only once on startup)
|
||||||
|
publish_ha_autodiscovery_config(client, self.req)
|
||||||
|
|
||||||
|
# Mark device as available
|
||||||
|
publish(availability_topic, client, "online", True, 1)
|
||||||
|
|
||||||
|
logging.info(f"[{self.device_name}] Starting monitoring loop")
|
||||||
|
|
||||||
|
# Main monitoring loop
|
||||||
while not shutdown_event.is_set():
|
while not shutdown_event.is_set():
|
||||||
try:
|
try:
|
||||||
# Publish Home Assistant configuration
|
|
||||||
publish(config_topic, client, ha_config, True, 0)
|
|
||||||
logging.debug(f"[{self.device_name}] Published config to {config_topic}")
|
|
||||||
|
|
||||||
# Get SNMP data and publish state
|
# Get SNMP data and publish state
|
||||||
state = asyncio.run(get_snmp(self.req))
|
state = asyncio.run(get_snmp(self.req))
|
||||||
publish(state_topic, client, state, False, 0)
|
publish(state_topic, client, state, False, 0)
|
||||||
logging.debug(f"[{self.device_name}] Published state to {state_topic}: {json.dumps(state)}")
|
logging.debug(f"[{self.device_name}] Published state to {state_topic}: {json.dumps(state)}")
|
||||||
|
|
||||||
|
# Update availability (heartbeat)
|
||||||
|
publish(availability_topic, client, "online", False, 1)
|
||||||
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logging.error(f"[{self.device_name}] Error in monitoring loop: {e}")
|
logging.error(f"[{self.device_name}] Error in monitoring loop: {e}")
|
||||||
|
# Mark as offline on error
|
||||||
|
publish(availability_topic, client, "offline", False, 1)
|
||||||
|
|
||||||
# Wait for next iteration or shutdown signal
|
# Wait for next iteration or shutdown signal
|
||||||
shutdown_event.wait(timeout=self.sleep_interval)
|
shutdown_event.wait(timeout=self.sleep_interval)
|
||||||
|
|
||||||
# Cleanup
|
# Cleanup - mark device as offline
|
||||||
|
publish(availability_topic, client, "offline", True, 1)
|
||||||
client.loop_stop()
|
client.loop_stop()
|
||||||
client.disconnect()
|
client.disconnect()
|
||||||
logging.info(f"[{self.device_name}] Monitoring thread stopped gracefully")
|
logging.info(f"[{self.device_name}] Monitoring thread stopped gracefully")
|
||||||
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logging.error(f"[{self.device_name}] Fatal error in monitoring thread: {e}")
|
logging.error(f"[{self.device_name}] Fatal error in monitoring thread: {e}")
|
||||||
|
# Try to mark as offline on fatal error
|
||||||
|
try:
|
||||||
|
publish(availability_topic, client, "offline", True, 1)
|
||||||
|
client.disconnect()
|
||||||
|
except:
|
||||||
|
pass
|
||||||
|
|
||||||
logging.info(f"[{self.device_name}] Thread {self.name} finished")
|
logging.info(f"[{self.device_name}] Thread {self.name} finished")
|
||||||
|
|
||||||
@@ -174,7 +192,11 @@ def connect_mqtt(mqtt_config):
|
|||||||
|
|
||||||
|
|
||||||
def publish(topic, client, data, retain, qos):
|
def publish(topic, client, data, retain, qos):
|
||||||
|
if isinstance(data, str):
|
||||||
|
msg = data
|
||||||
|
else:
|
||||||
msg = json.dumps(data)
|
msg = json.dumps(data)
|
||||||
|
|
||||||
result = client.publish(topic=topic, payload=msg, qos=qos, retain=bool(retain))
|
result = client.publish(topic=topic, payload=msg, qos=qos, retain=bool(retain))
|
||||||
status = result[0]
|
status = result[0]
|
||||||
if status == 0:
|
if status == 0:
|
||||||
@@ -184,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])}")
|
||||||
@@ -213,42 +244,101 @@ 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
|
||||||
|
|
||||||
|
|
||||||
def ha_create_config(req):
|
def create_ha_device_info(req):
|
||||||
ha_config = {}
|
"""Create device information for Home Assistant MQTT Discovery"""
|
||||||
device = {
|
return {
|
||||||
"ids": f"{req['device_name']}_{req['ip']}".replace(".", "_"),
|
"identifiers": [f"snmp2mqtt_{req['device_name']}_{req['ip']}".replace(".", "_")],
|
||||||
"name": req['device_name'],
|
"name": req['device_name'],
|
||||||
|
"model": "SNMP Device",
|
||||||
|
"manufacturer": "Network Equipment",
|
||||||
|
"via_device": "snmp2mqtt"
|
||||||
}
|
}
|
||||||
origin = {
|
|
||||||
"name": "snmp2mqtt"
|
|
||||||
|
def create_ha_sensor_config(req, oid):
|
||||||
|
"""Create Home Assistant MQTT Discovery configuration for a single sensor"""
|
||||||
|
device_info = create_ha_device_info(req)
|
||||||
|
sensor_id = f"{req['device_name']}_{req['ip']}_{oid['name']}".replace(".", "_")
|
||||||
|
|
||||||
|
config = {
|
||||||
|
"name": f"{req['device_name']} {oid['name']}",
|
||||||
|
"unique_id": sensor_id,
|
||||||
|
"state_topic": f"SNMP/{req['device_name']}/state",
|
||||||
|
"value_template": f"{{{{ value_json.{oid['name']} }}}}",
|
||||||
|
"device": device_info,
|
||||||
|
"origin": {
|
||||||
|
"name": "snmp2mqtt",
|
||||||
|
"sw_version": "1.0.0",
|
||||||
|
"support_url": "https://git.antoineve.me/AntoineVe/snmp2mqtt"
|
||||||
}
|
}
|
||||||
ha_config.update({"dev": device, "o": origin})
|
}
|
||||||
ha_config.update({"state_topic": f"SNMP/{req['device_name']}/state"})
|
|
||||||
ha_config.update({"qos": 2})
|
# Add device class if specified
|
||||||
cmps = {}
|
if 'HA_device_class' in oid:
|
||||||
|
config['device_class'] = oid['HA_device_class']
|
||||||
|
|
||||||
|
# Add unit of measurement if specified
|
||||||
|
if 'HA_unit' in oid:
|
||||||
|
config['unit_of_measurement'] = oid['HA_unit']
|
||||||
|
|
||||||
|
# Add icon based on device class
|
||||||
|
icon_mapping = {
|
||||||
|
'data_size': 'mdi:network',
|
||||||
|
'connectivity': 'mdi:network-outline',
|
||||||
|
'power_factor': 'mdi:gauge',
|
||||||
|
'temperature': 'mdi:thermometer',
|
||||||
|
'signal_strength': 'mdi:signal'
|
||||||
|
}
|
||||||
|
if 'HA_device_class' in oid and oid['HA_device_class'] in icon_mapping:
|
||||||
|
config['icon'] = icon_mapping[oid['HA_device_class']]
|
||||||
|
|
||||||
|
# Add availability topic
|
||||||
|
config['availability'] = {
|
||||||
|
"topic": f"SNMP/{req['device_name']}/availability",
|
||||||
|
"payload_available": "online",
|
||||||
|
"payload_not_available": "offline"
|
||||||
|
}
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
def get_ha_discovery_topic(req, oid):
|
||||||
|
"""Get the correct Home Assistant MQTT Discovery topic for a sensor"""
|
||||||
|
platform = oid['HA_platform'] # 'sensor' or 'binary_sensor'
|
||||||
|
node_id = req['device_name']
|
||||||
|
object_id = f"{req['device_name']}_{oid['name']}".replace(".", "_")
|
||||||
|
|
||||||
|
# Format: homeassistant/<platform>/<node_id>/<object_id>/config
|
||||||
|
return f"homeassistant/{platform}/{node_id}/{object_id}/config"
|
||||||
|
|
||||||
|
|
||||||
|
def publish_ha_autodiscovery_config(client, req):
|
||||||
|
"""Publish Home Assistant MQTT Discovery configuration for all sensors of a device"""
|
||||||
|
logging.info(f"[{req['device_name']}] Publishing Home Assistant autodiscovery configuration")
|
||||||
|
|
||||||
|
# Publish availability as online
|
||||||
|
availability_topic = f"SNMP/{req['device_name']}/availability"
|
||||||
|
publish(availability_topic, client, "online", True, 1)
|
||||||
|
|
||||||
|
# Publish discovery configuration for each OID/sensor
|
||||||
for oid in req['oids']:
|
for oid in req['oids']:
|
||||||
cmps.update(
|
config = create_ha_sensor_config(req, oid)
|
||||||
{
|
topic = get_ha_discovery_topic(req, oid)
|
||||||
f"{req['device_name']}_{req['ip']}_{oid['name']}".replace(".", "_"):
|
|
||||||
{
|
# Publish with retain=True so HA discovers it after restarts
|
||||||
"p": oid['HA_platform'],
|
publish(topic, client, config, True, 1)
|
||||||
"device_class": oid['HA_device_class'],
|
logging.info(f"[{req['device_name']}] Published discovery config for {oid['name']} to {topic}")
|
||||||
"value_template": f"{{{{ value_json.{oid['name']}}}}}",
|
|
||||||
"unique_id": f"{req['device_name']}_{req['ip']}_{oid['name']}".replace(".", "_"),
|
# Small delay to avoid overwhelming the broker
|
||||||
"name": oid['name']
|
time.sleep(0.1)
|
||||||
}
|
|
||||||
})
|
|
||||||
if "HA_unit" in oid.keys():
|
|
||||||
cmps.update(
|
|
||||||
{f"{req['device_name']}_{req['ip']}_{oid['name']}".replace(".", "_"):
|
|
||||||
{"unit_of_measurement": oid['HA_unit']}})
|
|
||||||
ha_config.update({"cmps": cmps})
|
|
||||||
logging.debug(f"config : {json.dumps(ha_config)}")
|
|
||||||
return ha_config
|
|
||||||
|
|
||||||
|
|
||||||
def signal_handler(signum, frame):
|
def signal_handler(signum, frame):
|
||||||
|
Reference in New Issue
Block a user