Diff: GirouetteWD1080.h

Revision:

4:dfa695d9c256

Parent:

3:d4d516a75ac9

--- a/GirouetteWD1080.h	Thu May 30 08:38:39 2019 +0000
+++ b/GirouetteWD1080.h	Sat Jun 29 16:14:36 2019 +0000
@@ -4,18 +4,34 @@
 #include "mbed.h"
 #include "string"
 
+// => /!\ Les pôles de réfèrence sont sculptés sur le pied de la girouette /!\
+
 class GirouetteWD1080
 {
     public:
+        //Notre constructeur
         GirouetteWD1080(PinName analog_pin);
+        /*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 read_string();
+        /*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 read_int();
        
-        //char direction[3];
+        //Varibale public, récupère le résultat en string
         string direction_string;
+        //Varibale public, récupère le résultat en int
         int direction_int;    
         
     private:
+        //Appel du constructeur AnalogIn pour lire le port de la girouette WS1080
         AnalogIn girouette;
 };