MiniOT - Gestionnaire IoT pour ESP32-S3

Plateforme IoT embarquée pour ESP32-S3 avec configuration WiFi via portail captif, mises à jour OTA depuis GitHub, et interface web de gestion.

🌟 Fonctionnalités

Configuration WiFi

Portail captif automatique au premier démarrage
Mode Access Point (AP) pour la configuration initiale
SSID par défaut : MiniOT-Setup-XXXX (XXXX = 4 derniers caractères MAC)
Interface web responsive à http://192.168.4.1
Sauvegarde persistante des credentials en NVS Flash

Mises à Jour OTA (Over-The-Air)

✅ Mises à jour depuis GitHub Releases (automatique)
✅ Mises à jour manuelles via URL personnalisée
✅ Barre de progression en temps réel dans l'interface web
✅ Dual-bank OTA (partitions ota_0 / ota_1) pour rollback automatique
✅ Validation de certificats HTTPS pour téléchargements sécurisés
✅ Vérification d'intégrité du firmware avant installation

Découverte Réseau

mDNS/Bonjour : Accès via http://miniot.local
Annonce du service HTTP sur le réseau local
Compatible avec la découverte macOS/iOS/Android

Interface Web

Dashboard de configuration responsive
Scan des réseaux WiFi disponibles avec force du signal
Informations système (version, partition, IP, MAC)
Gestion OTA avec progression visuelle
Factory Reset
Redémarrage à distance

🛠️ Matériel Requis

Composant	Spécification
Microcontrôleur	ESP32-S3
Flash	4MB minimum (dual-bank OTA)
RAM	512KB SRAM (inclus dans ESP32-S3)
WiFi	802.11 b/g/n 2.4GHz
Alimentation	3.3V via USB ou régulateur

Testé sur: ESP32-S3-DevKitC-1

🚀 Démarrage Rapide

Prérequis

# ESP-IDF v5.3 ou supérieur
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf && git checkout v5.3
./install.sh esp32s3
. ./export.sh

Installation

# Cloner le projet
git clone https://github.com/MatthieuGrr/miniot.git
cd miniot

# Configurer la cible
idf.py set-target esp32s3

# Compiler et flasher
idf.py build flash monitor

Configuration Initiale

Premier démarrage : L'ESP32 démarre en mode Access Point

I (XX) MAIN: === MiniOT Ready (AP Mode - First Boot) ===
I (XX) MAIN: Connect to WiFi network and navigate to http://192.168.4.1

Connectez-vous au réseau WiFi : MiniOT-Setup-XXXX
- Mot de passe : aucun (réseau ouvert)
Ouvrez un navigateur : http://192.168.4.1
- Scannez les réseaux WiFi disponibles
- Entrez vos credentials WiFi
- Cliquez sur "Save Configuration"
Redémarrage automatique en mode Station (STA)
- L'appareil se connecte à votre réseau WiFi
- Accessible via http://miniot.local ou l'IP affichée dans les logs

📡 API REST

Endpoints Disponibles

Configuration WiFi

POST /api/configure - Sauvegarder la configuration WiFi

{
  "ssid": "MonReseauWiFi",
  "password": "MonMotDePasse",
  "ap_timeout": 60
}

GET /api/scan - Scanner les réseaux WiFi

{
  "networks": [
    {"ssid": "WiFi-1", "rssi": -45, "auth": "WPA2"},
    {"ssid": "WiFi-2", "rssi": -67, "auth": "WPA3"}
  ]
}

Informations Système

GET /api/status - Statut du device

{
  "wifi_state": 3,
  "ip": "192.168.1.100",
  "mac": "AA:BB:CC:DD:EE:FF"
}

GET /api/ota_version - Version du firmware

{
  "version": "v1.0.5",
  "partition": "ota_0"
}

Mises à Jour OTA

GET /api/check_github_update - Vérifier les mises à jour

{
  "update_available": true,
  "current_version": "v1.0.0",
  "new_version": "v1.0.5",
  "download_url": "https://github.com/MatthieuGrr/miniot/releases/download/v1.0.5/miniot-v1.0.5.bin"
}

POST /api/install_github_update - Installer depuis GitHub

{
  "success": true,
  "message": "GitHub OTA update started"
}

POST /api/ota_update - Mise à jour manuelle

{
  "url": "http://192.168.1.50:8000/firmware.bin"
}

