MPAE-18221 updating readme

Author: Glen-Nilsen

README.md

@@ -6,16 +6,16 @@
    </picture>
 </a>
 
-# MCC Melody ADC Data Streamer Example - Callbacks Implementation (PIC18F57Q43)
+# MCC Melody ADC Spike Detection 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 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.
+The [ADC Spike Detection Example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.ADCC.SPIKE&version=latest&redirect=true "Analog-to-Digital Conversion (ADC) Data Streamer example"), ADCC Spike Detection is visualized with the Data Streamer. The spike detection can be modified to observe the change in sensitivity, to the rate of change of the ADC samples. Using a Callback Design Pattern, a change (above a set threshold) in the ADC result between successive conversions represents a \"spike\". Every 100 ms a timer callback starts an ADC conversion. If a spike occurs, adcResult_lastSpike and adcSpikeCount are updated in ADC Spike callback and a flag is set to send a Data Streamer frame.
 
 ## 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, 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. 
+**Note:** The image below shows the ADCC Example Component, as it would be moving to the ADCC Spike Detect Example, having implemented the ADCC Data Streamer Example, both of which are in the Callbacks implementation. In this case. a diff between the two examples is shown. 
 
-![MCC Melody Example Components](images/ADCCDataStreamer_CallbacksFromBasiPrintfCallbacks-Intro.png)
+![MCC Melody Example Components](images/ADCCExample-SpikeDetect-Callbacks-fromADCC-DataStreamer-Callbacks.png)
 
 
 Complete projects, available in [MPLAB® Discover](https://mplab-discover.microchip.com) or GitHub, are specific to a board and microcontroller. However, the current project could be recreated on a range of supported microcontrollers by following the steps in the example component.
@@ -31,7 +31,7 @@ Example Components are related to [MCC Melody Design Patterns for Control Flow](
 - MPLAB® XC8 2.46.0 or newer [(MPLAB® XC8 2.46)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
 
 - MPLAB® Code Configurator (MCC) Plugin Version 5.5.1 or newer (*Tools>Plugins>Installed*, search: "MCC")
-- ADC Converter with Computation (ADCC) Example Component 1.0.0 or newer
+- ADC Converter with Computation (ADCC) Example Component 1.0.0 
 - MCC Core 5.7.1 or newer 
 - MCC Melody Core 2.7.1 or newer (Communicates with the MCC core, providing views and other functionality for MCC Melody)
 
@@ -46,7 +46,7 @@ Example Components are related to [MCC Melody Design Patterns for Control Flow](
 ## Setup
 All instructions required to recreate this example are listed below, under Configuration Instructions.   
 
-![TIMER Toggle LED, Callbacks Implementation](images/ADCC_DataStreamer_Callbacks-ConfigComplete.png)
+![TIMER Toggle LED, Callbacks Implementation](images/ADCC_SpikeDetect_Callbacks-ConfigComplete.png)
 
 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).
@@ -59,7 +59,7 @@ Once the project is loaded in MPLAB X IDE, the user will be able to find more in
 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 the ADCC Basic Printf Example](images/Running_the_ADCC_Data_Streamer_Example.png)
+![Running the ADCC Basic Printf Example](images/Running%20the%20ADCC%20Spike%20example.png)
 
 ## Data Visualizer Configuration
 
@@ -73,9 +73,9 @@ The image below shows the [ADCC Basic Printf example](https://onlinedocs.microch
 
 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, for the ADCC Spike Detect Example. 
 
-![ds file loaded](images/ds_file_loaded_1_12cm.png)
+![ds file loaded](images/ds_file_loaded_spikeDetect.png)
 
 2) Click the ![no source button](images/button-no-source.png) button.
 3) Select your board from those available. 

images/ADCCExample-SpikeDetect-Callbacks-fromADCC-DataStreamer-Callbacks.png

@@ -2,7 +2,7 @@
 
 manifest_file_version: 1.0.0
 project: pic18f57q43-adcc-spike-detection-callbacks-mcc
-creation_date: 2024-09-06T11:41:20.895+02:00[Europe/Paris]
+creation_date: 2024-09-06T12:08:55.096+02:00[Europe/Paris]
 operating_system: Windows 10
 mcc_mode: IDE
 mcc_mode_version: v6.20