MPAE-18219 implemented review comments from MCU8_TEJ-1486

Author: Glen-Nilsen

Icon-DataVisualizer-SettingsGear.png

@@ -8,12 +8,12 @@
 
 # MCC Melody ADC Data Streamer Example - Callbacks Implementation (PIC18F57Q43)
 
-The [ADC Data Streamer example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.ADCC.DATA.STREAMER&version=latest&redirect=true "Analog-to-Digital Conversion (ADC) Data Streamer example"), of the MCC Melody ADCC Example Component, is used in the Callbacks Implementation.  Displays ADCC samples visualized with the Data Streamer. An ADC conversion is taken every 100 ms on the selected analog channel, also toggling a LED and Debug GPIO. 
+The [ADC Data Streamer example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.ADCC.DATA.STREAMER&version=latest&redirect=true "Analog-to-Digital Conversion (ADC) Data Streamer example"), of the MCC Melody ADCC Example Component, is used in the Callbacks implementation and displays ADCC samples visualized with the Data Streamer. An Analog-to-Digital Conversion measurement is taken every 100 ms on the selected analog channel, also toggling an LED and Debug GPIO.
 
 ## MCC Melody Example Components
 Example Components are a tight integration of learning material directly into MCC. This allows users to conveniently place configuration instructions side-by-side to the components they are configuring. For more information, refer to the [MCC Melody Example Components Introduction](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES&version=latest&redirect=true). 
 
-**Note:** The image below shows the ADCC Example Component, as it would be moving to the ADCC Data Streamer (Callbacks Implementation), having implemented the ADCC Basic Printf (Callbacks Implementation). In this case a diff between the two examples is shown. 
+**Note:** The image below shows the ADCC Example Component, as it would be moving to the ADCC Data Streamer, having implemented the ADCC Basic Printf, both of which are part of the Callbacks implementation. In this case. a diff between the two examples is shown. 
 
 ![MCC Melody Example Components](images/ADCCDataStreamer_CallbacksFromBasiPrintfCallbacks-Intro.png)
 
@@ -48,7 +48,7 @@ All instructions required to recreate this example are listed below, under Confi
 
 ![TIMER Toggle LED, Callbacks Implementation](images/ADCC_DataStreamer_Callbacks-ConfigComplete.png)
 
-Once you have loaded the project in MPLAB X IDE, you will also be able to find more information from Tooltips and links next to the instructions 
+Once the project is loaded in MPLAB X IDE, the user will be able to find more information from Tooltips and links next to the instructions 
 [![Tooltip and link](images/Icon-info-circle-fill.png "Find the Tx pin from your schematic and set it in Pin Grid View.")](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.CONFIGHELP.UART.CNANO&version=latest&redirect=true).
 
 
@@ -57,44 +57,42 @@ Once you have loaded the project in MPLAB X IDE, you will also be able to find m
 
 ## Operation
 The image below shows the [ADCC Basic Printf example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.ADCC.PRINTF&version=latest&redirect=true
-) running, using the MPLAB Data Visualizer. 
+) running, using the MPLAB Data Visualizer.
+
+![Running the ADCC Basic Printf Example](images/Running_the_ADCC_Data_Streamer_Example.png)
+
+## Data Visualizer Configuration
 
 1) Click the ![Data Visualizer icon](images/Icon-MPLAB-DataVisualizer_1cm.png) icon to open the MPLAB Data Visualizer.