GET /api/ota_progress - Progression du téléchargement

{
  "in_progress": true,
  "total_size": 819200,
  "downloaded": 409600,
  "percent": 50,
  "status": "Downloading..."
}

Actions Système

POST /api/reboot - Redémarrer l'appareil

POST /api/factory_reset - Réinitialisation usine

🔧 Configuration Avancée

Modifier le Hostname mDNS

Fichier: main/components/mdns_service/mdns_service.c:28

#define MDNS_HOSTNAME "miniot"  // Changer en "mon-device"
// Accessible via: http://mon-device.local

Personnaliser le SSID du Point d'Accès

Fichier: main/components/wifi_manager/wifi_manager.c:31-32

#define AP_SSID_PREFIX "MiniOT-Setup"  // Changer en "MonProduit-Setup"

Modifier la Version du Firmware

Développement local:

echo "v1.0.6" > VERSION
idf.py build flash

Release GitHub:

git tag v1.0.6
git push origin v1.0.6
# GitHub Actions compile et publie automatiquement

📦 Structure du Projet

miniot/
├── main/
│   ├── main.c                      # Point d'entrée de l'application
│   ├── version.h.in                # Template de version (auto-généré)
│   └── components/
│       ├── nvs_storage/            # Stockage persistant (WiFi config)
│       ├── wifi_manager/           # Gestion WiFi (AP/STA)
│       ├── dns_server/             # Serveur DNS captif
│       ├── web_server/             # Serveur HTTP + API REST
│       ├── mdns_service/           # Découverte réseau mDNS
│       └── ota_manager/            # Mises à jour OTA + GitHub
├── partitions.csv                  # Table de partitions (dual-bank OTA)
├── sdkconfig.defaults              # Configuration ESP-IDF minimale
├── CMakeLists.txt                  # Build system
├── get_version.sh                  # Script d'extraction de version
├── VERSION                         # Fichier de version (dev local)
└── .github/workflows/
    └── build-and-release.yml       # CI/CD GitHub Actions

🔐 Sécurité

⚠️ Avertissements Importants

Le système actuel présente des limitations de sécurité :

Mots de passe en clair : Les credentials WiFi sont stockés non chiffrés dans la NVS Flash
HTTP non sécurisé : L'interface web utilise HTTP (pas HTTPS)
Pas d'authentification : Les API REST ne sont pas protégées

Recommandé pour :

✅ Prototypage
✅ Environnements de développement
✅ Réseaux privés de confiance

Non recommandé pour :

❌ Environnements de production sans modifications
❌ Réseaux publics
❌ Données sensibles

Améliorations Futures

Voir SECURITY_AUDIT.md pour l'analyse complète et les recommandations.

Prévues :

Chiffrement NVS pour les credentials
HTTPS pour le serveur web
Authentification Basic Auth ou API token
Signature des firmwares OTA

🔄 Workflow de Mise à Jour

Option 1 : Via GitHub Releases (Automatique)

# 1. Développement local
echo "v1.0.6" > VERSION
idf.py build flash  # Test local

# 2. Commit et tag
git add .
git commit -m "Add new feature"
git tag v1.0.6
git push origin main
git push origin v1.0.6

# 3. GitHub Actions
# - Compile automatiquement
# - Crée la release v1.0.6
# - Attache miniot-v1.0.6.bin

# 4. Sur l'ESP32
# - Interface web : "Check GitHub for Updates"
# - Détecte v1.0.6 disponible
# - Clic sur "Install Update"
# - Téléchargement + installation automatique
# - Redémarrage sur nouvelle version

Option 2 : Mise à Jour Manuelle

# 1. Héberger le firmware
python3 -m http.server 8000

# 2. Interface web ESP32
# - Section "Manual Update"
# - URL: http://192.168.1.50:8000/build/miniot.bin
# - Clic "Update Firmware"

🧪 Développement

Activer les Logs de Debug

menuconfig:

idf.py menuconfig
# Component config → Log output → Default log verbosity → Debug

Ou dans sdkconfig.defaults:

CONFIG_LOG_DEFAULT_LEVEL_DEBUG=y

Monitorer les Logs

idf.py monitor

# Filtrer par composant
idf.py monitor | grep "OTA_MANAGER"

Tests Locaux

# Servir l'interface web localement
cd main/components/web_server
python3 -m http.server 8000
# Ouvrir http://localhost:8000

🐛 Dépannage

