Merge remote-tracking branch 'origin/master' into feat/balance

Reviewed-on: https://gitea.cb85.software/Epitech-T-DEV-811/T-DEV-811/pulls/25
Reviewed-by: nico <nicolas.sansd@gmail.com>
Reviewed-by: Guska <gildas.gonzalez@epitech.eu>

.gitignore

@@ -0,0 +1 @@
+IOT/docs/doxygen output/*

API/docs/diagram.wsd

@@ -0,0 +1,29 @@
+@startuml diagram
+class users {
+    id: text
+    username: text
+    email: email
+    name: text
+    image: file
+    created: date
+    updated: date
+}
+class trashs{
+    id: text
+    value: text
+    author: users
+    created: date
+    updated: date
+}
+class data {
+    id: text
+    value: number
+    poubelle_id: trashs
+    unit: text
+    status: bool
+    created: date
+    updated: date
+}
+users "1" <-- trashs
+trashs "1" <-- data
+@enduml

IOT/README.md

@@ -0,0 +1,6 @@
+#IOT:
+
+
+## setup :
+
+rename `secrets.ini.example` to `secrets.ini`

IOT/config.ini

@@ -14,6 +14,8 @@ build_flags =
     -D MONITOR_SPEED=${config.monitor_speed}
 ; DO NOT TOUCH --- END
 
-    -D EXAMPLE_NUMBER=69
+    -D API_HOST=\"iot.epi.cb85.software\"
+
+    -D MOYENNE_CALIBRATION=20
+
 
-    -D EXAMPLE_STRING=\"Pouet\"

IOT/docs/diagram/class.puml

@@ -0,0 +1,24 @@
+@startuml Class Diagram
+
+
+Class API {
+    - user: String
+    - password: String
+    - serveurHost: String
+    - https: bool
+    - client: WiFiEspClient*
+    - connect(): bool
+    + API(user: String, password: String, host: String, https: bool = true)
+    + wifiBegin(wifiId: String, wifiPass: String, espSerial: Stream*): bool
+    + sendValue(val: String, pouvelleID: String, unit: String, full: bool): bool
+}
+
+Class Program {
+    + Program()
+    + setup()
+}
+
+
+
+
+@enduml

IOT/lib/API/include/API.h

@@ -0,0 +1,94 @@
+#ifndef API_H
+#define API_H
+
+#include <Arduino_JSON.h>
+#include <WiFiEsp.h>
+
+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[in] wifiId nom du wifi
+     * @param[in] wifiPass mot de passe du wifi
+     * @param[in] 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[in] val valeur du capteur
+     * @param[in] poubelleID ID de la poubelle
+     * @param[in] unit uniter de mesure du capteur *(ex: g, cm, degree,...)
+     * @param[in] 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 sendValue(String val, String poubelleID, String unit, bool full);
+
+
+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;
+
+
+
+};
+
+
+#endif

IOT/lib/API/src/API.cpp

@@ -0,0 +1,120 @@
+#include "../include/API.h"
+
+
+API::API(String user, String password, String host, bool https){
+    this->user = user;
+    this->password = password;
+    this->serveurHost = host;
+    this->https = https;
+    this->token = "";
+    this->client = new WiFiEspClient();
+}
+
+
+bool API::wifiBegin(String wifiId, String wifiPass, Stream* espSerial){
+    WiFi.init(espSerial);
+
+    // check for the presence of the shield
+    if (WiFi.status() == WL_NO_SHIELD) {
+        Serial.println("WiFi shield not present");  // FIXME: rm debug
+        return false;
+    }
+
+    // attempt to connect to WiFi network
+    int status = WL_IDLE_STATUS;      // the Wifi radio's status
+    while (status != WL_CONNECTED) {
+        status = WiFi.begin(wifiId.c_str(), wifiPass.c_str());
+    }
+    return true;
+}
+bool API::connect(){
+    this->client->stop();
+    bool sortie = false;
+
+    JSONVar data;
+
+    data["identity"] = this->user;
+    data["password"] = this->password;
+
+    String strData = JSONVar::stringify(data);
+
+    if(this->https){
+        if (!this->client->connectSSL(this->serveurHost.c_str(), 443)) {
+            Serial.println("NOT Connected to server");
+            return sortie;
+        }
+    }else{
+        if (!this->client->connectSSL(("http://" + this->serveurHost).c_str(), 80)) {
+            Serial.println("NOT Connected to server");
+            return sortie;
+        }
+    }
+    this->client->println("POST /api/collections/users/auth-with-password HTTP/1.1");
+    this->client->println("Host: " + this->serveurHost);
+    this->client->println("Content-Type: application/json");
+    this->client->println("Content-Length: " + String(strData.length()));
+    this->client->println();
+    this->client->println(strData);
+    this->client->println("Connection: close");
+    this->client->println();
+
+
+    while (!client->available()) {}
+
+    String responce = "";
+    while (client->available()) {
+        responce += (char)client->read();
+    }
+
+    String str = responce.substring(responce.indexOf("{"),responce.lastIndexOf("}")+1);
+
+    JSONVar jsonRes =  new JSONVar(JSONVar::parse(str));
+
+    this->token = JSONVar::stringify(jsonRes["token"]);
+
+    this->token = this->token.substring(1,this->token.length()-1);
+    
+    this->client->stop();
+    
+    sortie = true;
+
+    return sortie;
+}
+
+bool API::sendValue(String val, String poubelleID, String valUnit, bool full){
+    JSONVar data;
+    data["value"] = val;
+    data["trash_id"] = poubelleID;
+    data["unit"] = valUnit;
+    data["status"] = full;
+
+    String strData = JSONVar::stringify(data);
+
+    if(this->token == ""){
+        bool connected = this->connect();
+        if(!connected)return false;
+    }
+    if(this->https){
+        if (!this->client->connectSSL(("https://" + this->serveurHost).c_str(), 443)) {
+            Serial.println("NOT Connected to server");
+            return false;
+        }
+    }else{
+        if (!this->client->connectSSL(("http://" + this->serveurHost).c_str(), 80)) {
+            Serial.println("NOT Connected to server");
+            return false;
+        }
+    }
+    this->client->println("POST /api/collections/data/records HTTP/1.1");
+    this->client->println("Host: " + this->serveurHost);
+    this->client->println("Content-Type: application/json");
+    this->client->println("Content-Length: " + String(strData.length()));
+    this->client->println("Authorization: Bearer " + this->token);
+    this->client->println();
+    this->client->print(strData);
+    this->client->println("Connection: close");
+    this->client->println();
+
+    this->token = "";//XXX: on rm le token a chaque fois car on sais pas si la requet a bien aboutie et donc si il y est encore bon
+    return true;
+}

IOT/lib/Balance/include/Balance.h

@@ -0,0 +1,80 @@
+#ifndef BALANCE_H
+#define BALANCE_H
+#include <Arduino.h>
+#include <HX711.h>
+
+class Balance {
+
+public:
+
+    /**
+     * @brief constructeur
+     *
+     * @param doutPin : pin DOUT du module HX711
+     *
+     * @param sckPin : pin horloge du module HX711
+     *
+     * @param poidsRef : valeur de poids posée sur la balance ref en grammes
+    */
+    Balance(int doutPin, int sckPin);
+
+    /**
+     * @brief determine le poids
+     *
+     * @return poids (double)
+    */
+    double getValue();
+
+    /**
+     * @brief determine la moyenne poids
+     *
+     * @param nbMesure : nombre de mesure effectues pour la moyenne
+     *
+     * @return moyenne poids (double)
+    */
+    double getAverage(int nbMesure);
+
+    /**
+     * @brief tare et scale a 0, et recuperation de la valeur brut du plateau
+    */
+    boolean initCalibration();
+
+    /**
+     * @brief initialisation du calibrage
+     * 
+     * @param[in] poidsRef : poid de reférence pour la calibration
+     * @param[in] moyenne_calibration : nombre de valeurs a lire pour une mesure
+     *
+     * @return renvoi un true si calibration bien effectue
+    */
+    boolean calibration(int poidsRef,int moyenne_calibration);
+
+    //TODO: faire doc setCalibration fact
+    void setCalibrationFact(int caliFact);
+
+
+private:
+
+    /**
+     * @brief true = calibration et false = erreur
+    */
+    boolean initialized;
+
+    /**
+     * @brief Facteur de calibration obtenu par : (val brute poids ref - val brute poids plexiglas)/ poids ref
+    */
+    int calibrationFact;
+
+    /**
+     * @brief Variable issue de la librairie HX711 qui permet d'utiliser les fonctions de celle-ci
+    */
+    HX711 scale;
+
+    /**
+     * @brief Valeur moyenne brute du poids sans rien sur la balance juste le plexiglas
+    */
+    long initialVal;
+
+};
+
+#endif

