Diff: GirouetteWD1080.cpp

Revision:

4:dfa695d9c256

Parent:

2:6d392919b388

diff -r d4d516a75ac9 -r dfa695d9c256 GirouetteWD1080.cpp
--- a/GirouetteWD1080.cpp	Thu May 30 08:38:39 2019 +0000
+++ b/GirouetteWD1080.cpp	Sat Jun 29 16:14:36 2019 +0000
@@ -1,16 +1,20 @@
 #include "GirouetteWD1080.h"
 #include "mbed.h"
 
+// => /!\ Les pôles de réfèrence sont sculptés sur le pied de la girouette /!\
 
+//Notre constructeur
 GirouetteWD1080::GirouetteWD1080(PinName analog_pin):girouette(analog_pin)
 {
 }
 
-// Lit les différentes valeurs donné par la GirouetteWD1080
-//En déduit la direction inidquée par la girouette
+
 
-// => /!\ Les pôles de réfèrence sont sculptés sur le pied de la girouette /!\
-
+/*Permet de lire la girouette et d'attribuer le résultat en string à la variable direction_string :
+    ---------------------------------------------------------------------------------------------------------------------------
+    | Retour |"Ouest" | "Sud-Ouest" | "Sud" | "Sud-Est" | "Est" | "Nord-Est" | "Nord" | "Nord-Ouest" | "Err" |
+    ---------------------------------------------------------------------------------------------------------------------------
+*/
 bool GirouetteWD1080::read_string( )
 {   
         uint16_t positions[8] = {770, 200, 53, 30, 13, 105, 350, 550}, girou, i=0;
@@ -29,6 +33,12 @@
         return false;
 }
 
+/*Permet de lire la girouette et d'attribuer le résultat en int  à la variable direction_int :
+    ------------------------------------------------------------------------------------------------------------
+    |    Retour | 0    | 1         | 2   | 3       | 4   | 5        | 6    | 7          | 8                    |
+    | Direction |Ouest | Sud-Ouest | Sud | Sud-Est | Est | Nord-Est | Nord | Nord-Ouest | Erreur d'acquisition |
+    ------------------------------------------------------------------------------------------------------------
+*/
 bool GirouetteWD1080::read_int( )
 {   
         uint16_t positions[8] = {770, 200, 53, 30, 13, 105, 350, 550}, girou, i=0;