Problème : "Failed to connect to WiFi"

Causes possibles :

SSID ou mot de passe incorrect
Réseau WiFi hors de portée
Canal WiFi incompatible

Solution :

# Logs détaillés
idf.py monitor
# Chercher : "wifi:state: xxx -> REASON_CODE"

# Réinitialiser la config
# Interface web → Factory Reset

Problème : "OTA update failed: Out of buffer"

Solution :

Le buffer HTTP est déjà configuré à 8192 bytes
Vérifier la taille du firmware (< 1.5MB)
Augmenter buffer_size dans ota_manager.c:110

Problème : "miniot.local" non accessible

Causes :

mDNS non supporté sur le routeur
Firewall bloque les requêtes mDNS

Solution :

# Utiliser l'IP directe (voir les logs)
I (XX) MAIN: Device IP: 192.168.1.100
# Accéder via http://192.168.1.100

# Ou forcer la résolution
avahi-browse -a  # Linux
dns-sd -B _http._tcp  # macOS

📊 Statistiques du Projet

Lignes de code C : ~2,500
Composants : 6 modules
Taille firmware : ~800 KB (compilé)
RAM utilisée : ~120 KB (runtime)
Flash utilisée : ~1.2 MB (firmware + partitions système)

🤝 Contribution

Les contributions sont les bienvenues ! Veuillez :

Fork le projet
Créer une branche feature (git checkout -b feature/AmazingFeature)
Commit vos changements (git commit -m 'Add AmazingFeature')
Push vers la branche (git push origin feature/AmazingFeature)
Ouvrir une Pull Request

Guidelines :

Code en anglais (commentaires, variables, fonctions)
Suivre le style ESP-IDF
Ajouter des tests si possible
Mettre à jour la documentation

📝 Roadmap

v1.1 (En cours)

Barre de progression OTA temps réel
Vérification automatique GitHub au boot
Reconnexion WiFi automatique
Watchdog pour détection de hang

v2.0 (Planifié)

v3.0 (Futur)

📄 Licence

À définir - Voir LICENSE pour plus de détails.

Suggestions :

MIT License (permissive)
Apache 2.0 (avec protection brevets)
GPL v3 (copyleft)

👨‍💻 Auteur

Matthieu Grr - @MatthieuGrr

🙏 Remerciements

Espressif Systems - ESP-IDF framework
cJSON - JSON parsing library
esp-idf-ci-action - GitHub Actions workflow

📚 Ressources

⭐ Si ce projet vous est utile, n'hésitez pas à lui donner une étoile sur GitHub !

Name		Name	Last commit message	Last commit date
Latest commit History 25 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
main		main
.gitignore		.gitignore
CMakeLists.txt		CMakeLists.txt
README.md		README.md
VERSION		VERSION
get_version.sh		get_version.sh
partitions.csv		partitions.csv
sdkconfig.defaults		sdkconfig.defaults

MatthieuGrr/miniot

Folders and files

Latest commit

History

Repository files navigation

MiniOT - Gestionnaire IoT pour ESP32-S3

🌟 Fonctionnalités

Configuration WiFi

Mises à Jour OTA (Over-The-Air)

Découverte Réseau

Interface Web

🛠️ Matériel Requis

🚀 Démarrage Rapide

Prérequis

Installation

Configuration Initiale

📡 API REST

Endpoints Disponibles

Configuration WiFi

Informations Système

Mises à Jour OTA

Actions Système

🔧 Configuration Avancée

Modifier le Hostname mDNS

Personnaliser le SSID du Point d'Accès

Modifier la Version du Firmware

📦 Structure du Projet

🔐 Sécurité

⚠️ Avertissements Importants

Améliorations Futures

🔄 Workflow de Mise à Jour

Option 1 : Via GitHub Releases (Automatique)

Option 2 : Mise à Jour Manuelle

🧪 Développement

Activer les Logs de Debug

Monitorer les Logs

Tests Locaux

🐛 Dépannage

Problème : "Failed to connect to WiFi"

Problème : "OTA update failed: Out of buffer"

Problème : "miniot.local" non accessible

📊 Statistiques du Projet

🤝 Contribution

📝 Roadmap

v1.1 (En cours)

v2.0 (Planifié)

v3.0 (Futur)

📄 Licence

👨‍💻 Auteur

🙏 Remerciements

📚 Ressources

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 2

Packages 0

Languages

Packages