Pull request #14: Develop

Merge in MCU16CE/mchv3-dspic33ck256mp508-an1206 from develop to master

* commit '273616bce6b389c383bb46c66aa1e1077dedc867':
  Added a special note on low resolution issue of external op- amp configuration with AC300023 motor.
  Excel sheet is updated.(External op-amp max peak current is changed from 16.4 to 16.5A)
  main.json and changelog files are modified for the release of version 1.0.1
  Tuning parameters for external op-Amp configuration are modified corresponding to peak current of 16.5A.
  Readme files are modified to correct the errors.

Author: SHYAMP8

.main-meta/main.json

@@ -4,7 +4,7 @@
    "content":{
       "metaDataVersion":"1.3.0",
       "name":"com.microchip.mplabx.project.mchv3-dspic33ck256mp508-an1206",
-      "version":"1.0.0",
+      "version":"1.0.1",
       "displayName":"AN1206 dspic33ck256mp508 MCHV3",
       "projectName":"mchv3-dspic33ck256mp508-an1206",
       "shortDescription":"Sensorless FOC (PLL estimator) of AC induction motor with field weakening",

README.md

@@ -1,6 +1,6 @@
 ![image](images/microchip.jpg) 
 
-# MCHV3 DSPIC33CK256MP508 AN1206
+# MCHV3 dsPIC33CK256MP508 AN1206
 
 ## INTRODUCTION
 <p style='text-align: justify;'>
@@ -20,5 +20,30 @@ A Phase-Locked Loop (PLL) estimator is implemented to estimate the speed and pos
   <img src="images/pllestimatorblockdiagram.PNG">
 </p>
 
+### The following hardware tools are used for the demonstration:
+
+Use one of the High-Voltage Motor Control Development Boards mentioned below:
+- dsPICDEM™ MCHV-2 Development Board, [DM330023-2](https://www.microchip.com/en-us/development-tool/dm330023-2)
+- dsPICDEM™ MCHV-3 Development Board, [DM330023-3](https://www.microchip.com/en-us/development-tool/dm330023-3)
+- High Voltage 3-Phase AC Induction Motor, [AC300023](https://www.microchip.com/en-us/development-tool/AC300023)
+- dsPIC33CK256MP508 Internal Op-Amp Motor Control Plug-in module, [MA330041-2](https://www.microchip.com/en-us/development-tool/MA330041-2)
+- dsPIC33CK256MP508 External Op-Amp Motor Control Plug-in module, [MA330041-1](https://www.microchip.com/en-us/development-tool/MA330041-1)
+
+Maximum rated current of the induction motor (AC300023) used for the demonstration is 0.25A.  The default gain of the internal amplifier is 15, capable of measuring a maximum peak current of 11A. To improve the measurement accuracy, modify the amplifier gain so that the maximum peak current is 1A. 
+
+- Readme document for Internal op-amp configuration [Readme for Internal Op-Amp](mchv3_dspic33ck256mp508_an1206/docs/README_internal.md)
+
+The default gain of the external amplifiers on the MCHV-2 or MCHV-3 is 10 (the maximum measurable peak current is 16.5A). 
+
 - Readme document for External op-amp configuration [Readme for External Op-Amp](mchv3_dspic33ck256mp508_an1206/docs/README_external.md)
-- Readme document for Internal op-amp configuration [Readme for Internal Op-Amp](mchv3_dspic33ck256mp508_an1206/docs/README_internal.md)
+
+</br>
+
+> **NOTE :**
+> - <p style='text-align: justify;'> The hardware setting for internal opamp configuration is altered to get a peak current of 1A. This is done to enable MCHV-2 or MCHV-3 board to run the  induction motor -AC300023 whose maximum rated current is only 0.25A.</p>
+> - <p style='text-align: justify;'>The hardware setting for external opamp configuration is left unaltered (with a peak current of 16.5A). This enables user to run higher power motors on MCHV-2 or MCHV-3 board. But, with the default external amplifier gain settings, the induction motor - AC300023 may not run properly or may stall at certain speeds, due to lower current resolution.</p>
+
+
+
+
+

changelog.md

@@ -1,3 +1,13 @@
+# mchv3-dspic33ck256mp508-an1206 v1.0.1
+### Release Highlights
+This is the code for  Sensorless FOC (PLL estimator) of AC induction motor with field weakening. 
+The code is set up for ZD AC induction motor (AC300023) with MCHV3 development board.
+
+
+### Features Added\Updated
+Tuning parameters for external op-Amp configuration are modified corresponding to peak current of 16.5A.
+Readme files are modified.
+
 # mchv3-dspic33ck256mp508-an1206 v1.0.0
 ### Release Highlights
 This is the first version of code for  Sensorless FOC (PLL estimator) of AC induction motor with field weakening. 

images/internalconfigsetup.PNG

@@ -6,7 +6,7 @@
 <p style='text-align: justify;'>
 This document describes the setup requirements for running the Sensor-less FOC algorithm for an Induction Motor, which is referenced in AN1206 “Sensorless Field Oriented Control (FOC) of a Three-Phase AC Induction Motor (ACIM)” </p>
 <p style='text-align: justify;'>
-The demonstration is configured to run on either the dsPICDEM™ MCHV-2 Development Board or the dsPICDEM™ MCHV-3 Development Board in the External Op-Amp configuration with the dsPIC33CK256MP508 Internal Op-Amp Motor Control Plug-In Module (PIM).
+The demonstration is configured to run on either the dsPICDEM™ MCHV-2 Development Board or the dsPICDEM™ MCHV-3 Development Board in the External Op-Amp configuration with the dsPIC33CK256MP508 External Op-Amp Motor Control Plug-In Module (PIM).
 </p>
 
 ## Hardware Connection and Running the Demo Code
@@ -26,8 +26,8 @@ To set up the demonstration, you may use one of the High-Voltage Motor Control D
 - dsPICDEM™ MCHV-3 Development Board [DM330023-3](https://www.microchip.com/en-us/development-tool/dm330023-3)
 > **_NOTE:_**
 >In this document, hereinafter High-Voltage Motor Control Development Board selected for setting up the demonstration is referred as Development Board..
-- High Voltage 3-Phase AC Induction Motor, Part-No. [AC300023](https://www.microchip.com/en-us/development-tool/AC300023)  
-- dsPIC33CK256MP508 Internal Op-Amp Motor Control Plug-in module, Part-No. [AC300023](https://www.microchip.com/en-us/development-tool/MA330041-2)
+- High Voltage 3-Phase AC Induction Motor. 
+- dsPIC33CK256MP508 External Op-Amp Motor Control Plug-in module, Part-No. [MA330041-1](https://www.microchip.com/en-us/development-tool/MA330041-1)
 <br />
 
 > **_NOTE:_**
@@ -38,7 +38,7 @@ To set up the demonstration, you may use one of the High-Voltage Motor Control D
 <p style='text-align: justify;'>
 Refer dsPICDEM™ MCHV-2 Development Board User’s Guide or dsPICDEM™ MCHV-3 Development Board User’s Guide, for any clarification while setting up the hardware.</p>
 <p style='text-align: justify;'>
-1.  Before making any connection, verify that the Development Board is not powered and it is fully discharged. This can be done by checking if Power on Status LED D13(Red) is off.</p>
+1. Before making any connection, verify that the Development Board is not powered and it is fully discharged. This can be done by checking if Power on Status LED D13(Red) is off.</p>
 <p style='text-align: justify;'> 
 2.  Open the top cover of the enclosure and set up the following jumpers (if they are not in specified positions):</p> 
 
@@ -57,7 +57,7 @@ Refer dsPICDEM™ MCHV-2 Development Board User’s Guide or dsPICDEM™ MCHV-3
   <img src="../../images/matrixboard.PNG">
 </p>
 <p style='text-align: justify;'>
-Note: Rated current of the board in External op amp configuration is 16.4 A.</p>
+Note: Rated current of the board in External op amp configuration is 16.5 A.</p>
 </br>
 <p style='text-align: justify;'>
 5. Insert the dsPIC33CK256MP508 External Op-Amp Motor Control PIM into the PIM Socket U11 provided on the Development Board. Make sure the PIM is correctly placed and oriented before proceeding.</p>
@@ -150,15 +150,15 @@ Define the Macro TORQUE_MODE, if the motor must run in Torque Control mode. If t
   </p>
 
   <p style='text-align: justify;'>
-5. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure the required Motor is defined and the Board and Motor parameters are corre-sponding to External Op-Amp design from the tuning parameter excel sheet in docs folder</p>
+5. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure the required Motor is defined and the Board and Motor parameters are corresponding to External Op-Amp design from the tuning parameter excel sheet in docs folder</p>
  <p align="center">
   <img  src="../../images/externalopampconfiguration.PNG">
   </p>
 
 ### **Parameters to Enter in the tuning parameter excel sheet:**
 ### **Board Parameters:**
 - **Board Peak voltage:** The Maximum measurable DC Bus voltage corresponding to Analog Channel voltage of 3.3V. By default, Board Peak Voltage for MCHV2/MCHV3 is 453V.
-- **Board Peak current:** The Maximum measurable Phase Current corresponding to Analog Channel voltage of 3.3V. By default, Board Peak current for MCHV2/MCHV3 in External OP AMP Configuration is 11A.
+- **Board Peak current:** The Maximum measurable Phase Current corresponding to Analog Channel voltage of 1.65V. By default, Board Peak current for MCHV2/MCHV3 in External OP AMP Configuration is 16.5A.
 - **PWM Period (Ts):** PWM Period is equal to 1/PWM switching frequency
 
 **Motor Parameters:**

images/internalopampselection.PNG

@@ -1,6 +1,6 @@
 ![image](../../images/microchip.jpg) 
 
-# AN1206 Demonstration ReadMe for the dsPICDEM™ MCHV-2 Development Board or dsPICDEM™ MCHV-3 Development Board with the dsPIC33CK256MP508 Inernal Op-Amp Motor Control PIM(MPLAB® X IDE)
+# AN1206 Demonstration ReadMe for the dsPICDEM™ MCHV-2 Development Board or dsPICDEM™ MCHV-3 Development Board with the dsPIC33CK256MP508 Internal Op-Amp Motor Control PIM(MPLAB® X IDE)
 
 ## INTRODUCTION
 <p style='text-align: justify;'>
@@ -25,9 +25,9 @@ To set up the demonstration, you may use one of the High-Voltage Motor Control D
 - dsPICDEM™ MCHV-2 Development Board, Part-No. [DM330023-2](https://www.microchip.com/en-us/development-tool/dm330023-2)
 - dsPICDEM™ MCHV-3 Development Board [DM330023-3](https://www.microchip.com/en-us/development-tool/dm330023-3)
 > **_NOTE:_**
->In this document, hereinafter High-Voltage Motor Control Development Board selected for setting up the demonstration is referred as Development Board..
-- High Voltage 3-Phase AC Induction Motor, Part-No. [AC300023](https://www.microchip.com/en-us/development-tool/AC300023)  
-- dsPIC33CK256MP508 Internal Op-Amp Motor Control Plug-in module, Part-No. [AC300023](https://www.microchip.com/en-us/development-tool/MA330041-2)
+>In this document, hereinafter High-Voltage Motor Control Development Board selected for setting up the demonstration is referred as Development Board. 
+- High Voltage 3-Phase AC Induction Motor.
+- dsPIC33CK256MP508 Internal Op-Amp Motor Control Plug-in module, Part-No. [MA330041-2](https://www.microchip.com/en-us/development-tool/MA330041-2)
 <br />
 
 > **_NOTE:_**
@@ -58,15 +58,13 @@ Refer dsPICDEM™ MCHV-2 Development Board User’s Guide or dsPICDEM™ MCHV-3
 </p>
 
 <p style='text-align: justify;'>
-5. The rated current of Induction Motor (AC300023) is 0.25 A, and the default rated current of the Board in Internal Op Amp Configuration is 11A. To increase the resolution please modify the rated current of the Board in Internal Op Amp Configuration from 11A to 1A by changing the gains of the current Amplifier.</p>
+5.  Maximum rated current of the induction motor (Part-No. AC300023) used for the demonstration is 0.25A.  The default gain of the internal amplifier is 15, capable of measuring a maximum peak current of 11A. To improve the measurement accuracy, modify the amplifier gain so that the maximum peak current is 1A.</p>
 
-Modify the **R6,R5,R13,R12** from **30k to 330k** ohm resistors.
+Modify the value of resistors **R6,R5,R13,R12** from **30k to 330k** ohm to change the measureable peak current from 11A to 1A.
 <p align="center">
   <img src="../../images/internalopampconfig.PNG">
 </p>
 <p style='text-align: justify;'>
-Note: if the Rated current of the motor is more than 1A, then there is no need to modify the gains of the internal Op Amp, during that case the rated current of the board in internal op amp configuration is 11A.</p>
-<p style='text-align: justify;'>
 6. Insert the dsPIC33CK256MP508 Internal Op-Amp Motor Control PIM into the PIM Socket U11 provided on the Development Board. Make sure the PIM is correctly placed and oriented before proceeding.</p>
 
 <p style='text-align: justify;'>
@@ -94,18 +92,17 @@ Install MPLAB X IDE and MPLAB XC16 Compiler versions that support the device dsP
 
 <p style='text-align: justify;'>If MPLAB IDE v8 or earlier is already installed on your computer, then run the MPLAB driver switcher (It is installed when MPLAB®X IDE is installed) to switch from MPLAB IDE v8 drivers to MPLAB X IDE drivers. If you have Windows 7 or 8, you must run MPLAB driver switcher in ‘Administrator Mode’. To run the Device Driver Switcher GUI application as administrator, right click on the executable (or desktop icon) and select ‘Run as Administrator’. For additional details refer MPLAB X IDE help topic “Before You Begin: Install the USB Device Drivers (For Hardware Tools): USB Driver Installation for Windows Operating Systems”. </p>
 
-### Setup: X2C - SCOPE
+### Setup: X2C - Scope
 <p style='text-align: justify;'>
-X2C - SCOPE is a MPLAB X IDE plugin that allows a developer to interact with an application while the application program is running. X2C-Scope enables you to read, write, and plot global variables (for motor control) in real time. It communicates with the target using the UART. To use X2C, the plugin must be installed:</p>
+X2C - Scope is a MPLAB X IDE plugin that allows a developer to interact with an application while the application program is running. X2C-Scope enables you to read, write, and plot global variables (for motor control) in real time. It communicates with the target using the UART. To use X2C, the plugin must be installed:</p>
 
 - In MPLAB X IDE, select Tools>Plugins and click on the Available Plugins tab.
-- Select X2C - SCOPE plug-in by checking its check box, and then click Install.
-- Look for tool X2C - SCOPE under Tools>Embedded.
+- Select X2C - Scope plug-in by checking its check box, and then click Install.
+- Look for tool X2C - Scope under Tools>Embedded.
 
 <p align="center">
   <img src="../../images/x2cinstall.PNG">
 </p>
-<br />
 
 ##  BASIC DEMONSTRATION
 ### Firmware Description
@@ -123,7 +120,7 @@ For more details refer Microchip Application note AN1206 “Sensorless Field Ori
 
 > **_NOTE:_**
 > The project may not build correctly in Windows OS if Maximum path length of any source file in the project is more than 260 characters. In case absolute path is exceeding or nearing maximum length, do any (or both) of the following:
- > - Shorten the name of the directory containing the firmware used in this demonstration. In this case, rename directory AN1206_dsPIC33CK256MP508_EXT_INT_OPAMP_MCHV2_MCHV3 to more ap-propriate shorter name. In case you renamed the directory, consider the new name while reading instructions provided in the upcoming sections of the document. 
+ > - Shorten the name of the directory containing the firmware used in this demonstration. In this case, rename directory AN1206_dsPIC33CK256MP508_EXT_INT_OPAMP_MCHV2_MCHV3 to more appropriate shorter name. In case you renamed the directory, consider the new name while reading instructions provided in the upcoming sections of the document. 
 > - Place firmware in a location, such that absolute path length of each file included in the projects does not exceed the Maximum Path length specified. 
 For details, refer MPLAB X IDE help topic “Path, File and Folder Name Restrictions”.
 
@@ -152,23 +149,23 @@ Define the Macro OPEN_LOOP_FUNCTIONING, if the motor must run in Open loop (V/F)
 Define the Macro TORQUE_MODE, if the motor must run in Torque Control mode. If the Macro OPEN_LOOP_FUNCTIONING is defined, then motor will run in Speed Con-trol mode.</p>
 
 <p style='text-align: justify;'>
-4. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure INTERNAL_OPAMP_CONFIGPIM is undefined as this demonstration is for Internal Op-Amp configuration.</p>
+4. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure INTERNAL_OPAMP_CONFIGPIM is defined as this demonstration is for Internal Op-Amp configuration.</p>
   <p align="center">
-  <img  src="../../images/undefinternalopamp.PNG">
+  <img  src="../../images/internalopampselection.PNG">
   </p>
 
   <p style='text-align: justify;'>
-5. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure the required Motor is defined and the Board and Motor parameters are corre-sponding to Internal Op-Amp design from the tuning parameter excel sheet in docs folder</p>
+5. Open userparams.h (under acim.X -> headerfiles) in the project acim.X and ensure the required Motor is defined and the Board and Motor parameters are corresponding to Internal Op-Amp design from the tuning parameter excel sheet in docs folder.</p>
  <p align="center">
   <img  src="../../images/internalconfigsetup.PNG">
   </p>
 
 ### **Parameters to Enter in the tuning parameter excel sheet:**
 ### **Board Parameters:**
 - **Board Peak voltage:** The Maximum measurable DC Bus voltage corresponding to Analog Channel voltage of 3.3V. By default, Board Peak Voltage for MCHV2/MCHV3 is 453V.
-- **Board Peak current:** The Maximum measurable Phase Current corresponding to Analog Channel voltage of 3.3V. By default, Board Peak current for MCHV2/MCHV3 in Internal OP AMP Configuration is 11A.
+- **Board Peak current:** The Maximum measurable Phase Current corresponding to Analog Channel voltage of 1.65V. For running ZD Motor,Part-No. [AC300023](https://www.microchip.com/en-us/development-tool/AC300023) the gains of the internal op Amp Module are modified and the Modified Board Peak Current is 1A.
+See Point #5 in [Hardware setup](#hadware-setup)
 
-    **Note:** For running **ZD Motor** the gains of the internal op Amp Module are modified and the Modified Board Peak Current is 1A.
 - **PWM Period (Ts):** PWM Period is equal to 1/PWM switching frequency
 
 **Motor Parameters:**
@@ -190,7 +187,7 @@ Enter the Motor Actual parameters and Generated parameters from tuning parameter
     In the ‘Conf: [default]’ category window: 
 
 - Select the specific Compiler Toolchain from the available list of compilers. Please ensure MPLAB® XC16 Compiler supports the device dsPIC33CK256MP508. In this case “XC16(v1.70)” is selected. The compiler used for testing the firmware is listed in the section Software Tools Used for Testing the firmware.
-- Select the Hardware Tool to be used for programming and debugging. In this case, “PKOB” is selected as the programmer from Connected Hardware Tools section.
+- Select the Hardware Tool to be used for programming and debugging. In this case, “PKoB” is selected as the programmer from Connected Hardware Tools section.
 
 - After selecting Hardware Tool and Compiler Toolchain, click button Apply
  <p align="center">

mchv3_dspic33ck256mp508_an1206/docs/README_external.md

@@ -59,7 +59,7 @@ controllers, tuning mode will disable the speed PI controller and undef to run i
 #ifdef INTERNAL_OPAMP_CONFIG
     #define MC1_PEAK_CURRENT            1    /* I Base *//* 11A for Unmodified Gain*/ 
 #else
-    #define MC1_PEAK_CURRENT            16.4    /* I Base */
+    #define MC1_PEAK_CURRENT            16.5    /* I Base */
 #endif    
 
 /* Define to run ZD Induction motor*/    
@@ -169,14 +169,14 @@ controllers, tuning mode will disable the speed PI controller and undef to run i
         /* the calculation of Rs gives a value exceeding the Q15 range so,
          the normalized value is further divided by 2^NORM_RS_SCALE to fit the 32768 limit
          this is taken care in the estim.c  */
-        #define NORM_RS 16438
+        #define NORM_RS 16538
         #define NORM_RS_SCALE   4   /* 2^NORM_RS_SCALE is the scaling */ 
         #define NORM_RS_SCALE_SHIFT (15 - NORM_RS_SCALE)  
         /* Normalized Sigmals/dt value */
         /* the calculation of NORM_SIGMA_LSDTBASE gives a value exceeding the Q15 range so,
          the normalized value is further divided by 2^NORM_SIGMA_LSDTBASE_SCALE to fit the 32768 limit
          this is taken care in the estim.c  */
-        #define NORM_SIGMA_LSDTBASE 21452   
+        #define NORM_SIGMA_LSDTBASE 21583   
         #define NORM_SIGMA_LSDTBASE_SCALE 10    /* 2^NORM_LSDTBASE_SCALE is the scaling */
         #define NORM_SIGMA_LSDTBASE_SCALE_SHIFT   (15- NORM_SIGMA_LSDTBASE_SCALE)    
         /* Normalized 1/(Lm^2/Lr) value */
@@ -193,7 +193,7 @@ controllers, tuning mode will disable the speed PI controller and undef to run i
         /* Normalized Inverse rotor time constant*/
         #define NORM_INVTR 2501    
         /* Normalized Stator Inductance (Lm + Lls)*/
-        #define NORM_LS 26923
+        #define NORM_LS 27088
         #define NORM_LS_SCALE 7    
         /* Limitation constants */
         /* di = i(t1)-i(t2) limitation