-2) Under the *Variable Streamers* tab (on the left hand side), click the ![Import ds file](images/button-import-ds-file.png "Import DS file.") button, to import a *.ds* file.
-3) From your project root, navigate into *mmc_generated_files/data_streamer/* directory.
-4) Click on the *data_streamer.ds* file to select it. 
-5) Then click the ![open button](images/button-open.png) button, to load the ds file.
+2) Under the **Variable Streamers** tab (on the left-hand side), click the ![Import ds file](images/button-import-ds-file.png "Import DS file.") button, to import a `.ds` file.
+3) From your project root, navigate into `mcc_generated_files/data_streamer/` directory.
+4) Click the `data_streamer.ds` file to select it. 
+5) Then click the ![open button](images/button-open.png) button to load the ds file.
 
-![Loading the ds file](images/Running the ADCC Data Streamer Example)
+![Loading the ds file](images/RunningDataStreamerEx-Open_ds_file_12cm.png)
 
-You should see a *data_streamer Properties* window, showing the *adcResult* and *adcSampleCount* variables loaded. 
+The data_streamer Properties window will open up, displaying the loaded adcResult and adcSampleCount variables. 
 
-1) Click the ![save button](images/button-save.png) button, to load this data streamer configuration. 
+1) Click the ![save button](images/button-save.png) button to load this data streamer configuration. 
 
 ![ds file loaded](images/ds_file_loaded_1_12cm.png)
 
-1) Click on the ![no source button](images/button-no-source.png) button.
-2) Select your board from those available. 
+2) Click the ![no source button](images/button-no-source.png) button.
+3) Select your board from those available. 
 
-   **Note:** If your board is not recognised by the MPLAB Data Visualizer, got to the Device Manager (Windows), to determine the COMx number.  
+   **Note:** If your board is not recognised by the MPLAB Data Visualizer, go to the Device Manager (Windows) to determine the COMx number.  
 
-3) Click on the ![settings gear icon](images/Icon-DataVisualizer-SettingsGear.png) icon, to bring up the COMx Settings. 
-4) Set the baud rate to 115200, then click out of the window to close the settings. 
-5) Click the ![Time Plot icon](images/Icon-DataVisualizer_TimePlot.png) icon, to plot all variables. 
+4) Click the ![settings gear icon](images/Icon-DataVisualizer-SettingsGear.png) icon to bring up the COMx Settings. 
+5) Set the baud rate to 115200, then click out of the window to close the settings. 
+6) Click the ![Time Plot icon](images/Icon-DataVisualizer_TimePlot.png) icon to plot all variables. 
 
 ![Data Streamer Config](images/DataStreamerConfig_25cm.png)
 
-1) Click on the *Connections* button.
-2) Under Debug GPIO, click the ![Add to time plot icon](images/Icon-DataVisualizer_TimePlot.png "Display as raw data on time plot.") icon, to add to the time plot.
+1) Click the **Connections** button.
+2) Under Debug GPIO, click the ![Add to time plot icon](images/Icon-DataVisualizer_TimePlot.png "Display as raw data on time plot.") icon to add to the time plot.
 
 ![Debug I/O Time Plot](images/DebugIO_TimePlot_8cm.png)
 
-If all is correct, when changing the pot meter value, you should see similar results to the below image.  
-
-![Running the ADCC Basic Printf Example](images/Running_the_ADCC_Data_Streamer_Example.png)
-
-
-## Summary
 For more example components, open the stand-alone Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) in MCC. 
 
 ![Standalone_CM](images/MCC_ContentManager_Examples_18cm.png) 

README.md

@@ -38,8 +38,11 @@
 static void ADCC_ConversionDone_Callback(void);
 static void Timer_Callback_100ms(void);
 
-static const struct TMR_INTERFACE *Timer = &Timer2; // TODO: Replace TimerX with name of const struct TMR_INTERFACE, from MCC Generated Files > timer > tmrx.c 
+static const struct TMR_INTERFACE *Timer_dsFrame = &Timer_ds; // TODO: Replace TimerX with name of const struct TMR_INTERFACE, from MCC Generated Files > timer > tmrx.c 
+static const struct TMR_INTERFACE *Timer_printfADC = &Timer_printf;  
+
 static volatile bool sendFrame = false;
+static volatile bool printResult = false;
 
 void ADCC_ConversionDone_Callback(void)
 {
@@ -56,14 +59,22 @@ void Timer_Callback_100ms(void)
     ADCC_StartConversion(channel_ANA7); // TODO: Replace x with the ADCC Channel you selected in Pin Grid View
 }
 
+void Timer_Callback_1s(void)
+{
+    printResult = true;
+}
+
+
 int main(void)
 {
     SYSTEM_Initialize();
 
     DataStreamer.adcSampleCount = 0;
     DataStreamer.adcResult = 0;
     ADCC_SetADIInterruptHandler(ADCC_ConversionDone_Callback);
-    Timer->TimeoutCallbackRegister(Timer_Callback_100ms);
+    
+    Timer_dsFrame->TimeoutCallbackRegister(Timer_Callback_100ms);
+    Timer_printfADC->TimeoutCallbackRegister(Timer_Callback_1s);
 
     INTERRUPT_GlobalInterruptEnable();
 
@@ -74,5 +85,11 @@ int main(void)
             WriteFrame();
             sendFrame = false;
         }
+        if (printResult)
+        {
+            (void) printf("The ADC Result is: %d\r\n", DataStreamer.adcResult);
+            IO_Debug_SetHigh();
+            printResult = false;
+        }
     }
 }

pic18f57q43-adcc-data-streamer-callbacks-mcc.X/main.c

@@ -2,15 +2,15 @@
 
 manifest_file_version: 1.0.0
 project: pic18f57q43-adcc-data-streamer-callbacks-mcc
-creation_date: 2024-08-07T17:23:42.438+02:00[Europe/Paris]
+creation_date: 2024-09-05T14:43:22.931+02:00[Europe/Paris]
 operating_system: Windows 10
 mcc_mode: IDE
 mcc_mode_version: v6.20
 device_name: PIC18F57Q43
 compiler: XC8 2.46
 mcc_version: 5.5.1
 mcc_core_version: 5.7.1
-content_manager_version: 5.0.1-e
+content_manager_version: 5.0.1
 is_mcc_offline: false
 is_using_prerelease_versions: false
 mcc_content_registries: https://registry.npmjs.org/

pic18f57q43-adcc-data-streamer-callbacks-mcc.X/mcc-manifest-autosave.yml

@@ -2,15 +2,15 @@
 
 manifest_file_version: 1.0.0
 project: pic18f57q43-adcc-data-streamer-callbacks-mcc
-creation_date: 2024-08-07T17:23:42.405+02:00[Europe/Paris]
+creation_date: 2024-09-05T14:43:22.901+02:00[Europe/Paris]
 operating_system: Windows 10
 mcc_mode: IDE
 mcc_mode_version: v6.20
 device_name: PIC18F57Q43
 compiler: XC8 2.46
 mcc_version: 5.5.1
 mcc_core_version: 5.7.1
-content_manager_version: 5.0.1-e
+content_manager_version: 5.0.1
 is_mcc_offline: false
 is_using_prerelease_versions: false
 mcc_content_registries: https://registry.npmjs.org/

pic18f57q43-adcc-data-streamer-callbacks-mcc.X/mcc-manifest-generated-success.yml

@@ -38,7 +38,7 @@
 #include <xc.h>
 #include "../tmr2.h"
 
-const struct TMR_INTERFACE Timer2 = {
+const struct TMR_INTERFACE Timer_ds = {
     .Initialize = TMR2_Initialize,
     .Start = TMR2_Start,
     .Stop = TMR2_Stop,

pic18f57q43-adcc-data-streamer-callbacks-mcc.X/mcc_generated_files/timer/src/tmr2.c

@@ -43,62 +43,62 @@
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_Initialize API
  */
