From 3b46a75b43e9876d4a98b1d25502dfb762bd3814 Mon Sep 17 00:00:00 2001
From: Samuel <samuel.kay@poivron-robotique.fr>
Date: Sun, 5 Nov 2023 12:59:45 +0100
Subject: [PATCH] Ajout documentation de la fonction
 Balise_VL53L1X_get_capteur_cm

---
 Balise_VL53L1X.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Balise_VL53L1X.c b/Balise_VL53L1X.c
index c48e20a..7e60fc5 100644
--- a/Balise_VL53L1X.c
+++ b/Balise_VL53L1X.c
@@ -101,6 +101,10 @@ uint8_t Balise_VL53L1X_get_min_distance(void){
     return min_distance_cm;
 }
 
+/// @brief Retourne la valeur lue par le capteur. Le seul traitement appliqué est de renvoyer  0cm si le capteur n'a pas détecter d'obstacles proches.
+/// @param capteur : numéro du capteur, 9 pour celui à 0° (par rapport à l'axe x), 10 pour celui à 30°,  11 pour celui à 60°, 
+///                  0 pour celui à 90, 1 pour celui à 120, etc...
+/// @return Distance en cm
 uint8_t Balise_VL53L1X_get_capteur_cm(uint8_t capteur){
     return capteurs_VL53L1X[capteur].distance_lue_cm;
 }