AntoineVe/snmp2mqtt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Mise à jour de la documentation (humaine + IA)

Browse Source
This commit is contained in:
Antoine Van Elstraete
2025-11-06 17:08:37 +01:00
parent 7888999ec3
commit 6c7248f08d
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
GEMINI.md
View File

@@ -40,12 +40,14 @@ Le script principal est organisé de la manière suivante :
- Attend un intervalle (`sleep_interval`) avant la prochaine interrogation. - Attend un intervalle (`sleep_interval`) avant la prochaine interrogation.
4. **`get_snmp(req)`** : 4. **`get_snmp(req)`** :
- Fonction `async` qui utilise `pysnmp` pour exécuter les requêtes `GET` SNMP pour tous les OIDs d'un appareil. - Fonction `async` qui utilise `pysnmp` pour exécuter les requêtes `GET` SNMP pour tous les OIDs d'un appareil.
- Traite la clé optionnelle `operation` pour appliquer une transformation mathématique.
- Retourne un dictionnaire contenant les valeurs formatées. - Retourne un dictionnaire contenant les valeurs formatées.
5. **Fonctions de configuration et MQTT** : 5. **Fonctions de configuration et MQTT** :
- `load_config()` : Charge et valide le fichier `config.yaml`. - `load_config()` : Charge et valide le fichier `config.yaml`.
- `connect_mqtt()` : Initialise le client MQTT. - `connect_mqtt()` : Initialise le client MQTT.
- `publish()` : Wrapper pour publier les messages MQTT. - `publish()` : Wrapper pour publier les messages MQTT.
- `publish_ha_autodiscovery_config()` : Construit et publie les messages de configuration pour Home Assistant MQTT Discovery. - `publish_ha_autodiscovery_config()` : Construit et publie les messages de configuration pour Home Assistant MQTT Discovery.
- `apply_operation(value, operation_str)` : Fonction d'aide qui applique de manière sécurisée une opération mathématique simple à une valeur.
## 4. Flux de Données ## 4. Flux de Données

11
README.md
View File

@@ -10,6 +10,7 @@ Passerelle SNMP vers MQTT pour l'intégration Home Assistant. Ce script Python s
- ⚡ **SNMP asynchrone** : Requêtes SNMP non-bloquantes pour de meilleures performances - ⚡ **SNMP asynchrone** : Requêtes SNMP non-bloquantes pour de meilleures performances
- 🔄 **Surveillance en temps réel** : Mise à jour continue des métriques réseau - 🔄 **Surveillance en temps réel** : Mise à jour continue des métriques réseau
- 📊 **Métriques réseau** : Trafic entrant/sortant et statut des interfaces - 📊 **Métriques réseau** : Trafic entrant/sortant et statut des interfaces
- 🔢 **Transformation de données** : Appliquez des opérations mathématiques simples (division, multiplication...) pour normaliser les valeurs.
## Architecture ## Architecture
@@ -119,6 +120,7 @@ Chaque OID dans la liste `oids` doit contenir :
| `HA_device_class` | string | ✅ | Classe d'équipement Home Assistant | | `HA_device_class` | string | ✅ | Classe d'équipement Home Assistant |
| `HA_platform` | string | ✅ | Plateforme Home Assistant ("sensor", "binary_sensor") | | `HA_platform` | string | ✅ | Plateforme Home Assistant ("sensor", "binary_sensor") |
| `HA_unit` | string | ❌ | Unité de mesure pour le capteur | | `HA_unit` | string | ❌ | Unité de mesure pour le capteur |
| `operation` | string | ❌ | Opération mathématique à appliquer (ex: "value / 1000") |
### Classes d'équipements Home Assistant courantes ### Classes d'équipements Home Assistant courantes
@@ -337,6 +339,15 @@ devices:
type: "bool" type: "bool"
HA_device_class: "connectivity" HA_device_class: "connectivity"
HA_platform: "binary_sensor" HA_platform: "binary_sensor"
# Exemple avec transformation de valeur (température en millidegrés -> degrés)
# - name: "temperature"
# oid: ".1.3.6.1.4.1.14988.1.1.6.1.0" # OID pour la température sur MikroTik
# type: "int"
# operation: "value / 1000"
# HA_device_class: "temperature"
# HA_platform: "sensor"
# HA_unit: "°C"
# Switch réseau # Switch réseau
switch_bureau: switch_bureau: