Permet de lire et de stocker dans des variables publiques la direction pointées par la girouette WS1080.

Dependents:   test_girouette_library

Files at this revision

API Documentation at this revision

Comitter:
Station_Meteo_Laos
Date:
Sat Jun 29 16:14:36 2019 +0000
Parent:
3:d4d516a75ac9
Commit message:
Permet de lire et de stocker dans des variables publiques la direction pointee par la girouette WS1080.

Changed in this revision

GirouetteWD1080.cpp Show annotated file Show diff for this revision Revisions of this file
GirouetteWD1080.h Show annotated file Show diff for this revision Revisions of this file
--- 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;
--- 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;
 };