Diff: X_NUCLEO_IHM07M1/SPN7Driver.cpp

Revision:

6:0eec4b6e94ba

Parent:

5:3290e8857120

Child:

7:022c306baeb9

--- a/X_NUCLEO_IHM07M1/SPN7Driver.cpp	Mon Oct 17 11:11:52 2016 +0000
+++ b/X_NUCLEO_IHM07M1/SPN7Driver.cpp	Mon Oct 17 15:17:28 2016 +0000
@@ -41,8 +41,21 @@
     ST_BLDC_OFF
 } st_bldc_status_t;
 
-// FIXME: add doxygen
-
+/**************************************************************************/
+/**
+    @brief  Constructor
+     * @param pIN1     Logic input pin IN1 of L6230 chip
+     * @param pIN2     Logic input pin IN2 of L6230 chip
+     * @param pIN3     Logic input pin IN3 of L6230 chip
+     * @param pEN1     Enable channel pin EN1 of L6230 chip
+     * @param pEN2     Enable channel pin EN2 of L6230 chip
+     * @param pEN3     Enable channel pin EN3 of L6230 chip
+     * @param pH1      Hall sensor pin for phase #1 (A) of X-NUCLEO-IHM07M1
+     * @param pH2      Hall sensor pin for phase #2 (B) of X-NUCLEO-IHM07M1
+     * @param pH3      Hall sensor pin for phase #3 (Z) of X-NUCLEO-IHM07M1
+     * @param pFault   Fault LED pin of X-NUCLEO-IHM07M1
+*/
+/**************************************************************************/
 SPN7Driver::SPN7Driver(PinName pIN1, PinName pIN2, PinName pIN3,
                        PinName pEN1, PinName pEN2, PinName pEN3,
                        PinName pH1,  PinName pH2,  PinName pH3,
@@ -72,6 +85,12 @@
     H3.fall(this, &SPN7Driver::commutation);    
 }
 
+/**************************************************************************/
+/**
+    @brief  Set duty cycle for motor control
+     * @param dc       duty cycle value (positive for clockwise spin)
+*/
+/**************************************************************************/
 void SPN7Driver::setDutyCycle(float dc) {
     if (dc >= -1 && dc <= 1) {
         ticker.attach(this, &SPN7Driver::commutation, sampleTime);