Diff: DRV8825.cpp

Revision:

3:ec3e5c8dd41b

Parent:

2:6d084e96623d

Child:

4:d9e022811431

Child:

5:41e1779ef9e4

--- a/DRV8825.cpp	Fri Jun 12 17:32:56 2020 +0000
+++ b/DRV8825.cpp	Mon Jun 29 17:20:24 2020 +0000
@@ -1,14 +1,24 @@
 #include "DRV8825.h"
 
+/**
+ * @brief Initialisation du modul avec des paramètres par défaut
+ */
+DRV8825::DRV8825(){
+
 
-DRV8825::DRV8825(){
-    m_en = new DigitalOut(PI_3);
-    m_dir = new DigitalOut(PI_0);
-    m_step = new FastPWM(PH_6);
+    m_en = new DigitalOut(PC_5);
+    m_dir = new DigitalOut(PC_6);
+    m_step = new FastPWM(PC_8);
     m_step->write(0.50);
 }
 
 
+/**
+ * @brief Initialisation du modul avec des paramètres choisis
+ * @param en : pin En
+ * @param dir : pin Dir
+ * @param step : pin Step
+ */
 DRV8825::DRV8825(PinName en, PinName dir ,PinName step){
     m_en = new DigitalOut(en);
     m_dir = new DigitalOut(dir);
@@ -16,14 +26,26 @@
     m_step->write(0.50);
 }
 
+/**
+ * @brief Permet d'affecter une directions à notre module
+ * @param dir : l'état que l'on souhaite appliquer
+ */
 void DRV8825::setDir(uint8_t dir){
         m_dir->write(dir);
 }
 
+/**
+ * @brief Permet de définir si l'on souhaite bloquer ou non le moteur
+ * @param en : l'état que l'on douhaite appliquer
+ */
 void DRV8825::setEnable(uint8_t en){
         m_en->write(en);
 }
 
+/**
+ * @brief Permet de définir la vitesse du moteur pas à pas
+ * @param ms : le temps en millis milliseconds
+ */
 void DRV8825::move(unsigned int ms){
         ms*=1000;
         m_step->period_us(ms);