Config example

Fusion du README pour l'autodiscovery HA

.gitignore

@@ -172,3 +172,4 @@ cython_debug/
 #.idea/
 
 
+WARP.md

README.md

@@ -15,7 +15,7 @@ Passerelle SNMP vers MQTT pour l'intégration Home Assistant. Ce script Python s
 
 ### Composants principaux
 
-- **Client SNMP** : Utilise `pysnmp.hlapi.asyncio.slim` pour la récupération asynchrone des données SNMP
+- **Client SNMP** : Utilise `pysnmp.hlapi.asyncio` (version 7.x) pour la récupération asynchrone des données SNMP avec `get_cmd`, `SnmpEngine` et `UdpTransportTarget`
 - **Publisher MQTT** : Utilise `paho.mqtt.client` pour publier les données vers un broker MQTT
 - **Intégration Home Assistant** : Génère la configuration de découverte automatique compatible avec Home Assistant MQTT Discovery
 - **Traitement des données** : Convertit les valeurs des OID SNMP vers les types appropriés (int, bool) pour les capteurs Home Assistant
@@ -28,6 +28,16 @@ Passerelle SNMP vers MQTT pour l'intégration Home Assistant. Ce script Python s
 - Accès réseau aux équipements SNMP à surveiller
 - Broker MQTT accessible
 
+### Dépendances principales
+
+- **pysnmp >= 7.0.0** : Bibliothèque SNMP avec nouvelle API asynchrone
+- **paho-mqtt >= 2.0.0** : Client MQTT pour la communication avec le broker
+- **PyYAML >= 6.0.0** : Parsing des fichiers de configuration YAML
+
+⚠️ **Notes importantes sur les versions** :
+- **pysnmp 7.x** : Changements d'API incompatibles avec les versions 6.x et antérieures. L'ancienne classe `Slim` a été supprimée au profit de `get_cmd()` avec des objets `SnmpEngine`, `UdpTransportTarget`, etc.
+- **paho-mqtt 2.x** : Nouvelle API de callbacks (VERSION2) qui remplace l'ancienne API deprecated (VERSION1). Les signatures des callbacks ont changé.
+
 ### Configuration de l'environnement
 
 ```bash
@@ -156,21 +166,136 @@ python snmp2mqtt.py -c config.yaml
 
 ## 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
 
-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`
-- **État** : `SNMP/{device_name}/state`
+**Exemples** :
+```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
-- Des capteurs groupés par équipement
-- Des icônes et unités appropriées selon la classe d'équipement
-- Des modèles de valeurs JSON pour extraire les données
+### Configuration automatique des capteurs
+
+Chaque capteur est configuré avec :
+
+```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
 
@@ -246,6 +371,16 @@ devices:
    - Vérifiez que MQTT Discovery est activé dans Home Assistant
    - Surveillez les logs MQTT avec `mosquitto_sub`
 