IOT/lib/Balance/src/Balance.cpp

@@ -0,0 +1,62 @@
+#include "../include/Balance.h"
+
+Balance::Balance(int doutPin, int sckPin) {
+
+    scale.begin(doutPin, sckPin);
+    this->initialized = false;
+    scale.set_scale();
+    scale.tare();
+    this->initialVal = 0;
+    this->calibrationFact = 0;
+}
+
+boolean Balance::initCalibration() {
+
+    scale.set_scale();
+    scale.tare();
+    this->initialVal = scale.read_average(20);
+    return true;
+}
+
+boolean Balance::calibration(int poidsRef,int moyenne_calibration) {
+
+    int rawValref = 0; // Valeur brute de plexiglas et poids réf
+    int tempPoids = 0; // C'est la valeur du poids en grammes calculée grâce au facteur de calibration
+
+    rawValref = scale.read_average(moyenne_calibration);
+    this->calibrationFact = (rawValref - this->initialVal) / poidsRef;
+    do {
+        scale.set_scale(calibrationFact);
+        tempPoids = scale.get_units(5);
+        if (tempPoids < poidsRef) {
+            calibrationFact -= 1;
+        } else if (tempPoids > poidsRef) {
+            calibrationFact += 1;
+        }
+    } while (tempPoids != poidsRef);
+    return initialized = true;
+}
+
+double Balance::getAverage(int nbMesure) {
+
+    if (initialized == true) {
+        return scale.get_units(nbMesure);
+    } else {
+        return 0;
+    }
+}
+
+double Balance::getValue() {
+
+    if (initialized == true) {
+        return scale.get_units();
+    } else {
+        return 0;
+    }
+}
+
+void Balance::setCalibrationFact(int caliFact){
+    this->initialized = true;
+    this->calibrationFact = caliFact;
+    scale.set_scale(caliFact);
+}