-#define Timer2_Initialize TMR2_Initialize
+#define Timer_ds_Initialize TMR2_Initialize
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_ModeSet API
  */
-#define Timer2_ModeSet TMR2_ModeSet
+#define Timer_ds_ModeSet TMR2_ModeSet
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_ExtResetSourceSet API
  */
-#define Timer2_ExtResetSourceSet TMR2_ExtResetSourceSet
+#define Timer_ds_ExtResetSourceSet TMR2_ExtResetSourceSet
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_Start API
  */
-#define Timer2_Start TMR2_Start
+#define Timer_ds_Start TMR2_Start
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_Stop API
  */
-#define Timer2_Stop TMR2_Stop
+#define Timer_ds_Stop TMR2_Stop
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_Read API
  */
-#define Timer2_Read TMR2_Read
+#define Timer_ds_Read TMR2_Read
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_Write API
  */
-#define Timer2_Write TMR2_Write
+#define Timer_ds_Write TMR2_Write
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_PeriodCountSet API
  */
-#define Timer2_PeriodCountSet TMR2_PeriodCountSet
+#define Timer_ds_PeriodCountSet TMR2_PeriodCountSet
 
 /**
  * @ingroup tmr2
  * @brief Defines the Custom Name for the \ref TMR2_OverflowCallbackRegister API
  */
-#define Timer2_OverflowCallbackRegister TMR2_OverflowCallbackRegister
+#define Timer_ds_OverflowCallbackRegister TMR2_OverflowCallbackRegister
 
 /**
  @ingroup tmr2
  @struct TMR_INTERFACE
  @brief This is an instance of TMR_INTERFACE for TMR2 module.
  */
-extern const struct TMR_INTERFACE Timer2;
+extern const struct TMR_INTERFACE Timer_ds;
 
 /**
  * @ingroup tmr2

pic18f57q43-adcc-data-streamer-callbacks-mcc.X/mcc_generated_files/timer/tmr2.h

@@ -425,6 +425,18 @@ void UART1_TransmitISR(void)
     }
 }
 
+int getch(void)
+{
+    while(!(UART1_IsRxReady()));
+    return UART1_Read();
+}
+
+void putch(char txData)
+{
+    while(!(UART1_IsTxReady()));
+    return UART1_Write(txData);   
+}
+