+5. **Erreurs liées à PySNMP**
+   - **"ModuleNotFoundError: No module named 'pysnmp.hlapi.asyncio.slim'"** : Vous utilisez une version pysnmp 6.x. Mettez à jour vers >= 7.0.0
+   - **"Please call .create() to construct UdpTransportTarget object"** : Erreur corrigée dans cette version, utilisez `pip install -r requirements.txt`
+   - **Erreurs d'importation SNMP** : Assurez-vous d'avoir pysnmp 7.x avec `pip show pysnmp`
+
+6. **Erreurs liées à Paho MQTT**
+   - **"DeprecationWarning: Callback API version 1 is deprecated"** : Vous utilisez une version paho-mqtt < 2.0. Mettez à jour vers >= 2.0.0
+   - **Erreurs de callback MQTT** : La nouvelle API VERSION2 change la signature des callbacks (ex: `on_connect` reçoit maintenant 5 paramètres)
+   - **Vérification version** : `pip show paho-mqtt` pour confirmer la version installée
+
 ### Commandes de test utiles
 
 ```bash
@@ -263,7 +398,63 @@ ping 192.168.10.202
 
 ## 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
 

WARP.md

@@ -1,112 +0,0 @@
-# WARP.md
-
-This file provides guidance to WARP (warp.dev) when working with code in this repository.
-
-## Project Overview
-
-snmp2mqtt is a Python script that bridges SNMP network device monitoring with MQTT messaging for Home Assistant integration. It specifically monitors a MikroTik router (Hex) and publishes network interface statistics and status information to MQTT topics for Home Assistant discovery.
-
-## Architecture
-
-### Core Components
-
-- **SNMP Client**: Uses `pysnmp.hlapi.asyncio.slim` for asynchronous SNMP data retrieval from network devices
-- **MQTT Publisher**: Uses `paho.mqtt.client` to publish data to an MQTT broker
-- **Home Assistant Integration**: Generates device discovery configuration compatible with Home Assistant MQTT Discovery
-- **Data Processing**: Converts SNMP OID values to appropriate data types (int, bool) for Home Assistant sensors
-
-### Key Functions
-
-- `get_snmp(req)`: Asynchronously retrieves SNMP data from configured OIDs
-- `connect_mqtt(mqtt_config)`: Establishes MQTT broker connection
-- `publish(topic, client, data, retain, qos)`: Publishes JSON data to MQTT topics
-- `ha_create_config(req)`: Generates Home Assistant device discovery configuration
-- `send_to_mqtt()`: Main loop that continuously publishes config and state data
-
-### Configuration Structure
-
-The script uses two main configuration dictionaries:
-- `req`: Defines the target device, SNMP community, and monitored OIDs with Home Assistant metadata
-- `mqtt_config`: MQTT broker connection parameters
-
-## Common Development Commands
-
-### Environment Setup
-```bash
-# Activate virtual environment
-source bin/activate
-
-# Install dependencies (if needed)
-pip install pysnmp paho-mqtt
-
-# Check installed packages
-pip list
-```
-
-### Running the Application
-```bash
-# Run the main script
-python snmp2mqtt.py
-
-# Run with Python 3 explicitly
-python3 snmp2mqtt.py
-
-# Run from virtual environment
-./bin/python snmp2mqtt.py
-```
-
-### Development and Testing
-```bash
-# Test SNMP connectivity to device
-# (Manual SNMP walk example)
-snmpwalk -v2c -c public 192.168.10.2 1.3.6.1.2.1.2.2.1.10
-
-# Monitor MQTT messages (if mosquitto-clients available)
-mosquitto_sub -h 192.168.10.202 -u snmp2mqtt -P 'snmp_2_MQTT' -t 'homeassistant/device/+/config'
-mosquitto_sub -h 192.168.10.202 -u snmp2mqtt -P 'snmp_2_MQTT' -t 'SNMP/+/state'
-
-# Check network connectivity
-ping 192.168.10.2
-ping 192.168.10.202
-```
-
-## Configuration Notes
-
-### Device Configuration
-- Hardcoded to monitor MikroTik Hex router at IP `192.168.10.2`
-- SNMP community: `public`
-- Monitors interfaces: Starlink (index 1), LAN bridge (index 6), VPN (index 12)
-
-### MQTT Configuration  
-- Broker: `192.168.10.202:1883`
-- Credentials: `snmp2mqtt` / `snmp_2_MQTT`
-- Config topic: `homeassistant/device/{device_id}/config`
-- State topic: `SNMP/{device_name}/state`
-
-### Monitored Metrics
-For each interface:
-- **Incoming bytes** (`oid: .1.3.6.1.2.1.2.2.1.10.X`) - Published as data_size sensor
-- **Outgoing bytes** (`oid: .1.3.6.1.2.1.2.2.1.16.X`) - Published as data_size sensor  
-- **Interface status** (`oid: .1.3.6.1.2.1.2.2.1.8.X`) - Published as connectivity binary_sensor
-
-## Customization Points
-
-### Adding New Devices
-1. Create new `req` configuration dictionary with device details
-2. Update `mqtt_config` if different broker needed
-3. Configure appropriate SNMP OIDs for the device type
-
-### Adding New OIDs
-Each OID entry requires:
-- `name`: Unique identifier for Home Assistant
-- `oid`: SNMP Object Identifier
-- `type`: Python type conversion (int, bool)
-- `HA_platform`: Home Assistant platform (sensor, binary_sensor)
-- `HA_device_class`: Device class for proper Home Assistant categorization
-- `HA_unit`: (optional) Unit of measurement
-
-### Home Assistant Integration
-The script automatically creates Home Assistant MQTT Discovery configuration with:
-- Device identification and grouping
-- Sensor types and units appropriate for network monitoring
-- Value templates for JSON data extraction

config.yaml

@@ -3,10 +3,10 @@
 
 # MQTT Broker Configuration
 mqtt:
-  broker: "192.168.10.202"
+  broker: "IP or FQDN"
   port: 1883
-  user: "snmp2mqtt"
-  password: "snmp_2_MQTT"
+  user: "USER"
+  password: "PASSWORD"
 
 # Optional: Sleep interval between SNMP polls (default: 2 seconds)
 sleep_interval: 2
@@ -16,67 +16,25 @@ sleep_interval: 2
 devices:
   # Device name (used for MQTT topics and Home Assistant device identification)
   mikrotik_hex:
-    ip: "192.168.10.2"
+    ip: "IP"
     snmp_community: "public"
     oids:
-      # Starlink VPN interface (interface index 12)
-      - name: "stln_vpn_in"
-        oid: ".1.3.6.1.2.1.2.2.1.10.12"
-        type: "int"
-        HA_device_class: "data_size"
-        HA_platform: "sensor"
-        HA_unit: "bit"
-      
-      - name: "stlon_vpn_out"
-        oid: ".1.3.6.1.2.1.2.2.1.16.12"
-        type: "int"
-        HA_device_class: "data_size"
-        HA_platform: "sensor"
-        HA_unit: "bit"
-      
-      - name: "stln_vpn_status"
-        oid: ".1.3.6.1.2.1.2.2.1.8.12"
-        type: "bool"
-        HA_device_class: "connectivity"
-        HA_platform: "binary_sensor"
-      
-      # LAN Bridge interface (interface index 6)
-      - name: "lan_bridge_in"
-        oid: ".1.3.6.1.2.1.2.2.1.10.6"
-        type: "int"
-        HA_device_class: "data_size"
-        HA_platform: "sensor"
-        HA_unit: "bit"
-      
-      - name: "lan_bridge_out"
-        oid: ".1.3.6.1.2.1.2.2.1.16.6"
-        type: "int"
-        HA_device_class: "data_size"
-        HA_platform: "sensor"
-        HA_unit: "bit"
-      
-      - name: "lan_bridge_status"
-        oid: ".1.3.6.1.2.1.2.2.1.8.6"
-        type: "bool"
-        HA_device_class: "connectivity"
-        HA_platform: "binary_sensor"
-      
-      # Starlink interface (interface index 1)
-      - name: "starlink_in"
+      # example interface index 1
+      - name: "if1_in"
         oid: ".1.3.6.1.2.1.2.2.1.10.1"
         type: "int"
         HA_device_class: "data_size"
         HA_platform: "sensor"
         HA_unit: "bit"
       
-      - name: "starlink_out"
+      - name: "if1_out"
         oid: ".1.3.6.1.2.1.2.2.1.16.1"
         type: "int"
         HA_device_class: "data_size"
         HA_platform: "sensor"
         HA_unit: "bit"
       
-      - name: "starlink_status"
+      - name: "if1_status"
         oid: ".1.3.6.1.2.1.2.2.1.8.1"
         type: "bool"
         HA_device_class: "connectivity"

requirements.txt

@@ -2,10 +2,12 @@
 # Install with: pip install -r requirements.txt
 
 # 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
-paho-mqtt>=1.6.0
+# Note: paho-mqtt 2.x uses a new callback API (VERSION2) instead of the deprecated VERSION1
+paho-mqtt>=2.0.0
 
 # YAML configuration file parsing
 PyYAML>=6.0.0

snmp2mqtt.py

@@ -1,7 +1,9 @@
 #!/bin/env python3
 import asyncio
-from pysnmp.hlapi.asyncio.slim import Slim
-from pysnmp.smi.rfc1902 import ObjectIdentity, ObjectType
+from pysnmp.hlapi.asyncio import (
+    get_cmd, CommunityData, UdpTransportTarget, ContextData, 
+    SnmpEngine, ObjectIdentity, ObjectType
+)
 import logging
 import random
 from paho.mqtt import client as mqtt_client
@@ -17,7 +19,7 @@ import time
 
 logging.basicConfig(
         format='(%(levelname)s) [%(threadName)s] %(message)s',
-        level=logging.DEBUG
+        level=logging.INFO
         )
 
 # Global shutdown flag
@@ -177,12 +179,14 @@ def load_config(config_path):
 
 
 def connect_mqtt(mqtt_config):
-    def on_connect(client, userdata, flags, rc):
-        if rc == 0:
-            print("Connected to MQTT Broker!")
+    def on_connect(client, userdata, connect_flags, reason_code, properties):
+        if reason_code == 0:
+            logging.info("Connected to MQTT Broker!")
         else:
-            print("Failed to connect, return code {rc}")
-    client = mqtt_client.Client()
+            logging.error(f"Failed to connect to MQTT Broker, reason code: {reason_code}")
+    
+    # Use the new callback API version 2
+    client = mqtt_client.Client(callback_api_version=mqtt_client.CallbackAPIVersion.VERSION2)
     client.username_pw_set(mqtt_config["user"], mqtt_config["password"])
     client.on_connect = on_connect
     client.connect(mqtt_config['broker'], mqtt_config['port'])
@@ -204,25 +208,34 @@ def publish(topic, client, data, retain, qos):
 
 
 async def get_snmp(req):
+    """Asynchronously retrieve SNMP data from device using new pysnmp API"""
     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"]:
-        with Slim(1) as slim:
-            errorIndication, errorStatus, errorIndex, varBinds = await slim.get(
-                req["snmp_community"],
-                req["ip"],
-                161,
-                ObjectType(ObjectIdentity(oid["oid"])),
+        try:
+            # Perform async SNMP GET operation
+            errorIndication, errorStatus, errorIndex, varBinds = await get_cmd(
+                snmpEngine,
+                authData,
+                transportTarget,
+                contextData,
+                ObjectType(ObjectIdentity(oid["oid"]))
             )
 
             if errorIndication:
-                logging.error(errorIndication)
+                logging.error(f"{req['device_name']} SNMP error indication: {errorIndication}")
+                continue
             elif errorStatus:
                 logging.error(
-                    "{} at {}".format(
-                        errorStatus.prettyPrint(),
-                        errorIndex and varBinds[int(errorIndex) - 1][0] or "?",
-                    )
+                    f"{req['device_name']} SNMP error status: {errorStatus.prettyPrint()} at {errorIndex and varBinds[int(errorIndex) - 1][0] or '?'}"
                 )
+                continue
             else:
                 for varBind in varBinds:
                     logging.debug(f"{req['device_name']} {oid['name']} => {oid['type'](varBind[1])}")
@@ -233,7 +246,11 @@ async def get_snmp(req):
                             data.update({oid["name"]: "OFF"})
                     else:
                         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