MPAE-7470 : json, readme is updated

Author: srinivasa K R

.main-meta/main.json

@@ -5,9 +5,9 @@
         "metaDataVersion": "1.1.0",
         "name": "com.microchip.mcu8.mplabx.project.pic18f47q10-adc-computation-modes-mplab",
         "version": "1.0.0",
-        "displayName": "ADC With Computational Modes",
+        "displayName": "Usage of PIC18-Q10 family 10-bit ADCC Computation modes for real-time sensing applications",
         "projectName": "pic18f47q10-adc-computation-modes-mplab",
-        "shortDescription": "Microchip offers a 10-bit ADCC module in PIC18 Q10 family microcontrollers. This example highlights the basic, average, burst average and low-pass filter computation modes of ADC using PIC18F47Q10 MCU and Curiosity High Pin Count development board.",
+        "shortDescription": "Microchip offers a 10-bit ADCC module in PIC18-Q10 family microcontrollers. This example highlights the basic, average, burst average and low-pass filter computation modes of ADC using PIC18F47Q10 MCU and Curiosity High Pin Count development board.",
         "ide": {
             "name": "MPLAB X IDE",
             "semverRange": ">=5.40"

README.md

@@ -1,9 +1,9 @@
 <!-- Please do not change this logo with link -->
 [![MCHP](images/microchip.png)](https://www.microchip.com)
 
-# ADC with Computational Modes
+# Usage of PIC18-Q10 family 10-bit ADCC Computation modes for real-time sensing applications
 
-The PIC18FxxQ10 family of devices are equipped with a 10-bit ADC with Computation (ADCC) automating Capacitive Voltage Divider (CVD) techniques for advanced touch sensing, averaging, filtering, oversampling and performing automatic threshold comparisons.
+The PIC18-Q10 family of devices are equipped with a 10-bit ADC with Computation (ADCC) automating Capacitive Voltage Divider (CVD) techniques for advanced touch sensing, averaging, filtering, oversampling and performing automatic threshold comparisons.
 
 ### Demonstration Video 
 
@@ -27,7 +27,7 @@ The PIC18F47Q10 MCU is used in this demo along with curiosity HPC board and USB-
 
 This demo demonstrates the usage of ADCC module with different computation modes such as basic, average, burst average and low pass filter mode for sensing applications.
 
-The basic mode is considered as ‘legacy’ mode since it does not use the computation features, like a typical ADC module available in many PIC16 and PIC18 devices.
+The basic mode is considered as ‘legacy' mode since it does not use the computation features, like a typical ADC module available in many PIC16 and PIC18 devices.
 
 In average mode, the ADCC module accumulates one sample for each auto conversion trigger. The ADCC module accumulates a certain number of samples (depending upon ADRPT value) and computes average of the accumulated value.
 
@@ -441,5 +441,5 @@ In the above diagrams, the waveform in yellow is the raw ADRES value and wavefor
 
 ## Conclusion 
 
-The demo provides a code example, which demonstrates the usage of PIC18FxxQ10 MCUs ADCC module and its advanced computation modes. The advanced ADCC module replaces common firmware tasks for average and filtering implementation with the hardware solution and completely avoids the firmware overhead. It performs advanced computations and filtering of data in hardware without any intervention of CPU, therefore reduces design efforts and improves system response.
+The demo provides a code example, which demonstrates the usage of PIC18-Q10 MCUs ADCC module and its advanced computation modes. The advanced ADCC module replaces common firmware tasks for average and filtering implementation with the hardware solution and completely avoids the firmware overhead. It performs advanced computations and filtering of data in hardware without any intervention of CPU, therefore reduces design efforts and improves system response.
 

images/BlockDiagram.png

@@ -1,15 +1,98 @@
 #include "application.h"
+#include "mcc_generated_files/pin_manager.h"
+
+void ADCC_Initialize_BasicMode(void) {
+    // ADCRS 0; ADMD Basic_mode; ADACLR disabled; ADPSIS ADRES; 
+    ADCON2 = 0x00;
+    // ADCALC First derivative of Single measurement; ADTMD enabled; ADSOI ADGO not cleared; 
+    ADCON3 = 0x07;
+    // ADACT TMR0; 
+    ADACT = 0x02;
+    // ADCS FOSC/64; 
+    ADCLK = 0x1F;
+    // ADGO stop; ADFM right; ADON enabled; ADCONT disabled; ADCS FOSC/ADCLK; 
+    ADCON0 = 0x84;
+}
+
+void ADCC_Initialize_AverageMode(void) {
+    // ADLTHL 56; 
+    ADLTHL = 0x38;
+    // ADLTHH 255;      // Lower threshold set to -200 diff from setpoint 
+    ADLTHH = 0xFF;
+    // ADUTHL 200; 
+    ADUTHL = 0xC8;
+    // ADUTHH 0;        // Upper threshold set to +200 diff from setpoint
+    ADUTHH = 0x00;
+    // ADSTPTL 255; 
+    ADSTPTL = 0xFF;
+    // ADSTPTH 1;       // Setpoint set to 511
+    ADSTPTH = 0x01;
+    // ADRPT 16; 
+    ADRPT = 0x10;
+    // ADCRS 4; ADMD Average_mode; ADACLR disabled; ADPSIS ADRES; 
+    ADCON2 = 0x42;
+    // ADCALC Actual result vs setpoint; ADTMD ADERR > ADLTH and ADERR < ADUTH; ADSOI ADGO not cleared; 
+    ADCON3 = 0x13;
+    // ADACT TMR0; 
+    ADACT = 0x02;
+    // ADCS FOSC/64; 
+    ADCLK = 0x1F;
+    // ADGO stop; ADFM right; ADON enabled; ADCONT disabled; ADCS FOSC/ADCLK; 
+    ADCON0 = 0x84;
+}
+
+void ADCC_Initialize_BurstAverageMode(void) {
+    // ADLTHL 56; 
+    ADLTHL = 0x38;
+    // ADLTHH 255;      // Lower threshold set to -200 diff from setpoint 
+    ADLTHH = 0xFF;
+    // ADUTHL 200; 
+    ADUTHL = 0xC8;
+    // ADUTHH 0;        // Upper threshold set to +200 diff from setpoint
+    ADUTHH = 0x00;
+    // ADSTPTL 255; 
+    ADSTPTL = 0xFF;
+    // ADSTPTH 1;       // Setpoint set to 511
+    ADSTPTH = 0x01;
+    // ADRPT 16; 
+    ADRPT = 0x10;
+    // ADCRS 4; ADMD Burst_average_mode; ADACLR disabled; ADPSIS ADRES; 
+    ADCON2 = 0x43;
+    // ADCALC Actual result vs setpoint; ADTMD ADERR > ADLTH and ADERR < ADUTH; ADSOI ADGO not cleared; 
+    ADCON3 = 0x13;
+    // ADACT TMR0; 
+    ADACT = 0x02;
+    // ADCS FOSC/64; 
+    ADCLK = 0x1F;
+    // ADGO stop; ADFM right; ADON enabled; ADCONT disabled; ADCS FOSC/ADCLK; 
+    ADCON0 = 0x84;
+}
+
+void ADCC_Initialize_LowPassFilterMode(void) {
+    // ADRPT 16; 
+    ADRPT = 0x10;
+    // ADCRS 3; ADMD Low_pass_filter_mode; ADACLR disabled; ADPSIS ADRES; 
+    ADCON2 = 0x34;
+    // ADCALC Filtered value vs setpoint; ADTMD enabled; ADSOI ADGO not cleared; 
+    ADCON3 = 0x57;
+    // ADACT TMR0; 
+    ADACT = 0x02;
+    // ADCS FOSC/64; 
+    ADCLK = 0x1F;
+    // ADGO stop; ADFM right; ADON enabled; ADCONT disabled; ADCS FOSC/ADCLK; 
+    ADCON0 = 0x84;
+}
 
 void ADCC_SetChannel(adcc_channel_t channel) {
     // select the A/D channel
     ADPCH = channel;
 }
 
-void ApplicationTask (void) {
+void ApplicationTask(void) {
     // change the ADCC modes based on button press
-    switch(count) {
+    switch (count) {
         case BASIC_MODE:
-            if(!basicModeInit) {
+            if (!basicModeInit) {
                 // stop the timer and configure it to 10ms for ADC auto conversion
                 TMR0_StopTimer();
                 TMR0_Reload(TIMER0_10ms);
@@ -24,14 +107,14 @@ void ApplicationTask (void) {
                 basicModeInit = true;
             } else {
                 // if ADC conversion is ready, print the data on serial port
-                if(adcReadyFlag) {
+                if (adcReadyFlag) {
                     adcReadyFlag = false;
-                    printf ("Basic Mode - ADRES=%d \r\n", ADRES);
+                    printf("Basic Mode - ADRES=%d \r\n", ADRES);
                 }
             }
             break;
         case AVG_MODE:
-            if(!avgModeInit) {
+            if (!avgModeInit) {
                 // stop the timer
                 TMR0_StopTimer();
                 // turn on LED 1
@@ -46,21 +129,21 @@ void ApplicationTask (void) {
                 basicModeInit = false;
             } else {
                 // if ADC value is within threshold limits, print the actual value
-                if(adcReadyFlag) {
+                if (adcReadyFlag) {
                     adcReadyFlag = false;
-                    printf ("AVG Mode - ADFLT=%d \r\n", ADFLTR);
+                    printf("AVG Mode - ADFLT=%d \r\n", ADFLTR);
                 }
                 // check if upper threshold is crossed
-                if(ADCC_HasErrorCrossedUpperThreshold()) {
-                    printf ("AVG Mode - ADFLT=%d - SP=%d - UT=%d - UT Crossed\r\n", ADFLTR,ADSTPT,ADUTH);
-                // check if lower threshold is crossed
-                } else if(ADCC_HasErrorCrossedLowerThreshold()) {
-                    printf ("AVG Mode - ADFLT=%d - SP=%d - LT=%d - LT Crossed\r\n", ADFLTR,ADSTPT,ADLTH);
-                } 
+                if (ADCC_HasErrorCrossedUpperThreshold()) {
+                    printf("AVG Mode - ADFLT=%d - SP=%d - UT=%d - UT Crossed\r\n", ADFLTR, ADSTPT, ADUTH);
+                    // check if lower threshold is crossed
+                } else if (ADCC_HasErrorCrossedLowerThreshold()) {
+                    printf("AVG Mode - ADFLT=%d - SP=%d - LT=%d - LT Crossed\r\n", ADFLTR, ADSTPT, ADLTH);
+                }
             }
             break;
         case BURST_AVG_MODE:
-            if(!burstAvgModeInit) {
+            if (!burstAvgModeInit) {
                 // stop the timer
                 TMR0_StopTimer();
                 // turn on LED 2
@@ -75,21 +158,21 @@ void ApplicationTask (void) {
                 avgModeInit = false;
             } else {
                 // if ADC value is within threshold limits, print the actual value
-                if(adcReadyFlag) {
+                if (adcReadyFlag) {
                     adcReadyFlag = false;
-                    printf ("Burst AVG Mode - ADFLT=%d \r\n", ADFLTR);
+                    printf("Burst AVG Mode - ADFLT=%d \r\n", ADFLTR);
                 }
                 // check if upper threshold is crossed
-                if(ADCC_HasErrorCrossedUpperThreshold()) {
-                    printf ("Burst AVG Mode - ADFLT=%d - SP=%d - UT=%d - UT Crossed\r\n", ADFLTR,ADSTPT,ADUTH);
-                // check if lower threshold is crossed
-                } else if(ADCC_HasErrorCrossedLowerThreshold()) {
-                    printf ("Burst AVG Mode - ADFLT=%d - SP=%d - LT=%d - LT Crossed\r\n", ADFLTR,ADSTPT,ADLTH);
-                } 
+                if (ADCC_HasErrorCrossedUpperThreshold()) {
+                    printf("Burst AVG Mode - ADFLT=%d - SP=%d - UT=%d - UT Crossed\r\n", ADFLTR, ADSTPT, ADUTH);
+                    // check if lower threshold is crossed
+                } else if (ADCC_HasErrorCrossedLowerThreshold()) {
+                    printf("Burst AVG Mode - ADFLT=%d - SP=%d - LT=%d - LT Crossed\r\n", ADFLTR, ADSTPT, ADLTH);
+                }
             }
             break;
         case LPF_MODE:
-            if(!lpfModeInit) {
+            if (!lpfModeInit) {
                 // stop the timer and configure it to 1ms for ADC auto conversion
                 TMR0_StopTimer();
                 TMR0_Reload(TIMER0_1ms);
@@ -105,20 +188,34 @@ void ApplicationTask (void) {
                 burstAvgModeInit = false;
             } else {
                 // send the low pass filter value to the data visualizer
-                if(adcReadyFlag) {
+                if (adcReadyFlag) {
                     adcReadyFlag = false;
-                    EUSART1_Write(0x03); 
-                    EUSART1_Write(ADRESL);                                                   // Visualizer reads low byte first
-                    EUSART1_Write(ADRESH);                                                   // Then reads the high byte// These are commands sent to the Data Visualizer, 0x03 = Start                                              
-                    EUSART1_Write(ADFLTRL);                                                   // Visualizer reads low byte first
-                    EUSART1_Write(ADFLTRH);                                                   // Then reads the high byte
-                    EUSART1_Write(0xFC);                                                      // Stop command 
+                    EUSART1_Write(0x03);
+                    EUSART1_Write(ADRESL); // Visualizer reads low byte first
+                    EUSART1_Write(ADRESH); // Then reads the high byte// These are commands sent to the Data Visualizer, 0x03 = Start                                              
+                    EUSART1_Write(ADFLTRL); // Visualizer reads low byte first
+                    EUSART1_Write(ADFLTRH); // Then reads the high byte
+                    EUSART1_Write(0xFC); // Stop command 
                 }
             }
-            break; 
+            break;
         default:
             count = BASIC_MODE;
             lpfModeInit = false;
             break;
     }
 }
+
+void ADCUserInterrupt(void) {
+    unsigned int ch;
+    ch++;
+
+    adcReadyFlag = true;
+    
+}
+
+void TMR4UserInterrupt(void) {
+    if (RC5_GetValue()) {
+        count++;
+    }
+}

images/HardwareSetup.jpg

@@ -37,11 +37,15 @@ volatile bool lpfModeInit = false;
 
 // set the analog channel for ADCC
 void ADCC_SetChannel(adcc_channel_t channel);
-
+void ADCC_Initialize_BasicMode(void);
+void ADCC_Initialize_AverageMode(void);
+void ADCC_Initialize_BurstAverageMode(void);
+void ADCC_Initialize_LowPassFilterMode(void);
 // application task
 void ApplicationTask(void);
 
-
+void ADCUserInterrupt(void);
+void TMR4UserInterrupt(void);
 #ifdef	__cplusplus
 }
 #endif