IOT/platformio.ini

@@ -36,6 +36,9 @@ monitor_flags =
 
 ; librairies
 lib_deps =
+    bportaluri/WiFiEsp@^2.2.2 ; gestion des commande 'AT' de l'esp01
+    arduino-libraries/Arduino_JSON@^0.2.0 ; gestion des json
+    bogde/HX711@0.7.5 ; lib pour la balance
 ;    example:
 ;    erropix/ESP32 AnalogWrite@^0.2
 

IOT/secrets.ini.example

@@ -4,3 +4,9 @@
 
 [secrets]
 build_flags =
+
+    -D WIFI_SSID=\"...\"
+    -D WIFI_PASSWORD=\"...\"4
+
+    -D USER_NAME=\"...\"
+    -D USER_PASSWORD=\"...\"

IOT/src/main.cpp

@@ -1,12 +1,41 @@
 #include <Arduino.h>
-#include "Program.h"
+// #include "Program.h"
 
-Program* program;
+// Program* program;
+
+// void setup() {
+//   program = new Program();
+// }
+
+// void loop() {
+//   program->loop();
+// }
+
+
+#include "Balance.h"
+
+Balance *balance;
+
+void setup(){
+  Serial.begin(MONITOR_SPEED);
+  balance = new Balance(14,15);
+  
+  Serial.print("start calibr : ");
+  balance->initCalibration();
+
+  Serial.println("OK");
+
+  // Serial.print("posé poids");
+  // delay(5000);
+  // Serial.println("OK");
+  // balance->calibration(500, MOYENNE_CALIBRATION);
+  // Serial.println("END calibration");
+
+  balance->setCalibrationFact(1077);
 
-void setup() {
-  program = new Program();
 }
 
-void loop() {
-  program->loop();
+void loop(){
+  // delay(500);
+  Serial.println(balance->getValue());
 }

README.md

@@ -2,3 +2,6 @@
 
 Lien du Gitea : (depot principale + gestion de projet)
 https://gitea.cb85.software/Epitech-T-DEV-811/T-DEV-811
+
+
+Lien de la CAO : https://cad.onshape.com/documents/d370ee863400195afb23d026/w/1a94981b6a6f71d70b075e30/e/d0feb75fc5a122c54598349b?renderMode=0&uiState=6422993bab4d903a51186392