From 97ae6c69771377f2e37f16e5ac2a977e179b1f6c Mon Sep 17 00:00:00 2001
From: Clement <c.boesmier@aptatio.com>
Date: Mon, 3 Apr 2023 16:23:59 +0200
Subject: [PATCH] docs(iot): documentation de la lib api client

---
 IOT/lib/API/include/API.h | 62 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 60 insertions(+), 2 deletions(-)

diff --git a/IOT/lib/API/include/API.h b/IOT/lib/API/include/API.h
index b4ff31c..c6df496 100644
--- a/IOT/lib/API/include/API.h
+++ b/IOT/lib/API/include/API.h
@@ -8,24 +8,82 @@ class API {
 public:
 
 
-
+    /**
+     * @brief Construit un nouvelle objet API
+     * 
+     * @param[in] user nom de l'utilisateur de l'API
+     * @param[in] password mot de passe de l'utilisateur
+     * @param[in] host address de l'api
+     * @param[in] https l'address de l'api est en https *(defaut `true`)*
+     */
     API(String user, String password, String host, bool https = true);
 
+    /**
+     * @brief Initialise la connection Wifi de l'esp
+     * 
+     * @param wifiId nom du wifi
+     * @param wifiPass mot de passe du wifi
+     * @param espSerial port serie de l'esp (hard ou soft)
+     * @return true la connexion a bien fonctionner
+     * @return false erreur a la connexion
+     */
     bool wifiBegin(String wifiId, String wifiPass, Stream* espSerial);
 
+    /**
+     * @brief envoie la valeur d'un capteur de poubelle à l'api
+     * 
+     * @param val valeur du capteur
+     * @param poubelleID ID de la poubelle
+     * @param unit uniter de mesure du capteur *(ex: g, cm, degree,...)
+     * @param full poubelle est considéré comme pleine
+     * @return true la valeur s'est bien envoyer
+     * @return false il y a une erreur durran l'envoie
+     */
     bool sendValute(String val, String poubelleID, String unit, bool full);
 
-    JSONVar* connect();
 
 private:
+    /**
+     * @brief connect l'utilisateur a l'api et met a jour le token
+     * 
+     * @return true l'utilisateur est bien connecter
+     * @return false erreur lors de la connexion de l'utilisateur
+     */
+    bool connect();
 
+    /**
+     * @brief ID de l'utilisateur
+     * 
+     */
     String user;
+    /**
+     * @brief mdp de l'utilisateur
+     * 
+     */
     String password;
+
+    /**
+     * @brief adresse du serveur API
+     * 
+     */
     String serveurHost;
+
+    /**
+     * @brief true = serveur en https (443)
+     * 
+     */
     bool https;
 
+    /**
+     * @brief client http
+     * 
+     */
     WiFiEspClient* client;
     
+    /**
+     * @brief token de connexion du client (vide = deconnecter)
+     * 
+     */
     String token;