ching-yang Trui / X_NUCLEO_IHM02A1

motor board library

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Dependents:   selfbalansingcar

Fork of X_NUCLEO_IHM02A1 by ST

Files at this revision

API Documentation at this revision

Revision 18:ddf3d5dc8137, committed 2016-04-08

Comitter:
Davidroid
Date:
Fri Apr 08 13:02:16 2016 +0000
Parent:
17:4b3dc908724f
Child:
19:b684efb6ba93
Commit message:
+ Some comments updated.

Changed in this revision

Components/Interfaces/StepperMotor_class.h Show annotated file Show diff for this revision Revisions of this file
Components/l6470/l6470_class.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Components/Interfaces/StepperMotor_class.h	Thu Apr 07 16:55:51 2016 +0000
+++ b/Components/Interfaces/StepperMotor_class.h	Fri Apr 08 13:02:16 2016 +0000
@@ -45,7 +45,7 @@
 
 /* Includes ------------------------------------------------------------------*/
 
-#include <Component_class.h>
+#include "Component_class.h"
 
 
 /* Classes  ------------------------------------------------------------------*/

--- a/Components/l6470/l6470_class.h	Thu Apr 07 16:55:51 2016 +0000
+++ b/Components/l6470/l6470_class.h	Fri Apr 08 13:02:16 2016 +0000
@@ -194,7 +194,7 @@
         return (unsigned int) L6470_GetStatus();
     }
 
-   /**
+    /**
      * @brief  Getting a parameter.
      * @param  parameter A parameter's register address.
      * @retval The parameter's value.
@@ -310,7 +310,7 @@
         return (direction_t) (L6470_CheckStatusRegisterFlag((eL6470_StatusRegisterFlagId_t) DIR_ID) == 1 ? StepperMotor::FWD : StepperMotor::BWD);
     }
 
-   /**
+    /**
      * @brief   Setting a parameter.
      * @param   parameter A parameter's register address.
      * @param   value The parameter's value.
@@ -655,7 +655,7 @@
         prepared_action = PREPARED_NO_ACTION;
     }
 
-   /**
+    /**
      * @brief  Preparing the command to get a parameter.
      * @param  parameter A parameter's register address.
      * @retval None.
@@ -795,7 +795,7 @@
         prepared_action = PREPARED_GET_DIRECTION;
     }
 
-   /**
+    /**
      * @brief  Preparing the command to set a parameter.
      * @param  parameter A parameter's register address.
      * @param  value The parameter's value.
@@ -1122,13 +1122,13 @@
     }
 
     /**
-      * @brief   Preparing the command to switch to step-clock mode.
-      * @param   direction The direction of rotation.
-      * @retval  None.
-      * @warning Setting the step-clock mode requires an explicit action by the user to first
-      *          disable the power bridge through the SoftHiZ() method.
-      * @note    The command will be sent by issuing "PerformAction()".
-      */
+     * @brief   Preparing the command to switch to step-clock mode.
+     * @param   direction The direction of rotation.
+     * @retval  None.
+     * @warning Setting the step-clock mode requires an explicit action by the user to first
+     *          disable the power bridge through the SoftHiZ() method.
+     * @note    The command will be sent by issuing "PerformAction()".
+     */
     virtual void PrepareStepClock(direction_t direction)
     {
         L6470_PrepareStepClock((eL6470_DirId_t) (direction == StepperMotor::FWD ? L6470_DIR_FWD_ID : L6470_DIR_REV_ID));