Compare commits
	
		
			5 Commits
		
	
	
		
			e4e79a34a9
			...
			update-pah
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						
						
							
						
						2309ef1deb
	
				 | 
					
					
						|||
| 
						
						
							
						
						75f8c6a637
	
				 | 
					
					
						|||
| 
						
						
							
						
						0d54632c52
	
				 | 
					
					
						|||
| 
						
						
							
						
						5b670c4708
	
				 | 
					
					
						|||
| 
						
						
							
						
						85a14f4fa0
	
				 | 
					
					
						
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -172,3 +172,4 @@ cython_debug/
 | 
				
			|||||||
#.idea/
 | 
					#.idea/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					WARP.md
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										22
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								README.md
									
									
									
									
									
								
							@@ -15,7 +15,7 @@ Passerelle SNMP vers MQTT pour l'intégration Home Assistant. Ce script Python s
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### Composants principaux
 | 
					### 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
 | 
					- **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
 | 
					- **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
 | 
					- **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
 | 
					- Accès réseau aux équipements SNMP à surveiller
 | 
				
			||||||
- Broker MQTT accessible
 | 
					- 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
 | 
					### Configuration de l'environnement
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```bash
 | 
					```bash
 | 
				
			||||||
@@ -361,6 +371,16 @@ devices:
 | 
				
			|||||||
   - Vérifiez que MQTT Discovery est activé dans Home Assistant
 | 
					   - Vérifiez que MQTT Discovery est activé dans Home Assistant
 | 
				
			||||||
   - Surveillez les logs MQTT avec `mosquitto_sub`
 | 
					   - 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
 | 
					### Commandes de test utiles
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```bash
 | 
					```bash
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										112
									
								
								WARP.md
									
									
									
									
									
								
							
							
						
						
									
										112
									
								
								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
 | 
					 | 
				
			||||||
@@ -2,10 +2,12 @@
 | 
				
			|||||||
# 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
 | 
					# 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
 | 
					# YAML configuration file parsing
 | 
				
			||||||
PyYAML>=6.0.0
 | 
					PyYAML>=6.0.0
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										55
									
								
								snmp2mqtt.py
									
									
									
									
									
								
							
							
						
						
									
										55
									
								
								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
 | 
				
			||||||
@@ -177,12 +179,14 @@ def load_config(config_path):
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def connect_mqtt(mqtt_config):
 | 
					def connect_mqtt(mqtt_config):
 | 
				
			||||||
    def on_connect(client, userdata, flags, rc):
 | 
					    def on_connect(client, userdata, connect_flags, reason_code, properties):
 | 
				
			||||||
        if rc == 0:
 | 
					        if reason_code == 0:
 | 
				
			||||||
            print("Connected to MQTT Broker!")
 | 
					            logging.info("Connected to MQTT Broker!")
 | 
				
			||||||
        else:
 | 
					        else:
 | 
				
			||||||
            print("Failed to connect, return code {rc}")
 | 
					            logging.error(f"Failed to connect to MQTT Broker, reason code: {reason_code}")
 | 
				
			||||||
    client = mqtt_client.Client()
 | 
					    
 | 
				
			||||||
 | 
					    # 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.username_pw_set(mqtt_config["user"], mqtt_config["password"])
 | 
				
			||||||
    client.on_connect = on_connect
 | 
					    client.on_connect = on_connect
 | 
				
			||||||
    client.connect(mqtt_config['broker'], mqtt_config['port'])
 | 
					    client.connect(mqtt_config['broker'], mqtt_config['port'])
 | 
				
			||||||
@@ -204,25 +208,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 +246,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