Epitech/T-DEV-811
4
0
Fork 0
Code Issues 7 Pull Requests 1 Packages Projects 1 Releases Wiki Activity

docs: Doxy-API-et-diagramme-API #25

Merged
Clement merged 5 commits from docs/Doxy-API-et-diagramme-API into master 2023-04-11 11:53:43 +00:00
Conversation 2 Commits 5 Files Changed 5 +9 -9
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit aba69c8181 - Show all commits

18
IOT/lib/API/include/API.h
View File

@ -21,25 +21,25 @@ public:
/** /**
* @brief Initialise la connection Wifi de l'esp * @brief Initialise la connection Wifi de l'esp
* *
* @param wifiId nom du wifi * @param[in] wifiId nom du wifi
* @param wifiPass mot de passe du wifi * @param[in] wifiPass mot de passe du wifi
* @param espSerial port serie de l'esp (hard ou soft) * @param[in] espSerial port serie de l'esp (hard ou soft)
* @return true la connexion a bien fonctionner * @return true la connexion a bien fonctionner
* @return false erreur a la connexion * @return false erreur a la connexion
*/ */
bool wifiBegin(String wifiId, String wifiPass, Stream* espSerial); bool wifiBegin(String wifiID, String wifiPass, Stream* espSerial);
/** /**
* @brief envoie la valeur d'un capteur de poubelle à l'api * @brief envoie la valeur d'un capteur de poubelle à l'api
* *
* @param val valeur du capteur * @param[in] val valeur du capteur
* @param poubelleID ID de la poubelle * @param[in] poubelleID ID de la poubelle
* @param unit uniter de mesure du capteur *(ex: g, cm, degree,...) * @param[in] unit uniter de mesure du capteur *(ex: g, cm, degree,...)
* @param full poubelle est considéré comme pleine * @param[in] full poubelle est considéré comme pleine
* @return true la valeur s'est bien envoyer * @return true la valeur s'est bien envoyer
* @return false il y a une erreur durran l'envoie * @return false il y a une erreur durran l'envoie
*/ */
bool sendValute(String val, String poubelleID, String unit, bool full); bool sendValue(String val, String poubelleID, String unit, bool full);
private: private: