README

README.md

@@ -0,0 +1,25 @@
+# Capteur de CO2 (logiciel)
+
+Pour la partie matérielle voir [CO2-HARDWARE](https://gitlab.univ-nantes.fr/E208835U/co2.git)
+
+## Installation
+Cloner le projet (avec le sous-module pour l'accès au capteur)
+
+`git clone --recurse-submodules https://gitlab.univ-nantes.fr/E208835U/co2-software.git`
+
+
+Après les commandes classiques de esp-idf peuvent être utilisées, pour flasher sur la carte :
+
+`idf.py -p /dev/ttyACM0 flash` (Remplacer /dev/ttyACM0 par le port sur lequel la carte est connectée)
+
+## TODO
+(non exhaustif, par ordre arbitraire d'importance)
+
+- [x] Connection I2C avec le capteur
+- [ ] Lecture du voltage batterie + protection sous-voltage
+- [ ] Indicateurs à LED
+- [ ] Interface HTTP
+- [ ] MQQT
+- [ ] Power management
+- [ ] OTA
+- [ ] BLE