Skip to content

Commit 7072686

Browse files
committed
Updated README with detailed installation and configuration guide
1 parent d255595 commit 7072686

1 file changed

Lines changed: 51 additions & 14 deletions

File tree

README.md

Lines changed: 51 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,59 @@
1-
# ChirpStack API Dashboard
1+
# LoRaWAN Analytics Platform
22

3-
Dashboard web pour visualiser les données LoRaWAN de ChirpStack.
3+
Une plateforme web moderne pour visualiser, décoder et analyser les données de vos capteurs LoRaWAN via ChirpStack.
44

5-
## Fonctionnalités
5+
## 🚀 Fonctionnalités
66

7-
- 📊 Affichage en temps réel des données de capteurs
8-
- 🔍 Filtrage par capteur, type et date
9-
- 📥 Export CSV
10-
- 🔄 Actualisation automatique
7+
* **Tableau de Bord Live** : Visualisation en temps réel de l'activité du réseau et des capteurs.
8+
* **Widgets Intelligents** : Détection et affichage automatique des métriques clés (Température, Humidité, CO2, Batterie, etc.) pour chaque capteur.
9+
* **Décodage Universel** : Intègre un décodeur unifié capable de gérer nativement de nombreux fabricants (Milesight, Dragino, Nexelec, Watteco, NKE, etc.) et de s'adapter automatiquement.
10+
* **Analytique** : Graphiques interactifs pour explorer l'historique des données.
11+
* **Configuration Facile** : Interface de paramétrage intégrée (pas besoin de toucher au code).
12+
* **Gestion de Flotte** : Suivi de l'état (Online/Offline) et du niveau de batterie des équipements.
13+
* **Console Live** : Flux de logs en temps réel et outil d'envoi de commandes Downlink.
1114

12-
## Utilisation
15+
## 🛠️ Installation
1316

14-
Visitez: https://princeddn.github.io/chirp-api/
17+
1. **Prérequis** :
18+
* Python 3.8 ou supérieur.
19+
* Un accès à une instance ChirpStack.
1520

16-
## Architecture
21+
2. **Installation des dépendances** :
22+
```bash
23+
pip install -r requirements.txt
24+
```
1725

18-
- `main`: Page GitHub Pages
19-
- `data-backup`: Données JSON
20-
- `beta`: Code API Flask
26+
3. **Lancement de l'application** :
27+
```bash
28+
python app.py
29+
```
30+
L'application sera accessible à l'adresse : `http://localhost:3000`
2131
22-
*Dernière vérification : 02/01/2026*
32+
## ⚙️ Configuration (Nouveau !)
33+
34+
Plus besoin de modifier les fichiers de code pour connecter votre instance ChirpStack.
35+
36+
1. Ouvrez l'application dans votre navigateur.
37+
2. Allez dans le menu **Paramètres** (dans la barre latérale).
38+
3. Remplissez les champs :
39+
* **URL API ChirpStack** : L'adresse de votre serveur (ex: `https://chirpstack.mon-domaine.com`).
40+
* **Token API** : Votre clé d'API (générée dans ChirpStack).
41+
* **Repo GitHub** (Optionnel) : Pour la sauvegarde automatique des données.
42+
4. Cliquez sur **Enregistrer**.
43+
44+
Les paramètres sont sauvegardés localement dans un fichier `config.json`.
45+
46+
## 📂 Structure du Projet
47+
48+
* `app.py` : Serveur Backend Flask.
49+
* `Decoder.py` : Moteur de décodage unifié (Python).
50+
* `index.html` : Interface utilisateur (SPA).
51+
* `assets/js/dashboard.js` : Logique Frontend et gestion des widgets.
52+
* `database.json` : Stockage local des trames reçues.
53+
* `config.json` : Fichier de configuration généré par l'interface.
54+
55+
## 🤝 Contribution
56+
57+
Les contributions sont les bienvenues ! Pour ajouter un nouveau décodeur :
58+
1. Ajoutez votre classe de décodage dans `Decoder.py`.
59+
2. Dans `Decoder.py`, ajoutez votre classe à la liste `globals.COMPATIBILITY`.

0 commit comments

Comments
 (0)